ably-rest 0.8.3 → 0.8.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6dc33fd0a8246405f3b3db4aa1adfa03711a6ccc
-  data.tar.gz: 0de772597367cd55d99437a0bbb34302086c1ee8
+  metadata.gz: 1b1045e268247db9dd96742a0c11404b03fbb533
+  data.tar.gz: 180a9c3dfee6b05b4fc8c8f947e1081bba97b635
 SHA512:
-  metadata.gz: 72696b8f25b34f36552978221b44f4f75bdc2772743b43d13686aabe4ed41932e88bc5e93b4b095d3abdc743d72b7d6f1cfba199f14ff7f618d9407bd9cdabd3
-  data.tar.gz: 4252aa2885f5e75ba6ad219aa4af7edef9989f4ba122972ab6e8b9d9d1b5e08794286819d6f26fa54746b0988a6725307c566b191be6a207e15a96f03a7eefb6
+  metadata.gz: 163805382715a09c67f446297b49c5c4588ff2c141c3cc6173eb9917423305b3f532d076f46af854d6b869439e9e465a02eb23735e40be64fe8d017773d782a0
+  data.tar.gz: b024865d3a6f266681e0ed4224b6a14c1e4248e21f93958d357d3009010a662d02d779615a21d0c4616e6397fc6c1053c0afc887ef7c52dcde9c286e24960d3d

data/.travis.yml

@@ -1,3 +1,4 @@
+sudo: false
 env: RSPEC_RETRY=true
 language: ruby
 rvm:

data/lib/submodules/ably-ruby/CHANGELOG.md

@@ -6,6 +6,12 @@
 
 **Implemented enhancements:**
 
+- Add compatibility support for default Crypto params [\#53](https://github.com/ably/ably-ruby/issues/53)
+
+- EventEmitter on connection [\#52](https://github.com/ably/ably-ruby/issues/52)
+
+- Add test for connectionId attribute for a message sent over REST [\#50](https://github.com/ably/ably-ruby/issues/50)
+
 - Implement :queue\_messages option [\#36](https://github.com/ably/ably-ruby/issues/36)
 
 - Check that a non 200-299 status code for REST requests uses fallback hosts [\#35](https://github.com/ably/ably-ruby/issues/35)
@@ -32,6 +38,10 @@
 
 **Merged pull requests:**
 
+- Spec update to fix a number of issues [\#60](https://github.com/ably/ably-ruby/pull/60) ([mattheworiordan](https://github.com/mattheworiordan))
+
+- Allow clientId to be provided on init if using externally created token [\#58](https://github.com/ably/ably-ruby/pull/58) ([SimonWoolf](https://github.com/SimonWoolf))
+
 - Separate token params for auth [\#57](https://github.com/ably/ably-ruby/pull/57) ([mattheworiordan](https://github.com/mattheworiordan))
 
 - Ensure files are required in a consistent order [\#51](https://github.com/ably/ably-ruby/pull/51) ([SimonWoolf](https://github.com/SimonWoolf))

data/lib/submodules/ably-ruby/README.md

@@ -187,7 +187,7 @@ token_details = client.auth.request_token
 token_details.token # => "xVLyHw.CLchevH3hF....MDh9ZC_Q"
 client = Ably::Rest.new(token: token_details.token)
 
-token = client.auth.create_token_request(token_params: { ttl: 3600 })
+token = client.auth.create_token_request(ttl: 3600)
 # => {"id"=>...,
 #     "clientId"=>nil,
 #     "ttl"=>3600,

data/lib/submodules/ably-ruby/Rakefile

@@ -16,7 +16,7 @@ begin
   namespace :doc do
     desc 'Generate Markdown Specification from the RSpec public API tests'
     task :spec do
-      ENV['TEST_LIMIT_PROTOCOLS'] = JSON.dump({ msgpack: 'JSON and MsgPack' })
+      ENV['PROTOCOL'] = 'json'
 
       rspec_task.rspec_opts = %w(
         --require ./spec/support/markdown_spec_formatter

data/lib/submodules/ably-ruby/lib/ably/auth.rb

@@ -43,11 +43,11 @@ module Ably
     # Creates an Auth object
     #
     # @param [Ably::Rest::Client] client  {Ably::Rest::Client} this Auth object uses
-    # @param [Hash] auth_options the authentication options used as a default future token requests
     # @param [Hash] token_params the token params used as a default for future token requests
+    # @param [Hash] auth_options the authentication options used as a default future token requests
     # @option (see #request_token)
     #
-    def initialize(client, auth_options, token_params)
+    def initialize(client, token_params, auth_options)
       unless auth_options.kind_of?(Hash)
         raise ArgumentError, 'Expected auth_options to be a Hash'
       end
@@ -74,7 +74,7 @@ module Ably
         raise ArgumentError, 'key is missing. Either an API key, token, or token auth method must be provided'
       end
 
-      if has_client_id?
+      if has_client_id? && !token_creatable_externally?
         raise ArgumentError, 'client_id cannot be provided without a complete API key. Key name & Secret is needed to authenticate with Ably and obtain a token' unless api_key_present?
         ensure_utf_8 :client_id, client_id
       end
@@ -87,8 +87,8 @@ module Ably
     #
     # In the event that a new token request is made, the provided options are used.
     #
-    # @param [Hash] auth_options the authentication options used for future token requests
     # @param [Hash] token_params the token params used for future token requests
+    # @param [Hash] auth_options the authentication options used for future token requests
     # @option auth_options [Boolean]   :force   obtains a new token even if the current token is valid
     # @option (see #request_token)
     #
@@ -100,12 +100,12 @@ module Ably
     #    token_details = client.auth.authorise
     #
     #    # will use token request from block to authorise if not already authorised
-    #    token_details = client.auth.authorise auth_callback: Proc.new do
+    #    token_details = client.auth.authorise {}, auth_callback: Proc.new do
     #      # create token_request object
     #      token_request
     #    end
     #
-    def authorise(auth_options = {}, token_params = {})
+    def authorise(token_params = {}, auth_options = {})
       ensure_valid_auth_attributes auth_options
 
       auth_options = auth_options.clone
@@ -120,7 +120,7 @@ module Ably
       token_params = (auth_options.delete(:token_params) || {}).merge(token_params)
       @token_params = @token_params.merge(token_params) # update defaults
 
-      @current_token_details = request_token(auth_options, token_params)
+      @current_token_details = request_token(token_params, auth_options)
     end
 
     # Request a {Ably::Models::TokenDetails} which can be used to make authenticated token based requests
@@ -143,15 +143,15 @@ module Ably
     #    token_details = client.auth.request_token
     #
     #    # token request with token params
-    #    client.auth.request_token token_params: { ttl: 1.hour }
+    #    client.auth.request_token ttl: 1.hour
     #
     #    # token request using auth block
-    #    token_details = client.auth.request_token auth_callback: Proc.new do
+    #    token_details = client.auth.request_token {}, auth_callback: Proc.new do
     #      # create token_request object
     #      token_request
     #    end
     #
-    def request_token(auth_options = {}, token_params = {})
+    def request_token(token_params = {}, auth_options = {})
       ensure_valid_auth_attributes auth_options
 
       token_params = (auth_options[:token_params] || {}).merge(token_params)
@@ -163,7 +163,7 @@ module Ably
       elsif auth_url = auth_options.delete(:auth_url)
         token_request_from_auth_url(auth_url, auth_options)
       else
-        create_token_request(auth_options, token_params)
+        create_token_request(token_params, auth_options)
       end
 
       case token_request
@@ -186,12 +186,6 @@ module Ably
 
     # Creates and signs a token request that can then subsequently be used by any client to request a token
     #
-    # @param [Hash] auth_options the authentication options for the token request
-    # @option auth_options [String]  :key           API key comprising the key name and key secret in a single string
-    # @option auth_options [String]  :client_id     client ID identifying this connection to other clients (will use +client_id+ specified when library was instanced if provided)
-    # @option auth_options [Boolean] :query_time    when true will query the {https://www.ably.io Ably} system for the current time instead of using the local time
-    # @option auth_options [Hash]    :token_params   convenience to pass in +token_params+ within the +auth_options+ argument, this helps avoid the following +authorise({key: key}, {ttl: 23})+ by allowing +authorise(key:key,token_params:{ttl:23})+
-    #
     # @param [Hash] token_params the token params used in the token request
     # @option token_params [String]  :client_id     A client ID to associate with this token. The generated token may be used to authenticate as this +client_id+
     # @option token_params [Integer] :ttl           validity time in seconds for the requested {Ably::Models::TokenDetails}.  Limits may apply, see {https://www.ably.io/documentation/other/authentication}
@@ -199,10 +193,16 @@ module Ably
     # @option token_params [Time]    :timestamp     the time of the request
     # @option token_params [String]  :nonce         an unquoted, unescaped random string of at least 16 characters
     #
+    # @param [Hash] auth_options the authentication options for the token request
+    # @option auth_options [String]  :key           API key comprising the key name and key secret in a single string
+    # @option auth_options [String]  :client_id     client ID identifying this connection to other clients (will use +client_id+ specified when library was instanced if provided)
+    # @option auth_options [Boolean] :query_time    when true will query the {https://www.ably.io Ably} system for the current time instead of using the local time
+    # @option auth_options [Hash]    :token_params  convenience to pass in +token_params+ within the +auth_options+ argument, especially useful when setting default token_params in the client constructor
+    #
     # @return [Models::TokenRequest]
     #
     # @example
-    #    client.auth.create_token_request(id: 'asd.asd', token_params: { ttl: 3600 })
+    #    client.auth.create_token_request({ ttl: 3600 }, { id: 'asd.asd' })
     #    #<Ably::Models::TokenRequest:0x007fd5d919df78
     #    #  @hash={
     #    #   :id=>"asds.adsa",
@@ -214,7 +214,7 @@ module Ably
     #    #   :mac=>"881oZHeFo6oMim7....uE56a8gUxHw="
     #    #  }
     #    #>>
-    def create_token_request(auth_options = {}, token_params = {})
+    def create_token_request(token_params = {}, auth_options = {})
       ensure_valid_auth_attributes auth_options
 
       auth_options = auth_options.clone
@@ -401,7 +401,11 @@ module Ably
 
     # Returns the current token if it exists or authorises and retrieves a token
     def token_auth_string
-      if token
+      # If a TokenDetails object has been issued by this library
+      # then that Token will take precedence
+      if @current_token_details
+        authorise.token
+      elsif token # token string was configured in the options
         token
       else
         authorise.token

data/lib/submodules/ably-ruby/lib/ably/exceptions.rb

@@ -58,6 +58,9 @@ module Ably
     # Connection Timeout accessing Realtime or REST service
     class ConnectionTimeout < ConnectionError; end
 
+    # Transport closed unexpectedly
+    class TransportClosed < ConnectionError; end
+
     # Connection closed unexpectedly
     class ConnectionClosed < ConnectionError; end
 

data/lib/submodules/ably-ruby/lib/ably/models/channel_state_change.rb

@@ -0,0 +1,41 @@
+module Ably::Models
+  # ChannelStateChange is a class that is emitted by the {Ably::Realtime::Channel} object
+  # when a state change occurs
+  #
+  # @!attribute [r] current
+  #   @return [Connection::STATE] Current connection state
+  # @!attribute [r] previous
+  #   @return [Connection::STATE] Previous connection state
+  # @!attribute [r] reason
+  #   @return [Ably::Models::ErrorInfo] Object describing the reason for a state change when not initiated by the consumer of the client library
+  #
+  class ChannelStateChange
+    include Ably::Modules::ModelCommon
+
+    def initialize(hash_object)
+      unless (hash_object.keys - [:current, :previous, :reason, :protocol_message]).empty?
+        raise ArgumentError, 'Invalid attributes, expecting :current, :previous, :reason'
+      end
+
+      @hash_object = {
+        current: hash_object.fetch(:current),
+        previous: hash_object.fetch(:previous),
+        retry_in: hash_object[:retry_in],
+        reason: hash_object[:reason],
+        protocol_message: hash_object[:protocol_message]
+      }
+    rescue KeyError => e
+      raise ArgumentError, e
+    end
+
+    %w(current previous reason protocol_message).each do |attribute|
+      define_method attribute do
+        @hash_object[attribute.to_sym]
+      end
+    end
+
+    def to_s
+      "ChannelStateChange: current state #{current}, previous state #{previous}"
+    end
+  end
+end

data/lib/submodules/ably-ruby/lib/ably/models/connection_state_change.rb

@@ -0,0 +1,43 @@
+module Ably::Models
+  # ConnectionStateChange is a class that is emitted by the {Ably::Realtime::Connection} object
+  # when a state change occurs
+  #
+  # @!attribute [r] current
+  #   @return [Connection::STATE] Current connection state
+  # @!attribute [r] previous
+  #   @return [Connection::STATE] Previous connection state
+  # @!attribute [r] retry_in
+  #   @return [Integer] Time in seconds until the connection will reattempt to connect when in the +:disconnected+ or +:suspended+ state
+  # @!attribute [r] reason
+  #   @return [Ably::Models::ErrorInfo] Object describing the reason for a state change when not initiated by the consumer of the client library
+  #
+  class ConnectionStateChange
+    include Ably::Modules::ModelCommon
+
+    def initialize(hash_object)
+      unless (hash_object.keys - [:current, :previous, :retry_in, :reason, :protocol_message]).empty?
+        raise ArgumentError, 'Invalid attributes, expecting :current, :previous, :retry_in, :reason'
+      end
+
+      @hash_object = {
+        current: hash_object.fetch(:current),
+        previous: hash_object.fetch(:previous),
+        retry_in: hash_object[:retry_in],
+        reason: hash_object[:reason],
+        protocol_message: hash_object[:protocol_message]
+      }
+    rescue KeyError => e
+      raise ArgumentError, e
+    end
+
+    %w(current previous retry_in reason protocol_message).each do |attribute|
+      define_method attribute do
+        @hash_object[attribute.to_sym]
+      end
+    end
+
+    def to_s
+      "ConnectionStateChange: current state #{current}, previous state #{previous}"
+    end
+  end
+end

data/lib/submodules/ably-ruby/lib/ably/models/message.rb

@@ -131,7 +131,7 @@ module Ably::Models
     end
 
     def logger
-      return logger if logger
+      return @logger if @logger
       protocol_message.logger if protocol_message
     end
   end

data/lib/submodules/ably-ruby/lib/ably/models/presence_message.rb

@@ -154,7 +154,7 @@ module Ably::Models
     end
 
     def logger
-      return logger if logger
+      return @logger if @logger
       protocol_message.logger if protocol_message
     end
   end

data/lib/submodules/ably-ruby/lib/ably/models/protocol_message.rb

@@ -226,7 +226,8 @@ module Ably::Models
       !action_enum || (ack_required? && !has_serial?)
     end
 
-    private
+    # @!attribute [r] logger
+    # @api private
     attr_reader :logger
   end
 end

data/lib/submodules/ably-ruby/lib/ably/models/token_details.rb

@@ -34,7 +34,7 @@ module Ably::Models
     # @param attributes
     # @option attributes [String]       :token      token used to authenticate requests
     # @option attributes [String]       :key_name   API key name used to create this token
-    # @option attributes [Time,Integer] :issued  Time the token was issued as Time or Integer in milliseconds
+    # @option attributes [Time,Integer] :issued     Time the token was issued as Time or Integer in milliseconds
     # @option attributes [Time,Integer] :expires    Time the token expires as Time or Integer in milliseconds
     # @option attributes [String]       :capability JSON stringified capabilities assigned to this token
     # @option attributes [String]       :client_id  client ID assigned to this token
@@ -52,31 +52,31 @@ module Ably::Models
     # @!attribute [r] token
     # @return [String] Token used to authenticate requests
     def token
-      hash.fetch(:token)
+      hash[:token]
     end
 
     # @!attribute [r] key_name
     # @return [String] API key name used to create this token.  An API key is made up of an API key name and secret delimited by a +:+
     def key_name
-      hash.fetch(:key_name)
+      hash[:key_name]
     end
 
     # @!attribute [r] issued
     # @return [Time] Time the token was issued
     def issued
-      as_time_from_epoch(hash.fetch(:issued), granularity: :ms)
+      as_time_from_epoch(hash[:issued], granularity: :ms, allow_nil: :true)
     end
 
     # @!attribute [r] expires
     # @return [Time] Time the token expires
     def expires
-      as_time_from_epoch(hash.fetch(:expires), granularity: :ms)
+      as_time_from_epoch(hash[:expires], granularity: :ms, allow_nil: :true)
     end
 
     # @!attribute [r] capability
     # @return [Hash] Capabilities assigned to this token
     def capability
-      JSON.parse(hash.fetch(:capability))
+      JSON.parse(hash.fetch(:capability)) if hash.fetch(:capability)
     end
 
     # @!attribute [r] client_id
@@ -86,9 +86,11 @@ module Ably::Models
     end
 
     # Returns true if token is expired or about to expire
+    # For tokens that have not got an explicit expires attribute expired? will always return true
     #
     # @return [Boolean]
     def expired?
+      return false if !expires
       expires < Time.now + TOKEN_EXPIRY_BUFFER
     end
 

data/lib/submodules/ably-ruby/lib/ably/modules/conversions.rb

@@ -6,6 +6,8 @@ module Ably::Modules
 
     private
     def as_since_epoch(time, options = {})
+      return nil if options[:allow_nil] && !time
+
       granularity = options.fetch(:granularity, :ms)
 
       case time
@@ -19,6 +21,8 @@ module Ably::Modules
     end
 
     def as_time_from_epoch(time, options = {})
+      return nil if options[:allow_nil] && !time
+
       granularity = options.fetch(:granularity, :ms)
 
       case time

data/lib/submodules/ably-ruby/lib/ably/modules/state_emitter.rb

@@ -141,7 +141,10 @@ module Ably::Modules
     #
     def deferrable_for_state_change_to(target_state)
       Ably::Util::SafeDeferrable.new(logger).tap do |deferrable|
-        once_or_if(target_state, else: proc { |*args| deferrable.fail self, *args }) do
+        fail_proc = Proc.new do |state_change|
+          deferrable.fail state_change.reason
+        end
+        once_or_if(target_state, else: fail_proc) do
           yield self if block_given?
           deferrable.succeed self
         end

data/lib/submodules/ably-ruby/lib/ably/modules/uses_state_machine.rb

@@ -13,8 +13,8 @@ module Ably::Modules
     #
     # @return [Boolean] true if new_state can be transitioned to by state machine
     # @api private
-    def transition_state_machine(new_state, emit_object = nil)
-      state_machine.transition_state(new_state, emit_object)
+    def transition_state_machine(new_state, emit_params = {})
+      state_machine.transition_state(new_state, emit_object(new_state, emit_params))
     end
 
     # Call #transition_to! on the StateMachine
@@ -22,8 +22,8 @@ module Ably::Modules
     #
     # @return [void]
     # @api private
-    def transition_state_machine!(new_state, emit_object = nil)
-      state_machine.transition_to!(new_state, emit_object)
+    def transition_state_machine!(new_state, emit_params = {})
+      state_machine.transition_to!(new_state, emit_object(new_state, emit_params))
     end
 
     # Provides an internal method for this object's state to match the StateMachine's current state.
@@ -70,5 +70,36 @@ module Ably::Modules
         logger.debug "#{self.class.name}: Transitioned to #{state_machine.current_state}"
       end
     end
+
+    def emit_object(new_state, emit_params)
+      if self.class.emits_klass
+        self.class.emits_klass.new((emit_params || {}).merge(current: STATE(new_state), previous: STATE(state_machine.current_state)))
+      else
+        emit_params
+      end
+    end
+
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      def emits_klass
+        @emits_klass ||= if @emits_klass_name
+          get_const(@emits_klass_name)
+        end
+      end
+
+      def ensure_state_machine_emits(klass)
+        @emits_klass_name = klass
+      end
+
+      def get_const(klass_name)
+        klass_names = klass_name.split('::')
+        klass_names.inject(Kernel) do |klass, name|
+          klass.const_get(name)
+        end
+      end
+    end
   end
 end