google_sheets 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 598703000a2529218f78b0bb7f0c049aec30d79ce9f3e309ebeab51a5c6d3451
+  data.tar.gz: 0fed844fbb50b5cb4275f647d4b8704ddec1ba90e7a69194498b0180ad98da22
+SHA512:
+  metadata.gz: c439fe3506db60ae0cfd37f26822a7525ed120b55a237be5eff4aea121d9d2f083d7bbfe897444a92ad5735d0550bdde3096c9a5d36754eb42d311749f922bc2
+  data.tar.gz: 69a0e9ef52693cf4dfd6011a1404288f16db25d285a60a1ad53c57b6c3cfe3f51f5b4542bc4f343387006c199dfa219e8ebd3c324efea295c20e2e08143330ab

data/README.md

@@ -0,0 +1,89 @@
+[google-drive-ruby](https://github.com/gimite/google-drive-ruby), a great gem, doesn't support Google's v4 Drive API.  As a result, I seem to encounter rate limiting errors fairly quickly.
+
+Since I only ever used that gem for creating/reading spreadsheets, I created this simple gem for just that, but using the v4 API.
+
+* [Installing](#installing)
+* [Getting started](#getting-started)
+* [GitHub](http://github.com/shmay/google_sheets)
+
+## <a name="installing">Installing</a>
+
+Add this line to your application's Gemfile & `bundle install`:
+
+```ruby
+gem 'google_sheets'
+```
+
+Or install it yourself:
+
+```
+$ gem install google_drive
+```
+
+### Authorization
+
+The authorization process is taken from Google's [own tutorial](https://developers.google.com/sheets/api/quickstart/ruby#step_3_set_up_the_sample).
+
+You'll need to create a project and enable the GSheets API, as detailed [in step 1 of that tutorial](https://developers.google.com/sheets/api/quickstart/ruby#step_1_turn_on_the_api_name).
+
+You'll download a `client_secret.json` that will contain a `client_id` and `client_secret`
+
+I recommend using Rails 5.2's encrypted credentials to store the id & secret.  So the final will result will look something like:
+
+``` ruby
+client_id = Rails.application.credentials[:client_id]
+client_secret = Rails.application.credentials[:client_secret]
+
+session = GoogleSheets::Session.start_session(
+  client_id: client_id,
+  client_secret: client_secret
+)
+```
+
+Or store them in an environment variable, EG: `ENV['client_id']`
+
+This will prompt you to authorize the app in the browser.  Once completed, you'll notice a `token.yaml` in your cwd.  If you'd like the file to be placed elsewhere, there's a `token_path` parameter that you can pass into `start_session`, EG:
+
+``` ruby
+session = GoogleSheets::Session.start_session(
+  client_id: client_id,
+  client_secret: client_secret,
+  token_path: './tmp'
+)
+```
+
+### Getting Started
+
+Once you're authorized, you can read, create, and delete sheets within a spreadsheet.
+
+``` ruby
+session = GoogleSheets::Session.start_session(
+  client_id: ENV['test_client_id'],
+  client_secret: ENV['test_client_secret']
+)
+
+spreadsheet = session.spreadsheet_from_key '[your spreadsheet key]'
+
+spreadsheet.sheets.map &:title
+# => ['Sheet1', 'yoyo1']
+
+sheet1 = spreadsheet.sheets[0]
+
+sheet1.values
+# => [['one','two'], ['three', 'four']
+
+values = [[1,2],[3,4]]
+
+sheet2 = spreadsheet.add_sheet('what', values: values)
+
+spreadsheet.sheets.map &:title
+# => ['Sheet1', 'yoyo1', 'what']
+
+# this will delete the sheet!!!
+sheet.delete!
+
+spreadsheet.sheets.map &:title
+# => ['Sheet1', 'yoyo1']
+```
+
+Or just look at [the spec](spec/test_all_the_things_spec.rb) to see it in action.

data/lib/google_sheets/session.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal
+
+require 'google/apis/sheets_v4'
+require 'googleauth'
+require 'googleauth/stores/file_token_store'
+require 'fileutils'
+
+require 'google_sheets/sheet'
+require 'google_sheets/spreadsheet'
+
+module GoogleSheets
+  class Session
+    OOB_URI = 'urn:ietf:wg:oauth:2.0:oob'.freeze
+    # APPLICATION_NAME = 'Google Sheets API Ruby Quickstart'.freeze
+    # CLIENT_SECRETS_FILENAME = 'client_secret.json'.freeze
+    CREDENTIALS_FILENAME = 'token.yaml'.freeze
+    SCOPE = Google::Apis::SheetsV4::AUTH_SPREADSHEETS
+
+    def initialize service
+      @service = service
+    end
+
+    def spreadsheet_from_key key
+      Spreadsheet.new @service, key
+    end
+
+    ### AUTH CODE TAKEN FROM: https://developers.google.com/sheets/api/quickstart/ruby#step_3_set_up_the_sample
+    #
+    ##
+    # Ensure valid credentials, either by restoring from the saved credentials
+    # files or intitiating an OAuth2 authorization. If authorization is required,
+    # the user's default browser will be launched to approve the request.
+    #
+    # @return [Google::Auth::UserRefreshCredentials] OAuth2 credentials
+    def self.authorize client_id, client_secret, token_path
+      credentials_hash = {
+        "installed" =>
+          {
+            "client_id" => client_id,
+            "client_secret" => client_secret
+          }
+      }
+
+      client_id = Google::Auth::ClientId.from_hash(credentials_hash)
+
+      # client_id = Google::Auth::ClientId.from_file(CLIENT_SECRETS_PATH)
+      token_store = Google::Auth::Stores::FileTokenStore.new(file: token_path + '/' + CREDENTIALS_FILENAME)
+      authorizer = Google::Auth::UserAuthorizer.new(client_id, SCOPE, token_store)
+      user_id = 'default'
+      credentials = authorizer.get_credentials(user_id)
+
+      if credentials.nil?
+        url = authorizer.get_authorization_url(base_url: OOB_URI)
+        puts "Open the following URL in the browser and enter the resulting code after authorization:\n #{url} \n"
+
+        code = STDIN.gets
+
+        credentials = authorizer.get_and_store_credentials_from_code(
+          user_id: user_id, code: code, base_url: OOB_URI
+        )
+      end
+
+      credentials
+    end
+
+    def self.start_session client_id:, client_secret:, token_path: '.'
+      # Initialize the API
+      service = Google::Apis::SheetsV4::SheetsService.new
+      # service.client_options.application_name = APPLICATION_NAME
+      service.authorization = authorize(client_id, client_secret, token_path)
+
+      Session.new(service)
+    end
+
+  end
+end

data/lib/google_sheets/sheet.rb

@@ -0,0 +1,39 @@
+module GoogleSheets
+  class Sheet
+    attr_reader :properties, :title
+    attr_writer :values
+
+    def initialize service, sheet, spreadsheet
+      @service = service
+      @spreadsheet = spreadsheet
+      @sheet = sheet
+      @properties = sheet.properties.to_h
+      @title = @properties[:title]
+    end
+
+    def id
+      @properties[:sheet_id]
+    end
+
+    def values
+      @values ||= @service.get_spreadsheet_values(@spreadsheet.key, @title).values
+    end
+
+    def delete!
+      delete_sheet_request = Google::Apis::SheetsV4::DeleteSheetRequest.new
+      delete_sheet_request.sheet_id = self.id
+
+      batch_update_spreadsheet_request = Google::Apis::SheetsV4::BatchUpdateSpreadsheetRequest.new
+      batch_update_spreadsheet_request.requests = Google::Apis::SheetsV4::Request.new
+
+      batch_update_spreadsheet_request_object = [ delete_sheet: delete_sheet_request ]
+      batch_update_spreadsheet_request.requests = batch_update_spreadsheet_request_object
+
+      response = @service.batch_update_spreadsheet(@spreadsheet.key, batch_update_spreadsheet_request)
+
+      @spreadsheet.sheets.delete(self)
+
+      self
+    end
+  end
+end

data/lib/google_sheets/spreadsheet.rb

@@ -0,0 +1,61 @@
+module GoogleSheets
+  class Spreadsheet
+    attr_reader :key
+
+    def initialize service, key
+      @key = key
+      @service = service
+      load_spreadsheet
+    end
+
+    def load_spreadsheet
+      @spreadsheet = @service.get_spreadsheet(@key)
+      @properties = @spreadsheet.properties.to_h
+    end
+
+    alias refresh! load_spreadsheet
+
+    def sheets
+      @sheets ||= @spreadsheet.sheets.map do |sheet|
+        Sheet.new(@service, sheet, self)
+      end
+    end
+
+    # HT this SO answer: https://stackoverflow.com/a/49886382/548170
+    def add_sheet title, values: []
+      add_sheet_request = Google::Apis::SheetsV4::AddSheetRequest.new
+      add_sheet_request.properties = Google::Apis::SheetsV4::SheetProperties.new
+      add_sheet_request.properties.title = title
+
+      batch_update_spreadsheet_request = Google::Apis::SheetsV4::BatchUpdateSpreadsheetRequest.new
+      batch_update_spreadsheet_request.requests = Google::Apis::SheetsV4::Request.new
+
+      batch_update_spreadsheet_request_object = [ add_sheet: add_sheet_request ]
+      batch_update_spreadsheet_request.requests = batch_update_spreadsheet_request_object
+
+      response = @service.batch_update_spreadsheet(@key, batch_update_spreadsheet_request)
+
+      resp = append_to_sheet(title, values) if values&.any?
+
+      add_sheet = response.replies[0].add_sheet
+
+      sheet = Sheet.new(@service, add_sheet, self)
+
+      sheet.values = values if values&.any?
+
+      self.sheets << sheet
+
+      sheet
+    end
+
+    def append_to_sheet title, values
+      # The A1 notation of a range to search for a logical table of data.
+      # Values will be appended after the last row of the table.
+      range = title
+
+      request_body = Google::Apis::SheetsV4::ValueRange.new(values: values)
+
+      response = @service.append_spreadsheet_value(@key, range, request_body, value_input_option: 'RAW')
+    end
+  end
+end

data/lib/google_sheets.rb

@@ -0,0 +1,4 @@
+require 'google_sheets/session'
+
+module GoogleSheets
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: google_sheets
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Kyle Murphy
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-07-03 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.11.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 0.22.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.11.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 0.22.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'
+description: CRUD Google Sheets in Ruby
+email: kmurph73@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/google_sheets.rb
+- lib/google_sheets/session.rb
+- lib/google_sheets/sheet.rb
+- lib/google_sheets/spreadsheet.rb
+homepage: http://rubygems.org/gems/google_sheets
+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.7.6
+signing_key: 
+specification_version: 4
+summary: Basic Google Sheets interaction, using the v4 api.
+test_files: []