ably-rest 0.8.6 → 0.8.9

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

@@ -16,7 +16,7 @@ module Ably::Models
   # TokenDetails is a class providing details of the token string and the token's associated metadata,
   # constructed from the response from Ably when request in a token via the REST API.
   #
-  # Ruby {Time} objects are supported in place of Ably ms since epoch time fields.  However, if a numeric is provided
+  # Ruby {http://ruby-doc.org/core/Time.html Time} objects are supported in place of Ably ms since epoch time fields.  However, if a numeric is provided
   # it must always be expressed in milliseconds as the Ably API always uses milliseconds for time fields.
   #
   class TokenDetails
@@ -38,46 +38,48 @@ module Ably::Models
       @hash_object = IdiomaticRubyWrapper(attributes.clone)
 
       %w(issued expires).map(&:to_sym).each do |time_attribute|
-        hash[time_attribute] = (hash[time_attribute].to_f * 1000).round if hash[time_attribute].kind_of?(Time)
+        if self.attributes[time_attribute].kind_of?(Time)
+          self.attributes[time_attribute] = (self.attributes[time_attribute].to_f * 1000).round
+        end
       end
 
-      hash.freeze
+      self.attributes.freeze
     end
 
     # @!attribute [r] token
     # @return [String] Token used to authenticate requests
     def token
-      hash[:token]
+      attributes[: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[:key_name]
+      attributes[:key_name]
     end
 
     # @!attribute [r] issued
     # @return [Time] Time the token was issued
     def issued
-      as_time_from_epoch(hash[:issued], granularity: :ms, allow_nil: :true)
+      as_time_from_epoch(attributes[:issued], granularity: :ms, allow_nil: :true)
     end
 
     # @!attribute [r] expires
     # @return [Time] Time the token expires
     def expires
-      as_time_from_epoch(hash[:expires], granularity: :ms, allow_nil: :true)
+      as_time_from_epoch(attributes[:expires], granularity: :ms, allow_nil: :true)
     end
 
     # @!attribute [r] capability
     # @return [Hash] Capabilities assigned to this token
     def capability
-      JSON.parse(hash.fetch(:capability)) if hash.has_key?(:capability)
+      JSON.parse(attributes.fetch(:capability)) if attributes.has_key?(:capability)
     end
 
     # @!attribute [r] client_id
     # @return [String] Optional client ID assigned to this token
     def client_id
-      hash[:client_id]
+      attributes[:client_id]
     end
 
     # Returns true if token is expired or about to expire
@@ -93,12 +95,12 @@ module Ably::Models
     # @return [Boolean]
     # @api private
     def from_token_string?
-      hash.keys == [:token]
+      attributes.keys == [:token]
     end
 
-    # @!attribute [r] hash
+    # @!attribute [r] attributes
     # @return [Hash] Access the token details Hash object ruby'fied to use symbolized keys
-    def hash
+    def attributes
       @hash_object
     end
 

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

@@ -16,7 +16,7 @@ module Ably::Models
 
   # TokenRequest is a class that stores the attributes of a token request
   #
-  # Ruby {Time} objects are supported in place of Ably ms since epoch time fields.  However, if a numeric is provided
+  # Ruby {http://ruby-doc.org/core/Time.html Time} objects are supported in place of Ably ms since epoch time fields.  However, if a numeric is provided
   # it must always be expressed in milliseconds as the Ably API always uses milliseconds for time fields.
   #
   class TokenRequest
@@ -24,7 +24,7 @@ module Ably::Models
 
     # @param attributes
     # @option attributes [Integer]      :ttl        requested time to live for the token in milliseconds
-    # @option attributes [Time,Integer] :timestamp  the timestamp of this request in milliseconds or as a {Time}
+    # @option attributes [Time,Integer] :timestamp  the timestamp of this request in milliseconds or as a {http://ruby-doc.org/core/Time.html Time}
     # @option attributes [String]       :key_name   API key name of the key against which this request is made
     # @option attributes [String]       :capability JSON stringified capability of the token
     # @option attributes [String]       :client_id  client ID to associate with this token
@@ -33,14 +33,16 @@ module Ably::Models
     #
     def initialize(attributes = {})
       @hash_object = IdiomaticRubyWrapper(attributes.clone)
-      hash[:timestamp] = (hash[:timestamp].to_f * 1000).round if hash[:timestamp].kind_of?(Time)
-      hash.freeze
+      if self.attributes[:timestamp].kind_of?(Time)
+        self.attributes[:timestamp] = (self.attributes[:timestamp].to_f * 1000).round
+      end
+      self.attributes.freeze
     end
 
     # @!attribute [r] key_name
     # @return [String] API key name of the key against which this request is made.  An API key is made up of an API key name and secret delimited by a +:+
     def key_name
-      hash.fetch(:key_name)
+      attributes.fetch(:key_name)
     end
 
     # @!attribute [r] ttl
@@ -49,7 +51,7 @@ module Ably::Models
     #                   settings and the attributes of the issuing key.
     #                   TTL when sent to Ably is in milliseconds.
     def ttl
-      hash.fetch(:ttl) / 1000
+      attributes.fetch(:ttl) / 1000
     end
 
     # @!attribute [r] capability
@@ -57,14 +59,14 @@ module Ably::Models
     #                the capability of the returned token will be the intersection of
     #                this capability with the capability of the issuing key.
     def capability
-      JSON.parse(hash.fetch(:capability))
+      JSON.parse(attributes.fetch(:capability))
     end
 
     # @!attribute [r] client_id
     # @return [String] the client ID to associate with this token. The generated token
     #                  may be used to authenticate as this clientId.
     def client_id
-      hash[:client_id]
+      attributes[:client_id]
     end
 
     # @!attribute [r] timestamp
@@ -73,7 +75,7 @@ module Ably::Models
     #                token requests from being replayed.
     #                Timestamp when sent to Ably is in milliseconds.
     def timestamp
-      as_time_from_epoch(hash.fetch(:timestamp), granularity: :ms)
+      as_time_from_epoch(attributes.fetch(:timestamp), granularity: :ms)
     end
 
     # @!attribute [r] nonce
@@ -81,26 +83,26 @@ module Ably::Models
     #                   uniqueness of this request. Any subsequent request using the
     #                   same nonce will be rejected.
     def nonce
-      hash.fetch(:nonce)
+      attributes.fetch(:nonce)
     end
 
     # @!attribute [r] mac
     # @return [String]  the Message Authentication Code for this request. See the
     #                   {https://www.ably.io/documentation Ably Authentication documentation} for more details.
     def mac
-      hash.fetch(:mac)
+      attributes.fetch(:mac)
     end
 
     # Requests that the token is always persisted
     # @api private
     #
     def persisted
-      hash.fetch(:persisted)
+      attributes.fetch(:persisted)
     end
 
-    # @!attribute [r] hash
+    # @!attribute [r] attributes
     # @return [Hash] the token request Hash object ruby'fied to use symbolized keys
-    def hash
+    def attributes
       @hash_object
     end
   end

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

@@ -2,7 +2,7 @@ require 'eventmachine'
 
 module Ably::Modules
   # Provides methods to convert synchronous operations into async operations through the use of
-  # {EventMachine#defer http://www.rubydoc.info/github/eventmachine/eventmachine/EventMachine#defer-class_method}.
+  # {http://www.rubydoc.info/github/eventmachine/eventmachine/EventMachine#defer-class_method EventMachine#defer}.
   # The async_wrap method can only be called from within an EventMachine reactor, and must be thread safe.
   #
   # @note using this AsyncWrapper should only be used for methods that are used less frequently and typically
@@ -42,7 +42,7 @@ module Ably::Modules
       raise ArgumentError, 'Block required' unless block_given?
 
       Ably::Util::SafeDeferrable.new(logger).tap do |deferrable|
-        deferrable.callback &success_callback if success_callback
+        deferrable.callback(&success_callback) if success_callback
 
         operation_with_exception_handling = proc do
           begin

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

@@ -70,6 +70,16 @@ module Ably::Modules
     end
 
     private
-    attr_reader :client, :channel_klass, :channels
+    def client
+      @client
+    end
+
+    def channel_klass
+      @channel_klass
+    end
+
+    def channels
+      @channels
+    end
   end
 end

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

@@ -5,9 +5,9 @@ module Ably::Modules
   # Provides methods to allow this model's `data` property to be encoded and decoded based on the `encoding` property.
   #
   # This module expects the following:
-  # - A #hash method that returns the underlying hash object
-  # - A #set_hash_object(hash) method that updates the underlying hash object
-  # - A #raw_hash_object attribute that returns the original hash used to create this object
+  # - A #attributes method that returns the underlying hash object
+  # - A #set_attributes_object(attributes) method that updates the underlying hash object
+  # - A #raw_hash_object attribute that returns the original hash object used to create this object
   #
   module Encodeable
     # Encode a message using the channel options and register encoders for the client
@@ -46,20 +46,20 @@ module Ably::Modules
 
     def apply_encoders(method, channel)
       max_encoding_length = 512
-      message_hash = hash.dup
+      message_attributes = attributes.dup
 
       begin
-        if message_hash[:encoding].to_s.length > max_encoding_length
-          raise Ably::Exceptions::EncoderError("Encoding error, encoding value is too long: '#{message_hash[:encoding]}'", nil, 92100)
+        if message_attributes[:encoding].to_s.length > max_encoding_length
+          raise Ably::Exceptions::EncoderError("Encoding error, encoding value is too long: '#{message_attributes[:encoding]}'", nil, 92100)
         end
 
-        previous_encoding = message_hash[:encoding]
+        previous_encoding = message_attributes[:encoding]
         channel.client.encoders.each do |encoder|
-          encoder.send method, message_hash, channel.options
+          encoder.send method, message_attributes, channel.options
         end
-      end until previous_encoding == message_hash[:encoding]
+      end until previous_encoding == message_attributes[:encoding]
 
-      set_hash_object message_hash
+      set_attributes_object message_attributes
     rescue Ably::Exceptions::CipherError => cipher_error
       if channel.respond_to?(:emit)
         channel.client.logger.error "Encoder error #{cipher_error.code} trying to #{method} message: #{cipher_error.message}"

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

@@ -90,7 +90,13 @@ module Ably::Modules
           end
 
           private
-          attr_reader :by_index, :by_symbol
+          def by_index
+            @by_index
+          end
+
+          def by_symbol
+            @by_symbol
+          end
 
           # Define constants for each of the Enum values
           # e.g. define_constants(:dog) creates Enum::Dog
@@ -173,7 +179,17 @@ module Ably::Modules
         end
 
         private
-        attr_reader :name, :index, :symbol
+        def name
+          @name
+        end
+
+        def index
+          @index
+        end
+
+        def symbol
+          @symbol
+        end
 
         define_values values
       end

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

@@ -39,7 +39,7 @@ module Ably
 
         # Ensure @event_emitter_coerce_proc option is passed down to any classes that inherit the class with callbacks
         def inherited(subclass)
-          subclass.instance_variable_set('@event_emitter_coerce_proc', @event_emitter_coerce_proc)
+          subclass.instance_variable_set('@event_emitter_coerce_proc', @event_emitter_coerce_proc) if defined?(@event_emitter_coerce_proc)
           super
         end
       end
@@ -90,7 +90,7 @@ module Ably
           clone.
           select do |proc_hash|
             if proc_hash[:unsafe]
-              proc_hash[:emit_proc].call *args
+              proc_hash[:emit_proc].call(*args)
             else
               safe_yield proc_hash[:emit_proc], *args
             end
@@ -133,7 +133,7 @@ module Ably
       def proc_for_block(block, options = {})
         {
           emit_proc: Proc.new do |*args|
-            block.call *args
+            block.call(*args)
             true if options[:delete_once_run]
           end,
           block: block,

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

@@ -12,24 +12,32 @@ module Ably::Modules
     #
     # @return [Object]
     def [](key)
-      hash[key]
+      attributes[key]
     end
 
     def ==(other)
       other.kind_of?(self.class) &&
-        hash == other.hash
+        attributes == other.attributes
     end
 
-    # Return a JSON ready object from the underlying #hash using Ably naming conventions for keys
+    # Return a JSON ready object from the underlying #attributes using Ably naming conventions for keys
+    # @return [Hash]
     def as_json
-      hash.as_json.reject { |key, val| val.nil? }
+      attributes.as_json.reject { |key, val| val.nil? }
     end
 
-    # Stringify the JSON representation of this object from the underlying #hash
+    # Stringify the JSON representation of this object from the underlying #attributes
+    # @return [String]
     def to_json(*args)
       as_json.to_json(*args)
     end
 
+    # @!attribute [r] hash
+    # @return [Integer] Compute a hash-code for this hash. Two hashes with the same content will have the same hash code
+    def hash
+      attributes.hash
+    end
+
     private
     def ensure_utf8_string_for(attribute, value)
       if value

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

@@ -59,7 +59,7 @@ module Ably::Modules
 
     private
     def safe_deferrable_block(*args)
-      yield *args
+      yield(*args)
     rescue StandardError => e
       message = "An exception in a Deferrable callback was caught. #{e.class}: #{e.message}\n#{e.backtrace.join("\n")}"
       if defined?(:logger) && logger.respond_to?(:error)

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

@@ -13,7 +13,7 @@ module Ably::Modules
     private
 
     def safe_yield(block, *args)
-      block.call *args
+      block.call(*args)
     rescue StandardError => e
       message = "An exception in an external block was caught. #{e.class}: #{e.message}\n#{e.backtrace.join("\n")}"
       safe_yield_log_error message
@@ -23,7 +23,7 @@ module Ably::Modules
       if defined?(:logger) && logger.respond_to?(:error)
         return logger.error message
       end
-    rescue StandardError => e
+    rescue StandardError
       fallback_logger.error message
     end
 

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

@@ -82,21 +82,21 @@ module Ably::Modules
 
         success_wrapper = Proc.new do
           yield
-          off &success_wrapper
-          off &failure_wrapper if failure_wrapper
+          off(&success_wrapper)
+          off(&failure_wrapper) if failure_wrapper
         end
 
         failure_wrapper = proc do |*args|
-          failure_block.call *args
-          off &success_wrapper
-          off &failure_wrapper
+          failure_block.call(*args)
+          off(&success_wrapper)
+          off(&failure_wrapper)
         end if failure_block
 
         Array(target_states).each do |target_state|
           safe_unsafe_method options[:unsafe], :once, target_state, &success_wrapper
 
           safe_unsafe_method options[:unsafe], :once_state_changed do |*args|
-            failure_wrapper.call *args unless state == target_state
+            failure_wrapper.call(*args) unless state == target_state
           end if failure_block
         end
       end
@@ -119,8 +119,8 @@ module Ably::Modules
       raise ArgumentError, 'Block required' unless block_given?
 
       once_block = proc do |*args|
-        off *self.class::STATE.map, &once_block
-        yield *args
+        off(*self.class::STATE.map, &once_block)
+        yield(*args)
       end
 
       safe_unsafe_method options[:unsafe], :once, *self.class::STATE.map, &once_block

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

@@ -5,7 +5,7 @@ module Ably::Modules
     # This can be removed once https://github.com/gocardless/statesman/issues/95 is solved
     def before_transition(options = nil, &block)
       arrayify_transition(options) do |options_without_from_array|
-        super *options_without_from_array, &block
+        super(*options_without_from_array, &block)
       end
     end
 
@@ -13,7 +13,7 @@ module Ably::Modules
     # This can be removed once https://github.com/gocardless/statesman/issues/95 is solved
     def after_transition(options = nil, &block)
       arrayify_transition(options) do |options_without_from_array|
-        super *options_without_from_array, &block
+        super(*options_without_from_array, &block)
       end
     end
 

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

@@ -59,7 +59,9 @@ module Ably::Modules
     def_delegators :state_machine, :can_transition_to?
 
     private
-    attr_reader :state_machine
+    def state_machine
+      @state_machine
+    end
 
     def_delegators :state_machine, :exception_for_state_change_to
 
@@ -85,7 +87,7 @@ module Ably::Modules
 
     module ClassMethods
       def emits_klass
-        @emits_klass ||= if @emits_klass_name
+        @emits_klass ||= if defined?(@emits_klass_name) && @emits_klass_name
           get_const(@emits_klass_name)
         end
       end