RubyGems - gcal_mapper - Versions diffs - 0.1.1 - Mend

gcal_mapper 0.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (58) hide show

data/.gitignore +32 -0
data/.travis.yml +16 -0
data/CHANGELOG.md +15 -0
data/Gemfile +20 -0
data/Guardfile +19 -0
data/LICENSE +22 -0
data/README.md +370 -0
data/Rakefile +32 -0
data/bin/ci/file/auth.yaml +7 -0
data/bin/ci/file/bad_yaml.yaml +0 -0
data/bin/ci/file/config.yaml +8 -0
data/bin/ci/file/privatekey.p12 +0 -0
data/bin/ci/travis_build.sh +4 -0
data/bin/ci/vcr/GcalMapper_Authentification/access_token_should_exist_with_assertion_auth.yml +49 -0
data/bin/ci/vcr/GcalMapper_Authentification/should_be_fasle_if_bad_client_email_is_given.yml +47 -0
data/bin/ci/vcr/GcalMapper_Authentification_Assertion/should_have_access_token_attribute.yml +49 -0
data/bin/ci/vcr/GcalMapper_Authentification_Assertion/should_have_refresh_token_attribute.yml +49 -0
data/bin/ci/vcr/GcalMapper_Calendar/should_get_the_calendar_list.yml +190 -0
data/bin/ci/vcr/GcalMapper_Calendar/should_get_the_events_list.yml +45 -0
data/bin/ci/vcr/GcalMapper_Calendar/should_raise_error_if_the_calendar_id_isn_t_accessible.yml +56 -0
data/bin/ci/vcr/GcalMapper_Calendar/should_raise_error_if_the_token_is_bad.yml +60 -0
data/bin/ci/vcr/GcalMapper_Mapper/should_save_all_events.yml +232 -0
data/bin/ci/vcr/GcalMapper_Mapper/should_save_events_only_once.yml +232 -0
data/bin/gcal-mapper +108 -0
data/gcal_mapper.gemspec +25 -0
data/lib/gcal_mapper.rb +15 -0
data/lib/gcal_mapper/authentification.rb +57 -0
data/lib/gcal_mapper/authentification/assertion.rb +110 -0
data/lib/gcal_mapper/authentification/base.rb +20 -0
data/lib/gcal_mapper/authentification/oauth2.rb +68 -0
data/lib/gcal_mapper/calendar.rb +51 -0
data/lib/gcal_mapper/configuration.rb +23 -0
data/lib/gcal_mapper/errors.rb +40 -0
data/lib/gcal_mapper/mapper.rb +76 -0
data/lib/gcal_mapper/mapper/active_record.rb +74 -0
data/lib/gcal_mapper/mapper/dsl.rb +57 -0
data/lib/gcal_mapper/mapper/simple.rb +97 -0
data/lib/gcal_mapper/railtie.rb +8 -0
data/lib/gcal_mapper/rest_request.rb +73 -0
data/lib/gcal_mapper/sync.rb +159 -0
data/lib/gcal_mapper/version.rb +4 -0
data/spec/authentification/assertion_spec.rb +15 -0
data/spec/authentification/base_spec.rb +18 -0
data/spec/authentification/oauth2_spec.rb +15 -0
data/spec/authentification_spec.rb +34 -0
data/spec/calendar_spec.rb +33 -0
data/spec/gcal_mapper_spec.rb +5 -0
data/spec/mapper/active_record_spec.rb +46 -0
data/spec/mapper/dsl_spec.rb +31 -0
data/spec/mapper/simple_spec.rb +48 -0
data/spec/mapper_spec.rb +32 -0
data/spec/rest_request_spec.rb +5 -0
data/spec/spec_helper.rb +51 -0
data/spec/support/models/event.rb +25 -0
data/spec/support/models/event_jeu.rb +22 -0
data/spec/support/schema.rb +28 -0
data/spec/sync_spec.rb +28 -0
metadata +200 -0

data/bin/gcal-mapper ADDED Viewed

@@ -0,0 +1,108 @@
+#!/usr/bin/env ruby
+bin_dir = File.expand_path("..", __FILE__)
+lib_dir = File.expand_path("../lib", bin_dir)
+$LOAD_PATH.unshift(lib_dir)
+$LOAD_PATH.uniq!
+require 'launchy'
+require 'socket'
+require 'gcal_mapper'
+OAUTH_SERVER_PORT = 12736
+options = {}
+opt_parser = OptionParser.new do |opt|
+  opt.on('--client_id CLIENT_ID', 'your client id') do |client_id|
+    options[:client_id] = client_id
+  end
+  opt.on('--client_secret CLIENT_SECRET', 'your client secret') do |client_secret|
+    options[:client_secret] = client_secret
+  end
+  opt.on('-f FILE', '--file FILE', 'the file to save credentials') do |file|
+    options[:file] = file
+  end
+  opt.on('--scope SCOPE', 'the scope to ask authorization for') do |scope|
+    options[:scope] = scope
+  end
+end
+opt_parser.parse!
+options[:scope] = 'https://www.googleapis.com/auth/calendar' if options[:scope].nil?
+options[:file] = '~/google_auth.yaml' if options[:file].nil?
+authorize_url = 'https://accounts.google.com/o/oauth2/auth?access_type=offline&approval_prompt=auto&'
+authorize_url += 'client_id=' + options[:client_id] + '&'
+authorize_url += 'redirect_uri=http://localhost:' + OAUTH_SERVER_PORT.to_s + '/&response_type=code&'
+authorize_url += 'scope=' + options[:scope]
+# open web browser with the authorisation page
+Launchy.open(authorize_url)
+msg = ''
+# tcp server to receive the response and close the window
+server = TCPServer.new('0.0.0.0', OAUTH_SERVER_PORT)
+loop do
+  Thread.new(server.accept) do |client|
+    msg = client.readline
+    body = "<html><head><script>function closeWindow() {window.open('', '_self', '');window.close();} setTimeout(closeWindow, 10);</script></head><body>You may close this window.</body></html>\r\n"
+    headers = [
+      "",
+      "HTTP/1.1 200 OK",
+      "Date: Fri, 30 Sep 2011 08:11:27 GMT",
+      "Server: TCP socket test",
+      "Content-Type: text/html; charset=iso-8859-1",
+      "Content-Length: #{body.length}\r\n\r\n"].join("\r\n")
+    client.write headers
+    client.write body
+    client.close
+  end
+  sleep(1.0/24.0)
+  break if msg.include?('code')
+end
+# keep just the authorization code
+msg.slice!('GET /?code=')
+msg.chop!
+msg.slice!(' HTTP/1.1')
+# form rest request and send it
+url = 'https://accounts.google.com/o/oauth2/token'
+data = {
+  'code' => msg,
+  'grant_type'=> 'authorization_code',
+  'redirect_uri' => 'http://localhost:' + OAUTH_SERVER_PORT.to_s + '/',
+  'client_id' => options[:client_id],
+  'client_secret' => options[:client_secret]
+}
+opts = {
+  :method => :post,
+  :headers => {'Content-Type' => 'application/x-www-form-urlencoded'},
+  :parameters => data
+}
+req = GcalMapper::RestRequest.new(url, opts)
+response = req.execute
+# store credentials in yaml file
+config = {
+  'mechanism' => 'oauth_2',
+  'scope' => options[:scope],
+  'client_id' => options[:client_id],
+  'client_secret' => options[:client_secret],
+  'access_token' => response['access_token'],
+  'refresh_token' => response['refresh_token']
+}
+config_file = File.expand_path(options[:file])
+open(config_file, 'w') { |file| file.write(YAML.dump(config)) }
+exit(0)

data/gcal_mapper.gemspec ADDED Viewed

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/gcal_mapper/version', __FILE__)
+Gem::Specification.new do |gem|
+  gem.authors       = ['Néville Dubuis']
+  gem.email         = ['neville.dubuis@liquid-concept.ch']
+  gem.description   = %q{A library to map Google Calendar events with an ORM}
+  gem.summary       = %q{A library to map Google Calendar events with an ORM}
+  gem.homepage      = 'http://rubygems.org/gems/gcal_mapper'
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = ['gcal-mapper']
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = 'gcal_mapper'
+  gem.require_paths = ['lib']
+  gem.version       = GcalMapper::VERSION
+  gem.add_dependency 'launchy'
+  gem.add_development_dependency 'activerecord'
+  gem.add_development_dependency 'rspec',   '>= 2.0'
+  gem.add_development_dependency 'vcr'
+  gem.add_development_dependency 'fakeweb'
+end

data/lib/gcal_mapper.rb ADDED Viewed

@@ -0,0 +1,15 @@
+require 'gcal_mapper/version'
+require 'gcal_mapper/rest_request'
+require 'gcal_mapper/authentification'
+require 'gcal_mapper/calendar'
+require 'gcal_mapper/errors'
+require 'gcal_mapper/sync'
+require 'gcal_mapper/mapper'
+require 'gcal_mapper/configuration'
+require 'gcal_mapper/railtie' if defined?(Rails)
+#
+# A library to map Google Calendar events with an ORM.
+#
+module GcalMapper
+end

data/lib/gcal_mapper/authentification.rb ADDED Viewed

@@ -0,0 +1,57 @@
+require 'gcal_mapper/authentification/assertion'
+require 'gcal_mapper/authentification/oauth2'
+module GcalMapper
+  #
+  # Abstract which type of authentification is required
+  #
+  class Authentification
+    REQUEST_URL = 'https://accounts.google.com/o/oauth2/token' # url where to request to authentificate
+    attr_reader :file           # file that is needed for authentification
+    attr_reader :client_email   # for assertion authentification
+    attr_reader :password       # password for the p12 file
+    # intialize client info needed for connection to Oauth2.
+    #
+    # @param [String] file path to the yaml or p12 file
+    # @param [String] client_email email from the api_consol (service account only)
+    # @param [String] user_email email from the impersonated user (service account only)
+    # @param [String] password p12 key password (service account only)
+    def initialize(file, client_email=nil, user_email=nil, password='notasecret')
+      @file = File.expand_path(file)
+      @client_email = client_email
+      @user_email = user_email
+      @password = password
+      raise GcalMapper::AuthFileError if !File.exist?(@file)
+    end
+    # do the authentification for one of the right authentification method
+    #
+    # @return [Bool] true if instantiation ok
+    def authenticate
+      if client_email==nil
+        @auth = Authentification::Oauth2.new(@file)
+      else
+        @auth = Authentification::Assertion.new(@file, @client_email, @user_email, @password)
+      end
+      !access_token.nil?
+    end
+    # Gives the access token
+    #
+    # @return [string] the access token
+    def access_token
+      @auth.access_token
+    end
+    # refresh the access token
+    #
+    # @return [string] the access token
+    def refresh_token
+      @auth.refresh_token
+    end
+  end
+end

data/lib/gcal_mapper/authentification/assertion.rb ADDED Viewed

@@ -0,0 +1,110 @@
+require 'gcal_mapper/authentification/base'
+require 'json'
+module GcalMapper
+  class Authentification
+    #
+    # make the authentification for service account and request data from google calendar.
+    #
+    class Assertion < Authentification::Base
+      ASSERTION_SCOPE = 'https://www.google.com/calendar/feeds/'  # scope for assertion
+      JWT_HEADER      = {'alg' => 'RS256', 'typ' => 'JWT'}  # header of the jwt to send
+      ASSERTION_TYPE  = 'http://oauth.net/grant_type/jwt/1.0/bearer'  # url to specify which type of assertion
+      attr_accessor :client_email   # the email given by google for the service account
+      attr_accessor :user_email     # the email of the user to impersonate
+      # New object
+      #
+      # @param [String] p12_file the path to the p12 key file
+      # @param [String] client_email email from the api_consol
+      # @param [String] user_email email from the impersonated user
+      # @param [String] password p12 key password
+      def initialize(p12_file, client_email, user_email, password)
+        @client_email = client_email
+        @p12_file = p12_file
+        @user_email = user_email
+        @password = password
+        request_token
+        @validity = Time.now.getutc.to_i
+      end
+      # give the acess token for th application and refresh if it is outdated
+      #
+      # @return [String] access token
+      def access_token
+        if Time.now.getutc.to_i - @validity > 3600
+          refresh_token
+        end
+        @access_token
+      end
+      # refresh the token by asking for a new one
+      #
+      # @return [String] access token
+      def refresh_token
+        request_token
+      end
+      private
+      # generate the JWT that must be include with the request acess token.
+      # the format of the JWT is (base64url encoded header).(base64url encoded claim set).(base64url encoded signature)
+      #
+      # @return [String] the generate JWT.
+      def generate_assertion()
+        encoded_header = [JWT_HEADER.to_json].pack("m0").tr("+/", "-_")
+        utc_time = Time.now.getutc.to_i
+        claim = {
+          'aud' => Authentification::REQUEST_URL,
+          'scope'=> ASSERTION_SCOPE,
+          'prn' => @user_email,
+          'iat' => utc_time,
+          'exp' => utc_time+3600,
+          'iss' => @client_email
+        }
+        encoded_claim = [claim.to_json].pack("m0").tr("+/", "-_")
+        begin
+          p12 = OpenSSL::PKCS12.new(File.read(@p12_file), @password)
+        rescue
+          raise GcalMapper::AuthFileError
+        end
+        key = p12.key
+        sign = key.sign(OpenSSL::Digest::SHA256.new, encoded_header + '.' + encoded_claim)
+        encoded_sign = [sign].pack("m0").tr("+/", "-_")
+        encoded_header + '.' + encoded_claim + '.' + encoded_sign
+      end
+      # Prepare all the parameters for sending the request token request to google
+      # and save the token in instance variable.
+      #
+      # @return [Hash] the HTTP response.
+      def request_token
+        data = {
+          'grant_type' => 'assertion',
+          'assertion_type' => ASSERTION_TYPE,
+          'assertion' => generate_assertion
+        }
+        options = {
+          :method => :post,
+          :headers => {'Content-Type' => 'application/x-www-form-urlencoded'},
+          :parameters => data
+        }
+        req = GcalMapper::RestRequest.new(Authentification::REQUEST_URL, options)
+        begin
+          response = req.execute
+        rescue
+          raise GcalMapper::AuthentificationError
+        end
+        @valididity = Time.now.getutc.to_i
+        @access_token = response['access_token']
+      end
+    end
+  end
+end

data/lib/gcal_mapper/authentification/base.rb ADDED Viewed

@@ -0,0 +1,20 @@
+module GcalMapper
+  class Authentification
+    #
+    # Base class for authentification methods
+    #
+    class Base
+      # raise error if this method is called -> mean that child class has not implemeted this method
+      def access_token
+        raise NotImplementedError
+      end
+      # raise error if this method is called -> mean that child class has not implemeted this method
+      def refresh_token
+        raise NotImplementedError
+      end
+    end
+  end
+end

data/lib/gcal_mapper/authentification/oauth2.rb ADDED Viewed

@@ -0,0 +1,68 @@
+require 'gcal_mapper/authentification/base'
+require 'yaml'
+module GcalMapper
+  class Authentification
+    #
+    # make the authentification with Oauth2 and request data from google calendar.
+    #
+    class Oauth2 < Authentification::Base
+      # intialize client info needed for connection to Oauth2.
+      #
+      # @param [String] yaml_file path to the yaml file which contains acess token, ...
+      def initialize (yaml_file)
+        begin
+          oauth_yaml = YAML.load_file(yaml_file)
+          @client_id = oauth_yaml["client_id"]
+          @client_secret = oauth_yaml["client_secret"]
+          @scope = oauth_yaml["scope"]
+          @refresh_token = oauth_yaml["refresh_token"]
+          @access_token = oauth_yaml["access_token"]
+          @validity = Time.now.getutc.to_i
+        rescue
+          raise GcalMapper::AuthFileError
+        end
+      end
+      # give the acess token for th application and refresh if it is outdated
+      #
+      # @return [String] access token
+      def access_token
+        if (Time.now.getutc.to_i - @validity) > 3600
+          refresh_token
+        end
+        @access_token
+      end
+      # refresh the token by using refresh token
+      #
+      # @return [String] access token
+      def refresh_token
+        data = {
+          'client_id' => @client_id,
+          'client_secret' => @client_secret,
+          'refresh_token' => @refresh_token,
+          'grant_type' => 'refresh_token'
+        }
+        options = {
+          :method => :post,
+          :headers => {'Content-Type' => 'application/x-www-form-urlencoded'},
+          :parameters => data
+        }
+        req = GcalMapper::RestRequest.new(Authentification::REQUEST_URL, options)
+        begin
+          response = req.execute
+        rescue
+          raise GcalMapper::AuthentificationError
+        end
+        @validity = Time.now.getutc.to_i
+        @access_token = response['access_token']
+        response
+      end
+    end
+  end
+end

data/lib/gcal_mapper/calendar.rb ADDED Viewed

@@ -0,0 +1,51 @@
+module GcalMapper
+  #
+  # Provide methods to get google calendar data
+  #
+  class Calendar
+    # Get the calendar list for the connected user.
+    #
+    # @param [Hash] access_token the token obtain with Authentification.access_token
+    # @return [Array] google calendar id that the user can access.
+    def get_calendars_list(access_token)
+      url = 'https://www.googleapis.com/calendar/v3/users/me/calendarList'
+      options = {
+        :method => :get,
+        :headers => {'Authorization' => 'Bearer ' + access_token}
+      }
+      req = GcalMapper::RestRequest.new(url, options)
+      response = req.execute
+      tab_cal=response['items']
+      ids = []
+      tab_cal.each do |t|
+        t.each do |k, v|
+          if k == 'id'
+            ids.push(v)
+          end
+        end
+      end
+      ids
+    end
+    # Get all events from specified calendar(s).
+    #
+    # @param [Hash] access_token the token obtain with Authentification.access_token
+    # @param [Array] calendar_id contain the calendar(s) id you want to map
+    # @return [Array] all events from given calendar(s) id.
+    def get_events_list(access_token, calendar_id)
+      url = 'https://www.googleapis.com/calendar/v3/calendars/'+calendar_id+'/events?showDeleted=true'
+      options = {
+        :method => :get,
+        :headers => {'Authorization' => 'Bearer ' + access_token},
+      }
+      req = GcalMapper::RestRequest.new(url, options)
+      response = req.execute
+      response['items']
+    end
+  end
+end