wamp_client 0.0.9 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5401c514eb36f3adbfa52b9f2f5d218a3f884ee5
-  data.tar.gz: fae4ea4045398f596d7f67262a121b29c754c724
+  metadata.gz: 461e1109df53efb8a73f4baa59154764499dc5b4
+  data.tar.gz: 20bfbab92bcfa98139f4eaa21b00da249cbb0e3b
 SHA512:
-  metadata.gz: 833e3a42b79b5de4624fab8ecdc989a4af23db6aba17352ad399f7614e12754ced273cef8419dd257423cfcc736f5ea2ccfb2c4945158b02b07703f650b8736b
-  data.tar.gz: 35ccc1c3bead4d40b9ff21c55caf44c69b1ca85474461f43fac9d9fc1777193be4147b2fba4d2e865af7de9b1f3c7879a5d37fc37ecba81c7b9d803d1f871a6f
+  metadata.gz: 92d7ade25879d7928d27aa83380d5f5196962fa241c325f556f4ae2da0fede72aa8198ef46a60f13d643c4121c4cc83d5bc7bc51fc5b3ee5ad8f8a79c5583335
+  data.tar.gz: 8da8ebf72fabfe7edf6a4700233d7ee076b7d7d4e89295c4c42748059c30ef423c15c70c94802a815d2f7b50d2741aa6b8059bd5efb88dc4c382318f67182a3c

data/README.md

@@ -1,4 +1,4 @@
-# WampClient
+# Wamp::Client
 
 [![Gem Version](https://badge.fury.io/rb/wamp_client.svg)](https://badge.fury.io/rb/wamp_client)
 [![Circle CI](https://circleci.com/gh/ericchapman/ruby_wamp_client/tree/master.svg?&style=shield&circle-token=92813c17f9c9510c4c644e41683e7ba2572e0b2a)](https://circleci.com/gh/ericchapman/ruby_wamp_client/tree/master)
@@ -10,6 +10,8 @@ Please use [wamp_rails](https://github.com/ericchapman/ruby_wamp_rails) to integ
 
 ## Revision History
 
+ - v0.1.0:
+   - BREAKING CHANGE - Changed all of the namespaces to be "Wamp::Client"
  - v0.0.9:
    - Added support for transport override and 'faye-websocket' transport
    - Added "on(event)" callback (still support legacy methods)
@@ -65,14 +67,14 @@ is open
 A connection can be created as follows
 
 ```ruby
-require 'wamp_client'
+require 'wamp/client'
 
 options = {
     uri: 'ws://127.0.0.1:8080/ws',
     realm: 'realm1',
     verbose: true
 }
-connection = WampClient::Connection.new(options)
+connection = Wamp::Client::Connection.new(options)
 
 connection.on(:join) do |session, details|
   puts "Session Open"
@@ -159,7 +161,7 @@ Install the "faye-websocket" Gem:
 Override the transport by doing the following:
 
 ```ruby
-require 'wamp_client'
+require 'wamp/client'
 
 options = {
     uri: 'ws://127.0.0.1:8080/ws',
@@ -168,10 +170,10 @@ options = {
       :origin  => 'http://username:password@proxy.example.com',
       :headers => {'User-Agent' => 'ruby'}
     },  
-    transport: WampClient::Transport::FayeWebSocket
+    transport: Wamp::Client::Transport::FayeWebSocket
 }
 
-connection = WampClient::Connection.new(options)
+connection = Wamp::Client::Connection.new(options)
 
 # More code
 ``` 
@@ -190,7 +192,7 @@ The library supports authentication.  Here is how to perform the different metho
 To perform WAMP CRA, do the following
 
 ```ruby
-require 'wamp_client'
+require 'wamp/client'
 
 options = {
     uri: 'ws://127.0.0.1:8080/ws',
@@ -198,12 +200,12 @@ options = {
     authid: 'joe',
     authmethods: ['wampcra']
 }
-connection = WampClient::Connection.new(options)
+connection = Wamp::Client::Connection.new(options)
 
 connection.on(:challenge) do |authmethod, extra|
   puts 'Challenge'
   if authmethod == 'wampcra'
-    WampClient::Auth::Cra.sign('secret', extra[:challenge])
+    Wamp::Client::Auth::Cra.sign('secret', extra[:challenge])
   else
     raise RuntimeError, "Unsupported auth method #{authmethod}"
   end
@@ -231,7 +233,7 @@ All handlers are called with the following parameters
  - args [Array] - Array of arguments
  - kwargs [Hash] - Hash of key/value arguments
  - details [Hash] - Hash containing some details about the call.  Details include
-   - session [WampClient::Session] - The session
+   - session [Wamp::Client::Session] - The session
    - etc.
 
 Some examples of this are shown below
@@ -261,7 +263,7 @@ All callbacks are called with the following parameters
  - error [Hash] - Hash containing "error", "args", and "kwargs" if an error occurred
  - details [Hash] - Hash containing some details about the call.  Details include
    - type [String] - The type of message
-   - session [WampClient::Session] - The session
+   - session [Wamp::Client::Session] - The session
    - etc.
 
 An example of this is shown below
@@ -503,9 +505,9 @@ Errors can either be raised OR returned as shown below
 handler = lambda do |args, kwargs, details|
   raise 'error'
   # OR
-  raise WampClient::CallError.new('wamp.error', ['some error'], {details: true})
+  raise Wamp::Client::CallError.new('wamp.error', ['some error'], {details: true})
   # OR
-  WampClient::CallError.new('wamp.error', ['some error'], {details: true})
+  Wamp::Client::CallError.new('wamp.error', ['some error'], {details: true})
 end
 session.register('com.example.procedure', handler)
 ```
@@ -518,7 +520,7 @@ caller.  This is shown below
 
 ```ruby
 def add(args, kwargs, details)
-  defer = WampClient::Defer::CallDefer.new
+  defer = Wamp::Client::Defer::CallDefer.new
   EM.add_timer(2) {  # Something Async
     defer.succeed(args[0]+args[1])
   }
@@ -531,9 +533,9 @@ Errors are returned as follows
 
 ```ruby
 def add(args, kwargs, details)
-  defer = WampClient::Defer::CallDefer.new
+  defer = Wamp::Client::Defer::CallDefer.new
   EM.add_timer(2) {  # Something Async
-    defer.fail(WampClient::CallError.new('test.error'))
+    defer.fail(Wamp::Client::CallError.new('test.error'))
   }
   defer
 end
@@ -559,15 +561,15 @@ end
 
 ```ruby
 def add(args, kwargs, details)
-  defer = WampClient::Defer::ProgressiveCallDefer.new
+  defer = Wamp::Client::Defer::ProgressiveCallDefer.new
   EM.add_timer(2) {  # Something Async
-    defer.progress(WampClient::CallResult.new([1,2,3]))
+    defer.progress(Wamp::Client::CallResult.new([1,2,3]))
   }
   EM.add_timer(4) {  # Something Async
-    defer.progress(WampClient::CallResult.new([4,5,6]))
+    defer.progress(Wamp::Client::CallResult.new([4,5,6]))
   }
   EM.add_timer(6) {  # Something Async
-    defer.succeed(WampClient::CallResult.new)
+    defer.succeed(Wamp::Client::CallResult.new)
   }
   defer
 end
@@ -610,20 +612,20 @@ def interrupt_handler(request, mode)
 end
 
 def add(args, kwargs, details)
-  defer = WampClient::Defer::ProgressiveCallDefer.new
+  defer = Wamp::Client::Defer::ProgressiveCallDefer.new
   EM.add_timer(2) {  # Something Async
     if @interrupts[defer.request].nil?
-      defer.progress(WampClient::CallResult.new([1,2,3]))
+      defer.progress(Wamp::Client::CallResult.new([1,2,3]))
     end
   }
   EM.add_timer(4) {  # Something Async
     if @interrupts[defer.request].nil?
-      defer.progress(WampClient::CallResult.new([4,5,6]))
+      defer.progress(Wamp::Client::CallResult.new([4,5,6]))
     end
   }
   EM.add_timer(6) {  # Something Async
     if @interrupts[defer.request].nil?
-      defer.succeed(WampClient::CallResult.new)
+      defer.succeed(Wamp::Client::CallResult.new)
     end
     @interrupts.delete(request)
   }
@@ -663,8 +665,8 @@ The *lib/wamp_client/message.rb* file and the *spec/message_spec.rb* file are au
 
     $ cd scripts
     $ ./gen_message.rb
-    $ mv message.rb.tmp ../lib/wamp_client/message.rb
-    $ mv message_spec.rb.tmp ../spec/message_spec.rb
+    $ mv message.rb.tmp ../lib/wamp/client/message.rb
+    $ mv message_spec.rb.tmp ../spec/wamp/client/message_spec.rb
 
 As I was writing the code for the messages I caught myself cutting and pasting allot and decided these would be
 better suited to be autogenerated.

data/lib/{wamp_client.rb → wamp/client.rb}

@@ -1,6 +1,6 @@
 =begin
 
-Copyright (c) 2016 Eric Chapman
+Copyright (c) 2018 Eric Chapman
 
 MIT License
 
@@ -25,10 +25,10 @@ WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
 =end
 
-require 'wamp_client/version'
-require 'wamp_client/message'
-require 'wamp_client/serializer'
-require 'wamp_client/connection'
-require 'wamp_client/session'
-require 'wamp_client/auth'
-require 'wamp_client/defer'
+require 'wamp/client/version'
+require 'wamp/client/message'
+require 'wamp/client/serializer'
+require 'wamp/client/connection'
+require 'wamp/client/session'
+require 'wamp/client/auth'
+require 'wamp/client/defer'

data/lib/{wamp_client → wamp/client}/auth.rb

@@ -1,6 +1,6 @@
 =begin
 
-Copyright (c) 2016 Eric Chapman
+Copyright (c) 2018 Eric Chapman
 
 MIT License
 
@@ -28,18 +28,20 @@ WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 require 'openssl'
 require 'base64'
 
-module WampClient
-  module Auth
-    module Cra
+module Wamp
+  module Client
+    module Auth
+      module Cra
 
-      # Generates the signature from the challenge
-      # @param key [String]
-      # @param challenge [String]
-      def self.sign(key, challenge)
-        hash  = OpenSSL::HMAC.digest('sha256', key, challenge)
-        Base64.encode64(hash).gsub(/\n/,'')
-      end
+        # Generates the signature from the challenge
+        # @param key [String]
+        # @param challenge [String]
+        def self.sign(key, challenge)
+          hash  = OpenSSL::HMAC.digest('sha256', key, challenge)
+          Base64.encode64(hash).gsub(/\n/,'')
+        end
 
+      end
     end
   end
 end

data/lib/wamp/client/check.rb

@@ -0,0 +1,86 @@
+=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
+
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+
+      module ClassMethods
+
+        def check_equal(name, expected, value)
+          raise ArgumentError, "The '#{name}' argument must have the value '#{expected}'.  Instead the value was '#{value}'" unless value == expected
+        end
+
+        def check_gte(name, expected, value)
+          raise ArgumentError, "The '#{name}' argument must be greater than or equal to '#{expected}'.  Instead the value was '#{value}'" unless value >= expected
+        end
+
+        def check_nil(name, param, nil_allowed)
+          raise ArgumentError, "The '#{name}' argument cannot be nil" if param.nil? and not nil_allowed
+        end
+
+        def check_int(name, param, nil_allowed=false)
+          check_nil(name, param, nil_allowed)
+          raise ArgumentError, "The '#{name}' argument must be an integer" unless param.nil? or param.is_a? Integer
+        end
+
+        def check_string(name, param, nil_allowed=false)
+          check_nil(name, param, nil_allowed)
+          raise ArgumentError, "The '#{name}' argument must be a string" unless param.nil? or param.is_a? String
+        end
+
+        def check_bool(name, param, nil_allowed=false)
+          check_nil(name, param, nil_allowed)
+          raise ArgumentError, "The '#{name}' argument must be a boolean" unless param.nil? or !!param == param
+        end
+
+        def check_dict(name, param, nil_allowed=false)
+          check_nil(name, param, nil_allowed)
+          raise ArgumentError, "The '#{name}' argument must be a hash" unless param.nil? or param.is_a? Hash
+        end
+
+        def check_list(name, param, nil_allowed=false)
+          check_nil(name, param, nil_allowed)
+          raise ArgumentError, "The '#{name}' argument must be an array" unless param.nil? or param.is_a? Array
+        end
+
+        def check_uri(name, param, nil_allowed=false)
+          check_string(name, param, nil_allowed)
+        end
+
+        def check_id(name, param, nil_allowed=false)
+          check_int(name, param, nil_allowed)
+        end
+      end
+
+    end
+  end
+end

data/lib/wamp/client/connection.rb

@@ -0,0 +1,249 @@
+=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/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, :verbose
+
+      @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
+
+      # 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
+
+      # 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
+
+      # @param options [Hash] The different options to pass to the connection
+      # @option options [String] :uri The uri of the WAMP router to connect to
+      # @option options [String] :proxy The proxy to get to the router
+      # @option options [String] :realm The realm to connect to
+      # @option options [String,nil] :protocol The protocol (default if wamp.2.json)
+      # @option options [String,nil] :authid The id to authenticate with
+      # @option options [Array, nil] :authmethods The different auth methods that the client supports
+      # @option options [Hash] :headers Custom headers to include during the connection
+      # @option options [WampClient::Serializer::Base] :serializer The serializer to use (default is json)
+      def initialize(options)
+        self.transport_class = options.delete(:transport) || Wamp::Client::Transport::WebSocketEventMachine
+        self.options = options || {}
+        self.verbose = options[:verbose] || false
+      end
+
+      # Opens the connection
+      def open
+
+        raise RuntimeError, 'The connection is already open' if self.is_open?
+
+        @reconnect = true
+        @retry_timer = 1
+        @retrying = false
+
+        self.transport_class.start_event_machine do
+          # Create the transport
+          self._create_transport
+        end
+
+      end
+
+      # Closes the connection
+      def close
+
+        raise RuntimeError, 'The connection is already closed' unless self.is_open?
+
+        # Leave the session
+        @reconnect = false
+        @retrying = false
+        session.leave
+
+      end
+
+      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
+        end
+
+        self.session.on(:join) do |details|
+          self._finish_retry
+          @on_join.call(self.session, details) if @on_join
+        end
+
+        self.session.on(:leave) do |reason, details|
+
+          unless @retrying
+            @on_leave.call(reason, details) if @on_leave
+          end
+
+          if @reconnect
+            # Retry
+            self._retry unless @retrying
+          else
+            # Close the transport
+            self.transport.disconnect
+          end
+        end
+
+        self.session.join(self.options[:realm])
+      end
+
+      def _create_transport
+
+        if self.transport
+          self.transport.disconnect
+          self.transport = nil
+        end
+
+        # Initialize the transport
+        self.transport = self.transport_class.new(self.options)
+
+        # Setup transport callbacks
+        self.transport.on(:open) do
+          puts "TRANSPORT OPEN" if self.verbose
+
+          # Call the callback
+          @on_connect.call if @on_connect
+
+          # Create the session
+          self._create_session
+
+        end
+
+        self.transport.on(:close) do |reason|
+          puts "TRANSPORT CLOSED: #{reason}" if self.verbose
+          @open = false
+
+          unless @retrying
+            @on_disconnect.call(reason) if @on_disconnect
+          end
+
+          # Nil out the session since the transport closed underneath it
+          self.session = nil
+
+          if @reconnect
+            # Retry
+            self._retry unless @retrying
+          else
+            # Stop the Event Machine
+            self.transport_class.stop_event_machine
+          end
+        end
+
+        self.transport.on(:error) do |message|
+          puts "TRANSPORT ERROR: #{message}"
+        end
+
+        @open = true
+
+        self.transport.connect
+
+      end
+
+      def _finish_retry
+        @retry_timer = 1
+        @retrying = false
+      end
+
+      def _retry
+
+        if self.session == nil or not self.session.is_open?
+          @retry_timer = 2*@retry_timer unless @retry_timer == 32
+          @retrying = true
+
+          self._create_transport
+
+          puts "Attempting Reconnect... Next attempt in #{@retry_timer} seconds" if self.verbose
+          self.transport_class.add_timer(@retry_timer*1000) do
+            self._retry if @retrying
+          end
+        end
+
+      end
+
+    end
+  end
+end