google_client 0.1.0

data/.rspec

@@ -0,0 +1 @@
+--color --format doc

data/Gemfile

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

data/README.md

@@ -0,0 +1,92 @@
+
+This gem can be used to get access to a specific set of Google APIs.
+
+# Installation
+
+    gem install google_client
+
+# Features
+
+* Rails Engine to launch OAuth mechanism
+* Refresh OAuth token
+* Google Calendar
+  * Fetch the list of user calendars
+  * Create a new calendar
+  * Retrieve a specific calendar
+  * Fetch calendar events, filtering by specific event id, time interval (and more coming)
+  * Delete calendar
+  * Create event
+  * Delete event
+* Google Contacts
+  * Fetch user contacts
+
+# Getting started
+
+Any request that may be done on behalf of the user needs a valid authentication token:
+
+    require "gogole_client"
+    user = GoogleClient::User.new "user-authentication-token"
+
+    # Get user contacts
+    contacts = user.contacts
+
+    # Get user calendars
+    calendars = user.calendars
+
+    # Get a specific user calendar
+    calendar = user.calendars("<calendar-id>")
+
+    # Fetch calendar events
+    events = calendar.events
+
+    # Create calendar
+    calendar = user.create_calendar({:title => "my-new-calendar", 
+                          :details => "Hello world", 
+                          :timezone => "Spain", :location => "Barcelona"})
+
+    # ...
+
+Take a look on the [user.rb](blob/master/lib/google_client/user.rb) file to check the available methods
+
+# Roadmap
+
+* Enhance filters
+* Handle contacts
+    * Create a new contact
+    * Delete an existing contact
+    * Update a contact
+* Add XML format support. Currently (except the OAuth requests) all the requests/responses are JSON encoded. It may be nice to add support for XML too.
+
+# Note on Patches/Pull Requests
+
+* Fork the project
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  * If you want to have your own version, that is fine but bump version in a commit by itself so I can ignore when I pull
+* Send me a pull request. Bonus points for topic branches.
+
+# License
+
+    The MIT License
+
+    Copyright (c) 2011 Juan de Bravo
+
+    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/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/app/controllers/google_client_controller.rb

@@ -0,0 +1,79 @@
+
+class GoogleClientController < ApplicationController
+
+  # parameters required in both OAuth steps
+  DEFAULT_PARAMS = {
+    :client_id => Rails.application.config.google_client.client_id
+  }
+  
+  # OAuth step1: redirect to Google endpoint with the application idenfitifer and the redirect uri
+  def index
+    _params = {
+      :redirect_uri => Rails.application.config.google_client.redirect_uri,
+      :response_type => "code",
+      :scope => Rails.application.config.google_client.scope,
+    }
+    _params.merge!(DEFAULT_PARAMS)
+    
+    redirect_to connection.create_uri("/o/oauth2/auth", _params).to_s
+  end
+
+  # OAuth step2: retrieve the code from Google, ask for a valid access token and
+  # forward to the user defined uri
+  def oauth2callback
+    # This code is retrieved from Google
+
+    _params = {
+      :redirect_uri => Rails.application.config.google_client.redirect_uri,
+      :client_secret => Rails.application.config.google_client.client_secret,
+      :grant_type => "authorization_code",
+      :code => params[:code]
+    }
+
+    _params.merge!(DEFAULT_PARAMS)
+
+    response = connection.post "/o/oauth2/token", _params
+    
+    if response.code.to_s.eql?("200")
+      response = ActiveSupport::JSON.decode(response.body)
+
+      if Rails.application.config.google_client.forward_action.nil? or !Rails.application.config.google_client.forward_action.is_a?(String)
+        raise GoogleClient::Error.new("Invalid forward_action value")
+      end
+
+      url = Rails.application.config.google_client.forward_action.split("#")
+
+      url.length == 2 or raise GoogleClient::Error.new("Invalid forward_action value")
+
+      @data = response
+
+      redirect_to ({
+        :controller => url.first,
+        :action => url.last,
+        :access_token => response["access_token"],
+        :token_type => response["token_type"],
+        :expires_in => response["expires_in"],
+        :refresh_token => response["refresh_token"]
+      })
+
+    else
+      logger.error "Error #{response.code} while accessing to Google #{response.body}"
+      raise RuntimeError, "Unable to access to Google"
+    end
+  end
+
+  def show
+    @data = {:access_token => params[:access_token], 
+              :token_type => params[:token_type],
+              :expires_in => params[:expires_in],
+              :refresh_token => params[:refresh_token]}
+  end
+
+  
+  private
+  
+  def connection
+    @connection ||= GoogleClient::HttpConnection.new("https://accounts.google.com")
+  end
+
+end

data/app/views/google_client/show.html.erb

@@ -0,0 +1,54 @@
+<style >
+#oauth {
+  margin-left: 10%;
+  width: 80%;
+  font-size: 1em; 
+  font-family: 'Verdana', 'Helvetica', 'Arial';
+}
+
+#oauth h2{
+  margin-top: 50px;
+  color: #47C3D3;
+}
+
+#oauth dt{
+  float: left;
+  font-weight: bold;
+  width: 30%;
+}
+
+#oauth dd{
+  width: 70%;
+}
+
+#oauth p{
+  margin-top: 50px;
+}
+
+#oauth .email{
+  float: right;
+}
+
+</style>
+
+<div id="oauth">
+  <h2>OAuth Engine</h2>
+  <p><h4>This is the data retrieved as result of the OAuth process:</h4></p>
+  <dl>
+    <dt>User access token</dt>
+    <dd><%=@data[:access_token]%></dd>
+    <dt>Token type</dt>
+    <dd><%=@data[:token_type]%></dd>
+    <dt>Expires in</dt>
+    <dd><%=@data[:expires_in]%></dd>
+    <dt>Refresh token</dt>
+    <dd><%=@data[:refresh_token]%></dd>
+  </dl>
+  <p>
+    So now that you have it working, please go to the configuration initializer and set up a cool forward page instead of this :)
+  </p>
+  <p class="email">
+    juandebravo at gmail dot com
+  </p>
+  
+</div>

data/config/routes.rb

@@ -0,0 +1,9 @@
+Rails.application.routes.draw do
+
+  get "google_client/index"
+  
+  get "google_client/oauth2callback"
+
+  get "google_client/show"
+
+end

data/google_client.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/google_client/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["juandebravo"]
+  gem.email         = ["juandebravo@gmail.com"]
+  gem.summary       = %q{Ease way to get access to Google API.}
+  gem.description   = %q{This gem is a wrapper on top of the Google API that allows a developer to handle calendars, events, contacts on behalf of the user.}
+  gem.homepage      = "http://www.github.com/juandebravo/google_client"
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name          = "google_client"
+  gem.require_paths = ["lib"]
+  gem.version       = GoogleClient::VERSION
+
+  gem.add_dependency("rest-client")
+  gem.add_dependency("addressable")
+
+  gem.add_development_dependency("rake")
+  gem.add_development_dependency("rspec")
+  gem.add_development_dependency("webmock")
+
+end

data/lib/google_client.rb

@@ -0,0 +1,26 @@
+require 'json'
+require "google_client/version"
+
+require 'google_client/engine' if defined?(Rails)
+
+module GoogleClient
+  
+  autoload :AuthenticationError, 'google_client/error'
+  autoload :BadRequestError    , 'google_client/error'
+  autoload :Calendar           , 'google_client/calendar'
+  autoload :Contact            , 'google_client/contact'
+  autoload :Error              , 'google_client/error'
+  autoload :Event              , 'google_client/event'
+  autoload :Format             , 'google_client/format'
+  autoload :HttpConnection     , 'google_client/http_connection'
+  autoload :NotFoundError      , 'google_client/error'
+  autoload :Profile            , 'google_client/profile'
+  autoload :User               , 'google_client/user'
+
+  class << self
+    def create_client(oauth_credentials)
+      User.new(oauth_credentials)
+    end
+  end
+
+end

data/lib/google_client/calendar.rb

@@ -0,0 +1,181 @@
+module GoogleClient
+  class Calendar
+
+    BASE_URL = "https://www.google.com/calendar/feeds"
+
+    include Format
+
+    attr_accessor :id
+    attr_accessor :title
+    attr_accessor :details
+    attr_accessor :timezone
+    attr_accessor :location
+
+    def initialize(params)
+      @user = params[:user]
+      @user.nil? or @connection = @user.connection
+      @id = params[:calendar_id] || params[:id]
+      @title = params[:title]
+      @details = params[:details]
+      @timezone = params[:timezone]
+      @location = params[:location]
+      @json_mode = true
+    end
+
+    def to_s
+      "#{self.class.name} => { id: #{@id}, title: #{@title}, :timezone => #{@timezone}, :location => #{@location} }"
+    end
+
+    def connection
+      @connection or raise RuntimeError.new "Http connection not established"
+    end
+
+    ##
+    # Save the Calendar in the server
+    # 
+    # @return Event instance
+    def save
+      if @id.nil?
+        data = decode_response connection.post("/calendar/feeds/default/owncalendars/full", {:data => self.to_hash})
+        self.id = data["data"]["id"].split("full/").last
+      else
+        data = decode_response connection.put("/calendar/feeds/default/owncalendars/full/#{@id}", {:apiVersion => "2.3", :data => self.to_hash})
+      end
+      self
+    end
+
+    def delete
+      @id.nil? and raise Error.new "calendar cannot be deleted if has not an unique identifier"
+      connection.delete("/calendar/feeds/default/owncalendars/full/#{@id}")
+      true
+    end
+
+    def to_hash
+      {
+        :title => @title,
+        :details => @details,
+        :timeZone => @timezone,
+        :location => @location
+      }.delete_if{|k,v| v.nil?}
+    end
+
+    ##
+    # Fetch a set of the events from the calendar
+    # ==== Parameters
+    # * *params*: Hash
+    # ** *id*: optional, specific event identifier. If present, no other parameter will be considered
+    # ** *from*: optional, if *to* is present and from is not, all events starting till *to* will be fetched
+    # ** *to*: optional, if *from* is present and to is not, all events starting after *from* will be fetched
+    #
+    # ==== Return
+    # * Nil if no event matches the query parameters.
+    # * Event instance if only one Event matches the query parameter.
+    # * An array of Event instances if more than one Event matches the query parameter.
+    #
+    def events(args = nil)
+      events = if args.nil? || args.eql?(:all)
+        events = decode_response connection.get "/calendar/feeds/#{id}/private/full"
+        events = events["feed"]["entry"]
+        events.map{ |event| Event.build_event(event, self)}
+      elsif args.is_a?(String)
+        raise Error.new "Unable to fetch a Event by id"
+        #Event.new({:id => args, :calendar => self}).fetch
+      elsif args.is_a?(Hash)
+        if args.is_a?(Hash) && args.has_key?(:id)
+          Event.new({:id => args[:id], :calendar => self}).fetch
+        else
+          params = { "start-min" => args[:from],
+                     "start-max" => args[:to]}
+          events = decode_response connection.get "/calendar/feeds/#{id}/private/full", params
+          events = events["feed"]["entry"]
+          events = events.nil? ? [] : events.map{ |event| Event.build_event(event, self)}
+        end
+      else
+        raise ArgumentError.new "Invalid argument type #{args.class}"
+      end
+
+    end
+
+    ##
+    # Fetch forthcoming events in the folowing *time* minutes
+    def forthcoming_events(time = 3600)
+      events({:from => Time.now.strftime("%Y-%m-%dT%k:%M:%S").concat(timezone).gsub(/ /,"0"),
+              :to => (Time.now + time).strftime("%Y-%m-%dT%k:%M:%S").concat(timezone).gsub(/ /,"0")})
+    end
+
+    def create_event(params = {})
+      event = if block_given?
+                    Event.create(params.merge({:calendar => self}), &Proc.new)
+                  else
+                    Event.create(params.merge({:calendar => self}))
+                  end
+      event.save
+    end
+
+    def delete_event(event_id)
+    end
+
+    def fetch
+      data = decode_response connection.get "/calendar/feeds/default/owncalendars/full/#{id}"
+      self.class.build_calendar data["entry"], @user
+    end
+
+    # Helper to get the Timezone in rfc3339 format
+    def timezone
+      @@timezone ||= (
+      timezone = Time.now.strftime("%z")
+      timezone[0..2].concat(":").concat(timezone[3..-1])
+      )
+    end
+
+    class << self
+      def create(params)
+        calendar = if block_given?
+          new(params, &Proc.new)
+        else
+          new(params)
+        end
+      end
+
+      def build_calendar(data, user = nil)
+
+        id = begin
+          data["id"]["$t"].split("full/").last
+        rescue
+          nil
+        end
+
+        details = begin
+          data["summary"]["$t"]
+        rescue
+          ""
+        end
+        title = begin
+          data["title"]["$t"]
+        rescue
+          ""
+        end
+
+        timezone = begin
+          data["gCal$timezone"]["value"]
+        rescue
+          nil
+        end
+
+        location = begin
+          data["gd$where"][0]["valueString"]
+        rescue
+          nil
+        end
+        
+        Calendar.new({:id => id, 
+                      :user => user, 
+                      :title => title,
+                      :details => details,
+                      :location => location,
+                      :timezone => timezone})
+      end
+    end
+  end
+
+end