ably 0.8.7 → 0.8.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bddcc0bf82f649840942920da7506c0bedba4c89
-  data.tar.gz: 9a920e4bb42e6770442d25d17f8f276eb82452c6
+  metadata.gz: 8b659327cc341068fce6404895940be1547529f7
+  data.tar.gz: 1cefe9e6c6ea0a874b71f37834088d85efd76307
 SHA512:
-  metadata.gz: dd4b8b79859f80cffff7f6087dc73ba56f1bbaf61a4364b8586b61b1d1fec90c7d1c239bfb87d4524f30d6567bb298d1206996583bc2278a9ba328d412b3a5f5
-  data.tar.gz: 2e886e10cb4d543e57420ae6d29e872608b0f5fb864374399f392959fc0033a9c9c5add42cafd266ee6e64514284fa5381e95c50ab17b4b986ce97db575539b4
+  metadata.gz: ca4059010c9811beb36753c2cc346c74fed4ac94a20caa45d3a62ec3d4abf5ba32dc90d0687c0f7a88bd642224e843a78dcc1a4537215d3d9a24b7adbb31c84c
+  data.tar.gz: a24b1ecf027d74490030d49bffafff647c4d9066b70ce603f7b82f1e987679817931267857e5087b3a0d84d197e6d058136417aa2b98c44fb7f64da109821a14

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Change Log
 
+## [v0.8.8](https://github.com/ably/ably-ruby/tree/v0.8.8)
+
+[Full Changelog](https://github.com/ably/ably-ruby/compare/v0.8.7...v0.8.8)
+
+**Closed issues:**
+
+- Support :key in ClientOptions and deprecate :api\_key [\#73](https://github.com/ably/ably-ruby/issues/73)
+
+## [v0.8.7](https://github.com/ably/ably-ruby/tree/v0.8.7) (2015-12-31)
+
+[Full Changelog](https://github.com/ably/ably-ruby/compare/v0.8.6...v0.8.7)
+
 ## [v0.8.6](https://github.com/ably/ably-ruby/tree/v0.8.6) (2015-12-02)
 
 [Full Changelog](https://github.com/ably/ably-ruby/compare/v0.8.5...v0.8.6)
@@ -13,6 +25,7 @@
 - 0.8 final spec \(98% compliance\) [\#66](https://github.com/ably/ably-ruby/pull/66) ([mattheworiordan](https://github.com/mattheworiordan))
 
 ## [v0.8.5](https://github.com/ably/ably-ruby/tree/v0.8.5) (2015-10-08)
+
 [Full Changelog](https://github.com/ably/ably-ruby/compare/v0.8.4...v0.8.5)
 
 **Implemented enhancements:**
@@ -22,7 +35,9 @@
 **Fixed bugs:**
 
 - Switch arity of auth methods [\#61](https://github.com/ably/ably-ruby/issues/61)
+
 - Add test: Message published, connection dropped, then restores to point before last message was published [\#56](https://github.com/ably/ably-ruby/issues/56)
+
 - Documentation for constructor is incorrect [\#49](https://github.com/ably/ably-ruby/issues/49)
 
 **Merged pull requests:**
@@ -30,30 +45,41 @@
 - Ensure connections are always closed in tests [\#63](https://github.com/ably/ably-ruby/pull/63) ([mattheworiordan](https://github.com/mattheworiordan))
 
 ## [v0.8.4](https://github.com/ably/ably-ruby/tree/v0.8.4) (2015-09-08)
+
 [Full Changelog](https://github.com/ably/ably-ruby/compare/v0.8.3...v0.8.4)
 
 **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)
 
 **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))
 
 ## [v0.8.3](https://github.com/ably/ably-ruby/tree/v0.8.3) (2015-08-19)
+
 [Full Changelog](https://github.com/ably/ably-ruby/compare/v0.8.2...v0.8.3)
 
 **Implemented enhancements:**
 
 - 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)
+
 - Move stats fixtures into ably-common [\#34](https://github.com/ably/ably-ruby/issues/34)
+
 - Add tests for messages with no data or name fields [\#21](https://github.com/ably/ably-ruby/issues/21)
+
 - Namespace MsgPack as MsgPack5 because compliance is not merged in [\#12](https://github.com/ably/ably-ruby/issues/12)
+
 - Add test coverage for receiving messages more than once i.e. historical messages resent somehow on reconnect [\#11](https://github.com/ably/ably-ruby/issues/11)
+
 - Add async methods for Authentication in the realtime library [\#8](https://github.com/ably/ably-ruby/issues/8)
 
 **Fixed bugs:**
@@ -63,28 +89,37 @@
 **Closed issues:**
 
 - Scope default token params in arguments [\#55](https://github.com/ably/ably-ruby/issues/55)
+
 - Channel options can be reset when accessing a channel with \#get [\#46](https://github.com/ably/ably-ruby/issues/46)
 
 **Merged pull requests:**
 
 - 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))
 
 ## [v0.8.2](https://github.com/ably/ably-ruby/tree/v0.8.2) (2015-05-20)
+
 [Full Changelog](https://github.com/ably/ably-ruby/compare/v0.8.1...v0.8.2)
 
 **Implemented enhancements:**
 
 - Ensure Array object can be used in place of Hash for payload [\#44](https://github.com/ably/ably-ruby/issues/44)
+
 - Change connect\_automatically option to auto\_connect for consistency [\#42](https://github.com/ably/ably-ruby/issues/42)
+
 - Rename PaginatedResource to PaginatedResult for consistency [\#40](https://github.com/ably/ably-ruby/issues/40)
+
 - EventEmitter should use `emit` not `trigger` to be consistent with other libs [\#31](https://github.com/ably/ably-ruby/issues/31)
+
 - Add exceptions when data attribute for messages/presence is not String, Binary or JSON data [\#4](https://github.com/ably/ably-ruby/issues/4)
+
 - Auth Callback and Auth URL should support tokens as well as token requests [\#2](https://github.com/ably/ably-ruby/issues/2)
 
 **Closed issues:**
 
 - Realtime Presence\#get does not wait by default [\#47](https://github.com/ably/ably-ruby/issues/47)
+
 - No implicit attach when accessing channel.presence [\#45](https://github.com/ably/ably-ruby/issues/45)
 
 **Merged pull requests:**
@@ -92,9 +127,11 @@
 - Reject invalid payload type [\#48](https://github.com/ably/ably-ruby/pull/48) ([mattheworiordan](https://github.com/mattheworiordan))
 
 ## [v0.8.1](https://github.com/ably/ably-ruby/tree/v0.8.1) (2015-04-23)
+
 [Full Changelog](https://github.com/ably/ably-ruby/compare/v0.8.0...v0.8.1)
 
 ## [v0.8.0](https://github.com/ably/ably-ruby/tree/v0.8.0) (2015-04-23)
+
 [Full Changelog](https://github.com/ably/ably-ruby/compare/v0.7.6...v0.8.0)
 
 **Merged pull requests:**
@@ -102,15 +139,18 @@
 - Token naming refactor [\#29](https://github.com/ably/ably-ruby/pull/29) ([mattheworiordan](https://github.com/mattheworiordan))
 
 ## [v0.7.6](https://github.com/ably/ably-ruby/tree/v0.7.6) (2015-04-17)
+
 [Full Changelog](https://github.com/ably/ably-ruby/compare/v0.7.5...v0.7.6)
 
 **Implemented enhancements:**
 
 - Rename Stat to Stats for consistency [\#32](https://github.com/ably/ably-ruby/issues/32)
+
 - Stats objects [\#24](https://github.com/ably/ably-ruby/issues/24)
+
 - Need a test to handle errors in callbacks [\#13](https://github.com/ably/ably-ruby/issues/13)
+
 - Allow token ID or API key in the client constructor [\#5](https://github.com/ably/ably-ruby/issues/5)
-- Typed stats similar to Java library + zero default for empty stats [\#25](https://github.com/ably/ably-ruby/pull/25) ([mattheworiordan](https://github.com/mattheworiordan))
 
 **Fixed bugs:**
 
@@ -123,14 +163,19 @@
 **Merged pull requests:**
 
 - Test encoded presence fixture data for \#get & \#history [\#28](https://github.com/ably/ably-ruby/pull/28) ([mattheworiordan](https://github.com/mattheworiordan))
+
 - Add coveralls.io coverage reporting [\#27](https://github.com/ably/ably-ruby/pull/27) ([mattheworiordan](https://github.com/mattheworiordan))
+
 - New paginated resource [\#26](https://github.com/ably/ably-ruby/pull/26) ([mattheworiordan](https://github.com/mattheworiordan))
-- History since attach [\#22](https://github.com/ably/ably-ruby/pull/22) ([mattheworiordan](https://github.com/mattheworiordan))
+
+- Typed stats similar to Java library + zero default for empty stats [\#25](https://github.com/ably/ably-ruby/pull/25) ([mattheworiordan](https://github.com/mattheworiordan))
 
 ## [v0.7.5](https://github.com/ably/ably-ruby/tree/v0.7.5) (2015-03-21)
+
 [Full Changelog](https://github.com/ably/ably-ruby/compare/v0.7.4...v0.7.5)
 
 ## [v0.7.4](https://github.com/ably/ably-ruby/tree/v0.7.4) (2015-03-21)
+
 [Full Changelog](https://github.com/ably/ably-ruby/compare/v0.7.2...v0.7.4)
 
 **Merged pull requests:**
@@ -138,6 +183,7 @@
 - Presence Member Map [\#14](https://github.com/ably/ably-ruby/pull/14) ([mattheworiordan](https://github.com/mattheworiordan))
 
 ## [v0.7.2](https://github.com/ably/ably-ruby/tree/v0.7.2) (2015-02-10)
+
 [Full Changelog](https://github.com/ably/ably-ruby/compare/v0.7.1...v0.7.2)
 
 **Implemented enhancements:**
@@ -147,12 +193,15 @@
 **Merged pull requests:**
 
 - Update README to include various missing snippets for core features [\#9](https://github.com/ably/ably-ruby/pull/9) ([kouno](https://github.com/kouno))
+
 - Fix connection retry frequency [\#7](https://github.com/ably/ably-ruby/pull/7) ([kouno](https://github.com/kouno))
 
 ## [v0.7.1](https://github.com/ably/ably-ruby/tree/v0.7.1) (2015-01-18)
+
 [Full Changelog](https://github.com/ably/ably-ruby/compare/v0.7.0...v0.7.1)
 
 ## [v0.7.0](https://github.com/ably/ably-ruby/tree/v0.7.0) (2015-01-12)
+
 [Full Changelog](https://github.com/ably/ably-ruby/compare/v0.6.2...v0.7.0)
 
 **Closed issues:**
@@ -160,30 +209,39 @@
 - JSON encoder should only append utf-8 before a cipher encoder is applied [\#1](https://github.com/ably/ably-ruby/issues/1)
 
 ## [v0.6.2](https://github.com/ably/ably-ruby/tree/v0.6.2) (2014-12-10)
+
 [Full Changelog](https://github.com/ably/ably-ruby/compare/v0.2.0...v0.6.2)
 
 ## [v0.2.0](https://github.com/ably/ably-ruby/tree/v0.2.0) (2014-12-09)
+
 [Full Changelog](https://github.com/ably/ably-ruby/compare/v0.1.6...v0.2.0)
 
 ## [v0.1.6](https://github.com/ably/ably-ruby/tree/v0.1.6) (2014-10-31)
+
 [Full Changelog](https://github.com/ably/ably-ruby/compare/v0.1.5...v0.1.6)
 
 ## [v0.1.5](https://github.com/ably/ably-ruby/tree/v0.1.5) (2014-10-23)
+
 [Full Changelog](https://github.com/ably/ably-ruby/compare/v0.1.4...v0.1.5)
 
 ## [v0.1.4](https://github.com/ably/ably-ruby/tree/v0.1.4) (2014-09-27)
+
 [Full Changelog](https://github.com/ably/ably-ruby/compare/v0.1.3...v0.1.4)
 
 ## [v0.1.3](https://github.com/ably/ably-ruby/tree/v0.1.3) (2014-09-26)
+
 [Full Changelog](https://github.com/ably/ably-ruby/compare/v0.1.2...v0.1.3)
 
 ## [v0.1.2](https://github.com/ably/ably-ruby/tree/v0.1.2) (2014-09-25)
+
 [Full Changelog](https://github.com/ably/ably-ruby/compare/v0.1.1...v0.1.2)
 
 ## [v0.1.1](https://github.com/ably/ably-ruby/tree/v0.1.1) (2014-09-23)
+
 [Full Changelog](https://github.com/ably/ably-ruby/compare/v0.1.0...v0.1.1)
 
 ## [v0.1.0](https://github.com/ably/ably-ruby/tree/v0.1.0) (2014-09-23)
 
 
-\* *This Change Log was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*
+
+\* *This Change Log was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*

data/ably.gemspec

@@ -23,7 +23,7 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'statesman', '~> 1.0.0'
   spec.add_runtime_dependency 'faraday', '~> 0.9'
   spec.add_runtime_dependency 'json'
-  spec.add_runtime_dependency 'websocket-driver', '~> 0.3'
+  spec.add_runtime_dependency 'websocket-driver', '~> 0.6'
   spec.add_runtime_dependency 'msgpack', '>= 0.6.2'
   spec.add_runtime_dependency 'addressable', '>= 2.0.0'
 

data/lib/ably/auth.rb

@@ -54,6 +54,10 @@ module Ably
         raise ArgumentError, 'Expected token_params to be a Hash'
       end
 
+      # Ensure instance variables are defined
+      @client_id = nil
+      @client_id_validated = nil
+
       ensure_valid_auth_attributes auth_options
 
       @client              = client
@@ -401,8 +405,13 @@ module Ably
     end
 
     private
-    attr_reader :client
-    attr_reader :token_option
+    def client
+      @client
+    end
+
+    def token_option
+      @token_option
+    end
 
     def ensure_valid_auth_attributes(attributes)
       if attributes[:timestamp]
@@ -453,7 +462,7 @@ module Ably
     end
 
     def split_api_key_into_key_and_secret!(options)
-      api_key_parts = options[:key].to_s.match(/(?<name>[\w_-]+\.[\w_-]+):(?<secret>[\w_-]+)/)
+      api_key_parts = options[:key].to_s.match(/(?<name>[\w-]+\.[\w-]+):(?<secret>[\w-]+)/)
       raise ArgumentError, 'key is invalid' unless api_key_parts
 
       options[:key_name]   = api_key_parts[:name].encode(Encoding::UTF_8)

data/lib/ably/logger.rb

@@ -37,7 +37,9 @@ module Ably
     def_delegators :logger, :fatal, :error, :warn, :info, :debug
 
     private
-    attr_reader :client
+    def client
+      @client
+    end
 
     def color(color_value, string)
       "\033[#{color_value}m#{string}\033[0m"

data/lib/ably/models/connection_details.rb

@@ -28,6 +28,7 @@ module Ably::Models
     # @option attributes [Integer]   :max_frame_size        maximum size for a single frame of data sent to Ably. This restriction applies to a {Ably::Models::ProtocolMessage} sent over a realtime connection, or the total body size for a REST request
     # @option attributes [Integer]   :max_inbound_rate      maximum allowable number of requests per second from a client
     # @option attributes [Integer]   :connection_state_ttl  duration in seconds that Ably will persist the connection state when a Realtime client is abruptly disconnected
+    # @option attributes [String]    :server_id             unique identifier of the Ably server where the connection is established
     #
     def initialize(attributes = {})
       @hash_object = IdiomaticRubyWrapper(attributes.clone)
@@ -35,7 +36,7 @@ module Ably::Models
       hash.freeze
     end
 
-    %w(client_id connection_key max_message_size max_frame_size max_inbound_rate connection_state_ttl).each do |attribute|
+    %w(client_id connection_key max_message_size max_frame_size max_inbound_rate connection_state_ttl server_id).each do |attribute|
       define_method attribute do
         hash[attribute.to_sym]
       end

data/lib/ably/models/idiomatic_ruby_wrapper.rb

@@ -150,7 +150,7 @@ module Ably::Models
     #   wrapper.as_json({ 'mixedCase': true, 'snakeCase': 1 })
     def as_json(*args)
       hash.each_with_object({}) do |key_val, new_hash|
-        key, val                 = key_val
+        key                      = key_val[0]
         mixed_case_key           = convert_to_mixed_case(key)
         wrapped_val              = self[key]
         wrapped_val              = wrapped_val.as_json(args) if wrapped_val.kind_of?(IdiomaticRubyWrapper)

data/lib/ably/models/message.rb

@@ -62,7 +62,7 @@ module Ably::Models
       ensure_utf_8 :encoding,  encoding,  allow_nil: true
     end
 
-    %w( name client_id encoding connection_id ).each do |attribute|
+    %w( name client_id encoding ).each do |attribute|
       define_method attribute do
         hash[attribute.to_sym]
       end
@@ -120,7 +120,9 @@ module Ably::Models
     end
 
     private
-    attr_reader :raw_hash_object
+    def raw_hash_object
+      @raw_hash_object
+    end
 
     def protocol_message_index
       protocol_message.messages.map(&:object_id).index(self.object_id)

data/lib/ably/models/message_encoders/cipher.rb

@@ -73,11 +73,11 @@ module Ably::Models::MessageEncoders
     end
 
     def cipher_algorithm(message)
-      current_encoding_part(message).to_s[/^#{ENCODING_ID}\+([\w_-]+)$/, 1]
+      current_encoding_part(message).to_s[/^#{ENCODING_ID}\+([\w-]+)$/, 1]
     end
 
     def already_encrypted?(message)
-      message.fetch(:encoding, '').to_s.match(%r{(^|/)#{ENCODING_ID}\+([\w_-]+)($|/)})
+      message.fetch(:encoding, '').to_s.match(%r{(^|/)#{ENCODING_ID}\+([\w-]+)($|/)})
     end
   end
 end

data/lib/ably/models/paginated_result.rb

@@ -95,7 +95,33 @@ module Ably::Models
     end
 
     private
-    attr_reader :http_response, :base_url, :client, :coerce_into, :raw_body, :each_block, :make_async
+    def http_response
+      @http_response
+    end
+
+    def base_url
+      @base_url
+    end
+
+    def client
+      @client
+    end
+
+    def coerce_into
+      @coerce_into
+    end
+
+    def raw_body
+      @raw_body
+    end
+
+    def each_block
+      @each_block
+    end
+
+    def make_async
+      @make_async
+    end
 
     def coerce_items_into(items, type_string)
       items.map do |item|

data/lib/ably/models/presence_message.rb

@@ -143,7 +143,9 @@ module Ably::Models
     end
 
     private
-    attr_reader :raw_hash_object
+    def raw_hash_object
+      @raw_hash_object
+    end
 
     def protocol_message_index
       protocol_message.presence.index(self)

data/lib/ably/models/{stat.rb → stats.rb}

@@ -82,7 +82,7 @@ module Ably::Models
       def from_interval_id(interval_id)
         raise ArgumentError, 'Interval ID must be a string' unless interval_id.kind_of?(String)
 
-        format = INTERVAL_FORMAT_STRING.find { |format| expected_length(format) == interval_id.length }
+        format = INTERVAL_FORMAT_STRING.find { |fmt| expected_length(fmt) == interval_id.length }
         raise ArgumentError, 'Interval ID is an invalid length' unless format
 
         Time.strptime("#{interval_id} +0000", "#{format} %z").utc
@@ -99,7 +99,7 @@ module Ably::Models
       def granularity_from_interval_id(interval_id)
         raise ArgumentError, 'Interval ID must be a string' unless interval_id.kind_of?(String)
 
-        format = INTERVAL_FORMAT_STRING.find { |format| expected_length(format) == interval_id.length }
+        format = INTERVAL_FORMAT_STRING.find { |fmt| expected_length(fmt) == interval_id.length }
         raise ArgumentError, 'Interval ID is an invalid length' unless format
 
         GRANULARITY[INTERVAL_FORMAT_STRING.index(format)]
@@ -195,7 +195,9 @@ module Ably::Models
     end
 
     private
-    attr_reader :raw_hash_object
+    def raw_hash_object
+      @raw_hash_object
+    end
 
     def set_hash_object(hash)
       @hash_object = IdiomaticRubyWrapper(hash.clone.freeze)

data/lib/ably/modules/async_wrapper.rb

@@ -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/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