ably 0.1.0

data/spec/unit/rest_spec.rb

@@ -0,0 +1,99 @@
+require "spec_helper"
+
+describe Ably::Rest do
+  let(:options) { { api_key: 'app.key:secret' } }
+
+  specify 'constructor returns an Ably::Rest::Client' do
+    expect(Ably::Rest.new(options)).to be_instance_of(Ably::Rest::Client)
+  end
+
+  describe Ably::Rest::Client do
+    describe "initializing the client" do
+      it "should disallow an invalid key" do
+        expect { Ably::Rest::Client.new({}) }.to raise_error(ArgumentError, /api_key is missing/)
+        expect { Ably::Rest::Client.new(api_key: 'invalid') }.to raise_error(ArgumentError, /api_key is invalid/)
+        expect { Ably::Rest::Client.new(api_key: 'invalid:asdad') }.to raise_error(ArgumentError, /api_key is invalid/)
+        expect { Ably::Rest::Client.new(api_key: 'appid.keyuid:keysecret') }.to_not raise_error
+      end
+
+      it "should disallow api_key and key_id" do
+        expect { Ably::Rest::Client.new(api_key: 'valid', key_id: 'invalid') }.to raise_error(ArgumentError, /api_key and key_id or key_secret are mutually exclusive/)
+      end
+
+      it "should disallow api_key and key_secret" do
+        expect { Ably::Rest::Client.new(api_key: 'valid', key_secret: 'invalid') }.to raise_error(ArgumentError, /api_key and key_id or key_secret are mutually exclusive/)
+      end
+
+      context 'using key_id and key_secret' do
+        let(:client) { Ably::Rest::Client.new(key_id: 'id', key_secret: 'secret') }
+
+        it "should allow key_id and key_secret in place of api_key" do
+          expect(client.auth.api_key).to eql('id:secret')
+        end
+      end
+
+      context "with a string key instead of options" do
+        let(:options) { 'app.key:secret' }
+        subject { Ably::Rest::Client.new(options) }
+
+        it 'should set the api_key' do
+          expect(subject.auth.api_key).to eql(options)
+        end
+
+        it 'should set the key_id' do
+          expect(subject.auth.key_id).to eql('app.key')
+        end
+
+        it 'should set the key_secret' do
+          expect(subject.auth.key_secret).to eql('secret')
+        end
+      end
+
+      context "with a client_id" do
+        it "should require a valid key" do
+          expect { Ably::Rest::Client.new(client_id: 'valid') }.to raise_error(ArgumentError, /client_id cannot be provided without a complete API key/)
+        end
+      end
+
+      it "should default to the production REST end point" do
+        expect(Ably::Rest::Client.new(api_key: 'appid.keyuid:keysecret').endpoint.to_s).to eql('https://rest.ably.io')
+      end
+
+      it "should allow an environment to be set" do
+        expect(Ably::Rest::Client.new(api_key: 'appid.keyuid:keysecret', environment: 'sandbox').endpoint.to_s).to eql('https://sandbox-rest.ably.io')
+      end
+
+      context 'with TLS disabled' do
+        let(:client) { Ably::Rest::Client.new(api_key: 'appid.keyid:secret', tls: false) }
+
+        it 'uses plain text' do
+          expect(client.use_tls?).to eql(false)
+        end
+
+        it 'uses HTTP' do
+          expect(client.endpoint.to_s).to eql('http://rest.ably.io')
+        end
+
+        it 'fails when authenticating with basic auth' do
+          expect { client.channel('a').publish('event', 'message') }.to raise_error(Ably::InsecureRequestError)
+        end
+      end
+
+      context 'with no TLS option provided' do
+        let(:client) { Ably::Rest::Client.new(api_key: 'appid.keyid:secret') }
+
+        it 'defaults to TLS' do
+          expect(client.use_tls?).to eql(true)
+        end
+      end
+
+      context 'with alternative environment' do
+        let(:client) { Ably::Rest::Client.new(api_key: 'appid.keyid:secret', environment: 'sandbox') }
+
+        it 'should alter the endpoint' do
+          expect(client.endpoint.to_s).to eql('https://sandbox-rest.ably.io')
+        end
+      end
+    end
+  end
+end

data/spec/unit/token_spec.rb

@@ -0,0 +1,90 @@
+require "spec_helper"
+
+describe Ably::Token do
+  context 'defaults' do
+    let(:one_hour)          { 60 * 60 }
+    let(:all_capabilities)  { { "*" => ["*"] } }
+
+    it 'should default TTL to 1 hour' do
+      expect(Ably::Token::DEFAULTS[:ttl]).to eql(one_hour)
+    end
+
+    it 'should default capability to all' do
+      expect(Ably::Token::DEFAULTS[:capability]).to eql(all_capabilities)
+    end
+
+    it 'should only have defaults for :ttl and :capability' do
+      expect(Ably::Token::DEFAULTS.keys).to contain_exactly(:ttl, :capability)
+    end
+  end
+
+  context 'attributes' do
+    let(:unique_value) { 'unique_value' }
+
+    %w(id capability client_id nonce).each do |attribute|
+      context "##{attribute}" do
+        subject { Ably::Token.new({ attribute.to_sym => unique_value }) }
+
+        it "retrieves attribute :#{attribute}" do
+          expect(subject.public_send(attribute)).to eql(unique_value)
+        end
+      end
+    end
+
+    context '#key_id' do
+      subject { Ably::Token.new({ key: unique_value }) }
+      it 'retrieves attribute :key' do
+        expect(subject.key_id).to eql(unique_value)
+      end
+    end
+
+    { :issued_at => :issued_at, :expires_at => :expires }.each do |method_name, attribute|
+      let(:time) { Time.now }
+      context "##{method_name}" do
+        subject { Ably::Token.new({ attribute.to_sym => time.to_i }) }
+
+        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
+    end
+
+    context '#expired?' do
+      let(:expire_time) { Time.now + Ably::Token::TOKEN_EXPIRY_BUFFER }
+
+      context 'once grace period buffer has passed' do
+        subject { Ably::Token.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::Token.new(expires: expire_time + 1) }
+
+        it 'is false' do
+          expect(subject.expired?).to eql(false)
+        end
+      end
+    end
+  end
+
+  context '==' do
+    let(:token_attributes) { { id: 'unique' } }
+
+    it 'is true when attributes are the same' do
+      new_token = -> { Ably::Token.new(token_attributes) }
+      expect(new_token[]).to eq(new_token[])
+    end
+
+    it 'is false when attributes are not the same' do
+      expect(Ably::Token.new(id: 1)).to_not eq(Ably::Token.new(id: 2))
+    end
+
+    it 'is false when class type differs' do
+      expect(Ably::Token.new(id: 1)).to_not eq(nil)
+    end
+  end
+end

metadata

@@ -0,0 +1,240 @@
+--- !ruby/object:Gem::Specification
+name: ably
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Lewis Marshall
+- Matthew O'Riordan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: eventmachine
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: websocket-driver
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A Ruby client library for ably.io, the real-time messaging service
+email:
+- lewis@lmars.net
+- matt@ably.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- ably.gemspec
+- lib/ably.rb
+- lib/ably/auth.rb
+- lib/ably/exceptions.rb
+- lib/ably/realtime.rb
+- lib/ably/realtime/callbacks.rb
+- lib/ably/realtime/channel.rb
+- lib/ably/realtime/client.rb
+- lib/ably/realtime/connection.rb
+- lib/ably/rest.rb
+- lib/ably/rest/channel.rb
+- lib/ably/rest/client.rb
+- lib/ably/rest/middleware/exceptions.rb
+- lib/ably/rest/middleware/external_exceptions.rb
+- lib/ably/rest/middleware/parse_json.rb
+- lib/ably/rest/paged_resource.rb
+- lib/ably/rest/presence.rb
+- lib/ably/support.rb
+- lib/ably/token.rb
+- lib/ably/version.rb
+- spec/acceptance/realtime_client_spec.rb
+- spec/acceptance/rest/auth_spec.rb
+- spec/acceptance/rest/base_spec.rb
+- spec/acceptance/rest/channel_spec.rb
+- spec/acceptance/rest/presence_spec.rb
+- spec/acceptance/rest/stats_spec.rb
+- spec/acceptance/rest/time_spec.rb
+- spec/spec_helper.rb
+- spec/support/api_helper.rb
+- spec/support/test_app.rb
+- spec/unit/auth.rb
+- spec/unit/realtime_spec.rb
+- spec/unit/rest_spec.rb
+- spec/unit/token_spec.rb
+homepage: http://github.com/ably/ably-ruby
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: A Ruby client library for ably.io, the real-time messaging service
+test_files:
+- spec/acceptance/realtime_client_spec.rb
+- spec/acceptance/rest/auth_spec.rb
+- spec/acceptance/rest/base_spec.rb
+- spec/acceptance/rest/channel_spec.rb
+- spec/acceptance/rest/presence_spec.rb
+- spec/acceptance/rest/stats_spec.rb
+- spec/acceptance/rest/time_spec.rb
+- spec/spec_helper.rb
+- spec/support/api_helper.rb
+- spec/support/test_app.rb
+- spec/unit/auth.rb
+- spec/unit/realtime_spec.rb
+- spec/unit/rest_spec.rb
+- spec/unit/token_spec.rb
+has_rdoc: