mirror-api 0.0.4 → 0.0.5

data/README.md

@@ -1,5 +1,6 @@
-![Travis-ci](https://travis-ci.org/ciberch/mirror-api.png)
-![Code Climate](https://codeclimate.com/github/ciberch/mirror-api.png)
+[![Travis-ci](https://travis-ci.org/ciberch/mirror-api.png)](https://travis-ci.org/ciberch/mirror-api)
+
+[![Code Climate](https://codeclimate.com/github/ciberch/mirror-api.png)](https://codeclimate.com/github/ciberch/mirror-api)
 
 # Mirror::Api
 
@@ -22,20 +23,23 @@ Or install it yourself as:
 ## Usage
 
 ``` ruby
-api = Mirror::Api::Timeline.new(token)
+
+require "mirror-api"
+
+api = Mirror::Api::Client.new(token)
 
 # Getting all the timeline items
-items = api.list
+items = api.timeline.list
 
 # Insert a simple text item - https://developers.google.com/glass/timeline#inserting_a_simple_timeline_item
-item1 = api.create({text: "Hello Word"})
+item1 = api.timeline.create({text: "Hello Word"})
 
 # Inserting an item with reply actions - https://developers.google.com/glass/timeline#user_interaction_with_menu_items
-item2 = api.create({text: "Hello Word", menu_items:[{action: "REPLY"}]})
+item2 = api.timeline.create({text: "Hello Word", menu_items:[{action: "REPLY"}]})
 
-item2 = api.update(item2.id, {text: "Hello Again Word", menu_items:[{action: "REPLY"}]})
+item2 = api.timeline.update(item2.id, {text: "Hello Again Word", menu_items:[{action: "REPLY"}]})
 
-api.delete(item2.id)
+api.timeline.delete(item2.id)
 ```
 
 ## See Also

data/lib/mirror-api/base.rb

@@ -9,7 +9,7 @@ module Mirror
 
       attr_accessor :last_error, :logger, :host, :last_exception, :throw_on_fail, :response, :data, :creds
 
-      def initialize(credentials, throw_on_fail=false, host="https://www.googleapis.com", logger=nil)
+      def initialize(credentials, throw_on_fail=true, host="https://www.googleapis.com", logger=nil)
         @creds = credentials
         @last_exception = nil
         @throw_on_fail = throw_on_fail

data/lib/mirror-api/client.rb

@@ -0,0 +1,26 @@
+require_relative "resource"
+
+module Mirror
+  module Api
+    class Client
+
+      def initialize(credentials)
+        @credentials =  if credentials.is_a?(String)
+                          {:token => credentials}
+                        elsif credentials.is_a?(Hash)
+                          credentials
+                        end
+
+        raise "Invalid credentials #{credentials.inspect}" unless @credentials
+      end
+
+      def timeline
+        @timeline ||= Resource.new(@credentials)
+      end
+
+      def subscriptions
+        @subscriptions ||= Resource.new(@credentials, Request::SUBSCRIPTIONS)
+      end
+    end
+  end
+end

data/lib/mirror-api/request.rb

@@ -0,0 +1,37 @@
+require_relative "base"
+
+module Mirror
+  module Api
+    HOST = "https://www.googleapis.com"
+
+    class Request < Mirror::Api::Base
+      TIMELINE = "timeline"
+      SUBSCRIPTIONS = "subscriptions"
+
+      def initialize(creds, options={})
+        @resource = options[:resource] || TIMELINE
+        @id = options[:id]
+        @params = options[:params]
+        @expected_response = options[:expected_response]
+        host = options[:host] || HOST
+        super(creds, options[:raise_errors], host, options[:logger])
+      end
+
+      def invoke_url
+        @invoke_url ||="#{self.host}/mirror/v1/#{@resource}/#{@id ? @id : ''}"
+      end
+
+      def params
+        @params ||={}
+      end
+
+      def ret_val
+        Hashie::Mash.new(@data)
+      end
+
+      def expected_response
+        @expected_response
+      end
+    end
+  end
+end

data/lib/mirror-api/resource.rb

@@ -0,0 +1,45 @@
+require_relative "request"
+
+module Mirror
+  module Api
+    class Resource
+
+      def initialize(credentials, resource_name=Request::TIMELINE)
+        @credentials =  credentials
+        @resource_name = resource_name
+
+        raise "Invalid credentials #{credentials}" unless @credentials
+      end
+
+      def list(params={})
+        Request.new(@credentials, make_options(params)).get
+      end
+
+      def create(params)
+        Request.new(@credentials, make_options(params, 201)).post
+      end
+
+      def get(id, params=nil)
+        Request.new(@credentials, item_options(id, params)).get
+      end
+
+      def update(id, params)
+        # This may become patch later
+        Request.new(@credentials, item_options(id, params)).put
+      end
+
+      def delete(id)
+        Request.new(@credentials, item_options(id)).delete
+      end
+
+    private
+      def make_options(params=nil, status=200)
+        {: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}
+      end
+    end
+  end
+end

data/lib/mirror-api/version.rb

@@ -1,5 +1,5 @@
 module Mirror
   module Api
-    VERSION = "0.0.4"
+    VERSION = "0.0.5"
   end
 end

data/mirror-api.gemspec

@@ -24,4 +24,5 @@ Gem::Specification.new do |gem|
 
   gem.add_development_dependency "rspec"
   gem.add_development_dependency "webmock"
+  gem.add_development_dependency "simplecov"
 end

data/spec/client_spec.rb

@@ -0,0 +1,65 @@
+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"
+
+           stub_request(:post, "https://www.googleapis.com/mirror/v1/timeline/").
+               with(body: {text: @msg},
+                    headers: json_post_request_headers).
+               to_return(status: 201,
+                         body: fixture("timeline_item.json", true),
+                         headers: JSON.parse(fixture("timeline_item_response_headers.json", true)))
+         end
+
+         it "should insert plain text items", :focus => true 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 = "Hello world"
+
+           # TODO: Verify error code is 422
+           stub_request(:post, "https://www.googleapis.com/mirror/v1/timeline/").
+               with(body: {random: "123"},
+                    headers: json_post_request_headers).
+               to_return(status: 422, body: {}.to_json,
+                         headers: {})
+         end
+
+         it "should not insert the item" do
+
+           item = @api.timeline.create({random: "123"})
+           item.should be_nil
+         end
+       end
+      end
+
+      def json_post_request_headers
+        {
+            'Accept'=>'application/json',
+            'Accept-Encoding'=>'gzip, deflate',
+            'Authorization'=>"Bearer #{@token}",
+            'Content-Length'=>/\d+/,
+            'Content-Type'=>'application/x-www-form-urlencoded',
+            'User-Agent'=>'Ruby'
+        }
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,8 +1,10 @@
+require 'simplecov'
+SimpleCov.start
 require "rspec"
 require 'webmock/rspec'
 require 'webmock'
 
-require_relative "../lib/mirror-api/timeline.rb"
+require_relative "../lib/mirror-api/client.rb"
 
 def fixture_path
   File.expand_path("../fixtures", __FILE__)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mirror-api
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-22 00:00:00.000000000 Z
+date: 2013-04-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -108,6 +108,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Wrapper for Google Glass Mirror API v1
 email:
 - monica@crushpath.com
@@ -125,15 +141,15 @@ files:
 - example/.gitkeep
 - lib/mirror-api.rb
 - lib/mirror-api/base.rb
-- lib/mirror-api/timeline.rb
-- lib/mirror-api/timeline_item_request.rb
-- lib/mirror-api/timeline_request.rb
+- lib/mirror-api/client.rb
+- lib/mirror-api/request.rb
+- lib/mirror-api/resource.rb
 - lib/mirror-api/version.rb
 - mirror-api.gemspec
+- spec/client_spec.rb
 - spec/fixtures/timeline_item.json
 - spec/fixtures/timeline_item_response_headers.json
 - spec/spec_helper.rb
-- spec/timeline_spec.rb
 homepage: https://github.com/ciberch/mirror-api
 licenses: []
 post_install_message: 
@@ -159,7 +175,7 @@ signing_key:
 specification_version: 3
 summary: https://developers.google.com/glass/v1/reference/
 test_files:
+- spec/client_spec.rb
 - spec/fixtures/timeline_item.json
 - spec/fixtures/timeline_item_response_headers.json
 - spec/spec_helper.rb
-- spec/timeline_spec.rb

data/lib/mirror-api/timeline.rb

@@ -1,40 +0,0 @@
-require_relative "timeline_request"
-require_relative "timeline_item_request"
-
-module Mirror
-  module Api
-    class Timeline
-
-      def initialize(credentials)
-        @credentials =  if credentials.is_a?(String)
-          {:token => credentials}
-        elsif credentials.is_a?(Hash)
-          credentials
-        end
-
-        raise "Invalid credentials #{credentials.inspect}" unless @credentials
-      end
-
-      def list(params={})
-        TimelineRequest.new(params, 200, @credentials).get
-      end
-
-      def create(params)
-        TimelineRequest.new(params, 201, @credentials).post
-      end
-
-      def get(id, params=nil)
-        TimelineItemRequest.new(id, params, 200, @credentials).get
-      end
-
-      def update(id, params)
-        # This may become patch later
-        TimelineItemRequest.new(id, params, 200, @credentials).put
-      end
-
-      def delete(id)
-        TimelineItemRequest.new(id, nil, 200, @credentials).delete
-      end
-    end
-  end
-end

data/lib/mirror-api/timeline_item_request.rb

@@ -1,33 +0,0 @@
-require_relative "base"
-
-module Mirror
-  module Api
-    HOST = "https://www.googleapis.com"
-
-    class TimelineItemRequest < Mirror::Api::Base
-
-      def initialize(id, params, expected_response, creds, raise_errors=false, host=Mirror::Api::HOST, logger=nil)
-        @id = id
-        @params = params
-        @expected_response = expected_response
-        super(creds, raise_errors)
-      end
-
-      def invoke_url
-        @invoke_url ||="#{self.host}/mirror/v1/timeline/#{@id}"
-      end
-
-      def params
-        @params ||={}
-      end
-
-      def ret_val
-        Hashie::Mash.new(@data)
-      end
-
-      def expected_response
-        @expected_response
-      end
-    end
-  end
-end

data/lib/mirror-api/timeline_request.rb

@@ -1,32 +0,0 @@
-require_relative "base"
-
-module Mirror
-  module Api
-    HOST = "https://www.googleapis.com"
-
-    class TimelineRequest < Mirror::Api::Base
-
-      def initialize(params, expected_response, creds, raise_errors=false, host=Mirror::Api::HOST, logger=nil)
-        @params = params
-        @expected_response = expected_response
-        super(creds, raise_errors)
-      end
-
-      def invoke_url
-        @invoke_url ||="#{self.host}/mirror/v1/timeline"
-      end
-
-      def params
-        @params ||={}
-      end
-
-      def ret_val
-        Hashie::Mash.new(@data)
-      end
-
-      def expected_response
-        @expected_response
-      end
-    end
-  end
-end

data/spec/timeline_spec.rb

@@ -1,64 +0,0 @@
-require_relative "spec_helper"
-
-describe Mirror::Api::Timeline do
-  before do
-    @token = "my-token"
-    @api = Mirror::Api::Timeline.new(@token)
-  end
-
-  describe "create" do
-    describe "inserting" do
-
-     context "with valid params" do
-       before do
-         @msg = "Hello world"
-
-         stub_request(:post, "https://www.googleapis.com/mirror/v1/timeline").
-             with(body: {text: @msg},
-                  headers: json_post_request_headers).
-             to_return(status: 201,
-                       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.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 = "Hello world"
-
-         # TODO: Verify error code is 422
-         stub_request(:post, "https://www.googleapis.com/mirror/v1/timeline").
-             with(body: {random: "123"},
-                  headers: json_post_request_headers).
-             to_return(status: 422, body: {}.to_json,
-                       headers: {})
-       end
-
-       it "should not insert the item" do
-
-         item = @api.create({random: "123"})
-         item.should be_nil
-       end
-     end
-    end
-
-    def json_post_request_headers
-      {
-          'Accept'=>'application/json',
-          'Accept-Encoding'=>'gzip, deflate',
-          'Authorization'=>"Bearer #{@token}",
-          'Content-Length'=>/\d+/,
-          'Content-Type'=>'application/x-www-form-urlencoded',
-          'User-Agent'=>'Ruby'
-      }
-    end
-  end
-
-end