mirror-api 0.0.9 → 0.1.0

data/spec/spec_helper.rb

@@ -16,4 +16,25 @@ def fixture(file, read=false)
   file = File.new(fixture_path + '/' + file)
   return File.read(file) if read
   file
+end
+
+def json_post_request_headers(token, body)
+  {
+      'Accept'=>'application/json',
+      'Accept-Encoding'=>'gzip, deflate',
+      'Authorization'=>"Bearer #{token}",
+      'Content-Length'=>body.length.to_s,
+      'Content-Type'=>'application/json',
+      'User-Agent'=>'Ruby'
+  }
+end
+
+def json_get_request_headers(token)
+  {
+      'Accept'=>'application/json',
+      'Accept-Encoding'=>'gzip, deflate',
+      'Authorization'=>"Bearer #{token}",
+      'Content-Type'=>'application/json',
+      'User-Agent'=>'Ruby'
+  }
 end

data/spec/subscriptions_spec.rb

@@ -0,0 +1,170 @@
+require_relative "spec_helper"
+
+describe "Subscriptions" do
+  before do
+    @token = "my-token"
+  end
+
+  describe "delete" do
+    context "with valid params" do
+      before do
+        @id = "timeline"
+        stub_request(:delete, "https://www.googleapis.com/mirror/v1/subscriptions/#{@id}").
+            with(headers: json_get_request_headers(@token)).
+            to_return(status: 200,
+                      body: {},
+                      headers: {})
+      end
+      it "should return true" do
+        @api = Mirror::Api::Client.new(@token)
+        @api.subscriptions.delete(@id).should be_true
+      end
+    end
+
+    context "with invalid params" do
+      before do
+        @id = "blah"
+        stub_request(:delete, "https://www.googleapis.com/mirror/v1/subscriptions/#{@id}").
+            with(headers: json_get_request_headers(@token)).
+            to_return(status: 400,
+                      body: {},
+                      headers: {})
+      end
+
+      context "without bubbling errors" do
+        it "should return nil" do
+          @api = Mirror::Api::Client.new(@token)
+          subscription = @api.subscriptions.delete(@id)
+          subscription.should == nil
+        end
+      end
+
+      context "bubbling errors" do
+        it "should raise ex" do
+          @api = Mirror::Api::Client.new(@token, true)
+          expect{@api.subscriptions.delete(@id)}.to raise_error
+        end
+      end
+    end
+
+  end
+
+  describe "insert" do
+
+    context "with valid params" do
+      before do
+        @body = {collection: "timeline", userToken:"user_1", operation: ["UPDATE"], callbackUrl: "https://yourawesomewebsite.com/callback"}
+
+        stub_request(:post, "https://www.googleapis.com/mirror/v1/subscriptions/").
+            with(body: @body,
+                 headers: json_post_request_headers(@token, @body.to_json)).
+            to_return(status: 200,
+                      body: fixture("subscriptions_item.json", true),
+                      headers: {})
+      end
+      it "should return a subscription with .kind == 'mirror#subscription'" do
+        @api = Mirror::Api::Client.new(@token)
+        subscription = @api.subscriptions.insert(@body)
+        subscription.kind.should == 'mirror#subscription'
+      end
+    end
+
+    context "with invalid params" do
+      before do
+        @body2 = {:notCoolDude => "Really you thought that was valid?!"}
+        stub_request(:post, "https://www.googleapis.com/mirror/v1/subscriptions/").
+            with(body: @body2,
+                 headers: json_post_request_headers(@token, @body2.to_json)).
+            to_return(status: 404,
+                      body: {},
+                      headers: {})
+      end
+      it "should return nil" do
+        @api = Mirror::Api::Client.new(@token)
+        subscription = @api.subscriptions.insert({not_cool_dude: "Really you thought that was valid?!"})
+        subscription.should == nil
+      end
+
+      context "bubbling errors" do
+        it "should raise ex" do
+          @api = Mirror::Api::Client.new(@token, {:raise_errors => true})
+          expect{@api.subscriptions.insert(@body)}.to raise_error
+        end
+      end
+    end
+
+  end
+
+  describe "list" do
+
+    context "with valid params" do
+      before do
+
+        stub_request(:get, "https://www.googleapis.com/mirror/v1/subscriptions/").
+            with(headers: json_get_request_headers(@token)).
+            to_return(status: 200,
+                      body: fixture("subscriptions_list.json", true),
+                      headers: {})
+      end
+
+      it "should return a list of subscriptions" do
+        @api = Mirror::Api::Client.new(@token)
+        subscriptions = @api.subscriptions.list
+        subscriptions.should_not be_nil
+        subscriptions.items.count.should == 1 # see fixture
+      end
+    end
+
+  end
+
+  describe "update" do
+
+    context "with valid params" do
+      before do
+        @id = 'timeline'
+        @body = {collection: 'timeline', callbackUrl: 'https://fullscreen.net/callback', operation:["INSERT", "UPDATE"]}
+
+        stub_request(:put, "https://www.googleapis.com/mirror/v1/subscriptions/#{@id}").
+            with(body: @body,
+                 headers: json_post_request_headers(@token, @body.to_json)).
+            to_return(status: 200,
+                      body: fixture("subscriptions_item.json", true),
+                      headers: {})
+      end
+      it "should return a subscription with .kind == 'mirror#subscription'" do
+        @api = Mirror::Api::Client.new(@token)
+        subscription = @api.subscriptions.update(@id, @body)
+        subscription.kind.should == 'mirror#subscription'
+      end
+    end
+
+    context "with invalid params" do
+      before do
+        @id = 'timeline'
+        @body = {derp: 'troll'}
+
+        stub_request(:put, "https://www.googleapis.com/mirror/v1/subscriptions/#{@id}").
+            with(body: @body,
+                 headers: json_post_request_headers(@token, @body.to_json)).
+            to_return(status: 400,
+                      body: {},
+                      headers: {})
+      end
+
+      it "should return nil" do
+        @api = Mirror::Api::Client.new(@token)
+        subscription = @api.subscriptions.update(@id, @body)
+        subscription.should == nil
+      end
+
+      context "when bubbling errors" do
+
+        it "should raise an exception" do
+          @api = Mirror::Api::Client.new(@token, {:raise_errors => true})
+          expect{@api.subscriptions.update(@id, @body)}.to raise_error
+        end
+      end
+    end
+
+  end
+end

data/spec/timeline_attachments_spec.rb

@@ -0,0 +1,141 @@
+require_relative "spec_helper"
+
+describe "Timeline Attachments" do
+
+  before do
+    @token = "my-token"
+    @api = Mirror::Api::Client.new(@token)
+  end
+
+  context "delete" do
+    context "with valid params" do
+      before do
+        @timeline_id = "1234"
+        @attachment_id = "123123312"
+        stub_request(:delete, "https://www.googleapis.com/mirror/v1/timeline/#{@timeline_id}/attachments/#{@attachment_id}").
+            with(headers: json_get_request_headers(@token)).
+            to_return(status: 200,
+                      body: "",
+                      headers: {})
+      end
+      it "should return true" do
+        @api.timeline.delete(@timeline_id, {attachments:{id: @attachment_id}}).should be_true
+      end
+    end
+
+    context "with invalid params" do
+      before do
+        @timeline_id = "1234"
+        @attachment_id = "blah"
+        stub_request(:delete, "https://www.googleapis.com/mirror/v1/timeline/#{@timeline_id}/attachments/#{@attachment_id}").
+            with(headers: json_get_request_headers(@token)).
+            to_return(status: 400,
+                      body: "",
+                      headers: {})
+      end
+      it "should return nil" do
+        timeline_attachment = @api.timeline.delete(@timeline_id, {attachments:{id: @attachment_id}})
+        timeline_attachment.should == nil
+      end
+    end
+  end
+
+  context "get" do
+    context "with valid params" do
+      before do
+        @timeline_id = "1234"
+        @attachment_id = "123123312"
+        stub_request(:get, "https://www.googleapis.com/mirror/v1/timeline/#{@timeline_id}/attachments/#{@attachment_id}").
+            with(headers: json_get_request_headers(@token)).
+            to_return(status: 200,
+                      body: fixture("timeline_item_attachments_item.json", true),
+                      headers: {})
+      end
+      it "should return timeline_attachment with id '1234'" do
+        timeline_attachment = @api.timeline.get(@timeline_id, {attachments:{id: @attachment_id}})
+        timeline_attachment.id == '1234'
+      end
+
+      it "should return isProcessingContent with boolean false" do
+        timeline_attachment = @api.timeline.get(@timeline_id, {attachments:{id: @attachment_id}})
+        timeline_attachment.is_processing_content == false
+      end
+    end
+
+    context "with invalid params" do
+      before do
+        @timeline_id = "1234"
+        @attachment_id = "blah"
+        stub_request(:get, "https://www.googleapis.com/mirror/v1/timeline/#{@timeline_id}/attachments/#{@attachment_id}").
+            with(headers: json_get_request_headers(@token)).
+            to_return(status: 404,
+                      body: "",
+                      headers: {})
+      end
+      it "should return nil" do
+        timeline_attachment = @api.timeline.get(@timeline_id, {attachments:{id: @attachment_id}})
+        timeline_attachment.should == nil
+      end
+    end
+  end
+
+  #TODO: Support file upload
+  # context "insert" do
+  #   context "with valid params" do
+  #     before do
+  #       @timeline_id = "1234"
+  #       @file = fixture_file_upload('files/fry.png', 'image/png')
+  #       @params = {uploadType: 'media'}
+
+  #       stub_request(:post, "https://www.googleapis.com/mirror/v1/timeline/#{@timeline_id}/attachments?uploadType=media").
+  #         with(
+  #           headers: json_post_request_headers(@token, @body.to_json)).
+  #         to_return(status: 200,
+  #           body: fixture("timeline_item_attachments_item.json", true),
+  #           headers: {})
+  #     end
+  #     it "should return timeline_attachment with id '1234'" do
+  #       timeline_attachment = @api.timeline.delete(@timeline_id, {attachments:{id: @attachment_id}})
+  #       timeline_attachment.id == '1234ß'
+  #     end
+  #   end
+
+  #   context "with invalid params" do
+  #     before do
+  #       @body = {canIHazContact: "Really you thought that was valid?!"}
+
+  #       stub_request(:post, "https://www.googleapis.com/mirror/v1/contacts/").
+  #         with(body: @body,
+  #           headers: json_post_request_headers(@token, @body.to_json)).
+  #         to_return(status: 404,
+  #           body: "",
+  #           headers: {})
+  #     end
+  #     it "should return nil" do
+  #       contact = @api.contacts.insert(@body)
+  #       contact.should == nil
+  #     end
+  #   end
+  # end
+
+  # TODO correct resource#list method to handle attachments
+  context "list" do
+    context "with valid params" do
+      before do
+        @timeline_id = "1234"
+        stub_request(:get, "https://www.googleapis.com/mirror/v1/timeline/#{@timeline_id}/attachments/").
+            with(headers: json_get_request_headers(@token)).
+            to_return(status: 200,
+                      body: fixture("timeline_item_attachments_list.json", true),
+                      headers: {})
+      end
+
+      it "should return a list of contacts", :focus => true do
+        attachments = @api.timeline.list(@timeline_id, {attachments: {} })
+        attachments.should_not be_nil
+        attachments.items.count.should == 2  # see fixture
+      end
+    end
+  end
+
+end

data/spec/timeline_spec.rb

@@ -0,0 +1,239 @@
+require_relative "spec_helper"
+
+describe "Timeline" do
+  before do
+    @token = "my-token"
+    @api = Mirror::Api::Client.new(@token)
+  end
+
+  describe "create" do
+    describe "inserting" do
+
+      context "with valid params" do
+        before do
+          @msg = "Hello world"
+          @body = {text: @msg}
+
+          stub_request(:post, "https://www.googleapis.com/mirror/v1/timeline/").
+              with(body: @body,
+                   headers: json_post_request_headers(@token, @body.to_json)).
+              to_return(status: 200,
+                        body: fixture("timeline_item.json", true),
+                        headers: JSON.parse(fixture("timeline_item_response_headers.json", true)))
+        end
+
+        it "should insert plain text items" do
+          item = @api.timeline.create({text: @msg})
+          item.should_not be_nil
+          item.created.should == "2012-09-25T23:28:43.192Z" # see fixture
+          item.text.should == @msg
+        end
+
+        it "should insert plain text items passing request data" do
+          data = Mirror::Api::RequestData.new({text: @msg})
+          item = @api.timeline.create(data)
+          item.should_not be_nil
+          item.created.should == "2012-09-25T23:28:43.192Z" # see fixture
+          item.text.should == @msg
+        end
+      end
+
+      context "with invalid params" do
+        before do
+          @msg = "123"
+          @body = {random: @msg}
+          stub_request(:post, "https://www.googleapis.com/mirror/v1/timeline/").
+              with(body: @body,
+                   headers: json_post_request_headers(@token, @body.to_json)).
+              to_return(status: 400, body: "",
+                        headers: {})
+        end
+
+        it "should not insert the item" do
+
+          item = @api.timeline.create(@body)
+          item.should be_nil
+        end
+
+      end
+
+    end
+  end
+
+  describe "delete" do
+    context "with valid params" do
+      before do
+        @id = "123123312"
+        stub_request(:delete, "https://www.googleapis.com/mirror/v1/timeline/#{@id}").
+            with(headers: json_get_request_headers(@token)).
+            to_return(status: 200,
+                      body: "",
+                      headers: {})
+      end
+      it "should return true" do
+        @api.timeline.delete(@id).should be_true
+      end
+    end
+
+    context "with invalid params" do
+      before do
+        @id = "blah"
+        stub_request(:delete, "https://www.googleapis.com/mirror/v1/timeline/#{@id}").
+            with(headers: json_get_request_headers(@token)).
+            to_return(status: 400,
+                      body: "",
+                      headers: {})
+      end
+      it "should return nil" do
+        @api.timeline.delete(@id).should == nil
+      end
+
+      it "log the error" do
+        logger = Logger.new(STDOUT)
+        @api.timeline.options[:logger] = logger
+        logger.should_receive(:warn)
+        @api.timeline.delete(@id).should == nil
+      end
+    end
+
+  end
+
+  describe "get" do
+
+    context "with valid params" do
+      before do
+        @id = "0987"
+
+        stub_request(:get, "https://www.googleapis.com/mirror/v1/timeline/#{@id}").
+            with(headers: json_get_request_headers(@token)).
+            to_return(status: 200,
+                      body: fixture("timeline_item.json", true),
+                      headers: {})
+      end
+      it "should return a timeline with .kind == 'mirror#timelineItem'" do
+        timeline_item = @api.timeline.get(@id)
+        timeline_item.kind.should == 'mirror#timelineItem'
+      end
+    end
+
+    context "with invalid params" do
+      before do
+        @id = "bad_id"
+
+        stub_request(:get, "https://www.googleapis.com/mirror/v1/timeline/#{@id}").
+            with(headers: json_get_request_headers(@token)).
+            to_return(status: 404,
+                      body: fixture("timeline_item.json", true),
+                      headers: {})
+      end
+      it "should return nil" do
+        timeline_item = @api.timeline.get(@id)
+        timeline_item.should == nil
+      end
+    end
+
+  end
+
+  describe "list" do
+
+    context "with valid params" do
+      before do
+
+        stub_request(:get, "https://www.googleapis.com/mirror/v1/timeline/").
+            with(headers: json_get_request_headers(@token)).
+            to_return(status: 200,
+                      body: fixture("timeline_list.json", true),
+                      headers: {})
+      end
+
+      it "should return a list of timelines" do
+        timeline = @api.timeline.list()
+        timeline.should_not be_nil
+        timeline.items.count.should == 1  # see fixture
+      end
+    end
+
+  end
+
+  describe "patch" do
+
+    context "with valid params" do
+      before do
+        @id = '1234'
+        @body = {text: "You realize you are a bad friend right?", menu_items:[{action: "REPLY"}]}
+        @body2 = {text: "You realize you are a bad friend right?", menuItems:[{action: "REPLY"}]}
+
+        stub_request(:patch, "https://www.googleapis.com/mirror/v1/timeline/#{@id}").
+            with(body: @body2,
+                 headers: json_post_request_headers(@token, @body2.to_json)).
+            to_return(status: 200,
+                      body: fixture("timeline_item.json", true),
+                      headers: {})
+      end
+      it "should return a timeline item with .kind == 'mirror#timelineItem'" do
+        timeline = @api.timeline.patch(@id, @body)
+        timeline.kind.should == 'mirror#timelineItem'
+      end
+    end
+
+    context "with invalid params" do
+      before do
+        @id = '1234'
+        @body = {derp: 'troll'}
+
+        stub_request(:patch, "https://www.googleapis.com/mirror/v1/timeline/#{@id}").
+            with(body: @body,
+                 headers: json_post_request_headers(@token, @body.to_json)).
+            to_return(status: 400,
+                      body: "",
+                      headers: {})
+      end
+      it "should return nil" do
+        timeline = @api.timeline.patch(@id, @body)
+        timeline.should == nil
+      end
+    end
+
+  end
+
+  describe "update" do
+
+    context "with valid params" do
+      before do
+        @id = '1234'
+        @body = {displayName: 'Demo App'}
+
+        stub_request(:put, "https://www.googleapis.com/mirror/v1/timeline/#{@id}").
+            with(body: @body,
+                 headers: json_post_request_headers(@token, @body.to_json)).
+            to_return(status: 200,
+                      body: fixture("timeline_item.json", true),
+                      headers: {})
+      end
+      it "should return a timeline item with .kind == 'mirror#timelineItem'" do
+        timeline = @api.timeline.update(@id, @body)
+        timeline.kind.should == 'mirror#timelineItem'
+      end
+    end
+
+    context "with invalid params" do
+      before do
+        @id = '1234'
+        @body = {derp: 'troll'}
+
+        stub_request(:put, "https://www.googleapis.com/mirror/v1/timeline/#{@id}").
+            with(body: @body,
+                 headers: json_post_request_headers(@token, @body.to_json)).
+            to_return(status: 400,
+                      body: "",
+                      headers: {})
+      end
+      it "should return nil" do
+        timeline = @api.timeline.update(@id, @body)
+        timeline.should == nil
+      end
+    end
+
+  end
+
+end