ably 1.0.4 → 1.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 3c9fbb2d2e98f6d82d7034718820679ab772adc9
-  data.tar.gz: 33f0173c647e92e77724c48c761a5aefef608360
+SHA256:
+  metadata.gz: a05adf2fb91ff543ae2797812dce8bc9c3119cc5ebf9c4a4468a177f07e2587c
+  data.tar.gz: 97c229e631a871cdba553220677629bff959be160db9a864b8c5b712e26480d1
 SHA512:
-  metadata.gz: efd51a591e92dc64137f257beaabb3c9b909166f19abeb7ee37a8895c5e6dec7069c7c02f7c326240b6fbd628831c5dd718f87f0fd4174a4bb8a2d8116926622
-  data.tar.gz: 1e0ef0ba81c9dcbc7ba86c44187c6afb2ff16f6841c96b430a461c1b121c63e5b76ab87c1d696428769f8948aee0774a061e183131e3b543d46e414919ccfe1c
+  metadata.gz: e3a2dc86d92459e6fe03721df934e819e504a39a6be899a42d3ea00b251e8dd8f465552e481451a024903ee199370a932addfdbda1962f441379fc5cb718ea73
+  data.tar.gz: db1ca5e7ae13cb490f469d72a58ee7ca8f1377a834e200ade85045f0b341f411aaed966a4c7d2d85de9dd7cd55084a8369ff39505e76508ce744549723b305a8

data/.travis.yml

@@ -6,7 +6,9 @@ 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:

data/CHANGELOG.md

@@ -1,21 +1,50 @@
 # Change Log
 
-## [v1.0.2](https://github.com/ably/ably-ruby/tree/v1.0.2)
+## [v1.0.5](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 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.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)
-- [Fallback hosts were used upon any disconnection as opposed to only when the primary host is unavailable](https://github.com/ably/ably-ruby/pull/120)
 
 **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.0.0...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)
 

data/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/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,21 +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 notes
+## 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/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/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,6 +35,7 @@ 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(' ')

data/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/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/ably/version.rb

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

data/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/spec/acceptance/rest/channel_spec.rb

@@ -343,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

data/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/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,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ably
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 1.0.5
 platform: ruby
 authors:
 - Lewis Marshall
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-31 00:00:00.000000000 Z
+date: 2018-04-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: eventmachine
@@ -440,7 +440,7 @@ files:
 - spec/unit/util/pub_sub_spec.rb
 homepage: http://github.com/ably/ably-ruby
 licenses:
-- Apache 2
+- Apache-2.0
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -458,7 +458,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: A Ruby client library for ably.io realtime messaging implemented using EventMachine