google-api-middle_man 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5afcff094f5049791c43c3a6c48ca55954b74948
+  data.tar.gz: c9adbbc80576746f427e7f40305dd257a21bb87c
+SHA512:
+  metadata.gz: 68bb54e6e9e0616be530ebefc00f7fdf9a83b7c7328e1cd337333c2f909da80550451630fc22320371173de862b88320d6764e3b94d486bcda7e3f5c3e87b872
+  data.tar.gz: 9d3b175573f860bb175c09d91a0755845816e1962b6c83a2c4714a9891c1268e24a75830b79e814dffa84f3483a40f5c74c018325f1d13d4b8e71252a665430a

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.ruby-version
+

data/.ruby-gemset

@@ -0,0 +1,2 @@
+google-api-middle_man
+

data/.ruby-version.example

@@ -0,0 +1,2 @@
+ruby-2.0.0-p195
+

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in google-api-middle_man.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,23 @@
+Copyright (c) 2013 Shaun Dern
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+

data/README.md

@@ -0,0 +1,29 @@
+# GoogleTravelAgent
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'google-api-middle_man'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install google-api-middle_man
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,15 @@
+#!/usr/bin/env rake
+
+require 'rubygems'
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+desc 'Default: run unit tests.'
+task :default => :spec
+
+desc "Run all specs"
+RSpec::Core::RakeTask.new do |t|
+  t.pattern = 'spec/**/*_spec.rb'
+  t.rspec_opts = '--color'
+ end
+

data/examples/google_calendar_example.rb

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+
+require 'google-api-middle_man'
+
+email = "google_service_account@email"
+calendarId = "google_calendar_id"
+
+google_config = {
+  application_name: "google_project_name",
+  key_location: 'client.p12',
+  google_service_email: email
+}
+
+travel_agent = GoogleAPIMiddleMan::Agent.new(google_config)
+travel_agent.calendar_events(calendar_id)
+

data/google-api-middle_man.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'google-api-middle_man/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "google-api-middle_man"
+  spec.version       = GoogleTravelAgent::VERSION
+  spec.authors       = ["Shaun Dern"]
+  spec.email         = ["shaun@substantial.com"]
+  spec.description   = %q{Simplify the Google API}
+  spec.summary       = %q{Simplify the Google API}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency 'rspec'
+
+  spec.add_dependency "google-api-client", "~> 0.6.3"
+end
+

data/lib/google-api-middle_man/version.rb

@@ -0,0 +1,3 @@
+module GoogleTravelAgent
+  VERSION = "0.0.1"
+end

data/lib/google-api-middle_man.rb

@@ -0,0 +1,64 @@
+require "google-api-middle_man/version"
+
+module GoogleAPIMiddleMan
+  class MissingConfigOptions < Exception; end
+
+  class Agent
+    require 'google/api_client'
+
+    attr_reader :client
+
+    def initialize(config)
+      [:application_name, :key_location, :google_service_email].each do |key|
+        unless config.has_key?(key)
+          raise MissingConfigOptions, "config is missing #{key}"
+        end
+      end
+
+      @application_name = config[:application_name]
+      @key_location = config[:key_location]
+      @google_service_email = config[:google_service_email]
+
+      @client = Google::APIClient.new(application_name: @application_name)
+    end
+
+    def calendar_events(calendar_id)
+      @client.authorization = service_account.authorize
+
+      options = {'calendarId' => calendar_id}
+      result = @client.execute(api_method: calendar_service.events.list, parameters: options)
+
+      result.data
+    end
+
+    private
+
+    def default_scope
+      'https://www.googleapis.com/auth/prediction'
+    end
+
+    def calendar_scope
+      'https://www.googleapis.com/auth/calendar.readonly'
+    end
+
+    def scopes
+      s = []
+      s << default_scope
+      s << calendar_scope
+      s
+    end
+
+    def api_key
+      @api_key ||= Google::APIClient::PKCS12.load_key(@key_location, 'notasecret')
+    end
+
+    def service_account
+      Google::APIClient::JWTAsserter.new(@google_service_email, scopes, api_key)
+    end
+
+    def calendar_service
+      @client.discovered_api('calendar', 'v3')
+    end
+  end
+end
+

data/spec/lib/google-api-middle_man_spec.rb

@@ -0,0 +1,137 @@
+require 'spec_helper'
+
+describe GoogleAPIMiddleMan::Agent do
+
+  let(:google_config) {
+    {
+      application_name: 'Foo App',
+      key_location: 'config/client.p12',
+      google_service_email: 'test@example.com'
+    }
+  }
+
+  before do
+    Google::APIClient.stub(:new) { double.as_null_object }
+  end
+
+  it "should require a configuration object" do
+    expect { GoogleAPIMiddleMan::Agent.new('foo') }.to raise_error
+  end
+
+  it "should require a complete config" do
+    incomplete_config = google_config
+    incomplete_config.delete(:key_location)
+    expect { GoogleAPIMiddleMan::Agent.new(incomplete_config) }.to raise_error GoogleAPIMiddleMan::MissingConfigOptions
+  end
+
+  it "should create a client with the correct application name" do
+    Google::APIClient.should_receive(:new).with(application_name: 'Foo App')
+    GoogleAPIMiddleMan::Agent.new(google_config)
+  end
+
+  describe "#calendar_events" do
+    let(:calendar_hash) { double }
+    let(:travel_agent) { GoogleAPIMiddleMan::Agent.new(google_config) }
+    let(:mock_service_account) { double(authorize: "authorization") }
+
+    before do
+      Google::APIClient.stub(:new) { double(:authorization= => :nil, execute: double(data: calendar_hash))}
+      travel_agent.stub(:api_key) { 'api_key' }
+      travel_agent.stub(:service_account) { mock_service_account }
+      travel_agent.stub(:calendar_service) { c = double
+                                             c.stub_chain(:events, :list) { "events_list_api" }
+                                             c
+      }
+    end
+
+    it "should require a calendar id" do
+      expect { travel_agent.calendar_events }.to raise_error ArgumentError
+    end
+
+    it "should set the client authorization" do
+      travel_agent.client.should_receive(:authorization=).with("authorization")
+      travel_agent.calendar_events('calendar_id')
+    end
+
+    it "should return hash of event info from Google" do
+      travel_agent.calendar_events('calendar_id').should == calendar_hash
+    end
+  end
+
+  describe "private methods" do
+    let(:travel_agent) { GoogleAPIMiddleMan::Agent.new(google_config) }
+
+    describe "scopes" do
+      let(:default_scope) { 'https://www.googleapis.com/auth/prediction' }
+      let(:calendar_scope) { 'https://www.googleapis.com/auth/calendar.readonly' }
+      let(:scopes) { [default_scope, calendar_scope]}
+
+      it "should have a default scope" do
+        travel_agent.send(:default_scope).should == default_scope
+      end
+
+      it "should have a have a calendar_scope" do
+        travel_agent.send(:calendar_scope).should == calendar_scope
+      end
+
+      it "should have a have a scopes" do
+        travel_agent.send(:scopes).should == scopes
+      end
+    end
+
+    describe "#api_key" do
+      before do
+        Google::APIClient::PKCS12.stub(:load_key) { 'some key' }
+      end
+      it "should load a valid api key" do
+        Google::APIClient::PKCS12.should_receive(:load_key).with(google_config[:key_location], 'notasecret')
+        travel_agent.send(:api_key).should == 'some key'
+      end
+
+      it "should memoize the key" do
+        travel_agent.send(:api_key)
+        Google::APIClient::PKCS12.should_not_receive(:load_key)
+        travel_agent.send(:api_key)
+      end
+    end
+
+    describe "#service_account" do
+      let(:mock_service)  { double }
+
+      before do
+        travel_agent.stub(:api_key) { "api_key" }
+        travel_agent.stub(:scopes) { "scopes" }
+        Google::APIClient::JWTAsserter.stub(:new) { mock_service }
+      end
+
+      it "should return a new google service account" do
+        Google::APIClient::JWTAsserter.should_receive(:new).with(
+          google_config[:google_service_email],
+          "scopes",
+          "api_key"
+        )
+        travel_agent.send(:service_account).should == mock_service
+      end
+    end
+
+    describe "#calendar_service" do
+
+      let(:mock_calendar_service) { double }
+
+      before do
+        travel_agent.client.stub(:discovered_api) { mock_calendar_service }
+      end
+
+      it "should return a calendar service" do
+        travel_agent.send(:calendar_service).should == mock_calendar_service
+      end
+
+      it "should discover calendar endpoint" do
+        travel_agent.client.should_receive(:discovered_api).with('calendar', 'v3')
+        travel_agent.send(:calendar_service)
+      end
+    end
+  end
+
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+require 'bundler'
+Bundler.setup
+
+SPEC_ROOT = File.dirname(__FILE__)
+
+RSpec.configure do |config|
+  config.mock_with :rspec
+end
+
+Dir[File.join(SPEC_ROOT, '../lib/**/*.rb')].each{ |file| require file }
+

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: google-api-middle_man
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Shaun Dern
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: google-api-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.3
+description: Simplify the Google API
+email:
+- shaun@substantial.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .ruby-gemset
+- .ruby-version.example
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- examples/google_calendar_example.rb
+- google-api-middle_man.gemspec
+- lib/google-api-middle_man.rb
+- lib/google-api-middle_man/version.rb
+- spec/lib/google-api-middle_man_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Simplify the Google API
+test_files:
+- spec/lib/google-api-middle_man_spec.rb
+- spec/spec_helper.rb