g_sheets 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cc92b3a82cf114ffe7d27920a57e044c63df59b6
+  data.tar.gz: 4c01053def903df907b56746493d1067914a182e
+SHA512:
+  metadata.gz: dd009be75e2ab073a9750dd8ddd5f82739829d96d05569cffbf49087780c71d7447b80d3950237746a5e6b10f47ce09da58b163b83461d77d7e39a08c60b4348
+  data.tar.gz: 5b8e72be57bd46cd6f18b5af7d41f334c7ebbc8a47d571842e761ccfde70a6fd769ae5d8f38402df2fe33e2439da172e8681273aff1c7208d8434666ddc5c20b

data/.env.sample

@@ -0,0 +1,3 @@
+export CLIENT_ID="your-client-id.apps.googleusercontent.com"
+export CLIENT_SECRET="your-client-secret"
+

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+.env
+

data/.rspec

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

data/.travis.yml

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

data/Gemfile

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

data/README.md

@@ -0,0 +1,69 @@
+# GSheets
+
+A Google Sheets api adapter in ruby
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'g_sheets'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install g_sheets
+
+## Usage
+
+### Configuration
+
+We're using the `dotenv` gem so you can just place your environment variables inside a file called `.env` and add that file to your `.gitignore` list; that way your authentication keys are kept safe.
+
+If you wish to access user's data, you will need to create credentials for an `OAuth client ID`. Please see the [documentation](https://developers.google.com/identity/protocols/OAuth2) on how to get the client id and secret.
+
+### Getting the an OAuth token from Google
+
+In order to make operations on a user's Google Spreadsheet you will need an authentication token. There is a sample console OAuth token generator available in `GSheets::Oauth`
+
+```ruby
+  CLIENT_ID = ENV["CLIENT_ID"]; CLIENT_SECRET = ENV["CLIENT_SECRET"]
+  authenticator = GSheets::Oauth::Offline.new(CLIENT_ID, CLIENT_SECRET)
+  uri = authenticator.get_authentication_uri
+
+  puts "Please open #{uri.to_s} in your browser, accept the permissions, and copy-paste the code"
+  code = $stdin.gets.chomp
+
+  refresh_token = authenticator.get_refresh_token(authentication_code: code)
+  access_token = authenticator.get_access_token(refresh_token: refresh_token)
+```
+
+Save the `refresh_token` somewhere safe, as it would be used later to create a new `get_access_token` when that expires.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+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).
+
+You can also run `bundle exec rake console` to get a `pry` console running with all files required.
+
+Please see the [documentation](https://developers.google.com/sheets/api/v3/data) on the sheets api if you'd like to add more functionality :)
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/parasquid/g_sheets.
+
+TODO:
+  * Ability to include a module into a class and magically give it crud properties:
+    * .where
+    * .find
+    * .create
+    * .order
+    * .delete
+  * Documentation and guides on how to use standalone
+  * Documentation and guides on how to use with Rails

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+desc "Open a pry session preloaded with this library"
+task :console do
+  system "pry --gem"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "g_sheets"
+
+# 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(__FILE__)

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/g_sheets.gemspec

@@ -0,0 +1,44 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'g_sheets/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "g_sheets"
+  spec.version       = GSheets::VERSION
+  spec.authors       = ["parasquid"]
+  spec.email         = ["tristan.gomez@gmail.com"]
+
+  spec.summary       = %q{Database like API for Google Spreadsheets}
+  # spec.description   = %q{TODO: Write a longer description or delete this line.}
+  spec.homepage      = "https://github.com/parasquid/g_sheets"
+
+  # 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.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against " \
+  #     "public gem pushes."
+  # end
+
+  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_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+
+  spec.add_development_dependency "rspec-given"
+  spec.add_development_dependency "guard-rspec"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "dotenv"
+
+  spec.add_dependency "faraday", "~> 0.11.0"
+  spec.add_dependency "nori", "~> 2.6.0"
+  spec.add_dependency "google-api-client", "~> 0.10"
+end

data/lib/g_sheets/oauth/offline.rb

@@ -0,0 +1,63 @@
+require 'signet/oauth_2/client'
+
+module GSheets
+  module Oauth
+    class Offline
+      attr_reader :client_id, :client_secret, :scope, :signet_client
+
+      def initialize(
+        client_id,
+        client_secret,
+        scope: default_scopes,
+        signet_client: nil
+      )
+        @client_id = client_id
+        @client_secret = client_secret
+        @scope = scope
+        @signet_client = signet_client || get_signet_client
+      end
+
+      def get_authentication_uri
+        @signet_client.authorization_uri
+      end
+
+      def get_access_token(authentication_code: nil, refresh_token: nil)
+        error_message = "you must provide either an authentication_code or refresh_token".freeze
+        raise ArgumentError, error_message if authentication_code.nil? && refresh_token.nil?
+        @signet_client.code = authentication_code if authentication_code
+        @signet_client.refresh_token = refresh_token if refresh_token
+        @signet_client.fetch_access_token!
+        @signet_client.access_token
+      end
+
+      def get_refresh_token(authentication_code:)
+        @signet_client.code = authentication_code
+        @signet_client.fetch_access_token!
+        @signet_client.refresh_token
+      end
+
+      private
+
+      def default_scopes
+        [
+          "https://www.googleapis.com/auth/drive",
+          "https://www.googleapis.com/auth/drive.file",
+          "https://www.googleapis.com/auth/drive.metadata",
+          "https://spreadsheets.google.com/feeds",
+          "https://docs.google.com/feeds"
+        ]
+      end
+
+      def get_signet_client
+        Signet::OAuth2::Client.new(
+          authorization_uri: 'https://accounts.google.com/o/oauth2/auth',
+          token_credential_uri:  'https://www.googleapis.com/oauth2/v3/token',
+          client_id: client_id,
+          client_secret: client_secret,
+          :scope => scope,
+          :redirect_uri => 'urn:ietf:wg:oauth:2.0:oob'
+        )
+      end
+    end
+  end
+end

data/lib/g_sheets/session.rb

@@ -0,0 +1,6 @@
+require "g_sheets/v4/session"
+
+module GSheets
+  class Session < V4::Session
+  end
+end

data/lib/g_sheets/sheet.rb

@@ -0,0 +1,6 @@
+require "g_sheets/v4/sheet"
+
+module GSheets
+  class Sheet < V4::Sheet
+  end
+end

data/lib/g_sheets/spread_sheet.rb

@@ -0,0 +1,6 @@
+require "g_sheets/v4/spread_sheet"
+
+module GSheets
+  class SpreadSheet < V4::SpreadSheet
+  end
+end

data/lib/g_sheets/v3/session.rb

@@ -0,0 +1,33 @@
+module GSheets
+  module V3
+    class Session
+      def initialize(access_token:, http_client: Faraday, alt: "json")
+        @access_token = access_token
+        @alt = alt
+        @http_client = http_client
+      end
+
+      def get_cells(id:, grid_id: "default", options:[])
+        connection.get "cells/#{id}/#{grid_id}/private/full?#{options.join('&')}"
+      end
+
+      def get_list(id:, grid_id: "default", options:[])
+        connection.get "list/#{id}/#{grid_id}/private/full?#{options.join('&')}"
+      end
+
+      def get_worksheets(id:)
+        connection.get "worksheets/#{id}/private/full"
+      end
+
+      def connection
+        @http_client.new "#{sheets_api_endpoint}?access_token=#{@access_token}&alt=#{@alt}"
+      end
+
+      private
+
+      def sheets_api_endpoint
+        "https://spreadsheets.google.com/feeds"
+      end
+    end
+  end
+end

data/lib/g_sheets/v3/spread_sheet.rb

@@ -0,0 +1,47 @@
+module GSheets
+  module V3
+    class SpreadSheet
+      def initialize(session:, id:)
+        @id = id
+        @session = session
+      end
+
+      def worksheets
+        list_work_sheets.keys.map do |title|
+          WorkSheet.new(session: @session, id: @id, grid_id: list_work_sheets[title])
+        end
+      end
+
+      private
+
+      def list_work_sheets
+        result = {}
+        document["feed"]["entry"].each do |e|
+          result[get_title(e)] = get_grid_id_from_link(e["link"])
+        end
+        result
+      end
+
+      def document
+        JSON.parse(@session.get_worksheets(id: @id).body)
+      end
+
+      def get_title(entry)
+        entry["title"]["$t"]
+      end
+
+      def get_self_link(link)
+        link.select { |l| l["rel"] == "self" }.first["href"]
+      end
+
+      def get_grid_id(self_link)
+        self_link.split("/").last
+      end
+
+      def get_grid_id_from_link(link)
+        self_link = get_self_link(link)
+        get_grid_id(self_link)
+      end
+    end
+  end
+end

data/lib/g_sheets/v3/work_sheet.rb

@@ -0,0 +1,50 @@
+module GSheets
+  module V3
+    class WorkSheet
+      def initialize(session:, grid_id: " default", id:)
+        @grid_id = grid_id
+        @session = session
+        @id = id
+      end
+
+      def headers
+        cells_first_row["feed"]["entry"].map {|e| e["content"]["$t"]}
+      end
+
+      def rows
+        data_list = worksheet_as_list["feed"]["entry"]
+        list = data_list.map {|entry|
+          [
+            "title: #{entry['title']['$t']}",
+            entry["content"]["$t"]
+          ].join(", ")
+        }
+
+        result = []
+        list.each do |l|
+          row = {}
+          l.split(",").each do |elem|
+            e = elem.split(":")
+            row[e.first.strip.freeze] = e.last.strip.freeze
+          end
+          result << row
+        end
+        result.map(&:values)
+      end
+
+      private
+
+      def cells_first_row
+        JSON.parse(@session.get_cells(id: @id, grid_id: @grid_id, options: header_row_options).body)
+      end
+
+      def worksheet_as_list
+        JSON.parse(@session.get_list(id: @id, grid_id: @grid_id).body)
+      end
+
+      def header_row_options
+        ["min-row=1", "max-row=1"]
+      end
+    end
+  end
+end

data/lib/g_sheets/v4/session.rb

@@ -0,0 +1,28 @@
+module GSheets
+  module V4
+    class Session
+      def initialize(access_token:, service: Google::Apis::SheetsV4::SheetsService.new)
+        @access_token = access_token
+        @service = service
+        @service.authorization = access_token
+      end
+
+      def get_sheets_from_spreadsheet(id)
+        service.get_spreadsheet(id).sheets
+      end
+
+      def append_row_to_spreadsheet(id:, row:, sheet_name:)
+        service.append_spreadsheet_value(
+          id,
+          sheet_name,
+          {"values": [row]},
+          value_input_option: "RAW"
+        )
+      end
+
+      def service
+        @service
+      end
+    end
+  end
+end

data/lib/g_sheets/v4/sheet.rb

@@ -0,0 +1,20 @@
+module GSheets
+  module V4
+    class Sheet
+      def initialize(sheet:, spread_sheet:)
+        @sheet = sheet
+        @spread_sheet = spread_sheet
+        @session = spread_sheet.session
+        @sheet_name = sheet.properties.title
+      end
+
+      def append(row)
+        @session.append_row_to_spreadsheet(
+          id: @spread_sheet.id,
+          sheet_name: @sheet_name,
+          row: row
+        )
+      end
+    end
+  end
+end

data/lib/g_sheets/v4/spread_sheet.rb

@@ -0,0 +1,22 @@
+module GSheets
+  module V4
+    class SpreadSheet
+      attr_accessor :id
+
+      def initialize(session:, id:)
+        @session = session
+        @id = id
+      end
+
+      def sheets
+        @session.get_sheets_from_spreadsheet(@id).map { |sheet|
+          Sheet.new(sheet: sheet, spread_sheet: self)
+        }
+      end
+
+      def session
+        @session
+      end
+    end
+  end
+end

data/lib/g_sheets/version.rb

@@ -0,0 +1,3 @@
+module GSheets
+  VERSION = "0.2.0"
+end

data/lib/g_sheets.rb

@@ -0,0 +1,14 @@
+require "dotenv/load"
+
+require "faraday"
+require "google/apis/sheets_v4"
+
+module GSheets
+  # Your code goes here...
+end
+
+require "g_sheets/version"
+require "g_sheets/oauth/offline"
+require "g_sheets/session"
+require "g_sheets/spread_sheet"
+require "g_sheets/sheet"

metadata

@@ -0,0 +1,205 @@
+--- !ruby/object:Gem::Specification
+name: g_sheets
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- parasquid
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-02-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec-given
+  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: guard-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'
+  type: :development
+  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: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.0
+- !ruby/object:Gem::Dependency
+  name: nori
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.6.0
+- !ruby/object:Gem::Dependency
+  name: google-api-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+description: 
+email:
+- tristan.gomez@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".env.sample"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- g_sheets.gemspec
+- lib/g_sheets.rb
+- lib/g_sheets/oauth/offline.rb
+- lib/g_sheets/session.rb
+- lib/g_sheets/sheet.rb
+- lib/g_sheets/spread_sheet.rb
+- lib/g_sheets/v3/session.rb
+- lib/g_sheets/v3/spread_sheet.rb
+- lib/g_sheets/v3/work_sheet.rb
+- lib/g_sheets/v4/session.rb
+- lib/g_sheets/v4/sheet.rb
+- lib/g_sheets/v4/spread_sheet.rb
+- lib/g_sheets/version.rb
+homepage: https://github.com/parasquid/g_sheets
+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.6.8
+signing_key: 
+specification_version: 4
+summary: Database like API for Google Spreadsheets
+test_files: []