mirror-api 0.0.1 → 0.0.2

data/.rspec

@@ -0,0 +1 @@
+--colour

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 1.9.2

data/README.md

@@ -1,6 +1,6 @@
 # Mirror::Api
 
-Mirror API client
+Simple Mirror Api client library
 
 ## Installation
 
@@ -19,16 +19,28 @@ Or install it yourself as:
 ## Usage
 
 ``` ruby
+api = Mirror::Api::Timeline.new(token)
+
+# Getting all the timeline items
+items = api.list
 
 # Insert a simple text item - https://developers.google.com/glass/timeline#inserting_a_simple_timeline_item
-timeline_api = Mirror::Api::Timeline.new({:token => access_token})
-item = timeline_api.post({:text => "Hello Word"})
+item1 = api.create({text: "Hello Word"})
 
 # Inserting an item with reply actions - https://developers.google.com/glass/timeline#user_interaction_with_menu_items
-item2 = timeline_api.post({:text => "Hello Word", :menu_items => [{:action => "REPLY"}]})
+item2 = api.create({text: "Hello Word", menu_items:[{action: "REPLY"}]})
+
+item2 = api.update(item2.id, {text: "Hello Again Word", menu_items:[{action: "REPLY"}]})
 
+api.delete(item2.id)
 ```
 
+## See Also
+
+Generic Google API Ruby Client
+
+https://github.com/google/google-api-ruby-client
+
 ## Contributing
 
 1. Fork it

data/Rakefile

@@ -1 +1,4 @@
 require "bundler/gem_tasks"
+
+
+require 'rake/testtask'

data/lib/mirror-api/base.rb

@@ -1,3 +1,7 @@
+require "rest-client"
+require "json"
+require "hashie/mash"
+
 module Mirror
   module Api
 
@@ -5,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, logger=nil)
+      def initialize(credentials, throw_on_fail=false, host="https://www.googleapis.com", logger=nil)
         @creds = credentials
         @last_exception = nil
         @throw_on_fail = throw_on_fail
@@ -41,15 +45,22 @@ module Mirror
         @request = request
         case response.code
           when 422
-            @logger.error("ERROR - Rejected #{request.inspect} to #{self.invoke_url} with params #{self.params}. Response is #{response.body}")
+            if @logger
+              msg = "ERROR - Rejected #{request.inspect} to #{self.invoke_url} with params #{self.params}. Response is #{response.body}"
+              @logger.error(msg)
+            end
             response
           else
             response.return!(request, result, &block)
         end
       end
 
+      def expected_response
+        200
+      end
+
       def successful_response?
-        @response and @response.code == 200
+        @response and @response.code == expected_response
       end
 
       def ret_val
@@ -57,13 +68,11 @@ module Mirror
       end
 
       def headers
-        if @creds and @creds['token']
-          {
-              "Accept" => "application/json",
-              "Content-type" => "application/json",
-              "Authorization" => "Bearer #{@creds['token']}"
-          }
-        end
+        {
+            "Accept" => "application/json",
+            "Content-type" => "application/json",
+            "Authorization" => "Bearer #{@creds[:token]}"
+        }
       end
 
       def handle_response
@@ -86,7 +95,7 @@ module Mirror
       def handle_exception(error_desc, msg, ex, params={})
         @last_exception = ex
         @last_error = error_desc
-        msg += " with params #{params}" if params.keys.count > 0
+        msg += " with params #{params}" if params && params.keys.count > 0
         msg += " due to #{ex}.\n" + ex.backtrace.join("\n")
         @logger.error(msg) if @logger
 

data/lib/mirror-api/timeline.rb

@@ -1,18 +1,40 @@
+require_relative "timeline_request"
+require_relative "timeline_item_request"
+
 module Mirror
   module Api
-    class Timeline < Mirror::Api::Base
+    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 invoke_url
-        @invoke_url ||="#{self.host}/mirror/v1/timeline"
+      def get(id, params=nil)
+        TimelineItemRequest.new(id, params, 200, @credentials).get
       end
 
-      def params
-        @params
+      def update(id, params)
+        # This may become patch later
+        TimelineItemRequest.new(id, params, 200, @credentials).put
       end
 
-      def successful_response?
-        @response and @response.code == 201
+      def delete(id)
+        TimelineItemRequest.new(id, nil, 200, @credentials).delete
       end
     end
   end
-end
+end

data/lib/mirror-api/timeline_item_request.rb

@@ -0,0 +1,33 @@
+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

@@ -0,0 +1,32 @@
+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/lib/mirror-api/version.rb

@@ -1,5 +1,5 @@
 module Mirror
   module Api
-    VERSION = "0.0.1"
+    VERSION = "0.0.2"
   end
 end

data/mirror-api.gemspec

@@ -6,11 +6,11 @@ require 'mirror-api/version'
 Gem::Specification.new do |gem|
   gem.name          = "mirror-api"
   gem.version       = Mirror::Api::VERSION
-  gem.authors       = ["Monica Wilkinson"]
-  gem.email         = ["ciberch@gmail.com"]
+  gem.authors       = ["Monica Wilkinson", "Drew Baumann"]
+  gem.email         = ["monica@crushpath.com"]
   gem.description   = %q{Wrapper for Google Glass Mirror API v1}
   gem.summary       = %q{https://developers.google.com/glass/v1/reference/}
-  gem.homepage      = ""
+  gem.homepage      = "https://github.com/ciberch/mirror-api"
 
   gem.files         = `git ls-files`.split($/)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
@@ -18,4 +18,9 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
 
   gem.add_dependency "rest-client"
+  gem.add_runtime_dependency "hashie"
+  gem.add_runtime_dependency "json"
+
+  gem.add_development_dependency "rspec"
+  gem.add_development_dependency "webmock"
 end

data/spec/fixtures/timeline_item.json

@@ -0,0 +1,9 @@
+{
+    "kind": "glass#timelineItem",
+    "id": "1234567890",
+    "selfLink": "https://www.googleapis.com/mirror/v1/timeline/1234567890",
+    "created": "2012-09-25T23:28:43.192Z",
+    "updated": "2012-09-25T23:28:43.192Z",
+    "etag": "\"G5BI0RWvj-0jWdBrdWrPZV7xPKw/t25selcGS3uDEVT6FB09hAG-QQ\"",
+    "text": "Hello world"
+}

data/spec/fixtures/timeline_item_response_headers.json

@@ -0,0 +1,5 @@
+{
+    "Date" : "Tue, 25 Sep 2012 23:30:11 GMT",
+    "Content-Type" : "application/json",
+    "Content-Length" : 303
+}

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+require "rspec"
+require 'webmock/rspec'
+require 'webmock'
+
+require_relative "../lib/mirror-api/timeline.rb"
+
+def fixture_path
+  File.expand_path("../fixtures", __FILE__)
+end
+
+def fixture(file, read=false)
+  file = File.new(fixture_path + '/' + file)
+  return File.read(file) if read
+  file
+end

data/spec/timeline_spec.rb

@@ -0,0 +1,64 @@
+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

metadata

@@ -1,11 +1,12 @@
 --- !ruby/object:Gem::Specification
 name: mirror-api
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
 - Monica Wilkinson
+- Drew Baumann
 autorequire: 
 bindir: bin
 cert_chain: []
@@ -27,14 +28,80 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  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:
-- ciberch@gmail.com
+- monica@crushpath.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .rspec
+- .travis.yml
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -43,9 +110,15 @@ files:
 - 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/version.rb
 - mirror-api.gemspec
-homepage: ''
+- 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: 
 rdoc_options: []
@@ -69,4 +142,8 @@ rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: https://developers.google.com/glass/v1/reference/
-test_files: []
+test_files:
+- spec/fixtures/timeline_item.json
+- spec/fixtures/timeline_item_response_headers.json
+- spec/spec_helper.rb
+- spec/timeline_spec.rb