ably-rest 0.8.9 → 0.8.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b903160b7b1b68664bdce7d8be48cb9758df7ed2
-  data.tar.gz: c176c6156f450ecdb199da2ed865d0e0573421e8
+  metadata.gz: 644dba1824658c7c1b6f8a4fa342e68175d97110
+  data.tar.gz: 29b9ef90f7717f4686f59947e4c0290ccc27c859
 SHA512:
-  metadata.gz: 0c88be9f37e66826972dd0fecc88865a183e25bec776cb8d0d025ca039ad9ddd55d15f02c8a760be6815ed2cb79c830eb1375ef9722e3b2bc7c7184f628ce178
-  data.tar.gz: 1adca79ac039224c15d3b3bbe24fc308feee608a7635eb2eeed8c92880c76e353f4ed5b3c954d7a3ef4c4a4bbe4c494696b4467b2655e2157c0df27776655a88
+  metadata.gz: 00f1c399652e8cb1fb1e2c4bf5f0b47aefdf9e791f96eb976f7c04d4fc5aa38547a21be2d9b6d594888e191612dbaf50abcafc26933f74500651ead4f53bb00f
+  data.tar.gz: 288d66b80b142e4a4b7cd00ff4db8450d7722e181ddc4bb07e59bb62585854b82e5e7437b1496b6c7cf4e0eec471afcc1b79a1c16b4adf66d9418fc842abe732

data/README.md

@@ -1,12 +1,14 @@
-# [Ably](https://ably.io)
+# [Ably](https://www.ably.io)
 
-[![Build Status](https://travis-ci.org/ably/ably-ruby-rest.png)](https://travis-ci.org/ably/ably-ruby-rest)
 [![Gem Version](https://badge.fury.io/rb/ably-rest.svg)](http://badge.fury.io/rb/ably-rest)
 
+A Ruby REST client library for [www.ably.io](https://www.ably.io), the realtime messaging service.
 
-A Ruby REST client library for [ably.io](https://ably.io), the real-time messaging service.
+Note: This library was created solely for developers who do not want EventMachine as a dependency of their application.  If this is not a requirement for you, then we recommended you use the combined [REST & Realtime gem](https://rubygems.org/gems/ably).
 
-Note: This library was created solely for developers who do not want EventMachine as a dependency of their application.  If this is not a requirement for you, then we recommended you use the combined [REST & Real-time gem](https://rubygems.org/gems/ably).
+## Documentation
+
+Visit https://www.ably.io/documentation for a complete API reference and more examples. The examples and API below is not exhaustive.
 
 ## Installation
 
@@ -42,47 +44,78 @@ channel.publish('myEvent', 'Hello!') #=> true
 ### Querying the History
 
 ```ruby
-mesage_history = channel.history #=> #<Ably::Models::PaginatedResource ...>
-message_history.first # => #<Ably::Models::Message ...>
+messages_page = channel.history #=> #<Ably::Models::PaginatedResult ...>
+messages_page.items.first #=> #<Ably::Models::Message ...>
+messages_page.items.first.data # payload for the message
+messages_page.next # retrieves the next page => #<Ably::Models::PaginatedResult ...>
+messages_page.has_next? # false, there are more pages
 ```
 
-### Presence on a channel
+### Current presence members on a channel
 
 ```ruby
-members = channel.presence.get # => #<Ably::Models::PaginatedResource ...>
-members.first # => #<Ably::Models::PresenceMessage ...>
+members_page = channel.presence.get # => #<Ably::Models::PaginatedResult ...>
+members_page.items.first # first member present in this page => #<Ably::Models::PresenceMessage ...>
+members_page.items.first.client_id # client ID of first member present
+members_page.next # retrieves the next page => #<Ably::Models::PaginatedResult ...>
+members_page.has_next? # false, there are more pages
 ```
 
-### Querying the Presence History
+### Querying the presence history
 
 ```ruby
-presence_history = channel.presence.history # => #<Ably::Models::PaginatedResource ...>
-presence_history.first # => #<Ably::Models::PresenceMessage ...>
+presence_page = channel.presence.history #=> #<Ably::Models::PaginatedResult ...>
+presence_page.items.first #=> #<Ably::Models::PresenceMessage ...>
+presence_page.items.first.client_id # client ID of first member
+presence_page.next # retrieves the next page => #<Ably::Models::PaginatedResult ...>
 ```
 
-### Generate Token and Token Request
+### Symmetric end-to-end encrypted payloads on a channel
+
+When a 128 bit or 256 bit key is provided to the library, all payloads are encrypted and decrypted automatically using that key on the channel. The secret key is never transmitted to Ably and thus it is the developer's responsibility to distribute a secret key to both publishers and subscribers.
 
 ```ruby
-client.auth.request_token
-# => #<Ably::Models::Token ...>
+secret_key = Ably::Util::Crypto.generate_random_key
+channel = client.channels.get('test', cipher: { key: secret_key })
+channel.publish nil, "sensitive data" # data will be encrypted before publish
+messages_page = channel.history
+messages_page.items.first.data #=> "sensitive data"
+```
 
-token = client.auth.create_token_request
+### Generate a Token
+
+Tokens are issued by Ably and are readily usable by any client to connect to Ably:
+
+```ruby
+token_details = client.auth.request_token
+# => #<Ably::Models::TokenDetails ...>
+token_details.token # => "xVLyHw.CLchevH3hF....MDh9ZC_Q"
+client = Ably::Rest.new(token: token_details)
+```
+
+### Generate a TokenRequest
+
+Token requests are issued by your servers and signed using your private API key. This is the preferred method of authentication as no secrets are ever shared, and the token request can be issued to trusted clients without communicating with Ably.
+
+```ruby
+token_request = client.auth.create_token_request(ttl: 3600, client_id: 'jim')
 # => {"id"=>...,
-#     "clientId"=>nil,
+#     "clientId"=>"jim",
 #     "ttl"=>3600,
 #     "timestamp"=>...,
 #     "capability"=>"{\"*\":[\"*\"]}",
 #     "nonce"=>...,
 #     "mac"=>...}
 
-client = Ably::Rest.new(token_id: token.id)
+client = Ably::Rest.new(token: token_request)
 ```
 
 ### Fetching your application's stats
 
 ```ruby
-stats = client.stats #=> #<Ably::Models::PaginatedResource ...>
-stats.first = #<Ably::Models::Stat ...>
+stats_page = client.stats #=> #<Ably::Models::PaginatedResult ...>
+stats_page.items.first = #<Ably::Models::Stats ...>
+stats_page.next # retrieves the next page => #<Ably::Models::PaginatedResult ...>
 ```
 
 ### Fetching the Ably service time
@@ -110,4 +143,4 @@ To see what has changed in recent versions of Bundler, see the [CHANGELOG](CHANG
 
 ## License
 
-Copyright (c) 2015 Ably Real-time Ltd, Licensed under the Apache License, Version 2.0.  Refer to [LICENSE](LICENSE) for the license terms.
+Copyright (c) 2016 Ably Real-time Ltd, Licensed under the Apache License, Version 2.0.  Refer to [LICENSE](LICENSE) for the license terms.

data/ably-rest.gemspec

@@ -32,7 +32,11 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_runtime_dependency 'faraday', '~> 0.9'
-  spec.add_runtime_dependency 'json'
+  if RUBY_VERSION.match(/^1/)
+    spec.add_runtime_dependency 'json', '< 2.0'
+  else
+    spec.add_runtime_dependency 'json'
+  end
   spec.add_runtime_dependency 'msgpack', '>= 0.6.2'
   spec.add_runtime_dependency 'addressable', '>= 2.0.0'
 
@@ -44,7 +48,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'yard'
   spec.add_development_dependency 'webmock'
 
-  if RUBY_VERSION.match(/^2/)
+  unless RUBY_VERSION.match(/^1/)
     spec.add_development_dependency 'pry'
     spec.add_development_dependency 'pry-byebug'
   end

data/lib/ably-rest.rb

@@ -1,3 +1,5 @@
+require 'addressable/uri'
+
 File.expand_path('submodules/ably-ruby/lib', File.dirname(__FILE__)).tap do |lib|
   $LOAD_PATH.unshift lib
 

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

@@ -1,8 +1,40 @@
 # Change Log
 
-## [v0.8.4](https://github.com/ably/ably-ruby/tree/v0.8.9) (2015-03-01)
+## [Unreleased](https://github.com/ably/ably-ruby/tree/v0.8.13)
 
-[Full Changelog](https://github.com/ably/ably-ruby/compare/v0.8.7...v0.8.9)
+[Full Changelog](https://github.com/ably/ably-ruby/compare/v0.8.12...v0.8.13)
+
+**Merged pull requests:**
+
+- Ensure interoperability with other libraries with JSON protocol [\#94](https://github.com/ably/ably-ruby/pull/94) ([mattheworiordan](https://github.com/mattheworiordan))
+
+## [v0.8.12](https://github.com/ably/ably-ruby/tree/v0.8.12) (2016-05-23)
+
+[Full Changelog](https://github.com/ably/ably-ruby/compare/v0.8.11...v0.8.12)
+
+**Fixed bugs:**
+
+- Ably::Exceptions::ConnectionError: SSL\_connect returned=1 errno=0 state=SSLv3 read server certificate B: certificate verify failed [\#87](https://github.com/ably/ably-ruby/issues/87)
+
+**Merged pull requests:**
+
+- Reauthorise [\#90](https://github.com/ably/ably-ruby/pull/90) ([mattheworiordan](https://github.com/mattheworiordan))
+
+## [v0.8.11](https://github.com/ably/ably-ruby/tree/v0.8.11) (2016-04-05)
+
+[Full Changelog](https://github.com/ably/ably-ruby/compare/v0.8.10...v0.8.11)
+
+**Merged pull requests:**
+
+- Ensure message emitter callbacks are safe \(i.e. cannot break the EM\) [\#85](https://github.com/ably/ably-ruby/pull/85) ([mattheworiordan](https://github.com/mattheworiordan))
+
+## [v0.8.10](https://github.com/ably/ably-ruby/tree/v0.8.10) (2016-04-01)
+
+[Full Changelog](https://github.com/ably/ably-ruby/compare/v0.8.9...v0.8.10)
+
+## [v0.8.9](https://github.com/ably/ably-ruby/tree/v0.8.9) (2016-03-01)
+
+[Full Changelog](https://github.com/ably/ably-ruby/compare/v0.8.8...v0.8.9)
 
 **Fixed bugs:**
 
@@ -14,14 +46,20 @@
 
 - New Crypto Spec [\#80](https://github.com/ably/ably-ruby/issues/80)
 
-- Support :key in ClientOptions and deprecate :api\_key [\#73](https://github.com/ably/ably-ruby/issues/73)
-
 **Merged pull requests:**
 
 - Various fixes for open issues [\#82](https://github.com/ably/ably-ruby/pull/82) ([mattheworiordan](https://github.com/mattheworiordan))
 
 - Encryption spec update [\#81](https://github.com/ably/ably-ruby/pull/81) ([mattheworiordan](https://github.com/mattheworiordan))
 
+## [v0.8.8](https://github.com/ably/ably-ruby/tree/v0.8.8) (2016-01-26)
+
+[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)

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

@@ -1,6 +1,5 @@
 # [Ably](https://www.ably.io)
 
-[![Build Status](https://travis-ci.org/ably/ably-ruby.png)](https://travis-ci.org/ably/ably-ruby)
 [![Gem Version](https://badge.fury.io/rb/ably.svg)](http://badge.fury.io/rb/ably)
 [![Coverage Status](https://coveralls.io/repos/ably/ably-ruby/badge.svg)](https://coveralls.io/r/ably/ably-ruby)
 
@@ -227,10 +226,10 @@ secret_key = Ably::Util::Crypto.generate_random_key
 channel = client.channels.get('test', cipher: { key: secret_key })
 channel.publish nil, "sensitive data" # data will be encrypted before publish
 messages_page = channel.history
-messages_page.first.data #=> "sensitive data"
+messages_page.items.first.data #=> "sensitive data"
 ```
 
-### Generate Token
+### Generate a Token
 
 Tokens are issued by Ably and are readily usable by any client to connect to Ably:
 

data/lib/submodules/ably-ruby/ably.gemspec

@@ -22,7 +22,11 @@ Gem::Specification.new do |spec|
   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'
+  if RUBY_VERSION.match(/^1/)
+    spec.add_runtime_dependency 'json', '< 2.0'
+  else
+    spec.add_runtime_dependency 'json'
+  end
   spec.add_runtime_dependency 'websocket-driver', '~> 0.6'
   spec.add_runtime_dependency 'msgpack', '>= 0.6.2'
   spec.add_runtime_dependency 'addressable', '>= 2.0.0'
@@ -37,7 +41,7 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency 'coveralls'
 
-  if RUBY_VERSION.match(/^2/)
+  unless RUBY_VERSION.match(/^1/)
     spec.add_development_dependency 'pry'
     spec.add_development_dependency 'pry-byebug'
   end

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

@@ -72,6 +72,7 @@ module Ably
       end
 
       split_api_key_into_key_and_secret! options if options[:key]
+      store_and_delete_basic_auth_key_from_options! options
 
       if using_basic_auth? && !api_key_present?
         raise ArgumentError, 'key is missing. Either an API key, token, or token auth method must be provided'
@@ -104,9 +105,9 @@ module Ably
     #
     # In the event that a new token request is made, the provided options are used.
     #
-    # @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
+    # @param [Hash, nil] token_params the token params used for future token requests. When nil, previously configured token params are used
+    # @param [Hash, nil] auth_options the authentication options used for future token requests. When nil, previously configure authentication options are used
+    # @option auth_options [Boolean]   :force   obtains a new token even if the current token is valid. If the provided +auth_options+ Hash contains only this +:force+ attribute, the existing configured authentication options are not overwriten
     # @option (see #request_token)
     #
     # @return (see #create_token_request)
@@ -122,23 +123,54 @@ module Ably
     #      token_request
     #    end
     #
-    def authorise(token_params = {}, auth_options = {})
-      ensure_valid_auth_attributes auth_options
+    def authorise(token_params = nil, auth_options = nil)
+      if auth_options == { force: true }
+        auth_options = options.merge(force: true)
+      elsif auth_options.nil?
+        auth_options = options
+      else
+        ensure_valid_auth_attributes auth_options
 
-      auth_options = auth_options.clone
+        auth_options = auth_options.clone
 
-      if current_token_details && !auth_options.delete(:force)
-        return current_token_details unless current_token_details.expired?
+        if auth_options[:token_params]
+          token_params = auth_options.delete(:token_params).merge(token_params || {})
+        end
+
+        # If basic credentials are provided then overwrite existing options
+        # otherwise we need to retain the existing credentials in the auth options
+        split_api_key_into_key_and_secret! auth_options if auth_options[:key]
+        if auth_options[:key_name] && auth_options[:key_secret]
+          store_and_delete_basic_auth_key_from_options! auth_options
+        end
+
+        @options = auth_options.clone
+
+        # Force reauth and query the server time only happens once
+        # the otpions remain in auth_options though so they are passed to request_token
+        @options.delete(:query_time)
+        @options.delete(:force)
+
+        @options.freeze
       end
 
-      split_api_key_into_key_and_secret! auth_options if auth_options[:key]
-      @options = @options.merge(auth_options) # update defaults
+      unless token_params.nil?
+        @token_params = token_params
+        @token_params.freeze
+      end
 
-      token_params = (auth_options.delete(:token_params) || {}).merge(token_params)
-      @token_params = @token_params.merge(token_params) # update defaults
+      if current_token_details && !auth_options[:force]
+        return current_token_details unless current_token_details.expired?
+      end
 
-      authorise_with_token(request_token(token_params, auth_options)).tap do |new_token_details|
+      authorise_with_token(request_token(@token_params, auth_options)).tap do |new_token_details|
         logger.debug "Auth: new token following authorisation: #{new_token_details}"
+
+        # If authorise was forced allow a block to be called so that the realtime library
+        # can force upgrade the authorisation
+        if auth_options[:force] && block_given?
+          yield new_token_details
+        end
       end
     end
 
@@ -240,11 +272,8 @@ module Ably
 
       raise Ably::Exceptions::TokenRequestFailed, 'Key Name and Key Secret are required to generate a new token request' unless request_key_name && request_key_secret
 
-      timestamp = if auth_options[:query_time]
-        client.time
-      else
-        token_params.delete(:timestamp) || Time.now
-      end
+      ensure_current_time_is_based_on_server_time if auth_options[:query_time]
+      timestamp = token_params.delete(:timestamp) || current_time
       timestamp = Time.at(timestamp) if timestamp.kind_of?(Integer)
 
       ttl = [
@@ -261,7 +290,14 @@ module Ably
         nonce:      token_params[:nonce] || SecureRandom.hex.force_encoding('UTF-8')
       }
 
-      token_request[:capability] = JSON.dump(token_request[:capability]) if token_request[:capability].is_a?(Hash)
+      if token_request[:capability].is_a?(Hash)
+        lexicographic_ordered_capabilities = Hash[
+          token_request[:capability].sort_by { |key, value| key }.map do |key, value|
+            [key, value.sort]
+          end
+        ]
+        token_request[:capability] = JSON.dump(lexicographic_ordered_capabilities)
+      end
 
       token_request[:mac] = sign_params(token_request, request_key_secret)
 
@@ -276,11 +312,11 @@ module Ably
     end
 
     def key_name
-      options[:key_name]
+      @key_name
     end
 
     def key_secret
-      options[:key_secret]
+      @key_secret
     end
 
     # True when Basic Auth is being used to authenticate with Ably
@@ -413,6 +449,24 @@ module Ably
       @token_option
     end
 
+    # Returns the current device clock time unless the
+    # the server time has previously been requested with query_time: true
+    # and the @server_time_offset is configured
+    def current_time
+      if @server_time_offset
+        Time.now + @server_time_offset
+      else
+        Time.now
+      end
+    end
+
+    # Get the difference in time between the server
+    # and the local clock and store this for future time requests
+    def ensure_current_time_is_based_on_server_time
+      server_time = client.time
+      @server_time_offset = server_time.to_f - Time.now.to_f
+    end
+
     def ensure_valid_auth_attributes(attributes)
       if attributes[:timestamp]
         unless attributes[:timestamp].kind_of?(Time) || attributes[:timestamp].kind_of?(Numeric)
@@ -471,6 +525,11 @@ module Ably
       options.delete :key
     end
 
+    def store_and_delete_basic_auth_key_from_options!(options)
+      @key_name = options.delete(:key_name)
+      @key_secret = options.delete(:key_secret)
+    end
+
     # Returns the current token if it exists or authorises and retrieves a token
     def token_auth_string
       if !current_token_details && token_option

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

@@ -4,6 +4,9 @@ module Ably::Modules
   # Message emitter, subscriber and unsubscriber (Pub/Sub) functionality common to Channels and Presence
   # In addition to standard Pub/Sub functionality, it allows subscribers to subscribe to :all.
   module MessageEmitter
+
+    include Ably::Modules::SafeYield
+
     # Subscribe to events on this object
     #
     # @param names [String,Symbol] Optional, the event name(s) to subscribe to. Defaults to `:all` events
@@ -50,8 +53,8 @@ module Ably::Modules
     #
     # @api private
     def emit_message(name, payload)
-      message_emitter_subscriptions[:all].each { |cb| cb.call(payload) }
-      message_emitter_subscriptions[name].each { |cb| cb.call(payload) } if name
+      message_emitter_subscriptions[:all].each { |cb| safe_yield(cb, payload) }
+      message_emitter_subscriptions[name].each { |cb| safe_yield(cb, payload) } if name
     end
 
     private