ably 0.7.0 → 0.7.1

data/ably.gemspec

@@ -19,6 +19,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_runtime_dependency 'eventmachine', '~> 1.0'
+  spec.add_runtime_dependency 'em-http-request', '~> 1.1'
   spec.add_runtime_dependency 'statesman', '~> 1.0.0'
   spec.add_runtime_dependency 'faraday', '~> 0.9'
   spec.add_runtime_dependency 'json'
@@ -29,6 +30,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'redcarpet'
   spec.add_development_dependency 'rspec', '~> 3.1.0' # version lock, see event_machine_helper.rb#patch_example_block_with_surrounding_eventmachine_reactor
+  spec.add_development_dependency 'rspec-retry'
   spec.add_development_dependency 'yard'
   spec.add_development_dependency 'webmock'
 end

data/lib/ably/auth.rb

@@ -37,6 +37,7 @@ module Ably
     # @param options (see Ably::Rest::Client#initialize)
     # @option (see Ably::Rest::Client#initialize)
     # @yield  (see Ably::Rest::Client#initialize)
+    #
     def initialize(client, options, &token_request_block)
       auth_options = options.dup
 
@@ -140,12 +141,12 @@ module Ably
     #      token_request
     #    end
     #
-    def request_token(options = {}, &token_request_block)
+    def request_token(options = {})
       token_options = self.auth_options.merge(options)
 
       auth_url = token_options.delete(:auth_url)
       token_request = if block_given?
-        token_request_block.call(token_options)
+        yield token_options
       elsif default_token_block
         default_token_block.call(token_options)
       elsif auth_url
@@ -203,7 +204,7 @@ module Ably
 
       token_request = {
         id:         request_key_id,
-        client_id:  client_id,
+        clientId:   client_id,
         ttl:        Ably::Models::Token::DEFAULTS[:ttl],
         timestamp:  timestamp,
         capability: Ably::Models::Token::DEFAULTS[:capability],
@@ -217,7 +218,8 @@ module Ably
       ensure_utf_8 :nonce, token_request[:nonce], allow_nil: true
 
       token_request[:mac] = sign_params(token_request, request_key_secret)
-      token_request
+
+      convert_to_mixed_case_hash(token_request)
     end
 
     def api_key
@@ -350,7 +352,7 @@ module Ably
       ).map { |t| "#{t}\n" }.join("")
 
       encode64(
-        Digest::HMAC.digest(text, secret, Digest::SHA256)
+        OpenSSL::HMAC.digest(OpenSSL::Digest::SHA256.new, secret, text)
       )
     end
 

data/lib/ably/models/idiomatic_ruby_wrapper.rb

@@ -76,7 +76,7 @@ module Ably::Models
       hash[source_key_for(key)] = value
     end
 
-    def fetch(key, default = nil, &missing_block)
+    def fetch(key, default = nil)
       if has_key?(key)
         self[key]
       else
@@ -107,15 +107,13 @@ module Ably::Models
     end
 
     # Method ensuring this {IdiomaticRubyWrapper} is {http://ruby-doc.org/core-2.1.3/Enumerable.html Enumerable}
-    def each(&block)
+    def each
+      return to_enum(:each) unless block_given?
+
       hash.each do |key, value|
         key = convert_to_snake_case_symbol(key)
         value = self[key]
-        if block_given?
-          block.call key, value
-        else
-          yield key, value
-        end
+        yield key, value
       end
     end
 

data/lib/ably/models/paginated_resource.rb

@@ -5,7 +5,7 @@ module Ably::Models
   # Paging information is provided by Ably in the LINK HTTP headers
   class PaginatedResource
     include Enumerable
-    include Ably::Modules::AsyncWrapper if defined?(EventMachine)
+    include Ably::Modules::AsyncWrapper if defined?(Ably::Realtime)
 
     # @param [Faraday::Response] http_response Initial HTTP response from an Ably request to a paged resource
     # @param [String] base_url Base URL for request that generated the http_response so that subsequent paged requests can be made
@@ -25,19 +25,9 @@ module Ably::Models
       @each_block    = each_block
       @make_async    = options.fetch(:async_blocking_operations, false)
 
-      @body = if @coerce_into
-        http_response.body.map do |item|
-          @coerce_into.split('::').inject(Kernel) do |base, klass_name|
-            base.public_send(:const_get, klass_name)
-          end.new(item)
-        end
-      else
-        http_response.body
-      end
-
-      @body = @body.map do |resource|
-        each_block.call(resource)
-      end if block_given?
+      @body = http_response.body
+      @body = coerce_items_into(body, @coerce_into) if @coerce_into
+      @body = body.map { |item| yield item } if block_given?
     end
 
     # Retrieve the first page of results.
@@ -100,13 +90,8 @@ module Ably::Models
 
     # Method to allow {PaginatedResource} to be {http://ruby-doc.org/core-2.1.3/Enumerable.html Enumerable}
     def each(&block)
-      body.each do |item|
-        if block_given?
-          block.call item
-        else
-          yield item
-        end
-      end
+      return to_enum(:each) unless block_given?
+      body.each(&block)
     end
 
     # First item in this page
@@ -134,6 +119,14 @@ module Ably::Models
     private
     attr_reader :body, :http_response, :base_url, :client, :coerce_into, :raw_body, :each_block, :make_async
 
+    def coerce_items_into(items, type_string)
+      items.map do |item|
+        @coerce_into.split('::').inject(Kernel) do |base, klass_name|
+          base.public_send(:const_get, klass_name)
+        end.new(item)
+      end
+    end
+
     def pagination_headers
       link_regex = %r{<(?<url>[^>]+)>; rel="(?<rel>[^"]+)"}
       @pagination_headers ||= begin

data/lib/ably/models/protocol_message.rb

@@ -37,7 +37,7 @@ module Ably::Models
   #
   class ProtocolMessage
     include Ably::Modules::ModelCommon
-    include EventMachine::Deferrable
+    include EventMachine::Deferrable if defined?(Ably::Realtime)
     extend Ably::Modules::Enum
 
     # Actions which are sent by the Ably Realtime API

data/lib/ably/modules/ably.rb

@@ -8,4 +8,8 @@ module Ably
   # network failures either at the client, between the client and Ably, within an Ably data center, or at the IO domain registrar
   #
   FALLBACK_HOSTS = %w(A.ably-realtime.com B.ably-realtime.com C.ably-realtime.com D.ably-realtime.com E.ably-realtime.com)
+  INTERNET_CHECK = {
+    url:     'http://internet-up.ably.io/is-the-internet-up.txt', #ably-realtime.com
+    ok_text: 'yes'
+  }
 end

data/lib/ably/modules/async_wrapper.rb

@@ -37,8 +37,8 @@ module Ably::Modules
     # @yield [Object] operation block that is run in a thread
     # @return [EventMachine::Deferrable]
     #
-    def async_wrap(success_callback = nil, &operation)
-      raise ArgumentError, "Operation block is missing" unless block_given?
+    def async_wrap(success_callback = nil)
+      raise ArgumentError, 'Block required' unless block_given?
 
       EventMachine::DefaultDeferrable.new.tap do |deferrable|
         deferrable.callback &success_callback if success_callback

data/lib/ably/modules/channels_collection.rb

@@ -2,6 +2,8 @@ module Ably::Modules
   # ChannelsCollection module provides common functionality to the Rest and Realtime Channels objects
   # such as #get, #[], #fetch, and #release
   module ChannelsCollection
+    include Enumerable
+
     def initialize(client, channel_klass)
       @client         = client
       @channel_klass  = channel_klass
@@ -11,11 +13,12 @@ module Ably::Modules
     # Return a Channel for the given name
     #
     # @param name [String] The name of the channel
-    # @param channel_options [Hash] Channel options, currently reserved for Encryption options
+    # @param channel_options [Hash] Channel options including the encryption options
+    #
+    # @return [Channel]
     #
-    # @return Channel
     def get(name, channel_options = {})
-      @channels[name] ||= channel_klass.new(client, name, channel_options)
+      channels[name] ||= channel_klass.new(client, name, channel_options)
     end
     alias_method :[], :get
 
@@ -27,20 +30,40 @@ module Ably::Modules
     # @yield [options] (optional) if a missing_block is passed to this method and no channel exists matching the name, this block is called
     # @yieldparam [String] name of the missing channel
     #
-    # @return Channel
+    # @return [Channel]
+    #
     def fetch(name, &missing_block)
-      @channels.fetch(name, &missing_block)
+      channels.fetch(name, &missing_block)
     end
 
     # Destroy the Channel and releases the associated resources.
     #
     # Releasing a Channel is not typically necessary as a channel consumes no resources other than the memory footprint of the
     # Channel object. Explicitly release channels to free up resources if required
-    def release(channel)
-      @channels.delete(channel)
+    #
+    # @param name [String] The name of the channel
+    #
+    # @return [void]
+    #
+    def release(name)
+      channels.delete(name)
+    end
+
+    # @!attribute [r] length
+    # @return [Integer] number of channels created
+    def length
+      channels.length
+    end
+    alias_method :count, :length
+    alias_method :size,  :length
+
+    # Method to allow {ChannelsCollection} to be {http://ruby-doc.org/core-2.1.3/Enumerable.html Enumerable}
+    def each(&block)
+      return to_enum(:each) unless block_given?
+      channels.values.each(&block)
     end
 
     private
-    attr_reader :client, :channel_klass
+    attr_reader :client, :channel_klass, :channels
   end
 end

data/lib/ably/modules/conversions.rb

@@ -58,6 +58,16 @@ module Ably::Modules
         join
     end
 
+    # Convert a Hash into a mixed case Hash objet
+    # i.e. { client_id: 1 } becomes { 'clientId' => 1 }
+    def convert_to_mixed_case_hash(hash, options = {})
+      raise ArgumentError, 'Hash expected' unless hash.kind_of?(Hash)
+      hash.each_with_object({}) do |pair, new_hash|
+        key, val = pair
+        new_hash[convert_to_mixed_case(key, options)] = val
+      end
+    end
+
     # Convert key to :snake_case from snakeCase
     def convert_to_snake_case_symbol(key)
       key.to_s.gsub(/::/, '/').

data/lib/ably/modules/enum.rb

@@ -80,9 +80,8 @@ module Ably::Modules
 
           # Method ensuring this {Enum} is {http://ruby-doc.org/core-2.1.3/Enumerable.html Enumerable}
           def each(&block)
-            by_symbol.each do |key, value|
-              yield value
-            end
+            return to_enum(:each) unless block_given?
+            by_symbol.values.each(&block)
           end
 
           # The name provided in the constructor for this Enum

data/lib/ably/modules/state_emitter.rb

@@ -69,17 +69,17 @@ module Ably::Modules
     # @yield block is called if the state is matched immediately or once when the state is reached
     #
     # @return [void]
-    def once_or_if(target_states, options = {}, &success_block)
-      raise ArgumentError, 'Block is expected' unless block_given?
+    def once_or_if(target_states, options = {})
+      raise ArgumentError, 'Block required' unless block_given?
 
       if Array(target_states).any? { |target_state| state == target_state }
-        success_block.call
+        yield
       else
         failure_block   = options.fetch(:else, nil)
         failure_wrapper = nil
 
         success_wrapper = Proc.new do
-          success_block.call
+          yield
           off &success_wrapper
           off &failure_wrapper if failure_wrapper
         end
@@ -107,7 +107,7 @@ module Ably::Modules
     #
     # @api private
     def once_state_changed(&block)
-      raise ArgumentError, 'Block is expected' unless block_given?
+      raise ArgumentError, 'Block required' unless block_given?
 
       once_block = proc do |*args|
         off *self.class::STATE.map, &once_block
@@ -120,13 +120,13 @@ module Ably::Modules
     private
 
     # Returns an {EventMachine::Deferrable} and once the target state is reached, the
-    # success_block if provided and {EventMachine::Deferrable#callback} is called.
+    # success block if provided and {EventMachine::Deferrable#callback} is called.
     # If the state changes to any other state, the {EventMachine::Deferrable#errback} is called.
     #
-    def deferrable_for_state_change_to(target_state, &success_block)
+    def deferrable_for_state_change_to(target_state)
       EventMachine::DefaultDeferrable.new.tap do |deferrable|
         once_or_if(target_state, else: proc { |*args| deferrable.fail self, *args }) do
-          success_block.call self if block_given?
+          yield self if block_given?
           deferrable.succeed self
         end
       end

data/lib/ably/modules/state_machine.rb

@@ -13,6 +13,7 @@ module Ably::Modules
         include Statesman::Machine
       end
       klass.extend Ably::Modules::StatesmanMonkeyPatch
+      klass.extend ClassMethods
     end
 
     # Alternative to Statesman's #transition_to that:
@@ -45,9 +46,12 @@ module Ably::Modules
       Ably::Exceptions::StateChangeError.new(error_message, nil, 80020)
     end
 
-    private
-    def self.is_error_type?(error)
-      error.kind_of?(Ably::Models::ErrorInfo) || error.kind_of?(StandardError)
+    module ClassMethods
+      private
+
+      def is_error_type?(error)
+        error.kind_of?(Ably::Models::ErrorInfo) || error.kind_of?(StandardError)
+      end
     end
   end
 end

data/lib/ably/realtime/channel.rb

@@ -214,6 +214,12 @@ module Ably
         @error_reason = error
       end
 
+      # Used by {Ably::Modules::StateEmitter} to debug state changes
+      # @api private
+      def logger
+        client.logger
+      end
+
       private
       attr_reader :queue, :subscriptions
 
@@ -276,11 +282,6 @@ module Ably
         client.rest_client.channel(name)
       end
 
-      # Used by {Ably::Modules::StateEmitter} to debug state changes
-      def logger
-        client.logger
-      end
-
       def connection
         client.connection
       end

data/lib/ably/realtime/channel/channel_manager.rb

@@ -20,10 +20,6 @@ module Ably::Realtime
         connection.on(:failed) do |error|
           channel.transition_state_machine :failed, error if can_transition_to?(:failed)
         end
-
-        channel.on(:attached, :detached) do
-          channel.set_failed_channel_error_reason nil
-        end
       end
 
       # Commence attachment
@@ -35,9 +31,9 @@ module Ably::Realtime
       end
 
       # Commence attachment
-      def detach
-        if connection.closed?
-          channel.transition_state_machine :detached
+      def detach(error = nil)
+        if connection.closed? || connection.connecting?
+          channel.transition_state_machine :detached, error
         elsif can_transition_to?(:detached)
           send_detach_protocol_message
         end
@@ -52,12 +48,17 @@ module Ably::Realtime
         end
       end
 
-      # Channel has failed
-      def failed(error)
-        logger.error "Channel #{channel.name} error: #{error}"
+      # An error has occurred on the channel
+      def emit_error(error)
+        logger.error "ChannelManager: Channel '#{channel.name}' error: #{error}"
         channel.trigger :error, error
       end
 
+      # Detach a channel as a result of an error
+      def suspend(error)
+        channel.transition_state_machine! :detaching, error
+      end
+
       private
 
       attr_reader :channel, :connection

data/lib/ably/realtime/channel/channel_state_machine.rb

@@ -38,21 +38,22 @@ module Ably::Realtime
         channel.manager.sync current_transition.metadata
       end
 
-      after_transition(to: [:detaching]) do |channel|
-        channel.manager.detach
+      after_transition(to: [:detaching]) do |channel, current_transition|
+        channel.manager.detach current_transition.metadata
       end
 
-      after_transition(to: [:failed]) do |channel, current_transition|
-        channel.manager.failed current_transition.metadata
+      after_transition(to: [:detached]) do |channel, current_transition|
+        channel.manager.emit_error current_transition.metadata if current_transition.metadata
       end
 
-      # Transitions responsible for updating channel#error_reason
-      before_transition(to: [:failed]) do |channel, current_transition|
-        channel.set_failed_channel_error_reason current_transition.metadata
+      after_transition(to: [:failed]) do |channel, current_transition|
+        channel.manager.emit_error current_transition.metadata
       end
 
-      before_transition(to: [:attached, :detached]) do |channel, current_transition|
-        channel.set_failed_channel_error_reason nil
+      # Transitions responsible for updating channel#error_reason
+      before_transition(to: [:attached, :detached, :failed]) do |channel, current_transition|
+        reason = current_transition.metadata if is_error_type?(current_transition.metadata)
+        channel.set_failed_channel_error_reason reason
       end
 
       private