google-api 0.0.1.alpha

data/.gitignore

@@ -0,0 +1,7 @@
+*.gem
+.bundle
+.DS_Store
+.rvmrc
+Gemfile.lock
+coverage/
+pkg/*

data/.rspec

@@ -0,0 +1,2 @@
+--colour
+--format documentation

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## v0.0.1.alpha (2012-08-21) ##
+
+* First release. (be careful!)

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Alex Robbin
+
+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,79 @@
+**This gem is not yet released! Proceed at your own risk...**
+
+Google API
+===================
+
+A simple but powerful ruby API wrapper for Google's services.
+
+Installation
+-------
+
+Add this line to your application's Gemfile:
+
+    gem 'google-api'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install google-api
+
+
+Before Using this Gem
+-------
+
+Google API depends on you to authenticate each user with Google via OAuth2. We don't really care how you get authenticated, but you must request access to a User's Google account and save the Refresh Token, Access Token, and Access Token Expiration Date.
+
+As a starting point, we recommend using Omniauth for most authentication with Ruby. It is a great gem, and integrates seemlessly with most SSO sites, including Google. Check out the [Wiki](https://github.com/agrobbin/google-api/wiki/Using-Omniauth-for-Authentication) for more information.
+
+Usage
+-------
+
+This gem couldn't be easier to set up. Once you have a Client ID and Secret from Google (check out the [Wiki](https://github.com/agrobbin/google-api/wiki/Getting-a-Client-ID-and-Secret-from-Google) for instructions on how to get these), you just need to add an initializer to your Rails application that looks like this:
+
+```ruby
+GoogleAPI.configure do |config|
+  config.client_id = '[CLIENT ID]'
+  config.client_secret = '[Client SECRET]'
+end
+```
+
+We make it easy to set up an object as 'Google API Ready', giving you a couple of conveniences. For starters, if you have a User model, add the OAuth2 fields to your database migration:
+
+```ruby
+create_table :users do |t|
+  t.string :email_address, :first_name, :last_name
+  t.oauthable
+  t.timestamps
+end
+```
+
+...and methods to the Model:
+
+```ruby
+class User < ActiveRecord::Base
+
+  oauthable
+
+end
+```
+
+Once you have set that up, making a request to the Google API is as simple as:
+
+```ruby
+user = User.find(1)
+client = GoogleAPI::Client.new(user)
+client.drive.all
+```
+
+This will fetch all files and folders in the user's Google Drive and return them in an array of hashes.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,5 @@
+#!/usr/bin/env rake
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new('spec')

data/google-api.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+Gem::Specification.new do |gem|
+  gem.authors       = ["Alex Robbin"]
+  gem.email         = ["alex@robbinsweb.biz"]
+  gem.summary       = %q{A simple but powerful ruby API wrapper for Google's services.}
+  gem.description   = gem.summary
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "google-api"
+  gem.require_paths = ["lib"]
+  gem.version       = "0.0.1.alpha"
+
+  gem.add_runtime_dependency 'oauth2', '0.8.0'
+  gem.add_runtime_dependency 'rails', '>= 3.2'
+  gem.add_development_dependency 'bundler'
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'simplecov'
+end

data/lib/google-api/active_record_inclusions.rb

@@ -0,0 +1,89 @@
+# Adapted from Paperclip's implementation of available migration methods
+# https://github.com/thoughtbot/paperclip/blob/v3.1.4/lib/paperclip/schema.rb
+
+module GoogleAPI
+  module ActiveRecordInclusions
+
+    def self.included(base)
+      base.extend ClassMethods
+      base.send :include, Migrations
+    end
+
+    module ClassMethods
+
+      def oauthable
+        define_method :oauth_hash do
+          {
+            access_token: oauth_access_token,
+            refresh_token: oauth_refresh_token,
+            expires_at: oauth_access_token_expires_at
+          }
+        end
+
+        define_method :update_access_token! do |access_token|
+          self.oauth_access_token = access_token
+          self.oauth_access_token_expires_at = 59.minutes.from_now
+          self.save
+        end
+      end
+
+    end
+
+    module Migrations
+
+      COLUMNS = {
+        oauth_refresh_token: :string,
+        oauth_access_token: :string,
+        oauth_access_token_expires_at: :datetime
+      }
+
+      def self.included(base)
+        ActiveRecord::ConnectionAdapters::Table.send :include, TableDefinition
+        ActiveRecord::ConnectionAdapters::TableDefinition.send :include, TableDefinition
+        ActiveRecord::ConnectionAdapters::AbstractAdapter.send :include, Statements
+        ActiveRecord::Migration::CommandRecorder.send :include, CommandRecorder
+      end
+
+      module TableDefinition
+
+        def oauthable
+          COLUMNS.each do |name, type|
+            column(name, type)
+          end
+        end
+
+      end
+
+      module Statements
+
+        def add_oauthable
+          COLUMNS.each do |name, type|
+            add_column(name, type)
+          end
+        end
+
+        def remove_oauthable
+          COLUMNS.each do |name, type|
+            remove_column(name, type)
+          end
+        end
+
+      end
+
+      module CommandRecorder
+
+        def add_oauth
+          record(:add_oauthable)
+        end
+
+        private
+          def invert_add_oauth
+            [:remove_oauthable]
+          end
+
+      end
+
+    end
+
+  end
+end

data/lib/google-api/api/calendar.rb

@@ -0,0 +1,44 @@
+module GoogleAPI
+  class Calendar < API
+
+    ENDPOINT = 'https://www.googleapis.com/calendar/v3'
+
+    # Fetch all calendars for a particular user, returning an array of calendar hashes.
+    def all
+      response = get('/users/me/calendarList')
+      response['items']
+    end
+
+    # Fetch a particular calendar based on the ID, returning a calendar hash.
+    def find(id)
+      get("/users/me/calendarList/#{id}")
+    end
+
+    # Delegates to #find, checking if the particular calendar exists.
+    def exists?(id)
+      find(id)['kind'].present?
+    end
+
+    # Create a calendar for a particular user, returning a calendar hash.
+    def create(calendar)
+      post('/calendars', body: calendar)
+    end
+
+    # Destroy a particular calendar based on the ID, returning true if successful.
+    def destroy(id)
+      delete("/calendars/#{id}")
+    end
+
+    private
+      def parse_calendar(response)
+        {
+          id: response['selfLink'],
+          title: response['title'],
+          updated_at: DateTime.parse(response['updated']),
+          details: response['details'],
+          eventFeed: response['eventFeedLink']
+        }
+      end
+
+  end
+end

data/lib/google-api/api/drive.rb

@@ -0,0 +1,53 @@
+module GoogleAPI
+  class Drive < API
+
+    ENDPOINT = 'https://www.googleapis.com/drive/v2'
+
+    # Fetch all files and folders for a particular user, returning an array of file/folder hashes.
+    def all
+      response = get('/files')
+      response['items']
+    end
+
+    # Fetch a particular file/folder based on the ID, returning a file/folder hash.
+    def find(id)
+      get("/files/#{id}")
+    end
+
+    # Delegates to #find, checking if the particular file/folder exists.
+    def exists?(id)
+      find(id)['kind'].present?
+    end
+
+    # Create a file/folder for a particular user, returning a file/folder hash.
+    # When you want to upload a file, pass a secondary parameter with the path to the file.
+    def create(object, file_path = nil)
+      response = if file_path
+        # Upload a file
+        upload('/files', object, file_path)
+      else
+        # Create a folder
+        object[:mimeType] = 'application/vnd.google-apps.folder'
+        post('/files', body: object)
+      end
+      response
+    end
+
+    # Destroy a particular file/folder based on the ID, returning true if successful.
+    def destroy(id)
+      delete("/files/#{id}")
+    end
+
+    private
+      def parse_object(response)
+        {
+          id: response['selfLink'],
+          title: response['title'],
+          updated_at: DateTime.parse(response['updated']),
+          details: response['details'],
+          eventFeed: response['eventFeedLink']
+        }
+      end
+
+  end
+end

data/lib/google-api/api.rb

@@ -0,0 +1,110 @@
+module GoogleAPI
+  class API
+
+    FORMAT = :json
+
+    attr_reader :access_token
+
+    def initialize(access_token)
+      @access_token = access_token
+    end
+
+    # The really important part of this parent class. The headers are injected here,
+    # and the full URL is built from the ENDPOINT constant and the value passed thru
+    # the URL parameter.
+    #
+    # The response is then returned, and appropriately parsed.
+    def request(method, url = nil, args = {})
+      args[:headers] = headers.merge(args[:headers] || {})
+      args[:body] = args[:body].send("to_#{format}") if args[:body].is_a?(Hash)
+
+      url.prepend(self.class::ENDPOINT) unless URI(url).scheme
+
+      # Adopt Google's API erorr handling recommendation here:
+      # https://developers.google.com/drive/manage-uploads#exp-backoff
+      #
+      # In essence, we try 5 times to perform the request. With each subsequent request,
+      # we wait 2^n seconds plus a random number of milliseconds (no greater than 1 second)
+      # until either we receive a successful response, or we run out of attempts.
+      # If the Retry-After header is in the error response, we use whichever happens to be
+      # greater, our calculated wait time, or the value in the Retry-After header.
+      attempt = 0
+      while attempt < 5
+        response = access_token.send(method, url, args)
+        break unless response.status >= 500
+        seconds_to_wait = [((2 ** attempt) + rand), response.headers['Retry-After'].to_i].max
+        attempt += 1
+        puts "#{attempt.ordinalize} request attempt failed. Trying again in #{seconds_to_wait} seconds..."
+        sleep seconds_to_wait
+      end
+
+      if response.body.present?
+        case format
+        when :json
+          JSON.parse(response.body)
+        when :xml
+          Nokogiri::XML(response.body)
+        end
+      else
+        response
+      end
+    end
+
+    # Shortcut methods to easily execute a HTTP request with any of the below HTTP verbs.
+    [:get, :post, :put, :patch, :delete].each do |method|
+      define_method method do |url = nil, args = {}|
+        request(method, url, args)
+      end
+    end
+
+    # Build a resumable upload request that then delegates to #post and #put with the correct
+    # headers for each request.
+    #
+    # The initial POST request initiates the upload process, passing the metadata for the file.
+    # The response from the API includes a Location header telling us where to actually send the
+    # file we want uploaded. The subsequent PUT request sends the file itself to the API.
+    def upload(url, object, file_path)
+      object[:mimeType] = MIME::Types.type_for(file_path).first.to_s
+      file = File.read(file_path)
+
+      response = post(build_upload_url(url), body: object, headers: {'X-Upload-Content-Type' => object[:mimeType]})
+      put(response.headers['Location'], body: file, headers: {'Content-Type' => object[:mimeType], 'Content-Length' => file.bytesize.to_s})
+    end
+
+    private
+      # Each class that inherits from this API class can have GDATA_VERSION set as a constant.
+      # This is then passed on to each request if present to dictate which version of Google's
+      # API we intend to use.
+      def version
+        self.class::GDATA_VERSION rescue nil
+      end
+
+      # By default we use JSON as the format we pass to Google and get back from Google. To override
+      # this default setting, each class that inherits from this API class can have FORMAT set as
+      # a constant. The only other possible value can be XML.
+      def format
+        raise ArgumentError, "#{self.class} has FORMAT set to #{self.class::FORMAT}, which is not :json or :xml" unless [:json, :xml].include?(self.class::FORMAT)
+        self.class::FORMAT
+      end
+
+      # Build the header hash for the request. If #version is set, we pass that as GData-Version,
+      # and if #format is set, we pass that as Content-Type.
+      def headers
+        headers = {}
+        headers['GData-Version'] = version if version
+        headers['Content-Type'] = case format
+        when :json
+          'application/json'
+        when :xml
+          'application/atom+xml'
+        end
+        return headers
+      end
+
+      def build_upload_url(url)
+        path = URI(self.class::ENDPOINT).path
+        "https://www.googleapis.com/upload#{path}#{url}?uploadType=resumable"
+      end
+
+  end
+end

data/lib/google-api/client.rb

@@ -0,0 +1,63 @@
+module GoogleAPI
+  class Client
+
+    attr_reader :object
+
+    # This is where the magic happens. All methods are based off of a new Client object.
+    # Before we go anywhere else, however, we must make sure that the object passed to the
+    # #new method is oauthable. If not, raise an error telling the user.
+    def initialize(object)
+      @object = object
+
+      raise NoMethodError, "GoogleAPI::Client must be passed an object that is to oauthable. #{object.class.name} is not oauthable." unless object.class.respond_to?(:oauthable)
+    end
+
+    # Build an AccessToken object from OAuth2. Check if the access token is expired, and if so,
+    # refresh it and save the new access token returned from Google.
+    def access_token
+      @access_token ||= ::OAuth2::AccessToken.new(client, oauth_hash[:access_token], oauth_hash.except(:access_token))
+      if @access_token.expired?
+        puts "Access Token expired, refreshing..."
+        @access_token = @access_token.refresh!
+        object.update_access_token!(@access_token.token)
+      end
+
+      @access_token
+    end
+
+    # Build the oauth_hash used to build the AccessToken object above. If any of the values
+    # are nil?, we raise an error and tell the user.
+    def oauth_hash
+      unless @oauth_hash
+        hash = object.oauth_hash.dup
+        hash[:expires_at] = hash[:expires_at].to_i if hash[:expires_at].present?
+        raise ArgumentError, "#{object.class.name} does not appeared to be OAuth2 authenticated. GoogleAPI requires :oauth_access_token, :oauth_request_token, and :oauth_access_token_expires_at to be present." unless hash.values.all?
+      end
+
+      @oauth_hash ||= hash
+    end
+
+    # Build the OAuth2::Client object to be used when building an AccessToken.
+    def client
+      puts "Creating the OAuth2::Client object..." unless @client
+      @client ||= ::OAuth2::Client.new(GoogleAPI.client_id, GoogleAPI.client_secret,
+        site: 'https://accounts.google.com',
+        token_url: '/o/oauth2/token',
+        raise_errors: false
+      )
+    end
+
+    # Each API that Google offers us is instantiated within its own method below.
+    # If you want to find all calendars for a user, you would do this:
+    #
+    #   GoogleAPI::Client.new(User.first).calendar.all
+    #
+    # See GoogleAPI::Calendar for more information about the Calendar API.
+    %w(calendar drive).each do |api|
+      define_method api do
+        "GoogleAPI::#{api.capitalize}".constantize.new(access_token)
+      end
+    end
+
+  end
+end

data/lib/google-api/railtie.rb

@@ -0,0 +1,14 @@
+# Adapted from Paperclip's implementation of available migration methods
+# https://github.com/thoughtbot/paperclip/blob/v3.1.4/lib/paperclip/railtie.rb
+
+require 'google-api/active_record_inclusions'
+
+module GoogleAPI
+  class Railtie < Rails::Railtie
+
+    initializer "google_api.configure_rails_initialization" do |app|
+      ActiveRecord::Base.send(:include, ActiveRecordInclusions)
+    end
+
+  end
+end

data/lib/google-api.rb

@@ -0,0 +1,24 @@
+require 'google-api/api'
+require 'google-api/api/calendar'
+require 'google-api/api/drive'
+require 'google-api/client'
+require 'google-api/railtie'
+
+module GoogleAPI
+
+  # This enables us to easily pass the client_id and client_secret from the Rails
+  # app with a GoogleAPI.configure block. See the README for more information.
+  # Loosely adapted from Twitter's configuration capabilities.
+  # https://github.com/sferik/twitter/blob/v3.6.0/lib/twitter/configurable.rb
+  class << self
+
+    attr_accessor :client_id, :client_secret
+
+    def configure
+      yield self
+      self
+    end
+
+  end
+
+end

metadata

@@ -0,0 +1,159 @@
+--- !ruby/object:Gem::Specification
+name: google-api
+version: !ruby/object:Gem::Version
+  version: 0.0.1.alpha
+  prerelease: 6
+platform: ruby
+authors:
+- Alex Robbin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-08-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: oauth2
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: rake
+  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: 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: 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: A simple but powerful ruby API wrapper for Google's services.
+email:
+- alex@robbinsweb.biz
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- google-api.gemspec
+- lib/google-api.rb
+- lib/google-api/active_record_inclusions.rb
+- lib/google-api/api.rb
+- lib/google-api/api/calendar.rb
+- lib/google-api/api/drive.rb
+- lib/google-api/client.rb
+- lib/google-api/railtie.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 3955981153678874912
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>'
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: A simple but powerful ruby API wrapper for Google's services.
+test_files: []