google_sheet_reader 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5fddd75645c1a3b2ab59543f2b803bb176597392
+  data.tar.gz: 723e426884952c3d1aa67b7177dd3f9bfe1cf847
+SHA512:
+  metadata.gz: 0416b7d595761e4c5236ad68889cce2ea4f7ba48b7bfb1c9fac152424e6d2f25dbb4e53f69ec522d0b017c2c8f6d9b6b0d27c3b4103faa7a186d770aa69a01b7
+  data.tar.gz: 09da21de9750c5ee53b31b6705a4e0dc55ed9a3c9f33ff5aee13bb73e1876bf0c494b428eb44a742810bb21faa7c8deaeb7b9f6bcac9e5c0792ef41a19a23be0

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.0
+before_install: gem install bundler -v 1.10.5

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 MJ Rossetti (@s2t2)
+
+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,83 @@
+# GoogleSheetReader
+
+A ruby library
+for extracting spreadsheet data from [Google Drive](https://www.google.com/drive/).
+
+Performs a custom ETL procedure on each row.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'google_sheet_reader'
+```
+
+Or install yourself with `gem install google_sheet_reader`.
+
+## Usage
+
+```` rb
+spreadsheet_id = "1a2B3C45_x0G44lk15Ff_M33ps"
+# see Prerequisites section below for instructions on how to obtain most of these configuration option values ...
+configuration_options = {
+  :app_name => "my-app",
+  :email_address => "abc-123@developer.gserviceaccount.com",
+  :key_file_path => File.expand_path("../key_file/my-app-abc123xy456z.p12", __FILE__),
+  :extraction_procedure => Proc.new do |row|
+    "PARSING A SPREADSHEET ROW HERE -- #{row.inspect}"
+  end
+}
+
+GoogleSheetReader.extract(spreadsheet_id, configuration_options)
+````
+
+### Prerequisites
+
+#### Drive API-enabled App
+
+Visit the [google developer console](https://console.developers.google.com), create a new application, and note its name.
+
+Navigate to the **APIs & Auth > APIs** menu and enable the *Drive API* by searching for it.
+
+#### Service Account
+
+Navigate to the **APIs & Auth > Credentials** menu and add credentials for a service account.
+
+Choose the .p12 key file option, download it, optionally move it somewhere else, and finally note its file path.
+
+Back in the browser, also note the service account's email address.
+
+#### Spreadsheet
+
+Create a spreadsheet, and inspect its url to find its document identifier: *docs.google.com/spreadsheets/d/`spreadsheet_id`/edit*.
+
+Share the spreadsheet with the service account's email address in a "can edit" role.
+
+## Contributing
+
+Browse existing [issues](https://github.com/data-creative/google-sheet-reader-ruby/issues) or create a new issue to communicate bugs, desired features, etc.
+
+After forking the repo and pushing your changes, create a pull request referencing the applicable issue(s).
+
+### Developing
+
+After checking out the repo, run `bin/setup` to install dependencies.
+
+### Testing
+
+Store a real service account .p12 key file in the **spec/key_file/** directory, and add the following environment variables to your .bash_profile:
+
+ + `GOOGLE_SHEET_READER_APP_NAME`
+ + `GOOGLE_SHEET_READER_EMAIL`
+ + `GOOGLE_SHEET_READER_KEY_FILE_NAME`
+
+Run `rake rspec` or `bundle exec rspec spec/` to run the tests.
+
+Optionally run `bin/console` for an interactive prompt that will allow you to experiment.
+
+### Releasing
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## [License](LICENSE.txt)

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,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "google_sheet_reader"
+
+# 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,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/google_sheet_reader.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'google_sheet_reader/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "google_sheet_reader"
+  spec.version       = GoogleSheetReader::VERSION
+  spec.authors       = ["MJ Rossetti (@s2t2)"]
+  spec.email         = ["s2t2mail+git@gmail.com"]
+
+  spec.summary       = %q{A ruby library for extracting spreadsheet data from Google Drive.}
+  spec.description   = %q{A ruby library for extracting spreadsheet data from Google Drive. Performs a custom ETL procedure on each row.}
+  spec.homepage      = "https://github.com/data-creative/google-sheet-reader-ruby"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "pry", "~> 0.10"
+  spec.add_development_dependency "yard"
+  spec.add_dependency 'google-api-client'
+end

data/lib/google_sheet_reader.rb

@@ -0,0 +1,72 @@
+require 'google/api_client'
+require 'csv'
+
+require "google_sheet_reader/version"
+
+module GoogleSheetReader
+
+  def self.client(options = {})
+    app_name = options[:app_name]
+    email_address = options[:email_address]
+    key_file_path = options[:key_file_path]
+
+    key = Google::APIClient::KeyUtils.load_from_pkcs12(key_file_path, 'notasecret')
+    asserter = Google::APIClient::JWTAsserter.new(email_address, 'https://www.googleapis.com/auth/drive', key)
+    google_api_client = Google::APIClient.new({:application_name => app_name, :application_version => "1.0"})
+    google_api_client.authorization = asserter.authorize()
+    return google_api_client
+  end
+
+  # Extract data from a Google Drive spreadsheet.
+  #
+  # @param [String] spreadsheet_id
+  # @param [Hash] options [String] app_name
+  # @param [Hash] options [String] email_address
+  # @param [Hash] options [String] key_file_path
+  # @param [Hash] options [Proc] extraction_procedure
+  #
+  # @example GoogleSheetReader.extract(file_id, opts)
+  #
+  def self.extract(spreadsheet_id, options = {})
+    app_name = options[:app_name]
+    email_address = options[:email_address]
+    key_file_path = options[:key_file_path]
+    extraction_procedure = options[:extraction_procedure]
+
+    puts "CONNECTING TO GOOGLE DRIVE ..."
+
+    google_api_client = self.client(options)
+    drive = google_api_client.discovered_api('drive', 'v2')
+
+    get_request_result = google_api_client.execute(
+      :api_method => drive.files.get,
+      :parameters => { 'fileId' => spreadsheet_id }
+    )
+    raise FileRetrievalError unless get_request_result.status == 200
+
+    file = get_request_result.data
+    download_url = file.exportLinks["text/csv"]
+    raise FileDownloadLinkError unless download_url
+
+    download_request_result = google_api_client.execute(:uri => download_url)
+    raise FileDownloadError unless download_request_result.status == 200
+
+    file_contents = download_request_result.body
+    csv_result = CSV.parse(file_contents, headers:true)
+    #headers = csv_result.headers
+
+    raise EmptyFileError.new("This spreadsheet has no data. Please add rows.") unless csv_result.any?
+
+    csv_result.each do |row|
+      extraction_procedure.call(row)
+    end
+
+    puts "PARSED #{csv_result.count} ROWS"
+    return {:status => "SUCCESS", :row_count => csv_result.count}
+  end
+
+  class FileRetrievalError < StandardError ; end
+  class FileDownloadLinkError < StandardError ; end
+  class FileDownloadError < StandardError ; end
+  class EmptyFileError < StandardError ; end
+end

data/lib/google_sheet_reader/version.rb

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

data/mocks/spreadsheet_file.rb

@@ -0,0 +1,36 @@
+#<Google::APIClient::Schema::Drive::V2::File:0x3fc9526f4edc DATA:
+{
+  "kind"=>"drive#file",
+  "id"=>"xyz_123",
+  "etag"=>"\"abcd\"",
+  "selfLink"=>"https://www.googleapis.com/drive/v2/files/xyz_123",
+  "alternateLink"=>"https://docs.google.com/spreadsheets/d/xyz_123/edit?usp=drivesdk",
+  "embedLink"=>"https://docs.google.com/spreadsheets/d/xyz_123/htmlembed",
+   "iconLink"=>"https://ssl.gstatic.com/docs/doclist/images/icon_11_spreadsheet_list.png",
+    "thumbnailLink"=>"https://docs.google.com/feeds/vt?gd=true&id=xyz_123&v=0&s=ggggg",
+     "title"=>"my-sheet",
+      "mimeType"=>"application/vnd.google-apps.spreadsheet",
+       "labels"=>{"starred"=>false, "hidden"=>false, "trashed"=>false, "restricted"=>false, "viewed"=>false}, "createdDate"=>"2015-09-18T23:40:45.972Z",
+        "modifiedDate"=>"2015-09-19T02:01:13.137Z",
+         "markedViewedByMeDate"=>"1970-01-01T00:00:00.000Z",
+          "sharedWithMeDate"=>"2015-09-19T02:01:13.144Z",
+           "version"=>"98647",
+            "sharingUser"=>{"kind"=>"drive#user",
+               "displayName"=>"Jim Jones",
+                "picture"=>{"url"=>"https://lh6.googleusercontent.com/photo.jpg"}, "isAuthenticatedUser"=>false, "permissionId"=>"1234567890987654321",
+                 "emailAddress"=>"jim.Jones@gmail.com"}, "parents"=>[],"exportLinks"=>{"text/csv"=>"https://docs.google.com/spreadsheets/export?id=xyz_123&exportFormat=csv",
+                    "application/pdf"=>"https://docs.google.com/spreadsheets/export?id=xyz_123&exportFormat=pdf",
+                     "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet"=>"https://docs.google.com/spreadsheets/export?id=xyz_123&exportFormat=xlsx"}, "userPermission"=>{"kind"=>"drive#permission",
+                        "etag"=>"\"tagggggggggg3434738473\"",
+                         "id"=>"me",
+                          "selfLink"=>"https://www.googleapis.com/drive/v2/files/xyz_123/permissions/me",
+                           "role"=>"writer",
+                            "type"=>"user"}, "quotaBytesUsed"=>"0",
+                             "ownerNames"=>["Jim Jones"], "owners"=>[{"kind"=>"drive#user",
+                                "displayName"=>"Jim Jones",
+                                 "picture"=>{"url"=>"https://lh6.googleusercontent.com/photo.jpg"}, "isAuthenticatedUser"=>false, "permissionId"=>"1234567890987654321",
+                                  "emailAddress"=>"jim.Jones@gmail.com"}], "lastModifyingUserName"=>"Jim Jones",
+                                   "lastModifyingUser"=>{"kind"=>"drive#user",
+                                      "displayName"=>"Jim Jones",
+                                       "picture"=>{"url"=>"https://lh6.googleusercontent.com/photo.jpg"}, "isAuthenticatedUser"=>false, "permissionId"=>"1234567890987654321",
+                                        "emailAddress"=>"jim.Jones@gmail.com"}, "editable"=>true, "copyable"=>true, "writersCanShare"=>true, "shared"=>true, "explicitlyTrashed"=>false, "appDataContents"=>false, "spaces"=>["drive"]} #>

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification
+name: google_sheet_reader
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- MJ Rossetti (@s2t2)
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-09-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.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: yard
+  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'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A ruby library for extracting spreadsheet data from Google Drive. Performs
+  a custom ETL procedure on each row.
+email:
+- s2t2mail+git@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- google_sheet_reader.gemspec
+- lib/google_sheet_reader.rb
+- lib/google_sheet_reader/version.rb
+- mocks/spreadsheet_file.rb
+homepage: https://github.com/data-creative/google-sheet-reader-ruby
+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.4.5
+signing_key: 
+specification_version: 4
+summary: A ruby library for extracting spreadsheet data from Google Drive.
+test_files: []
+has_rdoc: