mirror-api 0.0.9 → 0.1.0

data/lib/mirror-api/request_data.rb

@@ -0,0 +1,11 @@
+require "hashie/mash"
+
+module Mirror
+  module Api
+    class RequestData < Hashie::Mash
+      def convert_key(key) #:nodoc:
+        key.to_s.split('_').inject([]){ |buffer,e| buffer.push(buffer.empty? ? e : e.capitalize) }.join
+      end
+    end
+  end
+end

data/lib/mirror-api/resource.rb

@@ -4,16 +4,18 @@ module Mirror
   module Api
     class Resource
 
-      def initialize(credentials, resource_name=Request::TIMELINE)
+      attr_accessor :options
+
+      def initialize(credentials, resource_name=Request::TIMELINE, options={})
         @credentials =  credentials
         @resource_name = resource_name
+        self.options = options || {}
 
         raise "Invalid credentials #{credentials}" unless @credentials
       end
 
       def list(*args)
         handle_list(args)
-        
       end
 
       def create(params)
@@ -40,11 +42,20 @@ module Mirror
 
     private
       def make_options(params=nil, status=200)
-        {:resource => @resource_name, :params => params, :expected_response => status}
+        options.merge({
+            :resource => @resource_name,
+            :params => params,
+            :expected_response => status
+        })
       end
 
       def item_options(id, params=nil, status=200)
-        {:resource => @resource_name, :id => id, :params => params, :expected_response => status}
+        options.merge({
+            :resource => @resource_name,
+            :id => id,
+            :params => params,
+            :expected_response => status
+        })
       end
 
       def handle_list(args)

data/lib/mirror-api/response_data.rb

@@ -0,0 +1,15 @@
+require "hashie/mash"
+
+module Mirror
+  module Api
+    class ResponseData < Hashie::Mash
+      def convert_key(key) #:nodoc:
+        key.to_s.gsub(/::/, '/').
+            gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+            gsub(/([a-z\d])([A-Z])/,'\1_\2').
+            tr("-", "_").
+            downcase
+      end
+    end
+  end
+end

data/lib/mirror-api/version.rb

@@ -1,5 +1,5 @@
 module Mirror
   module Api
-    VERSION = "0.0.9"
+    VERSION = "0.1.0"
   end
 end

data/spec/client_spec.rb

@@ -3,481 +3,32 @@ require_relative "spec_helper"
 describe Mirror::Api::Client do
   before do
     @token = "my-token"
-    @api = Mirror::Api::Client.new(@token)
   end
 
-  describe "timeline" do
-    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(@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
-       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(@body.to_json)).
-               to_return(status: 400, body: {}.to_json,
-                         headers: {})
-         end
-
-         it "should not insert the item" do
-
-           item = @api.timeline.create(@body)
-           item.should be_nil
-         end
-
-       end
-
-      end
+  describe "initializing" do
+    it "should take the token as a string" do
+      @api = Mirror::Api::Client.new(@token)
+      @api.should_not be_nil
+      @api.credentials[:token].should == @token
     end
-  end
-
-  describe "locations" do
-   
-    describe "get" do
 
-      context "with valid params" do
-        before do
-          @id = "0987"
-
-          stub_request(:get, "https://www.googleapis.com/mirror/v1/locations/#{@id}").
-                  with(headers: json_get_request_headers).
-             to_return(status: 200,
-                       body: fixture("locations_item.json", true),
-                       headers: {})
-        end
-
-        it "should get the location for @id" do
-          location = @api.locations.get(@id)
-          location.should_not be_nil
-          location.displayName.should == "Home"  # see fixture
-        end
-      end
-
-      context "with invalid params" do
-        before do
-          @id = "0987asdasds"
-
-          stub_request(:get, "https://www.googleapis.com/mirror/v1/locations/").
-            with(headers: json_get_request_headers).
-              to_return(status: 404, body: {}.to_json,
-                         headers: {})
-
-        end
-
-        it "should not get the item" do
-
-          item = @api.timeline.get(@id)
-          item.should be_nil
-        end
-      end 
+    it "should take the credentials hash" do
+      hash = {:token => @token}
+      @api = Mirror::Api::Client.new(hash)
+      @api.should_not be_nil
+      @api.credentials.should == hash
     end
 
-    describe "list" do
-
-      context "with valid params" do
-        before do
-
-          stub_request(:get, "https://www.googleapis.com/mirror/v1/locations/").
-                  with(headers: json_get_request_headers).
-                    to_return(status: 200,
-                       body: fixture("locations_list.json", true),
-                       headers: {})
-        end
-
-        it "should return a list of locations" do
-          locations = @api.locations.list()
-          locations.should_not be_nil
-          locations.items.count.should == 2  # see fixture
-        end
-      end
+    it "should raise an error if invalid params" do
+      expect{@api = Mirror::Api::Client.new(nil)}.to raise_error "Invalid credentials. Missing token"
     end
   end
 
-  describe "contacts" do
-
-    describe "delete" do
-      context "with valid params" do
-        before do
-          @id = "123123312"
-          stub_request(:delete, "https://www.googleapis.com/mirror/v1/contacts/#{@id}").
-                  with(headers: json_get_request_headers).
-             to_return(status: 200,
-                       body: {},
-                       headers: {})
-        end
-        it "should return nil" do
-          contact = @api.contacts.delete(@id)
-          contact.should == nil
-        end
-      end
-
-      context "with invalid params" do
-        before do
-          @id = "blah"
-          stub_request(:delete, "https://www.googleapis.com/mirror/v1/contacts/#{@id}").
-                  with(headers: json_get_request_headers).
-             to_return(status: 400,
-                       body: {},
-                       headers: {})
-        end
-        it "should return nil" do
-          contact = @api.contacts.delete(@id)
-          contact.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/contacts/#{@id}").
-                  with(headers: json_get_request_headers).
-             to_return(status: 200,
-                       body: fixture("contacts_item.json", true),
-                       headers: {})
-        end
-        it "should return a contact with .kind == 'mirror#contact'" do
-          contact = @api.contacts.get(@id)
-          contact.kind.should == 'mirror#contact'
-        end
-      end
-
-      context "with invalid params" do
-        before do
-          @id = "bad_id"
-
-          stub_request(:get, "https://www.googleapis.com/mirror/v1/contacts/#{@id}").
-                  with(headers: json_get_request_headers).
-             to_return(status: 404,
-                       body: fixture("contacts_item.json", true),
-                       headers: {})
-        end
-        it "should return nil" do
-          contact = @api.contacts.get(@id)
-          contact.should == nil
-        end
-      end
-
+  describe "methods" do
+    it "should have methods that match the mirror api" do
+      @api = Mirror::Api::Client.new(@token)
+      @api.methods.should include(:timeline, :locations, :subscriptions, :contacts)
     end
-
-    describe "insert" do
-
-      context "with valid params" do
-        before do
-           @body = {id: '1234', displayName: 'Demo App', imageUrls: ["http://pixelr3ap3r.com/wp-content/uploads/2012/08/357c6328ee4b11e1bfbf22000a1c91a7_7.jpg"]}
-
-           stub_request(:post, "https://www.googleapis.com/mirror/v1/contacts/").
-               with(body: @body,
-                    headers: json_post_request_headers(@body.to_json)).
-               to_return(status: 200,
-                         body: fixture("contacts_item.json", true),
-                         headers: {})
-        end
-        it "should return a contact with .kind == 'mirror#contact'" do
-          contact = @api.contacts.insert(@body)
-          contact.kind.should == 'mirror#contact'
-        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(@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
-
-    describe "list" do
-
-      context "with valid params" do
-        before do
-
-          stub_request(:get, "https://www.googleapis.com/mirror/v1/contacts/").
-                  with(headers: json_get_request_headers).
-                    to_return(status: 200,
-                       body: fixture("contacts_list.json", true),
-                       headers: {})
-        end
-
-        it "should return a list of contacts" do
-          contacts = @api.contacts.list()
-          contacts.should_not be_nil
-          contacts.items.count.should == 2  # see fixture
-        end
-      end
-
-    end
-
-    describe "patch" do
-
-      context "with valid params" do
-        before do
-          @id = '1234'
-          @body = {displayName: 'Demo App'}
-
-           stub_request(:patch, "https://www.googleapis.com/mirror/v1/contacts/#{@id}").
-               with(body: @body,
-                    headers: json_post_request_headers(@body.to_json)).
-               to_return(status: 200,
-                         body: fixture("contacts_item.json", true),
-                         headers: {})
-        end
-        it "should return a contact with .kind == 'mirror#contact'" do
-          contact = @api.contacts.patch(@id, @body)
-          contact.kind.should == 'mirror#contact'
-        end
-      end
-
-      context "with invalid params" do
-        before do
-          @id = '1234'
-          @body = {derp: 'troll'}
-
-           stub_request(:patch, "https://www.googleapis.com/mirror/v1/contacts/#{@id}").
-               with(body: @body,
-                    headers: json_post_request_headers(@body.to_json)).
-               to_return(status: 400,
-                         body: {},
-                         headers: {})
-        end
-        it "should return nil" do
-          contact = @api.contacts.patch(@id, @body)
-          contact.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/contacts/#{@id}").
-               with(body: @body,
-                    headers: json_post_request_headers(@body.to_json)).
-               to_return(status: 200,
-                         body: fixture("contacts_item.json", true),
-                         headers: {})
-        end
-        it "should return a contact with .kind == 'mirror#contact'" do
-          contact = @api.contacts.update(@id, @body)
-          contact.kind.should == 'mirror#contact'
-        end
-      end
-
-      context "with invalid params" do
-        before do
-          @id = '1234'
-          @body = {derp: 'troll'}
-
-           stub_request(:put, "https://www.googleapis.com/mirror/v1/contacts/#{@id}").
-               with(body: @body,
-                    headers: json_post_request_headers(@body.to_json)).
-               to_return(status: 400,
-                         body: {},
-                         headers: {})
-        end
-        it "should return nil" do
-          contact = @api.contacts.update(@id, @body)
-          contact.should == nil
-        end
-      end
-
-    end
-
-  end
-
-  describe "timeline attachments" do
-    
-    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).
-             to_return(status: 200,
-                       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
-
-      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).
-             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).
-             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
-      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).
-             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(@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(@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).
-                    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
-
-  def json_post_request_headers(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
-    {
-        'Accept'=>'application/json',
-        'Accept-Encoding'=>'gzip, deflate',
-        'Authorization'=>"Bearer #{@token}",
-        'Content-Type'=>'application/json',
-        'User-Agent'=>'Ruby'
-    }
   end
 
 end