googlecal 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cab9c7f838cca955077ddff4aa3ddcf189ba0ca9
+  data.tar.gz: 2af1ecce263af3e2e6c0213c9f37961d144d30ae
+SHA512:
+  metadata.gz: f365f52c1322924c5a0ae3017e2431c3a030266d89105a883dd38750378a7c5d6018d3c33cf6b58c331082610199f197c64072b87fcd959844849bb9e420f95d
+  data.tar.gz: cb3c59e515fdb61a13c2352fa6ee6da483ab8836f98a6601b73c580205d63a296daa8556ba6dd534d4b8b4ac92f39d4491078b73ef74dd308c31902eb9572d0a

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+# dont keep your client_secrets in git
+client_secret.json
+/doc/
+.env

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+- 2.3.1
+before_install: gem install bundler -v 1.13.6

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,31 @@
+MIT License
+
+Copyright (c) 2017 Ennovar
+
+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,47 @@
+[![Build
+Status](https://travis-ci.org/Ennovar/googlecal.svg?branch=master)](https://travis-ci.org/Ennovar/googlecal)
+# Googlecal
+_simple wrapper for google calendar api for ruby_
+
+## This project is in Alpha!!!
+
+
+## Testing Setup
+Before you are ready to start developing on the project there are a
+couple steps to follow
+
+1. make sure you have a google account... **DUH**
+2. make sure you enable the account to access your google calendar, you
+   can find directions for that
+[here](https://developers.google.com/google-apps/calendar/quickstart/ruby)
+3. download your client_secret.json file into the project directory,
+   these will authenticate you. Dont worry the .gitignore will ignore
+this file
+4. run your tests with the following command inside the directory `rake
+   spec`
+
+**NOTE:** if you get the following output from running your tests
+
+```
+Open the following url in the browser ............
+```
+1. you need to cancel your tests
+2. run `./bin/console`
+3. in the irb console you need to run the following
+   `Googlecal::Base.new('')`
+4. the url should print out to the console, open the url in your browser
+   and then use the code that is in the webpage and paste it into the
+irb console to authenticate you.
+
+**Then you are clear to start running tests**
+
+
+## Generating Documentation
+1. install rdoc with
+```
+gem install rdoc
+```
+2. generate the docs by running this command in the project directory
+```
+rdoc
+```

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "googlecal"
+require 'dotenv'
+Dotenv.load('.env')
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/googlecal.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'googlecal/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "googlecal"
+  spec.version       = Googlecal::VERSION
+  spec.authors       = ["Austin M Crane"]
+  spec.email         = ["austin.crane@ennovar.wichita.edu"]
+
+  spec.summary       = %q{Simple wrapper around google calendar api}
+  spec.description   = %q{Simple wrapper around google calendar api}
+  spec.homepage      = "http://github.com"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "google-api-client"
+
+  spec.add_development_dependency "dotenv"
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/googlecal.rb

@@ -0,0 +1,166 @@
+require "googlecal/version"
+# google api stuff
+require 'google/apis/calendar_v3'
+require 'googleauth'
+require 'googleauth/stores/file_token_store'
+
+# :title: Googlecal
+module Googlecal
+  # :title: Base
+  class Base
+    attr_accessor :credentials, :default_calendar
+
+    # TODO: not sure what this is for, needs documentation
+    OOB_URL = 'urn:ietf:wg:oauth:2.0:oob'
+
+    # Initialize a new googlecal instance and authenticate with google with file paths
+    #
+    # ==== Attributes
+    #
+    # * +:application_name:+ - Name of application in gooogle console that you need to setup
+    # * +:authenticate_with_env:+ - Optionally authenticate with enviroment variables instead of client_secrets_path
+    # * +:credentials_path:+  - The file path to loading credentials path
+    # * +:client_secrets_path:+ - The file path to json file holding client secrets
+    # * +:scope:+ -The access scope for the use of the google api session
+    def initialize(application_name,
+                   authenticate_with_env = false,
+                   credentials_path = File.join(Dir.home, '.credentials',"calendar-ruby-quickstart.yaml"),
+                   client_secrets_path = 'client_secret.json',
+                   scope = Google::Apis::CalendarV3::AUTH_CALENDAR)
+      # authenticate with google
+      if authenticate_with_env
+        # set credentials
+        @credentials = authorize_with_env(scope)
+      else
+        # set credentials
+        @credentials = authorize(credentials_path, client_secrets_path, scope)
+      end
+     @calendar_service = setup_calendar_service(application_name, @credentials)
+    end
+
+    def events(calendar_id = 'primary', **opts)
+      @calendar_service.list_events(calendar_id,
+                                    max_results: 10)
+    end
+
+    def create_event(calendar_id = 'primary', **opts)
+      event = Google::Apis::CalendarV3::Event.new(
+        summary: opts[:summary] || '',
+        location: opts[:location] || '',
+        start: {
+          date_time: Time.now.iso8601,
+          time_zone: 'America/Los_Angeles',
+        },
+        end: {
+          date_time: (Time.now + 10*60).iso8601,
+          time_zone: 'America/Los_Angeles',
+        }
+      )
+      result = @calendar_service.insert_event(calendar_id, event)
+      return result
+    end
+
+    # Delete an even from a calendar by event id
+    #
+    # ==== Attributes
+    #
+    # * +:calendar_id:+ - Unique id of calendar
+    # * +:event_id:+ - Unique id of event to be deleted
+    def delete_event(calendar_id = 'primary', event_id)
+      result = @calendar_service.delete_event(calendar_id, event_id)
+      return result
+    end
+
+    # Get an event by event id
+    #
+    # ==== Attributes
+    #
+    # * +:calendar_id:+ - Unique id of calendar
+    # * +:event_id:+ - Unique id of event
+    # TODO: for some reason this part is not working with some of the tests i have tried
+    # with it
+    def get_event(calendar_id = 'primary', event_id)
+      result = @calendar_service.get_acl(calendar_id, event_id)
+      return result
+    end
+
+    private
+
+    # Authenticate with google with file paths and a scope
+    #
+    # ==== Attributes
+    #
+    # * +:credentials_path:+ - The file path to loading credentials path
+    # * +:client_secrets_path:+ - The file path to json file holding client secrets
+    # * +:scope:+ - The access scope for the use of the google api session
+    def authorize(credentials_path, client_secrets_path, scope)
+      FileUtils.mkdir_p(File.dirname(credentials_path))
+      client_id = Google::Auth::ClientId.from_file(client_secrets_path)
+      token_store = Google::Auth::Stores::FileTokenStore.new(file: credentials_path)
+      authorizer = Google::Auth::UserAuthorizer.new(client_id, scope, token_store)
+      user_id = 'default'
+      credentials = authorizer.get_credentials(user_id)
+      # check if loaded credentials exist
+      if credentials.nil?
+        url = authorizer.get_authorization_url(base_url: OOB_URL)
+        # user must verify application
+        puts "Open the following url in the browser"
+        puts url
+        code = gets
+        credentials = authorizer.get_and_store_credentials_from_code(
+          user_id: user_id,
+          code: code,
+          base_url: OOB_URL
+        )
+      end
+      # return the produced credentials
+      return credentials
+    end
+
+    # Authenticate with enviroment variables
+    #
+    # ==== Attributes
+    #
+    # * +:credentials_path:+ - The file path to store the credentials
+    # * +:scope:+ - The access scope for the use of the google api session
+    def authorize_with_env(scope)
+      FileUtils.mkdir_p(File.dirname(ENV['GCAL_TOKEN_STORE_PATH']))
+      # get values for env varibales
+      client_id = Google::Auth::ClientId.new(ENV['GCAL_CLIENT_ID'], ENV['GCAL_CLIENT_SECRET'])
+      # setup token store for the file
+      token_store = Google::Auth::Stores::FileTokenStore.new(file: ENV['GCAL_TOKEN_STORE_PATH'])
+      authorizer = Google::Auth::UserAuthorizer.new(client_id, scope, token_store)
+      user_id = 'default'
+      credentials = authorizer.get_credentials(user_id)
+      # check if loaded credentials exist
+      if credentials.nil?
+        url = authorizer.get_authorization_url(base_url: OOB_URL)
+        # user must verify application
+        puts "Open the following url in the browser"
+        puts url
+        code = gets
+        credentials = authorizer.get_and_store_credentials_from_code(
+          user_id: user_id,
+          code: code,
+          base_url: OOB_URL
+        )
+      end
+      # return the produced credentials
+      return credentials
+    end
+
+    # Setup calendar service for a session
+    #
+    # ==== Attributes
+    #
+    # * +:application_name:+ - Name of application setup in google console
+    # * +:credentials:+ - User authentication credentials
+    def setup_calendar_service(application_name, credentials)
+      service = Google::Apis::CalendarV3::CalendarService.new
+      service.client_options.application_name = application_name
+      service.authorization = credentials
+      # return service once it is setup
+      return service
+    end
+  end
+end

data/lib/googlecal/version.rb

@@ -0,0 +1,3 @@
+module Googlecal
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: googlecal
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Austin M Crane
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-03-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: google-api-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Simple wrapper around google calendar api
+email:
+- austin.crane@ennovar.wichita.edu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".DS_Store"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- googlecal.gemspec
+- lib/googlecal.rb
+- lib/googlecal/version.rb
+homepage: http://github.com
+licenses: []
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Simple wrapper around google calendar api
+test_files: []