channel_spec.rb in ably-0.7.0

- old
+ new
@@ -1,131 +1,131 @@
+# encoding: utf-8
 require 'spec_helper'
-require 'securerandom'
 
 describe Ably::Rest::Channel do
   include Ably::Modules::Conversions
 
-  [:msgpack, :json].each do |protocol|
-    context "over #{protocol}" do
-      let(:client) do
-        Ably::Rest::Client.new(api_key: api_key, environment: environment, protocol: protocol)
-      end
+  vary_by_protocol do
+    let(:client) do
+      Ably::Rest::Client.new(api_key: api_key, environment: environment, protocol: protocol)
+    end
 
-      describe 'publishing messages' do
-        let(:channel) { client.channel('test') }
-        let(:event)   { 'foo' }
-        let(:message) { 'woop!' }
+    describe '#publish' do
+      let(:channel) { client.channel('test') }
+      let(:event)   { 'foo' }
+      let(:message) { 'woop!' }
 
-        it 'should publish the message ok' do
-          expect(channel.publish(event, message)).to eql(true)
-        end
+      it 'should publish the message adn return true indicating success' do
+        expect(channel.publish(event, message)).to eql(true)
       end
+    end
 
-      describe 'fetching channel history' do
-        let(:channel) { client.channel("persisted:#{SecureRandom.hex(4)}") }
-        let(:expected_history) do
-          [
-            { :name => 'test1', :data => 'foo' },
-            { :name => 'test2', :data => 'bar' },
-            { :name => 'test3', :data => 'baz' }
-          ]
-        end
-        let!(:before_published) { client.time }
+    describe '#history' do
+      let(:channel) { client.channel("persisted:#{random_str(4)}") }
+      let(:expected_history) do
+        [
+          { :name => 'test1', :data => 'foo' },
+          { :name => 'test2', :data => 'bar' },
+          { :name => 'test3', :data => 'baz' }
+        ]
+      end
+      let!(:before_published) { client.time }
 
-        before(:each) do
-          expected_history.each do |message|
-            channel.publish(message[:name], message[:data]) || raise('Unable to publish message')
-          end
+      before(:each) do
+        expected_history.each do |message|
+          channel.publish(message[:name], message[:data]) || raise('Unable to publish message')
         end
+      end
 
-        it 'should return all the history for the channel' do
-          actual_history = channel.history
+      it 'should return the current message history for the channel' do
+        actual_history = channel.history
 
-          expect(actual_history.size).to eql(3)
+        expect(actual_history.size).to eql(3)
 
-          expected_history.each do |message|
-            message_name, message_data = message[:name], message[:data]
-            matching_message = actual_history.find { |message| message.name == message_name && message.data == message_data }
-            expect(matching_message).to be_a(Ably::Models::Message)
-          end
+        expected_history.each do |message|
+          message_name, message_data = message[:name], message[:data]
+          matching_message = actual_history.find { |message| message.name == message_name && message.data == message_data }
+          expect(matching_message).to be_a(Ably::Models::Message)
         end
+      end
 
-        context 'timestamps' do
-          it 'should be greater than the time before the messages were published' do
-            channel.history.each do |message|
-              expect(before_published.to_f).to be < message.timestamp.to_f
-            end
+      context 'message timestamps' do
+        it 'should all be after the messages were published' do
+          channel.history.each do |message|
+            expect(before_published.to_f).to be < message.timestamp.to_f
           end
         end
+      end
 
-        it 'should return messages with unique IDs' do
+      context 'message IDs' do
+        it 'should be unique' do
           message_ids = channel.history.map(&:id).compact
           expect(message_ids.count).to eql(3)
           expect(message_ids.uniq.count).to eql(3)
         end
+      end
 
-        it 'should return paged history' do
-          page_1 = channel.history(limit: 1)
-          page_2 = page_1.next_page
-          page_3 = page_2.next_page
+      it 'should return paged history using the PaginatedResource model' do
+        page_1 = channel.history(limit: 1)
+        page_2 = page_1.next_page
+        page_3 = page_2.next_page
 
-          all_items = [page_1[0].id, page_2[0].id, page_3[0].id]
-          expect(all_items.uniq).to eql(all_items)
+        all_items = [page_1[0].id, page_2[0].id, page_3[0].id]
+        expect(all_items.uniq).to eql(all_items)
 
-          expect(page_1.size).to eql(1)
-          expect(page_1).to_not be_last_page
-          expect(page_1).to be_first_page
+        expect(page_1.size).to eql(1)
+        expect(page_1).to_not be_last_page
+        expect(page_1).to be_first_page
 
-          # Page 2
-          expect(page_2.size).to eql(1)
-          expect(page_2).to_not be_last_page
-          expect(page_2).to_not be_first_page
+        # Page 2
+        expect(page_2.size).to eql(1)
+        expect(page_2).to_not be_last_page
+        expect(page_2).to_not be_first_page
 
-          # Page 3
-          expect(page_3.size).to eql(1)
-          expect(page_3).to be_last_page
-          expect(page_3).to_not be_first_page
-        end
+        # Page 3
+        expect(page_3.size).to eql(1)
+        expect(page_3).to be_last_page
+        expect(page_3).to_not be_first_page
       end
+    end
 
-      describe 'history options' do
-        let(:channel_name) { "persisted:#{SecureRandom.hex(4)}" }
-        let(:channel) { client.channel(channel_name) }
-        let(:endpoint) do
-          client.endpoint.tap do |client_end_point|
-            client_end_point.user = key_id
-            client_end_point.password = key_secret
-          end
+    describe '#history option' do
+      let(:channel_name) { "persisted:#{random_str(4)}" }
+      let(:channel) { client.channel(channel_name) }
+      let(:endpoint) do
+        client.endpoint.tap do |client_end_point|
+          client_end_point.user = key_id
+          client_end_point.password = key_secret
         end
+      end
 
-        [:start, :end].each do |option|
-          describe ":#{option}", webmock: true do
-            let!(:history_stub) {
-              stub_request(:get, "#{endpoint}/channels/#{CGI.escape(channel_name)}/messages?live=true&#{option}=#{milliseconds}").
-                to_return(:body => '{}', :headers => { 'Content-Type' => 'application/json' })
-            }
+      [:start, :end].each do |option|
+        describe ":#{option}", :webmock do
+          let!(:history_stub) {
+            stub_request(:get, "#{endpoint}/channels/#{CGI.escape(channel_name)}/messages?#{option}=#{milliseconds}").
+              to_return(:body => '{}', :headers => { 'Content-Type' => 'application/json' })
+          }
 
-            before do
-              channel.history(options)
-            end
+          before do
+            channel.history(options)
+          end
 
-            context 'with milliseconds since epoch' do
-              let(:milliseconds) { as_since_epoch(Time.now) }
-              let(:options) { { option => milliseconds } }
+          context 'with milliseconds since epoch value' do
+            let(:milliseconds) { as_since_epoch(Time.now) }
+            let(:options) { { option => milliseconds } }
 
-              specify 'are left unchanged' do
-                expect(history_stub).to have_been_requested
-              end
+            it 'uses this value in the history request' do
+              expect(history_stub).to have_been_requested
             end
+          end
 
-            context 'with Time' do
-              let(:time) { Time.now }
-              let(:milliseconds) { as_since_epoch(time) }
-              let(:options) { { option => time } }
+          context 'with a Time object value' do
+            let(:time) { Time.now }
+            let(:milliseconds) { as_since_epoch(time) }
+            let(:options) { { option => time } }
 
-              specify 'are left unchanged' do
-                expect(history_stub).to have_been_requested
-              end
+            it 'converts the value to milliseconds since epoch in the hisotry request' do
+              expect(history_stub).to have_been_requested
             end
           end
         end
       end
     end