ably-rest 1.0.0 → 1.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: db6fb6a1083ab0675e93787c68613dfe825626f8
-  data.tar.gz: caafe4849ad502083c994fedbb1ff502dcaba821
+  metadata.gz: a0d3b8547bb94eb6d8efd1847fee0cc7231916da
+  data.tar.gz: 34e92947e49eb6ff09f3bc608277f09ef1e9b390
 SHA512:
-  metadata.gz: 4fe732572bdbf0a4d1369f766fa8a2845f18919eb4d362f050ae44abdb25f8ee8beb402cdd263a7fb8e5355356e96d2a35f32633a9434ef52a81a98b4a0aedb1
-  data.tar.gz: 75d72d55a94cf6e60b4b50fa8b1f4bc60c53aa601e9d199b38a4ace1539c74a7eb08655856af382c6941daffd51910659fdacf02429a776244a81196afe66ffd
+  metadata.gz: 155934f7ef691a2248776199b86ab243aa8e872193b28c40afaa77f08dc939d24bb1cb7592cb0bda624f4418d4a2ce7e68f969ed57c7494d4c663a25fc90e9ec
+  data.tar.gz: d935e38fa7b0bbbbdafc071b63bfecedcfe5693160438f802a8a18a3db106c5aeada7845485b0d128037a09e3b69b84bf6f45ed3b7180a21bf0bd582e497d705

data/README.md

@@ -5,11 +5,15 @@
 
 A Ruby REST client library for [www.ably.io](https://www.ably.io), the realtime 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).
-
 ## Documentation
 
-Visit https://www.ably.io/documentation for a complete API reference and more examples. The examples and API below is not exhaustive.
+Visit https://www.ably.io/documentation for a complete API reference and more examples. The examples and API below is not exhaustive, you should use the completely [Ably API documentation](https://www.ably.io/documentation).
+
+## Realtime vs REST
+
+This REST only library was created for developers who do not want EventMachine as a dependency of their application. Typically developers who are using Ably within their Rails or Sinatra apps would prefer to use the REST library as it has less dependencies and offers a synchronous API.
+
+If however you need to use a realtime library that offers an asynchronous evented AP, then we recommended you [take a look at the combined REST & Realtime gem](https://rubygems.org/gems/ably).
 
 ## Installation
 
@@ -142,6 +146,10 @@ To see what has changed in recent versions of Bundler, see the [CHANGELOG](CHANG
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create a new Pull Request
 
+## Release Process
+
+See the [Ably Ruby release process notes](https://github.com/ably/ably-ruby#release-process).
+
 ## License
 
-Copyright (c) 2016 Ably Real-time Ltd, Licensed under the Apache License, Version 2.0.  Refer to [LICENSE](LICENSE) for the license terms.
+Copyright (c) 2017 Ably Real-time Ltd, Licensed under the Apache License, Version 2.0.  Refer to [LICENSE](LICENSE) for the license terms.

data/lib/submodules/ably-ruby/.travis.yml

@@ -6,7 +6,10 @@ language: ruby
 rvm:
   - 1.9.3
   - 2.0.0
+  - 2.1.10
   - 2.2.0
+  - 2.3.6
+  - 2.4.1
 script: bundle exec rspec
 notifications:
   slack:

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

@@ -1,11 +1,56 @@
 # Change Log
 
-## [v1.0.0](https://github.com/ably/ably-ruby/tree/v1.0.0) (2017-03-07)
-[Full Changelog](https://github.com/ably/ably-ruby/compare/v0.8.14...v1.0.0)
+## [Unreleased](https://github.com/ably/ably-ruby/tree/v1.0.5)
+
+[Full Changelog](https://github.com/ably/ably-ruby/compare/v1.0.4...v1.0.5)
+
+**Implemented enhancements:**
+
+- Add Ruby 2.1 and 2.3 to Travis tests [\#129](https://github.com/ably/ably-ruby/issues/129)
+- Add supported platforms to README file [\#128](https://github.com/ably/ably-ruby/issues/128)
+- Add Ruby 2.1 and 2.3 to Travis tests [\#130](https://github.com/ably/ably-ruby/pull/130) ([funkyboy](https://github.com/funkyboy))
+
+**Closed issues:**
+
+- Cannot get realtime to work [\#127](https://github.com/ably/ably-ruby/issues/127)
+
+**Merged pull requests:**
+
+- Improve pagination history test [\#138](https://github.com/ably/ably-ruby/pull/138) ([funkyboy](https://github.com/funkyboy))
+- Fix failing auth test [\#135](https://github.com/ably/ably-ruby/pull/135) ([funkyboy](https://github.com/funkyboy))
+- Add submodule instructions to Contributing section [\#134](https://github.com/ably/ably-ruby/pull/134) ([funkyboy](https://github.com/funkyboy))
+- Add request\_id option to client [\#133](https://github.com/ably/ably-ruby/pull/133) ([funkyboy](https://github.com/funkyboy))
+- Update README with supported platforms [\#131](https://github.com/ably/ably-ruby/pull/131) ([funkyboy](https://github.com/funkyboy))
+
+## [v1.0.4](https://github.com/ably/ably-ruby/tree/v1.0.4) (2017-05-31)
+[Full Changelog](https://github.com/ably/ably-ruby/compare/v1.0.3...v1.0.4)
 
-### v1.0 release and upgrade notes from v0.8
+## [v1.0.3](https://github.com/ably/ably-ruby/tree/v1.0.3) (2017-05-31)
+[Full Changelog](https://github.com/ably/ably-ruby/compare/v1.0.2...v1.0.3)
+
+## [v1.0.2](https://github.com/ably/ably-ruby/tree/v1.0.2) (2017-05-16)
+[Full Changelog](https://github.com/ably/ably-ruby/compare/v1.0.1...v1.0.2)
+
+**Fixed bugs:**
+
+- Reconnect following disconnection is hitting a 403 error [\#117](https://github.com/ably/ably-ruby/issues/117)
+
+**Merged pull requests:**
+
+- Fallback fixes [\#120](https://github.com/ably/ably-ruby/pull/120) ([mattheworiordan](https://github.com/mattheworiordan))
+- Channel name encoding error for REST requests [\#119](https://github.com/ably/ably-ruby/pull/119) ([mattheworiordan](https://github.com/mattheworiordan))
+
+## [v1.0.1](https://github.com/ably/ably-ruby/tree/v1.0.1) (2017-05-11)
+[Full Changelog](https://github.com/ably/ably-ruby/compare/v1.1.0-beta.push.1...v1.0.1)
+
+## [v1.1.0-beta.push.1](https://github.com/ably/ably-ruby/tree/v1.1.0-beta.push.1) (2017-04-25)
+[Full Changelog](https://github.com/ably/ably-ruby/compare/v1.0.0...v1.1.0-beta.push.1)
+
+## [v1.0.0](https://github.com/ably/ably-ruby/tree/v1.0.0) (2017-03-07)
+[Full Changelog](https://github.com/ably/ably-ruby/compare/v0.8.15...v1.0.0)
 
-- See https://github.com/ably/docs/issues/235
+## [v0.8.15](https://github.com/ably/ably-ruby/tree/v0.8.15) (2017-03-07)
+[Full Changelog](https://github.com/ably/ably-ruby/compare/v0.8.14...v0.8.15)
 
 **Implemented enhancements:**
 

data/lib/submodules/ably-ruby/LICENSE

@@ -1,6 +1,6 @@
-Copyright (c) 2016 Ably
+Copyright (c) 2015-2017 Ably
 
-Copyright 2016 Ably Real-time Ltd
+Copyright 2015-2017 Ably Real-time Ltd
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

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

@@ -5,6 +5,14 @@
 
 A Ruby client library for [ably.io](https://www.ably.io), the realtime messaging service.
 
+## Supported platforms
+
+This SDK supports Ruby 1.9.3+.
+
+We regression-test the SDK against a selection of Ruby versions (which we update over time, but usually consists of mainstream and widely used versions). Please refer to [.travis.yml](./.travis.yml) for the set of versions that currently undergo CI testing.
+
+If you find any compatibility issues, please [do raise an issue](https://github.com/ably/ably-ruby/issues/new) in this repository or [contact Ably customer support](https://support.ably.io/) for advice.
+
 ## Documentation
 
 Visit https://www.ably.io/documentation for a complete API reference and more examples.
@@ -296,12 +304,23 @@ To see what has changed in recent versions of Bundler, see the [CHANGELOG](CHANG
 ## Contributing
 
 1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Ensure you have added suitable tests and the test suite is passing(`bundle exec rspec`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create a new Pull Request
+2. When pulling to local, make sure to also pull the `ably-common` repo (`git submodule init && git submodule update`)
+3. Create your feature branch (`git checkout -b my-new-feature`)
+4. Commit your changes (`git commit -am 'Add some feature'`)
+5. Ensure you have added suitable tests and the test suite is passing(`bundle exec rspec`)
+6. Push to the branch (`git push origin my-new-feature`)
+7. Create a new Pull Request
+
+## Release process
+
+This library uses [semantic versioning](http://semver.org/). For each release, the following needs to be done:
+
+* Update the version number in [version.rb](./lib/ably/version.rb) and commit the change.
+* Run [`github_changelog_generator`](https://github.com/skywinder/Github-Changelog-Generator) to automate the update of the [CHANGELOG](./CHANGELOG.md). Once the `CHANGELOG` update has completed, manually change the `Unreleased` heading and link with the current version number such as `v1.0.0`. Also ensure that the `Full Changelog` link points to the new version tag instead of the `HEAD`. Commit this change.
+* Add a tag and push to origin such as `git tag v1.0.0 && git push origin v1.0.0`
+* Visit [https://github.com/ably/ably-ruby/tags](https://github.com/ably/ably-ruby/tags) and `Add release notes` for the release including links to the changelog entry.
+* Run `rake release` to publish the gem to [Rubygems](http://www.rubydoc.info/gems/ably)
 
 ## License
 
-Copyright (c) 2016 Ably Real-time Ltd, Licensed under the Apache License, Version 2.0.  Refer to [LICENSE](LICENSE) for the license terms.
+Copyright (c) 2017 Ably Real-time Ltd, Licensed under the Apache License, Version 2.0.  Refer to [LICENSE](LICENSE) for the license terms.

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

@@ -11,7 +11,7 @@ Gem::Specification.new do |spec|
   spec.description   = %q{A Ruby client library for ably.io realtime messaging}
   spec.summary       = %q{A Ruby client library for ably.io realtime messaging implemented using EventMachine}
   spec.homepage      = 'http://github.com/ably/ably-ruby'
-  spec.license       = 'Apache 2'
+  spec.license       = 'Apache-2.0'
 
   spec.files         = `git ls-files`.split($/)
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }

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

@@ -13,7 +13,7 @@ module Ably
     # @!attribute [r] code
     #   @return [String] Ably specific error code
     class BaseAblyException < StandardError
-      attr_reader :status, :code
+      attr_reader :status, :code, :request_id
 
       def initialize(message, status = nil, code = nil, base_exception = nil, options = {})
         super message
@@ -25,6 +25,7 @@ module Ably
         @code = code
         @code ||= base_exception.code if base_exception && base_exception.respond_to?(:code)
         @code ||= options[:fallback_code]
+        @request_id ||= options[:request_id]
       end
 
       def to_s
@@ -34,12 +35,13 @@ module Ably
           additional_info << "code: #{code}" if code
           additional_info << "http status: #{status}" if status
           additional_info << "base exception: #{@base_exception.class}" if @base_exception
+          additional_info << "request_id: #{request_id}" if request_id
           message << "(#{additional_info.join(', ')})"
         end
         message.join(' ')
       end
 
-      def as_json
+      def as_json(*args)
         {
           message: "#{self.class}: #{message}",
           status: @status,

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

@@ -26,7 +26,7 @@ module Ably::Modules
 
     # Return a JSON ready object from the underlying #attributes using Ably naming conventions for keys
     # @return [Hash]
-    def as_json
+    def as_json(*args)
       attributes.as_json.reject { |key, val| val.nil? }
     end
 

data/lib/submodules/ably-ruby/lib/ably/realtime/connection.rb

@@ -351,7 +351,7 @@ module Ably
       def determine_host
         raise ArgumentError, 'Block required' unless block_given?
 
-        if can_use_fallback_hosts?
+        if should_use_fallback_hosts?
           internet_up? do |internet_is_up_result|
             @current_host = if internet_is_up_result
               client.fallback_endpoint.host
@@ -424,7 +424,8 @@ module Ably
               )
 
               # Use native websocket heartbeats if possible
-              url_params['heartbeats'] = 'false' unless defaults.fetch(:websocket_heartbeats_disabled)
+              # TODO: Fix once https://github.com/ably/ably-ruby/issues/116 is resolved
+              url_params['heartbeats'] = 'true' # unless defaults.fetch(:websocket_heartbeats_disabled)
 
               url_params['clientId'] = client.auth.client_id if client.auth.has_client_id?
 
@@ -444,6 +445,10 @@ module Ably
               end
 
               determine_host do |host|
+                # Ensure the hostname matches the fallback host name
+                url.hostname = host
+                url.port = port
+
                 begin
                   logger.debug { "Connection: Opening socket connection to #{host}:#{port}/#{url.path}?#{url.query}" }
                   @transport = create_transport(host, port, url) do |websocket_transport|
@@ -509,6 +514,7 @@ module Ably
 
       # @api private
       def create_transport(host, port, url, &block)
+        logger.debug { "Connection: EventMachine connecting to #{host}:#{port} with URL: #{url}" }
         EventMachine.connect(host, port, WebsocketTransport, self, url.to_s, &block)
       end
 
@@ -641,14 +647,22 @@ module Ably
         !!client.custom_realtime_host
       end
 
-      def can_use_fallback_hosts?
+      def should_use_fallback_hosts?
         if client.fallback_hosts && !client.fallback_hosts.empty?
-          if connecting? && previous_state
+          if connecting? && previous_state && !disconnected_from_connected_state?
             use_fallback_if_disconnected? || use_fallback_if_suspended?
           end
         end
       end
 
+      def disconnected_from_connected_state?
+        most_recent_state_changes = state_history.last(3).first(2) # Ignore current state
+
+        # A valid connection was disconnected
+        most_recent_state_changes.last.fetch(:state) == Connection::STATE.Disconnected &&
+          most_recent_state_changes.first.fetch(:state) == Connection::STATE.Connected
+      end
+
       def use_fallback_if_disconnected?
         second_reconnect_attempt_for(:disconnected, 1)
       end

data/lib/submodules/ably-ruby/lib/ably/rest/channel.rb

@@ -130,7 +130,7 @@ module Ably
 
       private
       def base_path
-        "/channels/#{Addressable::URI.encode(name)}"
+        "/channels/#{URI.encode_www_form_component(name)}"
       end
 
       def decode_message(message)

data/lib/submodules/ably-ruby/lib/ably/rest/client.rb

@@ -83,6 +83,10 @@ module Ably
       # if empty or nil then fallback host functionality is disabled
       attr_reader :fallback_hosts
 
+      # Whethere the {Client} has to add a random identifier to the path of a request
+      # @return [Boolean]
+      attr_reader :add_request_ids
+
       # Creates a {Ably::Rest::Client Rest Client} and configures the {Ably::Auth} object for the connection.
       #
       # @param [Hash,String] options an options Hash used to configure the client and the authentication, or String with an API key or Token ID
@@ -146,6 +150,7 @@ module Ably
         @custom_host      = options.delete(:rest_host)
         @custom_port      = options.delete(:port)
         @custom_tls_port  = options.delete(:tls_port)
+        @add_request_ids  = options.delete(:add_request_ids)
 
         if options[:fallback_hosts_use_default] && options[:fallback_jhosts]
           raise ArgumentError, "fallback_hosts_use_default cannot be set to trye when fallback_jhosts is also provided"
@@ -434,11 +439,25 @@ module Ably
         max_retry_duration = http_defaults.fetch(:max_retry_duration)
         requested_at       = Time.now
         retry_count        = 0
+        request_id         = nil
+        if add_request_ids
+          params = if params.nil?
+            {}
+          else
+            params.dup
+          end
+          request_id = SecureRandom.urlsafe_base64(10)
+          params[:request_id] = request_id
+        end
 
         begin
           use_fallback = can_fallback_to_alternate_ably_host? && retry_count > 0
 
           connection(use_fallback: use_fallback).send(method, path, params) do |request|
+            if add_request_ids
+              request.options.context = {} if request.options.context.nil?
+              request.options.context[:request_id] = request_id
+            end
             unless options[:send_auth_header] == false
               request.headers[:authorization] = auth.auth_header
               if options[:headers]
@@ -456,12 +475,12 @@ module Ably
             logger.warn { "Ably::Rest::Client - Retry #{retry_count} for #{method} #{path} #{params} as initial attempt failed: #{error}" }
             retry
           end
-
           case error
             when Faraday::TimeoutError
-              raise Ably::Exceptions::ConnectionTimeout.new(error.message, nil, 80014, error)
+              raise Ably::Exceptions::ConnectionTimeout.new(error.message, nil, 80014, error, { request_id: request_id })
             when Faraday::ClientError
-              raise Ably::Exceptions::ConnectionError.new(error.message, nil, 80000, error)
+              # request_id is also available in the request context
+              raise Ably::Exceptions::ConnectionError.new(error.message, nil, 80000, error, { request_id: request_id })
             else
               raise error
           end

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

@@ -27,8 +27,8 @@ module Ably
             end
 
             message = 'Unknown server error' if message.to_s.strip == ''
-
-            exception_args = [message, error_status_code, error_code]
+            request_id = env.request.context[:request_id] if env.request.context
+            exception_args = [message, error_status_code, error_code, nil, { request_id: request_id }]
 
             if env.status >= 500
               raise Ably::Exceptions::ServerError.new(*exception_args)

data/lib/submodules/ably-ruby/lib/ably/rest/presence.rb

@@ -84,7 +84,7 @@ module Ably
 
       private
       def base_path
-        "/channels/#{Addressable::URI.encode(channel.name)}/presence"
+        "/channels/#{URI.encode_www_form_component(channel.name)}/presence"
       end
 
       def decode_message(presence_message)

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

@@ -1,5 +1,5 @@
 module Ably
-  VERSION = '1.0.0'
+  VERSION = '1.0.5'
   PROTOCOL_VERSION = '1.0'
 
   # Allow a variant to be configured for all instances of this client library

data/lib/submodules/ably-ruby/spec/acceptance/realtime/connection_failures_spec.rb

@@ -1178,6 +1178,27 @@ describe Ably::Realtime::Connection, 'failures', :event_machine do
               stop_reactor
             end
           end
+
+          it 'does not use a fallback host if the connection connects on the default host and then later becomes disconnected', em_timeout: 25 do
+            request = 0
+
+            allow(connection).to receive(:create_transport).and_wrap_original do |wrapped_proc, host, *args, &block|
+              expect(host).to eql(expected_host)
+              request += 1
+              wrapped_proc.call(host, *args, &block)
+            end
+
+            connection.on(:connected) do
+              if request <= 2
+                EventMachine.add_timer(3) do
+                  # Force a disconnect
+                  connection.transport.unbind
+                end
+              else
+                stop_reactor
+              end
+            end
+          end
         end
 
         context ':fallback_hosts array is provided' do
@@ -1286,6 +1307,29 @@ describe Ably::Realtime::Connection, 'failures', :event_machine do
                 end
               end
             end
+
+            it 'uses the correct host name for the WebSocket requests to the fallback hosts' do
+              request = 0
+              expect(connection).to receive(:create_transport).at_least(:once) do |host, port, uri|
+                if request == 0 || request == expected_retry_attempts + 1
+                  expect(uri.hostname).to eql(expected_host)
+                else
+                  expect(custom_hosts + [expected_host]).to include(uri.hostname)
+                  fallback_hosts_used << host if @suspended > 0
+                end
+                request += 1
+                raise EventMachine::ConnectionError
+              end
+
+              connection.on(:suspended) do
+                @suspended += 1
+
+                if @suspended > 4
+                  expect(fallback_hosts_used.uniq).to match_array(custom_hosts + [expected_host])
+                  stop_reactor
+                end
+              end
+            end
           end
 
           context ':fallback_hosts array is provided by an empty array' do

data/lib/submodules/ably-ruby/spec/acceptance/realtime/connection_spec.rb

@@ -980,6 +980,7 @@ describe Ably::Realtime::Connection, :event_machine do
 
       context 'transport-level heartbeats are supported in the websocket transport' do
         it 'provides the heartbeats argument in the websocket connection params (#RTN23b)' do
+          skip 'Native heartbeats not yet supported in the WS driver https://github.com/ably/ably-ruby/issues/116'
           expect(EventMachine).to receive(:connect) do |host, port, transport, object, url|
             uri = URI.parse(url)
             expect(CGI::parse(uri.query)['heartbeats'][0]).to eql('false')
@@ -1007,6 +1008,7 @@ describe Ably::Realtime::Connection, :event_machine do
         let(:client_options) { default_options.merge(websocket_heartbeats_disabled: true) }
 
         it 'does not provide the heartbeats argument in the websocket connection params (#RTN23b)' do
+          skip 'Native heartbeats not yet supported in the WS driver https://github.com/ably/ably-ruby/issues/116'
           expect(EventMachine).to receive(:connect) do |host, port, transport, object, url|
             uri = URI.parse(url)
             expect(CGI::parse(uri.query)['heartbeats'][0]).to be_nil

data/lib/submodules/ably-ruby/spec/acceptance/realtime/message_spec.rb

@@ -76,6 +76,8 @@ describe 'Ably::Realtime::Channel Message', :event_machine do
     end
 
     context 'with supported extra payload content type (#RTL6h, #RSL6a2)' do
+      let(:channel) { client.channel("pushenabled:#{random_str}") }
+
       def publish_and_check_extras(extras)
         channel.attach
         channel.publish 'event', {}, extras: extras
@@ -86,7 +88,7 @@ describe 'Ably::Realtime::Channel Message', :event_machine do
       end
 
       context 'JSON Object (Hash)' do
-        let(:data) { { 'push' => { 'title' => 'Testing' } } }
+        let(:data) { { 'push' => { 'notification' => { 'title' => 'Testing' } } } }
 
         it 'is encoded and decoded to the same hash' do
           publish_and_check_extras data
@@ -94,7 +96,8 @@ describe 'Ably::Realtime::Channel Message', :event_machine do
       end
 
       context 'JSON Array' do
-        let(:data) { { 'push' => [ nil, true, false, 55, 'string', { 'Hash' => true }, ['array'] ] } }
+        # TODO: Add nil type back in
+        let(:data) { { 'push' => { 'data' => { 'key' => [ true, false, 55, 'string', { 'Hash' => true }, ['array'] ] } } } }
 
         it 'is encoded and decoded to the same Array' do
           publish_and_check_extras data

data/lib/submodules/ably-ruby/spec/acceptance/rest/auth_spec.rb

@@ -1083,7 +1083,7 @@ describe Ably::Auth do
           expect { auth.request_token(timestamp: Time.now - 180) }.to raise_error do |error|
             expect(error).to be_a(Ably::Exceptions::UnauthorizedRequest)
             expect(error.status).to eql(401)
-            expect(error.code).to eql(40101)
+            expect(error.code).to eql(40104)
           end
         end
 

data/lib/submodules/ably-ruby/spec/acceptance/rest/channel_spec.rb

@@ -256,6 +256,25 @@ describe Ably::Rest::Channel do
           end
         end
       end
+
+      context 'with a non ASCII channel name' do
+        let(:channel_name) { 'foo:¡€≤`☃' }
+        let(:channel_name_encoded) { 'foo%3A%C2%A1%E2%82%AC%E2%89%A4%60%E2%98%83' }
+        let(:endpoint) { client.endpoint }
+        let(:channel) { client.channels.get(channel_name) }
+
+        context 'stubbed', :webmock do
+          let!(:get_stub) {
+            stub_request(:post, "#{endpoint}/channels/#{channel_name_encoded}/publish").
+              to_return(:body => '{}', :headers => { 'Content-Type' => 'application/json' })
+          }
+
+          it 'correctly encodes the channel name' do
+            channel.publish('foo')
+            expect(get_stub).to have_been_requested
+          end
+        end
+      end
     end
 
     describe '#history' do
@@ -324,7 +343,13 @@ describe Ably::Rest::Channel do
 
         # Page 3
         expect(page_3.items.size).to eql(1)
-        expect(page_3).to be_last
+        # This test should be deterministic but it's not.
+        # Sometimes the backend, to avoid too much work, returns a `next` link that contains empty reults.
+        if page_3.next
+          expect(page_3.next.items.length).to eql(0)
+        else
+          expect(page_3).to be_last
+        end
       end
 
       context 'direction' do
@@ -374,7 +399,7 @@ describe Ably::Rest::Channel do
           let!(:history_stub) {
             query_params = default_history_options
             .merge(option => milliseconds).map { |k, v| "#{k}=#{v}" }.join('&')
-            stub_request(:get, "#{endpoint}/channels/#{Addressable::URI.encode(channel_name)}/messages?#{query_params}").
+            stub_request(:get, "#{endpoint}/channels/#{URI.encode_www_form_component(channel_name)}/messages?#{query_params}").
               to_return(:body => '{}', :headers => { 'Content-Type' => 'application/json' })
           }
 

data/lib/submodules/ably-ruby/spec/acceptance/rest/client_spec.rb

@@ -959,5 +959,100 @@ describe Ably::Rest::Client do
         end
       end
     end
+
+    context 'request_id generation' do
+      context 'Timeout error' do
+        context 'with request_id', :webmock do
+          let(:custom_logger) do
+            Class.new do
+              def initialize
+                @messages = []
+              end
+
+              [:fatal, :error, :warn, :info, :debug].each do |severity|
+                define_method severity do |message, &block|
+                  message_val = [message]
+                  message_val << block.call if block
+
+                  @messages << [severity, message_val.compact.join(' ')]
+                end
+              end
+
+              def logs
+                @messages
+              end
+
+              def level
+                1
+              end
+
+              def level=(new_level)
+              end
+            end
+          end
+          let(:custom_logger_object) { custom_logger.new }
+          let(:client_options) { default_options.merge(key: api_key, logger: custom_logger_object, add_request_ids: true) }
+          before do
+            @request_id = nil
+            stub_request(:get, Addressable::Template.new("#{client.endpoint}/time{?request_id}")).with do |request|
+              @request_id = request.uri.query_values['request_id']
+            end.to_return do
+              raise Faraday::TimeoutError.new('timeout error message')
+            end
+          end
+          it 'has an error with the same request_id of the request' do
+            expect{ client.time }.to raise_error(Ably::Exceptions::ConnectionTimeout, /#{@request_id}/)
+            expect(custom_logger_object.logs.find { |severity, message| message.match(/#{@request_id}/i)} ).to_not be_nil
+          end
+        end
+
+        context 'when specifying fallback hosts', :webmock do
+          let(:client_options) { { key: api_key, fallback_hosts_use_default: true, add_request_ids: true } }
+          let(:requests)       { [] }
+          before do
+            @request_id = nil
+            hosts = Ably::FALLBACK_HOSTS + ['rest.ably.io']
+            hosts.each do |host|
+              stub_request(:get, Addressable::Template.new("https://#{host.downcase}/time{?request_id}")).with do |request|
+                @request_id = request.uri.query_values['request_id']
+                requests << @request_id
+              end.to_return do
+                raise Faraday::TimeoutError.new('timeout error message')
+              end
+            end
+          end
+          it 'request_id is the same across retries' do
+            expect{ client.time }.to raise_error(Ably::Exceptions::ConnectionTimeout, /#{@request_id}/)
+            expect(requests.uniq.count).to eql(1)
+            expect(requests.uniq.first).to eql(@request_id)
+          end
+        end
+
+        context 'without request_id' do
+          let(:client_options) { default_options.merge(key: api_key, http_request_timeout: 0) }
+          it 'does not include request_id in ConnectionTimeout error' do
+            begin
+              client.stats
+            rescue Ably::Exceptions::ConnectionTimeout => err
+              expect(err.request_id).to eql(nil)
+            end
+          end
+        end
+      end 
+
+      context 'UnauthorizedRequest nonce error' do
+        let(:token_params) { { nonce: "samenonce_#{protocol}", timestamp:  Time.now.to_i } }
+        it 'includes request_id in UnauthorizedRequest error due to replayed nonce' do
+          client1 = Ably::Rest::Client.new(default_options.merge(key: api_key))
+          client2 = Ably::Rest::Client.new(default_options.merge(key: api_key, add_request_ids: true))
+          expect { client1.auth.request_token(token_params) }.not_to raise_error
+          begin
+            client2.auth.request_token(token_params)
+          rescue Ably::Exceptions::UnauthorizedRequest => err
+            expect(err.request_id).to_not eql(nil)
+          end
+        end
+      end
+    end
   end
 end

data/lib/submodules/ably-ruby/spec/acceptance/rest/message_spec.rb

@@ -62,8 +62,10 @@ describe Ably::Rest::Channel, 'messages' do
     end
 
     context 'with supported extra payload content type (#RSL1h, #RSL6a2)' do
+      let(:channel) { client.channel("pushenabled:#{random_str}") }
+
       context 'JSON Object (Hash)' do
-        let(:data) { { 'push' => { 'title' => 'Testing' } } }
+        let(:data) { { 'push' => { 'notification' => { 'title' => 'Testing' } } } }
 
         it 'is encoded and decoded to the same hash' do
           channel.publish 'event', {}, extras: data
@@ -72,9 +74,10 @@ describe Ably::Rest::Channel, 'messages' do
       end
 
       context 'JSON Array' do
-        let(:data) { { 'push' => [ nil, true, false, 55, 'string', { 'Hash' => true }, ['array'] ] } }
+        # TODO: Add nil type back in
+        let(:data) { { 'push' => { 'data' => { 'key' => [ true, false, 55, 'string', { 'Hash' => true }, ['array'] ] } } } }
 
-        it 'is encoded and decoded to the same Array' do
+        it 'is encoded and decoded to the same deep multi-type object' do
           channel.publish 'event', {}, extras: data
           expect(channel.history.items.first.extras).to eql(data)
         end

data/lib/submodules/ably-ruby/spec/acceptance/rest/presence_spec.rb

@@ -73,7 +73,7 @@ describe Ably::Rest::Presence do
           end
           let!(:get_stub) {
             query_params = query_options.map { |k, v| "#{k}=#{v}" }.join('&')
-            stub_request(:get, "#{endpoint}/channels/#{Addressable::URI.encode(channel_name)}/presence?#{query_params}").
+            stub_request(:get, "#{endpoint}/channels/#{URI.encode_www_form_component(channel_name)}/presence?#{query_params}").
               to_return(:body => '{}', :headers => { 'Content-Type' => 'application/json' })
           }
           let(:channel_name) { random_str }
@@ -111,6 +111,25 @@ describe Ably::Rest::Presence do
             expect(fixtures_channel.presence.get(connection_id: 'does.not.exist').items).to be_empty
           end
         end
+
+        context 'with a non ASCII channel name' do
+          let(:channel_name) { 'foo:¡€≤`☃' }
+          let(:channel_name_encoded) { 'foo%3A%C2%A1%E2%82%AC%E2%89%A4%60%E2%98%83' }
+          let(:endpoint) { client.endpoint }
+          let(:channel) { client.channels.get(channel_name) }
+
+          context 'stubbed', :webmock do
+            let!(:get_stub) {
+              stub_request(:get, "#{endpoint}/channels/#{channel_name_encoded}/presence?limit=100").
+                to_return(:body => '{}', :headers => { 'Content-Type' => 'application/json' })
+            }
+
+            it 'correctly encodes the channel name' do
+              channel.presence.get
+              expect(get_stub).to have_been_requested
+            end
+          end
+        end
       end
 
       describe '#history' do
@@ -194,7 +213,7 @@ describe Ably::Rest::Presence do
         context 'limit options', :webmock do
           let!(:history_stub) {
             query_params = history_options.map { |k, v| "#{k}=#{v}" }.join('&')
-            stub_request(:get, "#{endpoint}/channels/#{Addressable::URI.encode(channel_name)}/presence/history?#{query_params}").
+            stub_request(:get, "#{endpoint}/channels/#{URI.encode_www_form_component(channel_name)}/presence/history?#{query_params}").
               to_return(:body => '{}', :headers => { 'Content-Type' => 'application/json' })
           }
 
@@ -234,7 +253,7 @@ describe Ably::Rest::Presence do
               }
               let!(:history_stub) {
                 query_params = history_options.map { |k, v| "#{k}=#{v}" }.join('&')
-                stub_request(:get, "#{endpoint}/channels/#{Addressable::URI.encode(channel_name)}/presence/history?#{query_params}").
+                stub_request(:get, "#{endpoint}/channels/#{URI.encode_www_form_component(channel_name)}/presence/history?#{query_params}").
                   to_return(:body => '{}', :headers => { 'Content-Type' => 'application/json' })
               }
 
@@ -338,7 +357,7 @@ describe Ably::Rest::Presence do
 
         context '#get' do
           let!(:get_stub)   {
-            stub_request(:get, "#{endpoint}/channels/#{Addressable::URI.encode(channel_name)}/presence?limit=100").
+            stub_request(:get, "#{endpoint}/channels/#{URI.encode_www_form_component(channel_name)}/presence?limit=100").
               to_return(:body => serialized_encoded_message, :headers => { 'Content-Type' => content_type })
           }
 
@@ -355,7 +374,7 @@ describe Ably::Rest::Presence do
 
         context '#history' do
           let!(:history_stub)   {
-            stub_request(:get, "#{endpoint}/channels/#{Addressable::URI.encode(channel_name)}/presence/history?direction=backwards&limit=100").
+            stub_request(:get, "#{endpoint}/channels/#{URI.encode_www_form_component(channel_name)}/presence/history?direction=backwards&limit=100").
               to_return(:body => serialized_encoded_message, :headers => { 'Content-Type' => content_type })
           }
 
@@ -385,7 +404,7 @@ describe Ably::Rest::Presence do
         context '#get' do
           let(:client_options) { default_options.merge(log_level: :fatal) }
           let!(:get_stub)   {
-            stub_request(:get, "#{endpoint}/channels/#{Addressable::URI.encode(channel_name)}/presence?limit=100").
+            stub_request(:get, "#{endpoint}/channels/#{URI.encode_www_form_component(channel_name)}/presence?limit=100").
               to_return(:body => serialized_encoded_message_with_invalid_encoding, :headers => { 'Content-Type' => content_type })
           }
           let(:presence_message) { presence.get.items.first }
@@ -409,7 +428,7 @@ describe Ably::Rest::Presence do
         context '#history' do
           let(:client_options) { default_options.merge(log_level: :fatal) }
           let!(:history_stub)   {
-            stub_request(:get, "#{endpoint}/channels/#{Addressable::URI.encode(channel_name)}/presence/history?direction=backwards&limit=100").
+            stub_request(:get, "#{endpoint}/channels/#{URI.encode_www_form_component(channel_name)}/presence/history?direction=backwards&limit=100").
               to_return(:body => serialized_encoded_message_with_invalid_encoding, :headers => { 'Content-Type' => content_type })
           }
           let(:presence_message) { presence.history.items.first }

data/lib/submodules/ably-ruby/spec/unit/rest/client_spec.rb

@@ -50,4 +50,11 @@ describe Ably::Rest::Client do
       end
     end
   end
+
+  context 'request_id generation' do
+    let(:client_options) { { key: 'appid.keyuid:keysecret', add_request_ids: true } }
+    it 'includes request_id in URL' do
+      expect(subject.add_request_ids).to eql(true)
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ably-rest
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.5
 platform: ruby
 authors:
 - Matthew O'Riordan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-07 00:00:00.000000000 Z
+date: 2018-04-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday