ably 0.1.1 → 0.1.2

data/lib/ably/rest/paged_resource.rb

@@ -1,117 +0,0 @@
-module Ably
-  module Rest
-    # Wraps any Ably HTTP response that supports paging and automatically provides methdos to iterated through
-    # the array of resources using {#first}, {#next}, {#last?} and {#first?}
-    #
-    # Paging information is provided by Ably in the LINK HTTP headers
-    class PagedResource
-      include Enumerable
-
-      # @param [Faraday::Response] http_response Initial HTTP response from an Ably request to a paged resource
-      # @param [String] base_url Base URL for request that generated the http_response so that subsequent paged requests can be made
-      # @param [Ably::Rest::Client] client {Ably::Client} used to make the request to Ably
-      # @param [Hash] options Options for this paged resource
-      # @option options [Symbol] :coerce_into symbol representing class that should be used to represent each item in the PagedResource
-      #
-      # @return [Ably::Rest::PagedResource]
-      def initialize(http_response, base_url, client, coerce_into: nil)
-        @http_response = http_response
-        @client        = client
-        @base_url      = "#{base_url.gsub(%r{/[^/]*$}, '')}/"
-        @coerce_into   = coerce_into
-
-        @body = if coerce_into
-          http_response.body.map do |item|
-            Kernel.const_get(coerce_into).new(item)
-          end
-        else
-          http_response.body
-        end
-      end
-
-      # Retrieve the first page of results
-      #
-      # @return [Ably::Rest::PagedResource]
-      def first
-        PagedResource.new(@client.get(pagination_url('first')), @base_url, @client, coerce_into: @coerce_into)
-      end
-
-      # Retrieve the next page of results
-      #
-      # @return [Ably::Rest::PagedResource]
-      def next
-        PagedResource.new(@client.get(pagination_url('next')), @base_url, @client, coerce_into: @coerce_into)
-      end
-
-      # True if this is the last page in the paged resource set
-      #
-      # @return [Boolean]
-      def last?
-        !supports_pagination? ||
-          pagination_header('next').nil?
-      end
-
-      # True if this is the first page in the paged resource set
-      #
-      # @return [Boolean]
-      def first?
-        !supports_pagination? ||
-          pagination_header('first') == pagination_header('current')
-      end
-
-      # True if the HTTP response supports paging with the expected LINK HTTP headers
-      #
-      # @return [Boolean]
-      def supports_pagination?
-        !pagination_headers.empty?
-      end
-
-      # Standard Array accessor method
-      def [](index)
-        @body[index]
-      end
-
-      # Returns number of items within this page, not the total number of items in the entire paged resource set
-      def length
-        @body.length
-      end
-      alias_method :count, :length
-      alias_method :size,  :length
-
-      # Method ensuring this {Ably::Rest::PagedResource} is {http://ruby-doc.org/core-2.1.3/Enumerable.html Enumerable}
-      def each(&block)
-        @body.each do |item|
-          if block_given?
-            block.call item
-          else
-            yield item
-          end
-        end
-      end
-
-      private
-      def pagination_headers
-        link_regex = %r{<(?<url>[^>]+)>; rel="(?<rel>[^"]+)"}
-        @pagination_headers ||= @http_response.headers['link'].scan(link_regex).inject({}) do |hash, val_array|
-          url, rel = val_array
-          hash[rel] = url
-          hash
-        end
-      end
-
-      def pagination_header(id)
-        pagination_headers[id]
-      end
-
-      def pagination_url(id)
-        raise Ably::Exceptions::InvalidPageError, "Paging heading link #{id} does not exist" unless pagination_header(id)
-
-        if pagination_header(id).match(%r{^\./})
-          "#{@base_url}#{pagination_header(id)[2..-1]}"
-        else
-          pagination_header[id]
-        end
-      end
-    end
-  end
-end

data/spec/acceptance/realtime_client_spec.rb

@@ -1,12 +0,0 @@
-require "spec_helper"
-
-describe "Using the Realtime client" do
-  describe "initializing the client" do
-    it "should disallow an invalid key" do
-      expect { Ably::Realtime::Client.new({}) }.to raise_error(ArgumentError, /api_key is missing/)
-      expect { Ably::Realtime::Client.new(api_key: 'invalid') }.to raise_error(ArgumentError, /api_key is invalid/)
-      expect { Ably::Realtime::Client.new(api_key: 'invalid:asdad') }.to raise_error(ArgumentError, /api_key is invalid/)
-      expect { Ably::Realtime::Client.new(api_key: 'appid.keyuid:keysecret') }.to_not raise_error
-    end
-  end
-end

data/spec/unit/message_spec.rb

@@ -1,73 +0,0 @@
-require "spec_helper"
-
-describe Ably::Message do
-  context 'attributes' do
-    let(:unique_value) { 'unique_value' }
-
-    %w(name data client_id timestamp channel_serial).each do |attribute|
-      context "##{attribute}" do
-        subject { Ably::Message.new({ attribute.to_sym => unique_value }) }
-
-        it "retrieves attribute :#{attribute}" do
-          expect(subject.public_send(attribute)).to eql(unique_value)
-        end
-      end
-    end
-
-    context '#timestamp_at' do
-      subject { Ably::Message.new(timestamp: Time.now.to_i * 1000) }
-      it 'retrieves attribute :key' do
-        expect(subject.timestamp_at.to_i).to be_within(1).of(Time.now.to_i)
-      end
-    end
-
-    context '#raw_message' do
-      let(:attributes) { { timestamp: Time.now.to_i * 1000 } }
-      subject { Ably::Message.new(attributes) }
-
-      it 'provides access to #raw_message' do
-        expect(subject.raw_message).to eql(attributes)
-      end
-    end
-
-    context '#[]' do
-      subject { Ably::Message.new(unusual: 'attribute') }
-
-      it 'provides accessor method to #raw_message' do
-        expect(subject[:unusual]).to eql('attribute')
-      end
-    end
-  end
-
-  context '==' do
-    let(:attributes) { { client_id: 'unique' } }
-
-    it 'is true when attributes are the same' do
-      new_message = -> { Ably::Message.new(attributes) }
-      expect(new_message[]).to eq(new_message[])
-    end
-
-    it 'is false when attributes are not the same' do
-      expect(Ably::Message.new(client_id: 1)).to_not eq(Ably::Message.new(client_id: 2))
-    end
-
-    it 'is false when class type differs' do
-      expect(Ably::Message.new(client_id: 1)).to_not eq(nil)
-    end
-  end
-
-  context 'is immutable' do
-    let(:options) { { client_id: 'John' } }
-    subject { Ably::Message.new(options) }
-
-    it 'prevents changes' do
-      expect { subject.raw_message[:client_id] = 'Joe' }.to raise_error RuntimeError, /can't modify frozen Hash/
-    end
-
-    it 'dups options' do
-      expect(subject.raw_message[:client_id]).to eql('John')
-      options[:client_id] = 'Joe'
-      expect(subject.raw_message[:client_id]).to eql('John')
-    end
-  end
-end

data/spec/unit/realtime_spec.rb

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