htmon-client 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d9563ea02f37218a9bfe83d1a35afc325ba6aaaf
+  data.tar.gz: 81c0b262b988fbbc77e6549f5b5b861f834384e0
+SHA512:
+  metadata.gz: a2bff3bc01d0c2e07971cc1c4b5558e8c04b202ba055190305832c8c55b25406858091de94d2cc96be9fde3120c6591ba80e0436857476baf2ed86f26881fac9
+  data.tar.gz: 6a47b8845797983e42d36686aeb41ebf16f22ea156a8699160982ccf3cdc39a08bf5da71dc8f899894e91e5eaf104a8bf69763251704c661402b1b9856533257

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.11.2

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+group :development do
+  gem 'pry'
+end
+# Specify your gem's dependencies in htmon-client.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Tim Foerster
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,57 @@
+# Htmon::Client
+
+A Faye-Websocket based Websocket or ActionCable client.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'htmon-client'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install htmon-client
+
+## Usage
+
+Initialize client, which automatically connects and reconnects to server, by default.
+
+```ruby
+  client = Htmon::Client.new(server: 'ws://example.org/cable', channels: 'SystemChannel')
+```
+
+The autoreconnect could be disables by passing autoconnect: false to constructor.
+
+You are able to react on open and receive events.
+
+```ruby
+  # Globally
+  Htmon::Client.on_receive do |mesage|
+    # content will be dumped and replied
+    { command: :message ... }
+  end
+
+  # Instance based
+  client.on_receive do |mesage|
+    # content will be dumped and replied
+    { command: :message ... }
+  end
+```
+
+If a callbacks will return *nil*, then the reply will be skipped. 
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/timmyArch/htmon-client.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "htmon/client"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/htmon-client.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'htmon/client/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "htmon-client"
+  spec.version       = Htmon::Client::VERSION
+  spec.authors       = ["Tim Foerster"]
+  spec.email         = ["github@mailserver.1n3t.de"]
+
+  spec.summary       = %q{Websocket client}
+  spec.homepage      = "https://github.com/timmyArch/htmon-client"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_dependency "activesupport"
+  spec.add_dependency "faye-websocket"
+end

data/lib/htmon/client.rb

@@ -0,0 +1,137 @@
+require "htmon/client/version"
+require 'faye/websocket'
+require 'eventmachine'
+require 'logger'
+require 'json'
+require 'active_support/core_ext/time'
+
+Thread.abort_on_exception = true
+
+module Htmon
+  class Client
+
+    attr_reader :server, :autoconnect, :channels
+
+    attr_accessor :reconnect, :timeout
+
+    def self.on_receive &block
+      callbacks[:receive] << block
+    end
+    
+    def on_receive &block
+      callbacks[:receive] << block
+    end
+ 
+    def self.on_open &block
+      callbacks[:open] << block
+    end
+    
+    def on_open &block
+      callbacks[:open] << block
+    end
+
+    def initialize server: nil, channels: [], autoconnect: true, timeout: 2
+      @autoconnect, @server = autoconnect, server
+      @timeout = timeout
+      @channels = [channels].flatten
+      connect! if autoconnect
+      autoconnect! if autoconnect
+      register_subscriber_callbacks
+    end
+
+    def connect!
+      @thread ||= Thread.new do
+        EM.run do
+          ws = Faye::WebSocket::Client.new(server)
+
+          ws.on :open do |event|
+            logger.info "Connection opened"
+            (self.class.callbacks[:open] + callbacks[:open]).each do |x| 
+              Timeout::timeout(timeout) do
+                ret = x.call(event)
+                ws.send JSON.dump(ret) if ret
+              end rescue nil
+            end
+          end
+
+          ws.on :message do |event|
+            logger.debug "Message received: #{event.data.inspect}"
+            self.reconnect = Time.now + 5
+            (self.class.callbacks[:receive] + callbacks[:receive]).each do |x| 
+              Timeout::timeout(timeout) do 
+                ret = x.call(event.date)
+                ws.send JSON.dump(ret) if ret
+              end rescue nil
+            end
+          end
+
+          ws.on :close do |event|
+            logger.info("Connection closed { code: #{event.code},"+
+                        " reason: #{event.reason.inspect} }")
+          end
+          
+          ws.on :error do |event|
+            logger.info("Connection error occured... #{event.inspect}")
+          end
+        end
+      end
+    end
+
+    def reconnect!
+      disconnect! and connect!
+    end
+
+    def disconnect!
+      @thread.kill rescue nil
+    ensure 
+      @thread = nil
+    end
+
+    def self.logger
+      @logger ||= Logger.new(STDOUT)
+    end
+
+    def logger
+      @logger ||= begin
+                    l = self.class.logger.dup
+                    l.instance_variable_set(:@progname, 
+                                            "Websocket##{server}")
+                    l
+                  end
+    end
+
+    def self.callbacks
+      @callbacks ||= { open: [],
+                       receive: [] }
+    end
+    
+    def callbacks
+      @callbacks ||= { open: [],
+                       receive: [] }
+    end
+    
+    private
+    
+    def autoconnect!
+      @autoconnect_poller ||= Thread.new do
+        loop do
+          if self.reconnect and self.reconnect.past?
+            logger.info "Connection will be restored ... "
+            reconnect!
+          end
+          sleep 1
+        end
+      end
+    end
+
+    def register_subscriber_callbacks
+      channels.each do |x|
+        on_open do
+          { command: :subscribe, identifier: JSON.dump(channel: x) }
+        end
+      end
+    end
+
+
+  end
+end

data/lib/htmon/client/version.rb

@@ -0,0 +1,5 @@
+module Htmon
+  class Client
+    VERSION = "0.1.0"
+  end
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: htmon-client
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tim Foerster
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-02-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faye-websocket
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- github@mailserver.1n3t.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- htmon-client.gemspec
+- lib/htmon/client.rb
+- lib/htmon/client/version.rb
+homepage: https://github.com/timmyArch/htmon-client
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Websocket client
+test_files: []