ably-rest 0.7.5 → 0.8.1

data/lib/submodules/ably-ruby/spec/unit/models/token_details_spec.rb

@@ -0,0 +1,111 @@
+require 'spec_helper'
+require 'shared/model_behaviour'
+
+describe Ably::Models::TokenDetails do
+  include Ably::Modules::Conversions
+
+  subject { Ably::Models::TokenDetails }
+
+  it_behaves_like 'a model', with_simple_attributes: %w(token key_name client_id) do
+    let(:model_args) { [] }
+  end
+
+
+  context 'attributes' do
+    let(:capability) { { "value" => random_str } }
+    let(:capability_str) { JSON.dump(capability) }
+
+    context '#capability' do
+      subject { Ably::Models::TokenDetails.new({ capability: capability_str }) }
+
+      it 'retrieves attribute :capability as parsed JSON' do
+        expect(subject.capability).to eql(capability)
+      end
+    end
+
+    { :issued => :issued, :expires => :expires }.each do |method_name, attribute|
+      let(:time) { Time.now }
+      context "##{method_name} with :#{method_name} option as milliseconds in constructor" do
+        subject { Ably::Models::TokenDetails.new({ attribute.to_sym => time.to_i * 1000 }) }
+
+        it "retrieves attribute :#{attribute} as Time" do
+          expect(subject.public_send(method_name)).to be_a(Time)
+          expect(subject.public_send(method_name).to_i).to eql(time.to_i)
+        end
+      end
+
+      context "##{method_name} with :#{method_name} option as a Time in constructor" do
+        subject { Ably::Models::TokenDetails.new({ attribute.to_sym => time }) }
+
+        it "retrieves attribute :#{attribute} as Time" do
+          expect(subject.public_send(method_name)).to be_a(Time)
+          expect(subject.public_send(method_name).to_i).to eql(time.to_i)
+        end
+      end
+
+      context "##{method_name} when converted to JSON" do
+        subject { Ably::Models::TokenDetails.new({ attribute.to_sym => time }) }
+
+        it 'is in milliseconds' do
+          expect(JSON.parse(JSON.dump(subject))[convert_to_mixed_case(attribute)]).to eql((time.to_f * 1000).round)
+        end
+      end
+    end
+
+    context '#expired?' do
+      let(:expire_time) { Time.now + Ably::Models::TokenDetails::TOKEN_EXPIRY_BUFFER }
+
+      context 'once grace period buffer has passed' do
+        subject { Ably::Models::TokenDetails.new(expires: expire_time - 1) }
+
+        it 'is true' do
+          expect(subject.expired?).to eql(true)
+        end
+      end
+
+      context 'within grace period buffer' do
+        subject { Ably::Models::TokenDetails.new(expires: expire_time + 1) }
+
+        it 'is false' do
+          expect(subject.expired?).to eql(false)
+        end
+      end
+    end
+  end
+
+  context '==' do
+    let(:token_attributes) { { token: 'unique' } }
+
+    it 'is true when attributes are the same' do
+      new_token = -> { Ably::Models::TokenDetails.new(token_attributes) }
+      expect(new_token[]).to eq(new_token[])
+    end
+
+    it 'is false when attributes are not the same' do
+      expect(Ably::Models::TokenDetails.new(token: 1)).to_not eq(Ably::Models::TokenDetails.new(token: 2))
+    end
+
+    it 'is false when class type differs' do
+      expect(Ably::Models::TokenDetails.new(token: 1)).to_not eq(nil)
+    end
+  end
+
+  context 'TokenDetails conversion methods', :api_private do
+    context 'with a TokenDetails object' do
+      let(:token_details) { Ably::Models::TokenDetails.new(client_id: random_str) }
+
+      it 'returns the TokenDetails object' do
+        expect(Ably::Models::TokenDetails(token_details)).to eql(token_details)
+      end
+    end
+
+    context 'with a JSON object' do
+      let(:client_id) { random_str }
+      let(:token_details_json) { { client_id: client_id } }
+
+      it 'returns a new TokenDetails object from the JSON' do
+        expect(Ably::Models::TokenDetails(token_details_json).client_id).to eql(client_id)
+      end
+    end
+  end
+end

data/lib/submodules/ably-ruby/spec/unit/models/token_request_spec.rb

@@ -0,0 +1,110 @@
+require 'spec_helper'
+require 'shared/model_behaviour'
+
+describe Ably::Models::TokenRequest do
+  subject { Ably::Models::TokenRequest }
+
+  it_behaves_like 'a model', with_simple_attributes: %w(key_name client_id nonce mac) do
+    let(:model_args) { [] }
+  end
+
+  context 'attributes' do
+    context '#capability' do
+      let(:capability) { { "value" => random_str } }
+      let(:capability_str) { JSON.dump(capability) }
+
+      subject { Ably::Models::TokenRequest.new({ capability: capability_str }) }
+
+      it 'retrieves attribute :capability as parsed JSON' do
+        expect(subject.capability).to eql(capability)
+      end
+    end
+
+    context "#timestamp" do
+      let(:time) { Time.now }
+
+      context 'with :timestamp option as milliseconds in constructor' do
+        subject { Ably::Models::TokenRequest.new(timestamp: time.to_i * 1000) }
+
+        it "retrieves attribute :timestamp as Time" do
+          expect(subject.timestamp).to be_a(Time)
+          expect(subject.timestamp.to_i).to eql(time.to_i)
+        end
+      end
+
+      context 'with :timestamp option as Time in constructor' do
+        subject { Ably::Models::TokenRequest.new(timestamp: time) }
+
+        it "retrieves attribute :timestamp as Time" do
+          expect(subject.timestamp).to be_a(Time)
+          expect(subject.timestamp.to_i).to eql(time.to_i)
+        end
+      end
+
+      context 'when converted to JSON' do
+        subject { Ably::Models::TokenRequest.new(timestamp: time) }
+
+        it "is in milliseconds since epoch" do
+          expect(JSON.parse(JSON.dump(subject))['timestamp']).to eql((time.to_f * 1000).round)
+        end
+      end
+    end
+
+    context "#ttl" do
+      let(:ttl) { 500 }
+
+      context 'with :ttl option as milliseconds in constructor' do
+        subject { Ably::Models::TokenRequest.new(ttl: ttl * 1000) }
+
+        it "retrieves attribute :ttl as seconds" do
+          expect(subject.ttl).to be_a(Integer)
+          expect(subject.ttl).to eql(ttl)
+        end
+      end
+
+      context 'when converted to JSON' do
+        subject { Ably::Models::TokenRequest.new(ttl: ttl * 1000) }
+
+        it "is in milliseconds since epoch" do
+          expect(JSON.parse(JSON.dump(subject))['ttl']).to eql(ttl * 1000)
+        end
+      end
+    end
+  end
+
+  context '==' do
+    let(:token_attributes) { { client_id: random_str } }
+
+    it 'is true when attributes are the same' do
+      new_token = -> { Ably::Models::TokenRequest.new(token_attributes) }
+      expect(new_token[]).to eq(new_token[])
+    end
+
+    it 'is false when attributes are not the same' do
+      expect(Ably::Models::TokenRequest.new(client_id: 1)).to_not eq(Ably::Models::TokenRequest.new(client_id: 2))
+    end
+
+    it 'is false when class type differs' do
+      expect(Ably::Models::TokenRequest.new(client_id: 1)).to_not eq(nil)
+    end
+  end
+
+  context 'TokenRequest conversion methods', :api_private do
+    context 'with a TokenRequest object' do
+      let(:token_request) { Ably::Models::TokenRequest.new(client_id: random_str) }
+
+      it 'returns the TokenRequest object' do
+        expect(Ably::Models::TokenRequest(token_request)).to eql(token_request)
+      end
+    end
+
+    context 'with a JSON object' do
+      let(:client_id) { random_str }
+      let(:token_request_json) { { client_id: client_id } }
+
+      it 'returns a new TokenRequest object from the JSON' do
+        expect(Ably::Models::TokenRequest(token_request_json).client_id).to eql(client_id)
+      end
+    end
+  end
+end

data/lib/submodules/ably-ruby/spec/unit/modules/async_wrapper_spec.rb

@@ -16,7 +16,7 @@ describe Ably::Modules::AsyncWrapper, :api_private do
       end
 
       def logger
-        true
+        @logger ||= Ably::Models::NilLogger.new
       end
     end
   end

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

@@ -10,7 +10,7 @@ describe Ably::Realtime::Client do
   it_behaves_like 'a client initializer'
 
   context 'delegation to the REST Client' do
-    let(:client_options) { { api_key: 'appid.keyuid:keysecret' } }
+    let(:client_options) { { key: 'appid.keyuid:keysecret' } }
 
     it 'passes on the options to the initializer' do
       rest_client = instance_double('Ably::Rest::Client', auth: instance_double('Ably::Auth'), options: client_options)

data/lib/submodules/ably-ruby/spec/unit/realtime/realtime_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 
 describe Ably::Realtime do
-  let(:options) { { api_key: 'app.key:secret' } }
+  let(:options) { { key: 'app.key:secret' } }
 
   specify 'constructor returns an Ably::Realtime::Client' do
     expect(Ably::Realtime.new(options)).to be_instance_of(Ably::Realtime::Client)

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

@@ -1,7 +1,7 @@
 # encoding: utf-8
 require 'spec_helper'
 
-describe Ably::Rest::Channels do
+describe Ably::Rest::Channel do
   let(:client)       { instance_double('Ably::Rest::Client', encoders: [], post: instance_double('Faraday::Response', status: 201)) }
   let(:channel_name) { 'unique' }
 

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

@@ -12,7 +12,7 @@ describe Ably::Rest::Client do
   context 'initializer options' do
     context 'TLS' do
       context 'disabled' do
-        let(:client_options) { { api_key: 'appid.keyuid:keysecret', tls: false } }
+        let(:client_options) { { key: 'appid.keyuid:keysecret', tls: false } }
 
         it 'fails for any operation with basic auth and attempting to send an API key over a non-secure connection' do
           expect { subject.channel('a').publish('event', 'message') }.to raise_error(Ably::Exceptions::InsecureRequestError)
@@ -22,28 +22,28 @@ describe Ably::Rest::Client do
 
     context ':use_token_auth' do
       context 'set to false' do
-        context 'with an api_key with :tls => false' do
-          let(:client_options) { { use_token_auth: false, api_key: 'appid.keyuid:keysecret', tls: false } }
+        context 'with an key with :tls => false' do
+          let(:client_options) { { use_token_auth: false, key: 'appid.keyuid:keysecret', tls: false } }
 
           it 'fails for any operation with basic auth and attempting to send an API key over a non-secure connection' do
             expect { subject.channel('a').publish('event', 'message') }.to raise_error(Ably::Exceptions::InsecureRequestError)
           end
         end
 
-        context 'without an api_key' do
+        context 'without an key' do
           let(:client_options) { { use_token_auth: false } }
 
-          it 'fails as an api_key is required if not using token auth' do
+          it 'fails as an key is required if not using token auth' do
             expect { subject.channel('a').publish('event', 'message') }.to raise_error(ArgumentError)
           end
         end
       end
 
       context 'set to true' do
-        context 'without an api_key or token_id' do
-          let(:client_options) { { use_token_auth: true, api_key: true } }
+        context 'without an key or token' do
+          let(:client_options) { { use_token_auth: true, key: true } }
 
-          it 'fails as an api_key is required to issue tokens' do
+          it 'fails as an key is required to issue tokens' do
             expect { subject.channel('a').publish('event', 'message') }.to raise_error(ArgumentError)
           end
         end

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

@@ -2,7 +2,7 @@
 require 'spec_helper'
 
 describe Ably::Rest do
-  let(:options) { { api_key: 'app.key:secret' } }
+  let(:options) { { key: 'app.key:secret' } }
 
   specify 'constructor returns an Ably::Rest::Client' do
     expect(Ably::Rest.new(options)).to be_instance_of(Ably::Rest::Client)

data/lib/submodules/ably-ruby/spec/unit/util/crypto_spec.rb

@@ -45,7 +45,7 @@ describe Ably::Util::Crypto do
   end
 
   context 'using shared client lib fixture data' do
-    let(:resources_root)      { File.expand_path('../../../resources', __FILE__) }
+    let(:resources_root)      { File.expand_path('../../../../lib/submodules/ably-common/test-resources', __FILE__) }
     let(:encryption_data_128) { JSON.parse(File.read(File.join(resources_root, 'crypto-data-128.json'))) }
     let(:encryption_data_256) { JSON.parse(File.read(File.join(resources_root, 'crypto-data-256.json'))) }
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ably-rest
 version: !ruby/object:Gem::Version
-  version: 0.7.5
+  version: 0.8.1
 platform: ruby
 authors:
 - Matthew O'Riordan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-21 00:00:00.000000000 Z
+date: 2015-04-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -172,6 +172,7 @@ files:
 - lib/ably-rest.rb
 - lib/ably-rest/modules/eventmachine_deferrable.rb
 - lib/submodules/ably-ruby/.gitignore
+- lib/submodules/ably-ruby/.gitmodules
 - lib/submodules/ably-ruby/.rspec
 - lib/submodules/ably-ruby/.travis.yml
 - lib/submodules/ably-ruby/Gemfile
@@ -197,7 +198,9 @@ files:
 - lib/submodules/ably-ruby/lib/ably/models/presence_message.rb
 - lib/submodules/ably-ruby/lib/ably/models/protocol_message.rb
 - lib/submodules/ably-ruby/lib/ably/models/stat.rb
-- lib/submodules/ably-ruby/lib/ably/models/token.rb
+- lib/submodules/ably-ruby/lib/ably/models/stats_types.rb
+- lib/submodules/ably-ruby/lib/ably/models/token_details.rb
+- lib/submodules/ably-ruby/lib/ably/models/token_request.rb
 - lib/submodules/ably-ruby/lib/ably/modules/ably.rb
 - lib/submodules/ably-ruby/lib/ably/modules/async_wrapper.rb
 - lib/submodules/ably-ruby/lib/ably/modules/channels_collection.rb
@@ -269,8 +272,6 @@ files:
 - lib/submodules/ably-ruby/spec/acceptance/rest/presence_spec.rb
 - lib/submodules/ably-ruby/spec/acceptance/rest/stats_spec.rb
 - lib/submodules/ably-ruby/spec/acceptance/rest/time_spec.rb
-- lib/submodules/ably-ruby/spec/resources/crypto-data-128.json
-- lib/submodules/ably-ruby/spec/resources/crypto-data-256.json
 - lib/submodules/ably-ruby/spec/rspec_config.rb
 - lib/submodules/ably-ruby/spec/shared/client_initializer_behaviour.rb
 - lib/submodules/ably-ruby/spec/shared/model_behaviour.rb
@@ -297,8 +298,9 @@ files:
 - lib/submodules/ably-ruby/spec/unit/models/paginated_resource_spec.rb
 - lib/submodules/ably-ruby/spec/unit/models/presence_message_spec.rb
 - lib/submodules/ably-ruby/spec/unit/models/protocol_message_spec.rb
-- lib/submodules/ably-ruby/spec/unit/models/stat_spec.rb
-- lib/submodules/ably-ruby/spec/unit/models/token_spec.rb
+- lib/submodules/ably-ruby/spec/unit/models/stats_spec.rb
+- lib/submodules/ably-ruby/spec/unit/models/token_details_spec.rb
+- lib/submodules/ably-ruby/spec/unit/models/token_request_spec.rb
 - lib/submodules/ably-ruby/spec/unit/modules/async_wrapper_spec.rb
 - lib/submodules/ably-ruby/spec/unit/modules/conversions_spec.rb
 - lib/submodules/ably-ruby/spec/unit/modules/enum_spec.rb

data/lib/submodules/ably-ruby/lib/ably/models/token.rb

@@ -1,74 +0,0 @@
-module Ably::Models
-  # Authentication token issued by Ably in response to an token request
-  class Token
-    include Ably::Modules::ModelCommon
-
-    DEFAULTS = {
-      capability: { '*' => ['*'] },
-      ttl:        60 * 60 # 1 hour
-    }
-
-    # Buffer in seconds given to the use of a token prior to it being considered unusable
-    # For example, if buffer is 10s, the token can no longer be used for new requests 9s before it expires
-    TOKEN_EXPIRY_BUFFER = 5
-
-    def initialize(attributes)
-      @hash_object = IdiomaticRubyWrapper(attributes.clone.freeze)
-    end
-
-    # @!attribute [r] id
-    # @return [String] Unique token ID used to authenticate requests
-    def id
-      hash.fetch(:id)
-    end
-
-    # @!attribute [r] key_id
-    # @return [String] Key ID used to create this token
-    def key_id
-      hash.fetch(:key)
-    end
-
-    # @!attribute [r] issued_at
-    # @return [Time] Time the token was issued
-    def issued_at
-      as_time_from_epoch(hash.fetch(:issued_at), granularity: :s)
-    end
-
-    # @!attribute [r] expires_at
-    # @return [Time] Time the token expires
-    def expires_at
-      as_time_from_epoch(hash.fetch(:expires), granularity: :s)
-    end
-
-    # @!attribute [r] capability
-    # @return [Hash] Capabilities assigned to this token
-    def capability
-      hash.fetch(:capability)
-    end
-
-    # @!attribute [r] client_id
-    # @return [String] Optional client ID assigned to this token
-    def client_id
-      hash[:client_id]
-    end
-
-    # @!attribute [r] nonce
-    # @return [String] unique nonce used to generate Token and ensure token generation cannot be replayed
-    def nonce
-      hash.fetch(:nonce)
-    end
-
-    # Returns true if token is expired or about to expire
-    #
-    # @return [Boolean]
-    def expired?
-      expires_at < Time.now + TOKEN_EXPIRY_BUFFER
-    end
-
-    # @!attribute [r] hash
-    # @return [Hash] Access the token Hash object ruby'fied to use symbolized keys
-    def hash
-      @hash_object
-    end
-  end
-end