google-cells 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8e91eb8141cc97ad38d072e1986b3de439b103fd
+  data.tar.gz: 1e5513c4d68f3a6f399530e376ad01ef85a5006d
+SHA512:
+  metadata.gz: bfbe733459648d1e428206fdd530383a6a24d8ddb91b3de3404f398f108fd7d0ca4230ae74b94a5ee52a4517e7b12c7a4b57b8a607ef34b79522e44c52e41cb0
+  data.tar.gz: 967e8491a166307e0ca3a09e4edbee55c0d53f9c9fa16cedad097fad35dbc4ed1f47e479fcb072cd79da23f8f049bec46915dcd935725292bb7bfeb579586292

data/.gitignore

@@ -0,0 +1,26 @@
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/
+
+# vim temp files
+*~
+*.swp
+*.swo
+
+# sensitive data
+spec/private_spec_helper.rb

data/.ruby-gemset

@@ -0,0 +1 @@
+google_cells

data/.ruby-version

@@ -0,0 +1,2 @@
+ruby-2.1.1
+

data/CHANGELOG.md

@@ -0,0 +1,28 @@
+Version 0.3.0
+=========================
+
++ Added Spreadsheet.subscribe and Spreadsheet.unsubscribe  
+
+Version 0.2.1
+=========================
+
++ Added if-match header to update for new Google sheets compatibility  
+  Fixes [GH#2](https://github.com/pikimal/google-cells/issues/2)
+
+Version 0.2.0
+=========================
+
++ Added Spreadsheet#defold to remove from a folder
++ Added explicit title setting to Spreadsheet.copy
+
+Version 0.1.1
+=========================
+
++ Fixed bug in Spreadsheet.delete  
++ Fixed rake default task to run specs  
+
+Version 0.1.0
+=========================
+
++ Added Spreadsheet#delete and Spreadsheet.delete  
+  Fixes [GH#1](https://github.com/pikimal/google-cells/issues/1)

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,73 @@
+PATH
+  remote: .
+  specs:
+    google-cells (0.2.1)
+      google-api-client (~> 0.7, >= 0.7.1)
+      nokogiri (~> 1.6, >= 1.6.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.3.5)
+    autoparse (0.3.3)
+      addressable (>= 2.3.1)
+      extlib (>= 0.9.15)
+      multi_json (>= 1.0.0)
+    crack (0.4.2)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.2.5)
+    extlib (0.9.16)
+    faraday (0.9.0)
+      multipart-post (>= 1.2, < 3)
+    google-api-client (0.7.1)
+      addressable (>= 2.3.2)
+      autoparse (>= 0.3.3)
+      extlib (>= 0.9.15)
+      faraday (>= 0.9.0)
+      jwt (>= 0.1.5)
+      launchy (>= 2.1.1)
+      multi_json (>= 1.0.0)
+      retriable (>= 1.4)
+      signet (>= 0.5.0)
+      uuidtools (>= 2.1.0)
+    jwt (0.1.11)
+      multi_json (>= 1.5)
+    launchy (2.4.2)
+      addressable (~> 2.3)
+    mini_portile (0.5.2)
+    multi_json (1.8.4)
+    multipart-post (2.0.0)
+    nokogiri (1.6.1)
+      mini_portile (~> 0.5.0)
+    rake (0.9.6)
+    retriable (1.4.1)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.7)
+    rspec-expectations (2.14.4)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.4)
+    safe_yaml (1.0.1)
+    signet (0.5.0)
+      addressable (>= 2.2.3)
+      faraday (>= 0.9.0.rc5)
+      jwt (>= 0.1.5)
+      multi_json (>= 1.0.0)
+    uuidtools (2.1.4)
+    vcr (2.8.0)
+    webmock (1.16.0)
+      addressable (>= 2.2.7)
+      crack (>= 0.3.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.5)
+  google-cells!
+  rake (~> 0)
+  rspec (~> 2.14, >= 2.14.1)
+  vcr (~> 2.8, >= 2.8.0)
+  webmock (~> 1.16, >= 1.6.0)

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Jessica Megan Thrower
+
+MIT License
+
+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,75 @@
+# GoogleCells
+
+A wrapper for Google's Spreadsheet and Drive APIs.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'google_cells'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install google_cells
+
+## Usage
+
+```ruby
+# configure with Google Service account keys
+GoogleCells.configure do |config|
+  config.service_account_email = 'my_service_account@email.here'
+  config.key_file = File.dirname(__FILE__) + 
+    '/path/to/private-key.file/from/Google'
+  config.key_secret = 'notasecret'
+end
+
+# list all spreadsheets in account
+files = GoogleCells::Spreadsheet.list
+files.each do |s|
+  p s.title
+end
+
+# get spreadsheet by google key
+s = GoogleCells::Spreadsheet.get('my-spreadsheet-key-here')
+
+# spread the love
+s.share(value:'mybestfriend@email.here', type:'user', role:'writer')
+
+# create a copy of file
+c = s.copy
+
+# put spreadsheet in a folder
+s.enfold('my-folder-key-here')
+
+# read cell content
+w = s.worksheets[0]
+w.rows.each do |row|
+  row.cells.each do |c|
+    p c.value
+    p c.input_value
+    p c.numeric_value
+  end
+end
+
+# and write it!
+w.rows.from(1).to(2).each do |row|
+  row.cells.each do |c|
+    c.input_value = "#{cell.row + cell.col}"
+  end
+end
+w.save!
+
+```
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/google_cells/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+

data/Rakefile

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

data/examples/oauth2_service_account.rb

@@ -0,0 +1,17 @@
+require 'rubygems'
+require 'sinatra'
+require "google_cells"
+require 'yaml'
+
+path =  File.expand_path(File.dirname(__FILE__) + '/../tmp/service_account.yml')
+file = YAML.load_file(path)
+
+GoogleCells.configure do |config|
+  config.service_account_email = file['email']
+  config.key_file = File.dirname(__FILE__) + file['path']
+  config.key_secret = file['key_secret']
+end
+ 
+require File.expand_path(File.dirname(__FILE__) + '/sinatra/routes')
+
+App::Routes.run!

data/examples/oauth2_web_flow.rb

@@ -0,0 +1,66 @@
+require 'rubygems'
+require 'sinatra'
+require "google_cells"
+require 'yaml'
+
+path =  File.expand_path(File.dirname(__FILE__) + '/../tmp/web_flow.yml')
+file = YAML.load_file(path)
+
+GoogleCells.configure do |config|
+  config.client_id = file['client_id']
+  config.client_secret = file['client_secret']
+end
+
+module App
+  class Routes < ::Sinatra::Base
+
+    enable :sessions
+
+    set :client, GoogleCells.client
+
+    def client
+      settings.client
+    end
+
+    def authorization
+      @authorization ||= (
+        auth = client.authorization.dup
+        auth.redirect_uri = to('/oauth2_callback')
+        auth.update_token!(session)
+        auth
+      )
+    end
+
+    before do
+      # Ensure user has authorized the app
+      unless authorization.access_token || request.path_info =~ /^\/oauth2/
+        redirect to('/oauth2_authorize')
+      end
+      GoogleCells.client.authorization = authorization
+    end
+
+    after do
+      # Serialize the access/refresh token to the session
+      session[:access_token] = authorization.access_token
+      session[:refresh_token] = authorization.refresh_token
+      session[:expires_in] = authorization.expires_in
+      session[:issued_at] = authorization.issued_at
+    end
+
+    get '/oauth2_authorize' do
+      # Request authorization
+      redirect authorization.authorization_uri.to_s, 303
+    end
+
+    get '/oauth2_callback' do
+      # Exchange token
+      authorization.code = params[:code] if params[:code]
+      authorization.fetch_access_token!
+      redirect to('/')
+    end
+  end
+end
+
+require File.expand_path(File.dirname(__FILE__) + '/sinatra/routes')
+
+App::Routes.run!

data/examples/sinatra/routes.rb

@@ -0,0 +1,21 @@
+require 'sinatra/base'
+
+module App
+  class Routes < ::Sinatra::Base
+    get '/' do
+      @spreadsheets = GoogleCells::Spreadsheet.list
+      @spreadsheets.sort_by!{|s| s.updated_at}
+      @spreadsheets.reverse!
+      text = "<h1>All Spreadsheets</h1>"
+      if @spreadsheets.empty?
+        text << "Nothing here."
+      else
+        text << "<% for s in @spreadsheets %>"
+        text << "<br/><%= s.updated_at %> -- <a href=\"https://docs.google.com/"
+        text << "spreadsheet/ccc?key=<%= s.key %>\"><%= s.title %></a>"
+        text << "<% end %>"
+      end
+      erb text
+    end
+  end
+end

data/google_cells.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'google_cells/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "google-cells"
+  spec.version       = GoogleCells::VERSION
+  spec.authors       = ["Jessica Megan Thrower"]
+  spec.email         = ["jmthrower@gmail.com"]
+  spec.summary       = %q{Google Spreadsheets API wrapper}
+  spec.description   = %q{An intuitive Google Spreadsheets API wrapper}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'google-api-client', '~> 0.7', '>= 0.7.1'
+  spec.add_dependency "nokogiri", "~> 1.6", ">= 1.6.1"
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency 'rake', '~> 0'
+
+  spec.add_development_dependency "rspec", '~> 2.14', ">= 2.14.1"
+  spec.add_development_dependency "vcr", "~> 2.8", '>= 2.8.0'
+  spec.add_development_dependency "webmock", "~> 1.16", ">= 1.6.0"
+end

data/lib/google_cells.rb

@@ -0,0 +1,80 @@
+require 'google/api_client'
+require 'nokogiri'
+
+require "google_cells/url_helper"
+require "google_cells/fetcher"
+require "google_cells/reader"
+require "google_cells/util"
+require "google_cells/google_object"
+require "google_cells/author"
+require "google_cells/cell"
+require "google_cells/cell_selector"
+require "google_cells/folder"
+require "google_cells/row"
+require "google_cells/spreadsheet"
+require "google_cells/worksheet"
+require "google_cells/version"
+
+module GoogleCells
+  class << self
+    attr_accessor :config, :client
+  end
+
+  def self.configure
+    self.config ||= Configuration.new
+    yield(config)
+
+    self.client = Google::APIClient.new(
+      :application_name => 'GoogleCells App',
+      :application_version => '0.0.3'
+    )
+    if config.path_to_credentials_file
+      config_from_file
+    elsif config.client_id
+      config_web_application
+    else
+      config_service_account
+    end
+    client.authorization.scope = ['https://www.googleapis.com/auth/drive',
+      'https://spreadsheets.google.com/feeds']
+    client.authorization.token_credential_uri = 'https://accounts.google.com/o/oauth2/token'
+
+    config
+  end
+
+  class Configuration
+    attr_accessor :service_account_email, :key_secret, :key_file, :client_id, 
+      :client_secret, :path_to_credentials_file
+
+    def initialize
+      @key_secret = 'notasecret'
+
+      @api_version = 'v2'
+      @cached_api_file = "drive-#{@api_version}.cache"
+    end
+  end
+
+  private
+
+  def self.config_web_application
+    client.authorization.client_id = config.client_id
+    client.authorization.client_secret = config.client_secret
+  end
+
+  def self.config_service_account
+    key = Google::APIClient::KeyUtils.load_from_pkcs12(config.key_file, 
+      config.key_secret)
+    opts = { issuer: config.service_account_email,
+      signing_key: key }
+
+    client.authorization = Signet::OAuth2::Client.new(opts)
+    client.authorization.audience = 'https://accounts.google.com/o/oauth2/token'
+  end
+
+  def self.config_from_file
+    flow = Google::APIClient::FileStorage.new(
+      :path => config.path_to_credentials_file
+    )
+    client.authorization = flow.authorize
+  end
+end