wamp_client 0.1.4 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 35fec0c02c367a33b50ea31953fbd8dc6c27e59e
-  data.tar.gz: c8d09d7b4b8982268f4f761b8b308d43aecca67b
+  metadata.gz: 581eccd047b7af79793d5fa979acf389b3f9b6b3
+  data.tar.gz: c08465e7c7ff8c4d631e8213af9f4bc940b35731
 SHA512:
-  metadata.gz: b7a400d331ea4fcf219543f6652be2c571a8aa11ec2dcd460283b5b4b2a8ff4b577a08d9968260a17e9be38d634f61f92de8dc4c4a2ad5379af6557d0245b5e7
-  data.tar.gz: 040ced48fc89779307a76a277bb491d993955b6b04d18054229806b05a8fecc2a5cc09032b75cbb8dd0c5b6c21d0967b56850d785add51d013db7e4a0ab10d6b
+  metadata.gz: c24b0896d73a539ede06d8e369f9003bc3e3c5e3fe4b22d3e4726509aaea7ec7bff767718e6ea504fd07af0bc7b3e844448831feeb19480f1797dea6dd073840
+  data.tar.gz: fea059c5cd3b4221b57dd0e3f90a7501c511cbf67168acfd9d3e467a8dd314c5604bfea33ea26fd211eb760ca3c61d65c65913160f7f69a71ab48ec6c398747b

data/README.md

@@ -6,10 +6,21 @@
 
 Client for talking to a WAMP Router.  This is defined [here](https://tools.ietf.org/html/draft-oberstet-hybi-tavendo-wamp-02)
 
-Please use [wamp_rails](https://github.com/ericchapman/ruby_wamp_rails) to integrate this GEM in to RAILS.
+Note: [wamp_rails](https://github.com/ericchapman/ruby_wamp_rails) has been deprecated in favor of
+[wamp-worker](https://github.com/ericchapman/ruby_wamp_worker) which allows this library to be run
+in a RAILS worker.  It will also allow integration with Sidekiq to support allowing handlers to
+execute in the background.
 
 ## Revision History
 
+ - v0.2.0:
+   - Breaking changes to the API including
+     - Moving CallResult, CallError, CallDefer, and ProgressiveCallDefer to common module called "Response"
+     - Results to calls return a Hash object instead of a CallResult object
+     - Catches "StandardError" instead of "Exception"
+     - Session object has been split into *request* and *manager* objects
+     - Callback subscriptions are now all "on(event)"
+   - Lots of code cleanup and combining handling of methods
  - v0.1.4:
    - Wrapped defer logic inside of yield method for cleanliness
  - v0.1.3:
@@ -79,11 +90,7 @@ A connection can be created as follows
 ```ruby
 require 'wamp/client'
 
-options = {
-    uri: 'ws://127.0.0.1:8080/ws',
-    realm: 'realm1',
-}
-connection = Wamp::Client::Connection.new(options)
+connection = Wamp::Client::Connection.new(uri: 'ws://127.0.0.1:8080/ws', realm: 'realm1')
 
 connection.on(:join) do |session, details|
   puts "Session Open"
@@ -97,7 +104,7 @@ connection.on(:join) do |session, details|
     # Call It
     session.call('com.example.procedure', [3,4]) do |result, error, details|
       if result
-        puts result.args[0] # => 7
+        puts result[:args][0] # => 7
       end
     end
 
@@ -163,12 +170,7 @@ method 'add_tick_loop'
 ```ruby
 require 'wamp/client'
 
-options = {
-    uri: 'ws://127.0.0.1:8080/ws',
-    realm: 'realm1',
-}
-
-connection = Wamp::Client::Connection.new(options)
+connection = Wamp::Client::Connection.new(uri: 'ws://127.0.0.1:8080/ws', realm: 'realm1')
 
 connection.transport_class.add_tick_loop do
   # Do something periodic
@@ -516,8 +518,8 @@ To call, do the following
 ```ruby
 session.call('com.example.procedure', [15], {param: value}, {}) do |result, error, details|
   # TODO: Do something
-  args = result.args
-  kwargs = result.kwargs
+  args = result[:args]
+  kwargs = result[:kwargs]
 end
 ```
 
@@ -532,11 +534,11 @@ Errors can either be raised OR returned as shown below
 
 ```ruby
 handler = lambda do |args, kwargs, details|
-  raise 'error'
+  raise RuntimeError,'error'
   # OR
-  raise Wamp::Client::CallError.new('wamp.error', ['some error'], {details: true})
+  raise Wamp::Client::Response::CallError.new('wamp.error', ['some error'], {details: true})
   # OR
-  Wamp::Client::CallError.new('wamp.error', ['some error'], {details: true})
+  Wamp::Client::Response::CallError.new('wamp.error', ['some error'], {details: true})
 end
 session.register('com.example.procedure', handler)
 ```
@@ -549,7 +551,7 @@ caller.  This is shown below
 
 ```ruby
 def add(args, kwargs, details)
-  defer = Wamp::Client::Defer::CallDefer.new
+  defer = Wamp::Client::Response::CallDefer.new
   EM.add_timer(2) {  # Something Async
     defer.succeed(args[0]+args[1])
   }
@@ -562,9 +564,9 @@ Errors are returned as follows
 
 ```ruby
 def add(args, kwargs, details)
-  defer = Wamp::Client::Defer::CallDefer.new
+  defer = Wamp::Client::Response::CallDefer.new
   EM.add_timer(2) {  # Something Async
-    defer.fail(Wamp::Client::CallError.new('test.error'))
+    defer.fail(Wamp::Client::Response::CallError.new('test.error'))
   }
   defer
 end
@@ -579,7 +581,7 @@ Progressive calls are ones that return the result in pieces rather than all at o
 ```ruby
 results = []
 session.call('com.example.procedure', [], {}, {receive_progress: true}) do |result, error, details|
-  results = results + result.args
+  results = results + result[:args]
   unless details[:progress]
     puts results # => [1,2,3,4,5,6]
   end
@@ -590,15 +592,15 @@ end
 
 ```ruby
 def add(args, kwargs, details)
-  defer = Wamp::Client::Defer::ProgressiveCallDefer.new
+  defer = Wamp::Client::Response::ProgressiveCallDefer.new
   EM.add_timer(2) {  # Something Async
-    defer.progress(Wamp::Client::CallResult.new([1,2,3]))
+    defer.progress(Wamp::Client::Response::CallResult.new([1,2,3]))
   }
   EM.add_timer(4) {  # Something Async
-    defer.progress(Wamp::Client::CallResult.new([4,5,6]))
+    defer.progress(Wamp::Client::Response::CallResult.new([4,5,6]))
   }
   EM.add_timer(6) {  # Something Async
-    defer.succeed(Wamp::Client::CallResult.new)
+    defer.succeed(Wamp::Client::Response::CallResult.new)
   }
   defer
 end
@@ -613,8 +615,8 @@ A cancelled call will tell a callee who implements a progressive call to cancel
 ```ruby
 call = session.call('com.example.procedure', [15], {param: value}, {}) do |result, error, details|
   # TODO: Do something
-  args = result.args
-  kwargs = result.kwargs
+  args = result[:args]
+  kwargs = result[:kwargs]
 end
 
 # At some later time...
@@ -641,20 +643,20 @@ def interrupt_handler(request, mode)
 end
 
 def add(args, kwargs, details)
-  defer = Wamp::Client::Defer::ProgressiveCallDefer.new
+  defer = Wamp::Client::Response::ProgressiveCallDefer.new
   EM.add_timer(2) {  # Something Async
     if @interrupts[defer.request].nil?
-      defer.progress(Wamp::Client::CallResult.new([1,2,3]))
+      defer.progress(Wamp::Client::Response::CallResult.new([1,2,3]))
     end
   }
   EM.add_timer(4) {  # Something Async
     if @interrupts[defer.request].nil?
-      defer.progress(Wamp::Client::CallResult.new([4,5,6]))
+      defer.progress(Wamp::Client::Response::CallResult.new([4,5,6]))
     end
   }
   EM.add_timer(6) {  # Something Async
     if @interrupts[defer.request].nil?
-      defer.succeed(Wamp::Client::CallResult.new)
+      defer.succeed(Wamp::Client::Response::CallResult.new)
     end
     @interrupts.delete(request)
   }

data/lib/wamp/client/auth.rb

@@ -1,30 +1,3 @@
-=begin
-
-Copyright (c) 2018 Eric Chapman
-
-MIT License
-
-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.
-
-=end
-
 require 'openssl'
 require 'base64'
 

data/lib/wamp/client/check.rb

@@ -1,30 +1,3 @@
-=begin
-
-Copyright (c) 2018 Eric Chapman
-
-MIT License
-
-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.
-
-=end
-
 module Wamp
   module Client
     module Check

data/lib/wamp/client/connection.rb

@@ -1,100 +1,16 @@
-=begin
-
-Copyright (c) 2018 Eric Chapman
-
-MIT License
-
-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.
-
-=end
-
 require 'wamp/client/session'
+require 'wamp/client/event'
 require 'wamp/client/transport/web_socket_event_machine'
 require 'wamp/client/transport/faye_web_socket'
 
 module Wamp
   module Client
     class Connection
-      attr_accessor :options, :transport_class, :transport, :session
-
-      @reconnect = true
-
-      @open = false
-      def is_open?
-        @open
-      end
-
-      # Called when the connection is established
-      @on_connect
-      def on_connect(&on_connect)
-        @on_connect = on_connect
-      end
-
-      # Called when the WAMP session is established
-      # @param session [WampClient::Session]
-      # @param details [Hash]
-      @on_join
-      def on_join(&on_join)
-        @on_join = on_join
-      end
-
-      # Called when the WAMP session presents a challenge
-      # @param authmethod [String]
-      # @param extra [Hash]
-      @on_challenge
-      def on_challenge(&on_challenge)
-        @on_challenge = on_challenge
-      end
+      include Event
 
-      # Called when the WAMP session is terminated
-      # @param reason [String] The reason the session left the router
-      # @param details [Hash] Object containing information about the left session
-      @on_leave
-      def on_leave(&on_leave)
-        @on_leave = on_leave
-      end
+      attr_accessor :options, :transport_class, :transport, :session
 
-      # Called when the connection is terminated
-      # @param reason [String] The reason the transport was disconnected
-      @on_disconnect
-      def on_disconnect(&on_disconnect)
-        @on_disconnect = on_disconnect
-      end
-
-      # Simple setter for callbacks
-      def on(event, &callback)
-        case event
-        when :connect
-          self.on_connect(&callback)
-        when :join
-          self.on_join(&callback)
-        when :challenge
-          self.on_challenge(&callback)
-        when :leave
-          self.on_leave(&callback)
-        when :disconnect
-          self.on_disconnect(&callback)
-        else
-          raise RuntimeError, "Unknown on(event) '#{event}'"
-        end
-      end
+      create_event [:connect, :join, :challenge, :leave, :disconnect]
 
       # @param options [Hash] The different options to pass to the connection
       # @option options [String] :uri The uri of the WAMP router to connect to
@@ -108,12 +24,17 @@ module Wamp
       def initialize(options)
         self.transport_class = options.delete(:transport) || Wamp::Client::Transport::WebSocketEventMachine
         self.options = options || {}
+
+        @reconnect = true
+        @open = false
+
+        logger.info("#{self.class.name} using version #{Wamp::Client::VERSION}")
       end
 
       # Opens the connection
       def open
 
-        raise RuntimeError, 'The connection is already open' if self.is_open?
+        raise RuntimeError, 'connection is already open' if self.is_open?
 
         @reconnect = true
         @retry_timer = 1
@@ -121,7 +42,7 @@ module Wamp
 
         self.transport_class.start_event_machine do
           # Create the transport
-          self._create_transport
+          create_transport
         end
 
       end
@@ -129,7 +50,7 @@ module Wamp
       # Closes the connection
       def close
 
-        raise RuntimeError, 'The connection is already closed' unless self.is_open?
+        raise RuntimeError, 'connection is already closed' unless self.is_open?
 
         # Leave the session
         @reconnect = false
@@ -138,29 +59,37 @@ module Wamp
 
       end
 
-      def _create_session
+      # Returns true if the connection is open
+      #
+      def is_open?
+        @open
+      end
+
+      private
+
+      def create_session
         self.session = Wamp::Client::Session.new(self.transport, self.options)
 
         # Setup session callbacks
         self.session.on(:challenge) do |authmethod, extra|
-          self._finish_retry
-          @on_challenge.call(authmethod, extra) if @on_challenge
+          finish_retry
+          trigger :challenge, authmethod, extra
         end
 
         self.session.on(:join) do |details|
-          self._finish_retry
-          @on_join.call(self.session, details) if @on_join
+          finish_retry
+          trigger :join, self.session, details
         end
 
         self.session.on(:leave) do |reason, details|
 
           unless @retrying
-            @on_leave.call(reason, details) if @on_leave
+            trigger :leave, reason, details
           end
 
           if @reconnect
             # Retry
-            self._retry unless @retrying
+            retry_connect unless @retrying
           else
             # Close the transport
             self.transport.disconnect
@@ -170,7 +99,7 @@ module Wamp
         self.session.join(self.options[:realm])
       end
 
-      def _create_transport
+      def create_transport
 
         if self.transport
           self.transport.disconnect
@@ -183,22 +112,22 @@ module Wamp
         # Setup transport callbacks
         self.transport.on(:open) do
 
-          logger.info("#{self.class.name} TRANSPORT OPEN")
+          logger.info("#{self.class.name} transport open")
 
           # Call the callback
-          @on_connect.call if @on_connect
+          trigger :connect
 
           # Create the session
-          self._create_session
+          create_session
 
         end
 
         self.transport.on(:close) do |reason|
-          logger.info("#{self.class.name} TRANSPORT CLOSED: #{reason}")
+          logger.info("#{self.class.name} transport closed: #{reason}")
           @open = false
 
           unless @retrying
-            @on_disconnect.call(reason) if @on_disconnect
+            trigger :disconnect, reason
           end
 
           # Nil out the session since the transport closed underneath it
@@ -206,7 +135,7 @@ module Wamp
 
           if @reconnect
             # Retry
-            self._retry unless @retrying
+            retry_connect unless @retrying
           else
             # Stop the Event Machine
             self.transport_class.stop_event_machine
@@ -214,7 +143,7 @@ module Wamp
         end
 
         self.transport.on(:error) do |message|
-          logger.error("#{self.class.name} TRANSPORT ERROR: #{message}")
+          logger.error("#{self.class.name} transport error: #{message}")
         end
 
         @open = true
@@ -223,29 +152,27 @@ module Wamp
 
       end
 
-      def _finish_retry
+      def finish_retry
         @retry_timer = 1
         @retrying = false
       end
 
-      def _retry
+      def retry_connect
 
         if self.session == nil or not self.session.is_open?
           @retry_timer = 2*@retry_timer unless @retry_timer == 32
           @retrying = true
 
-          self._create_transport
+          create_transport
 
-          logger.info("#{self.class.name} RECONNECT in #{@retry_timer} seconds")
+          logger.info("#{self.class.name} reconnect in #{@retry_timer} seconds")
           self.transport_class.add_timer(@retry_timer*1000) do
-            self._retry if @retrying
+            retry_connect if @retrying
           end
         end
 
       end
 
-      private
-
       # Returns the logger
       #
       def logger

data/lib/wamp/client/event.rb

@@ -0,0 +1,78 @@
+module Wamp
+  module Client
+
+    # Module that adds event capabilities to the class.
+    #
+    # Usage:
+    #
+    #   class MyClass
+    #     include Event
+    #
+    #     create_event [:open, :close]
+    #
+    #     def do_something
+    #       trigger :open, 4
+    #     end
+    #
+    #   end
+    #
+    #   object = MyClass.new
+    #
+    #   object.on(:open) do |value|
+    #     puts value
+    #   end
+    #
+    #   object.do_something
+    #
+    # Prints:
+    #
+    #   4
+    #
+    module Event
+
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+
+      module ClassMethods
+        def create_event(events, attribute: nil, setter: nil, trigger: nil)
+          attribute ||= :event
+          setter ||= :on
+          trigger ||= :trigger
+
+          # Create the attributes
+          callback_name = "#{attribute}_callbacks"
+          event_list_name = "#{attribute}_list"
+
+          # Creates the attribute to store the callbacks
+          attr_accessor callback_name
+
+          # Creates the attributes to store the allowed events
+          define_method event_list_name do
+            events
+          end
+
+          # Creates the setter.  Default: "on"
+          define_method setter do |event, &handler|
+            unless self.send(event_list_name).include?(event)
+              raise RuntimeError, "unknown #{setter}(event) '#{event}'"
+            end
+
+            callback = self.send(callback_name) || {}
+            callback[event] = handler
+            self.send("#{callback_name}=", callback)
+          end
+
+          # Create the trigger.  Default: "trigger"
+          define_method trigger do |event, *args|
+            handler = (self.send(callback_name) || {})[event]
+            if handler != nil
+              handler.call(*args)
+            end
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/wamp/client/manager/base.rb

@@ -0,0 +1,39 @@
+module Wamp
+  module Client
+    module Manager
+
+      class Base
+        attr_reader :session, :send_message_callback
+
+        # Constructor
+        #
+        # @param session [Wamp::Client::Session] - The session
+        # @param success [Block] - A block to run when the request was successful
+        def initialize(session, send_message)
+          @session = session
+          @send_message_callback = send_message
+        end
+
+        private
+
+        # Returns the logger
+        #
+        def logger
+          Wamp::Client.logger
+        end
+
+        # Sends a message
+        #
+        def send_message(message)
+          self.send_message_callback.call(message) if self.send_message_callback
+        end
+
+        # Triggers an event
+        def trigger(event, *args)
+          self.session.trigger event, *args
+        end
+      end
+    end
+  end
+end
+

data/lib/wamp/client/manager/base_multiple.rb

@@ -0,0 +1,37 @@
+require_relative "base"
+
+module Wamp
+  module Client
+    module Manager
+
+      class BaseMultiple < Base
+        attr_reader :objects
+
+        # Constructor
+        #
+        # @param session [Wamp::Client::Session] - The session
+        # @param success [Block] - A block to run when the request was successful
+        def initialize(session, send_message)
+          super session, send_message
+          @objects = {}
+        end
+
+        # Adds an object to the manager
+        #
+        # @param id [Int] - The ID of the object
+        # @param object [Object] - The object to handle
+        def add(id, object)
+          self.objects[id] = object
+        end
+
+        # Removes an object
+        #
+        # @param id [Int] - The ID of the object
+        def remove(id)
+          self.objects.delete(id)
+        end
+
+      end
+    end
+  end
+end