wamp-worker 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 100ca25f15cff8d32a52b162a735f31cdb2753ef
-  data.tar.gz: a9895ee49189e59cfc5a90d7466da65cca11cd09
+  metadata.gz: d59dde6fad655ba748c0aaec07b00104922c21ad
+  data.tar.gz: 04b00eacf5d7a51f84c2e1d5bbaed32b24f68a41
 SHA512:
-  metadata.gz: f001f796d69ea9e0e076035efaa45c6f759f2cd573c5252a8aa083806e41eb506e8b56052d5e88e24e2ec357ee5e2564caa69a8acacc379f86586ce6d5b28d5b
-  data.tar.gz: 45d4550224b221af0e22d2164f5ea48dacd38442e017d286687eef8bcf5ac81e68f17005b3965c804b9f40e39aa09b14d5ff37e93abd262fdf1b16277b32f337
+  metadata.gz: 241db674bc4577109ddc1ceea83200ba0f592d97c2c69b0a568422ea05708aee5b1b9900c3c38dbc967030f2ce46c44cbaf14859fcaa56f2298382c6a8b6f345
+  data.tar.gz: 158cb1345b8401eccc38e50a5fa83508de319b4371ce6450cabf8b1d659afa07137463dba1f533a1e36f81d93050c615cde47b1d39d3efe2c83438dfa30e21c5

data/.gitignore

@@ -11,3 +11,4 @@
 /test/wamp_test/log/
 *.pyc
 .idea/
+*.gem

data/.travis.yml

@@ -2,4 +2,4 @@ sudo: false
 language: ruby
 rvm:
   - 2.3.0
-before_install: gem install bundler -v 1.13.2
+before_install: gem install bundler -v 1.17

data/README.md

@@ -1,7 +1,7 @@
 # Wamp::Worker
 
-[![Gem Version](https://badge.fury.io/rb/wamp-worker.svg)](https://badge.fury.io/rb/wamp_client)
-[![Circle CI](https://circleci.com/gh/ericchapman/ruby_wamp_worker/tree/master.svg?&style=shield&circle-token=92813c17f9c9510c4c644e41683e7ba2572e0b2a)](https://circleci.com/gh/ericchapman/ruby_wamp_worker/tree/master)
+[![Gem Version](https://badge.fury.io/rb/wamp-worker.svg)](https://badge.fury.io/rb/wamp-worker)
+[![CI Status](https://travis-ci.org/ericchapman/ruby_wamp_worker.svg?branch=master)](https://travis-ci.org/ericchapman/ruby_wamp_worker)
 [![Codecov](https://img.shields.io/codecov/c/github/ericchapman/ruby_wamp_worker/master.svg)](https://codecov.io/github/ericchapman/ruby_wamp_worker)
 
 Rails worker for talking to a WAMP Router which is described [here](https://tools.ietf.org/html/draft-oberstet-hybi-tavendo-wamp-02)
@@ -42,6 +42,9 @@ Some notes about Wamp::Worker
    
 ## Revision History
 
+ - v0.0.2:
+   - Updated to use Wamp::Client logger
+   - Other minor cleanup
  - v0.0.1:
    - Initial Release
 
@@ -65,8 +68,9 @@ Or install it yourself as:
 
 ### Configuration
 
-To configure Wamp::Worker, create a "config/initializers/wamp-worker.rb" file with the
-following options
+To configure Wamp::Worker, create a initializer file with the following options
+
+**config/initializers/wamp-worker.rb**
 
 ``` ruby
 Wamp::Worker.configure do
@@ -87,7 +91,8 @@ The attributes are defined as follows
 You can also "subscribe" and "register" in the configuration object.  That will be 
 described later.
 
-**Note that you MUST make sure "config.eager_load = true" is set in the environment files**
+**Note that you MUST make sure "config.eager_load = true" is set in the environment files
+located in "config/environments/\*.rb"**
 
 ### Multiple Workers
 
@@ -154,27 +159,42 @@ For Rails applications that have Sidekiq, you can push the processing of the han
 to the background by including "Wamp::Worker::BackgroundHandler" instead of
 "Wamp::Worker::Handler".
 
-### Rails Access
+### Call/Publish Methods
 
-The library also supports "call" and "publish" methods from Rails objects.  This is
-done by including "Wamp::Worker::Session" in your class.  For example
+The library also supports "call" and "publish" methods from objects outside of the
+worker.  This is done by including "Wamp::Worker::Session" in your class.  For example
 
-**app/controllers/application_controller.rb**
+**app/controllers/add_controller.rb**
 
 ``` ruby
-class ApplicationController < ActionController::Base
+class AddController < ApplicationController
   include Wamp::Worker::Session.new
+  
+  def index
+    response = nil
+
+    self.wamp_session.call "com.example.back.add", [params[:a].to_i, params[:b].to_i] do |result, error, details|
+      response = result
+    end
+
+    render json: { result: response }
+  end
 end
 ```
 
+Note that the name defaults to ":default" and the method "wamp_session".  These
+can be overridden by adding the following attributes to the "include"
+
 **app/controllers/add_controller.rb**
 
 ``` ruby
 class AddController < ApplicationController
+  include Wamp::Worker::Session.new, :other, :different_session
+  
   def index
     response = nil
 
-    self.wamp_session.call "com.example.back.add", [params[:a].to_i, params[:b].to_i] do |result, error, details|
+    self.different_session.call "com.example.back.add", [params[:a].to_i, params[:b].to_i] do |result, error, details|
       response = result
     end
 
@@ -183,22 +203,52 @@ class AddController < ApplicationController
 end
 ```
 
-Note that the name defaults to ":default" and the method ":wamp_session".  These
-can be overridden by including in the "include"
-
-``` ruby
-class ApplicationController < ActionController::Base
-  include Wamp::Worker::Session.new :other, method: :different_session
-end
-```
+This will talk to the ":other" worker and expose it using "different_session"
+rather than "wamp_session"
 
 ### Starting the Worker
 
+There are 2 different ways you can start a worker
+
+#### Rails/Heroku worker
+
 To start the worker, use the "wamp-worker" executable
 
     $ bundle exec wamp-worker
     
-this executable supports the following options
+This executable supports the following options
 
  - "-l" (default: "info"): logging level (debug, info, warn, error)
  - "-n" (default: "default"): name of the worker
+ - "-e" (default: "development"): application environment to load
+
+or in your Procfile for Heroku
+
+**Procfile**
+
+```
+web: bundle exec puma -C config/puma.rb
+worker: bundle exec wamp-worker -e production
+```
+
+#### Thread
+
+You can also spawn a thread inside if your application.  One way to do this
+is as follows
+
+**config/initializers/wamp-worker.rb**
+
+``` ruby
+require "thread"
+
+Thread.new do
+  Wamp::Worker.run uri: 'ws://127.0.0.1:8080/ws', realm: 'realm1'
+end
+```
+
+Note that this method is not recommended for scalable designs because it will
+create a new instance of the worker every time you scale the web instance.
+Only do this if you really know what you are doing.
+
+Also, when calling "register", you must include the "invoke" option.  See WAMP
+documentation for more details.

data/lib/wamp/worker.rb

@@ -13,13 +13,13 @@ require "redis"
 module Wamp
   module Worker
 
-    # Used to include a requestor in a rails class
+    # Used to include a requestor in any class
     #
     class Session
       def self.new(name=nil, method: :wamp_session)
         name ||= DEFAULT
         Module.new do
-          define_method(method) { Wamp::Worker.requestor(name) }
+          define_method(method) { Proxy::Requestor.new(name) }
         end
       end
     end
@@ -36,12 +36,7 @@ module Wamp
     # Returns the logger object
     #
     def self.logger
-      unless defined?(@logger)
-        $stdout.sync = true unless ENV['RAILS_ENV'] == "production"
-        @logger = Logger.new $stdout
-        @logger.level = Logger::INFO
-      end
-      @logger
+      Wamp::Client.logger
     end
 
     # Sets the log level
@@ -49,20 +44,6 @@ module Wamp
     # @param log_level [Symbol] - the desired log level
     def self.log_level=(log_level)
       Wamp::Client.log_level = log_level
-      level =
-          case log_level
-          when :error
-            Logger::ERROR
-          when :debug
-            Logger::DEBUG
-          when :fatal
-            Logger::FATAL
-          when :warn
-            Logger::WARN
-          else
-            Logger::INFO
-          end
-      self.logger.level = level
     end
 
     # Method to configure the worker
@@ -75,7 +56,7 @@ module Wamp
     # Method to start a worker
     #
     # @param name [Symbol] - The name of the connection
-    def self.run(name, **args)
+    def self.run(name=nil, **args)
       name ||= DEFAULT
 
       # Get the connection info
@@ -85,17 +66,6 @@ module Wamp
       Runner::Main.new(name, **options).start
     end
 
-    # Returns a requestor for objects to perform calls to the worker
-    #
-    # @param name [Symbol] - The name of the connection
-    # @return [Wamp::Worker::Proxy::Requestor] - An object that can be used to make requests
-    def self.requestor(name)
-      name ||= DEFAULT
-
-      # Create a requestor proxy for the connection
-      Proxy::Requestor.new(name)
-    end
-
     # Registers procedures
     #
     # @param name [Symbol] - The name of the connection
@@ -107,8 +77,14 @@ module Wamp
           self.logger.debug("#{self.name} invoking handler '#{r.klass}##{r.method}' for procedure '#{r.procedure}'")
           r.klass.create(proxy, :procedure, a, k, d).invoke(r.method)
         }
-        session.register(r.procedure, handler, r.options)
-        self.logger.info("#{self.name} register '#{r.klass}##{r.method}' for procedure '#{r.procedure}'")
+        session.register(r.procedure, handler, r.options) do |result, error, details|
+          if error
+            self.logger.error("#{self.name} register failed '#{r.klass}##{r.method}' for procedure '#{r.procedure}'")
+            self.logger.error("   error: #{error.inspect}")
+          else
+            self.logger.info("#{self.name} registered for '#{r.klass}##{r.method}' for procedure '#{r.procedure}'")
+          end
+        end
       end
     end
 
@@ -123,8 +99,14 @@ module Wamp
           self.logger.debug("#{self.name} invoking handler '#{s.klass}##{s.method}' for subscription '#{s.topic}'")
           s.klass.create(proxy, :subscription, a, k, d).invoke(s.method)
         }
-        session.subscribe(s.topic, handler, s.options)
-        self.logger.info("#{self.name} subscribe '#{s.klass}##{s.method}' for topic '#{s.topic}'")
+        session.subscribe(s.topic, handler, s.options) do |result, error, details|
+          if error
+            self.logger.error("#{self.name} subscribe failed '#{s.klass}##{s.method}' for topic '#{s.topic}'")
+            self.logger.error("   error: #{error.inspect}")
+          else
+            self.logger.info("#{self.name} subscribed '#{s.klass}##{s.method}' for topic '#{s.topic}'")
+          end
+        end
       end
     end
 

data/lib/wamp/worker/runner.rb

@@ -110,11 +110,6 @@ module Wamp
           @client = options[:client] || Wamp::Client::Connection.new(options)
           @active = false
 
-          # Log the event
-          logger.info("#{self.class.name} '#{self.name}' created with options")
-          logger.info("   uri: #{options[:uri]}")
-          logger.info("   realm: #{options[:realm]}")
-
           # Create a queue for passing messages to the main runner
           @descriptor_queue = ::Queue.new
 

data/lib/wamp/worker/version.rb

@@ -1,5 +1,5 @@
 module Wamp
   module Worker
-    VERSION = "0.1.0"
+    VERSION = "0.1.1"
   end
 end

data/spec/spec_helper.rb

@@ -1,11 +1,13 @@
 require 'simplecov'
-SimpleCov.start do
-  add_filter 'spec/'
-end
+SimpleCov.start
 
-$LOAD_PATH.unshift File.expand_path("../../lib", __FILE__)
 require "wamp/worker"
 
+if ENV['CODECOV_TOKEN']
+  require 'codecov'
+  SimpleCov.formatter = SimpleCov::Formatter::Codecov
+end
+
 Dir[File.expand_path('spec/support/**/*.rb')].each { |f| require f }
 
 require 'sidekiq/testing'

data/spec/wamp/worker/runner_spec.rb

@@ -3,7 +3,7 @@ require "spec_helper"
 describe Wamp::Worker::Runner do
   let(:name) { :other }
   let(:runner) { described_class::Main.new(name) }
-  let(:requestor) { Wamp::Worker.requestor(name) }
+  let(:requestor) { Wamp::Worker::Proxy::Requestor.new(name) }
 
   def execute_runner
 
@@ -65,12 +65,10 @@ describe Wamp::Worker::Runner do
 
   it "increments the ticker" do
     expect(runner.dispatcher.ticker.get).to eq(0)
-
-    expect {
-      execute_runner do
-        sleep(2.5)
-      end
-    }.to change{ runner.dispatcher.ticker.get }.by(3)
+    execute_runner do
+      sleep(2)
+    end
+    expect(runner.dispatcher.ticker.get).not_to eq(0)
   end
 
   context "challenge" do

data/test/wamp_test/Gemfile

@@ -34,7 +34,7 @@ gem 'jbuilder', '~> 2.5'
 # gem 'capistrano-rails', group: :development
 
 gem 'sidekiq'
-gem 'wamp-worker'
+gem 'wamp-worker', '~> 0.1.1'
 
 # Reduces boot times through caching; required in config/boot.rb
 gem 'bootsnap', '>= 1.1.0', require: false

data/test/wamp_test/Gemfile.lock

@@ -189,10 +189,10 @@ GEM
       thread_safe (~> 0.1)
     uglifier (4.1.20)
       execjs (>= 0.3.0, < 3)
-    wamp-worker (0.1.0)
-      redis
-      wamp_client (>= 0.1.2)
-    wamp_client (0.2.0)
+    wamp-worker (0.1.1)
+      redis (~> 4.0)
+      wamp_client (~> 0.2.2)
+    wamp_client (0.2.2)
       json (~> 2.0)
       websocket-eventmachine-client (~> 1.1)
     web-console (3.7.0)
@@ -236,7 +236,7 @@ DEPENDENCIES
   turbolinks (~> 5)
   tzinfo-data
   uglifier (>= 1.3.0)
-  wamp-worker
+  wamp-worker (~> 0.1.1)
   web-console (>= 3.3.0)
 
 RUBY VERSION

data/wamp-worker.gemspec

@@ -27,6 +27,6 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = '>= 2.3'
 
-  spec.add_dependency 'wamp_client', '~> 0.2.0'
+  spec.add_dependency 'wamp_client', '~> 0.2.2'
   spec.add_dependency 'redis', '~> 4.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wamp-worker
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Eric Chapman
@@ -100,14 +100,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: 0.2.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: 0.2.2
 - !ruby/object:Gem::Dependency
   name: redis
   requirement: !ruby/object:Gem::Requirement