sheetsapi 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5887f33b34b4d32d067e4cc69728f5532a157af1
+  data.tar.gz: e12c57c00648b6bbadbff69f140c49981b4c099a
+SHA512:
+  metadata.gz: 53cbf7018790907f3aa5162fc84200ca85a620645c9848d8aae8290e2332d0d9f6238d6c221535a0d4222b5b1addaa293ab806533080966b124d56652d946ad1
+  data.tar.gz: 65b7c0fa468630afe0e453e1bc17b4b11dca4e61475375881a8771df733e89aa93594909af13f9c9d20996e4e3c5ee1548f97c22c7f0b682e3bf4d74648ffde1

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Phusion B.V.
+
+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,81 @@
+Simple Sheets API
+============================
+
+This gem contains a simple API to insert data into google sheets.
+
+Authentication
+==============
+
+This gem needs to authenticate as a Google Service Account to access files.
+Follow these steps to download the credentials you need:
+
+1. Go to https://console.developers.google.com/apis/dashboard
+2. Create a new Project (if you have to)
+2. Enable the Google Sheets API
+3. Go to 'Credentials'
+4. Create Credentials for a 'Service account key'
+6. Under 'Service account' select your Project. Key type JSON.
+7. Save the downloaded file as 'GoogleAPICredentials.json' in the root of your project
+
+To give the API access to a sheet in Google Sheets, you need to specifically share that document with the Service Account.
+In the GoogleAPICredentials.json file you will find a `client_email` field. Share a document with that email address to grant access.
+
+
+Usage
+=====
+
+    document = SheetsAPI.document("1xuQVCadaMmTPiz_13hXuZHGKDihc41w5aii4DtuxOmU5j_eQ4BD98T-H")
+    sheet = document.sheet("Daily Sales")
+    sheet.insert(
+      index: [:Date, :Client],
+      sort: true,
+      upsert: true,
+      rows: [
+        {
+          Date: Date.new(2017,3,9),
+          Client: "Some Guy",
+          Email: "guy@client.com",
+          Sales: 14,
+          Profit: 5
+        },
+        {
+          Date: Date.new(2017,3,9),
+          Client: "Other Guy",
+          Sales: 2,
+          Profit: -1
+        },
+        {
+          Date: Date.new(2017,3,10),
+          Client: "Some Guy",
+          Email: "guy@client.com",
+          Sales: 8,
+          Margin: 3
+        }
+      ]
+    )
+
+Insert Parameters
+=================
+
+Index
+-----
+The headers to use for upsert matching and sorting. Case sensitive. Default: []
+If no index is provided, sort and upsert have no effect.
+
+Sort
+----
+Sort the content of the sheet based on the index after all other operations are completed. Default: false
+
+Upsert
+------
+Attempt to match given inputs to existing rows, based on the index. Default: false
+If the index fields are the same, the data provided in the row parameter will override the existing row in the sheet.
+
+Rows
+----
+An array of objects that represent rows to be updated. Default: []
+Keys in the objects represent the header for the value. Keys are case sensitive.
+The default behaviour is to insert new rows in the sheet for all provided rows.
+Set the Upsert parameter to change to update instead.
+It is not necessary to provide a value for every header value.
+For the index headers, an empty value is considered "" for comparisons.

data/lib/sheetsAPI.rb

@@ -0,0 +1,121 @@
+require 'set'
+require 'googleauth'
+require 'google/apis/sheets_v4'
+
+# # Uncomment this to inspect requests made to the google API
+# module Google
+#   module Apis
+#     module Core
+#       class HttpClientAdapter
+#         alias old_call call
+#         def call(request)
+#           puts request.inspect
+#           old_call(request)
+#         end
+#       end
+#     end
+#   end
+# end
+
+module SheetsAPI
+  if !File.file? "#{Dir.pwd}/GoogleAPICredentials.json"
+    raise "Missing Google API Credentials: #{Dir.pwd}/GoogleAPICredentials.json"
+  end
+
+  ENV["GOOGLE_APPLICATION_CREDENTIALS"] = "#{Dir.pwd}/GoogleAPICredentials.json"
+  scopes = ['https://www.googleapis.com/auth/drive']
+  authorization = Google::Auth.get_application_default(scopes)
+
+  SheetService = Google::Apis::SheetsV4::SheetsService.new
+  SheetService.authorization = authorization
+
+  class << self
+    # This will raise if the document cannot be opened
+    def document(id)
+      return Document.new(id)
+    end
+  end
+
+  class Sheet
+    def initialize(document, sheetName)
+      @document = document
+      @sheetName = sheetName
+    end
+
+    def insert(rows:[], index:[], upsert: false, sort: false)
+      # Get current content of sheet
+      sheetContent = SheetService.get_spreadsheet_values(@document.id, "'#{@sheetName}'")&.values || []
+
+      # Get current headers in the sheet
+      sheetHeaders = sheetContent.shift || []
+
+      # Add any missing headers
+      missingHeaders = ([Set.new(index)] + rows.map(&:keys)).reduce(&:merge).to_a.map(&:to_s) - sheetHeaders
+      newHeaders = sheetHeaders + missingHeaders
+      symbolHeaders = newHeaders.map(&:to_sym)
+
+      # If we need to upsert and an index is provided
+      if upsert && index.length > 0
+        # If we upsert a row it no longer needs further processing
+        rows.delete_if do |row|
+          rowIndex = index.map{ |i| row[i].to_s }
+          lineIndex = index.map{ |i| symbolHeaders.index(i) }
+          # Attempt to match the index of the row with the corresponding index of each line in the current content
+          match = sheetContent.index{ |line| lineIndex.map{ |i| line[i] } == rowIndex }
+          # If we match, replace the values in that line with the contents of our row, and return true to remove this row
+          if match
+            sheetContent[match] = symbolHeaders.each_with_index.map { |header, index| row[header] || sheetContent[match][index] }
+            true
+          else
+            false
+          end
+        end
+      end
+
+      # Append any remaining rows
+      sheetContent += rows.map{ |row| symbolHeaders.map{ |header| row[header] || "" }}
+
+      # Sort the output
+      if sort && index.length > 0
+        sortIndex = index.map{ |s| symbolHeaders.index(s) }
+        sheetContent.sort!{ |row1, row2| sortIndex.map{ |i| row1[i].to_s } <=> sortIndex.map{ |i| row2[i].to_s }}
+      end
+
+      # Write the updated content to the spreadsheet
+      SheetService.update_spreadsheet_value(@document.id, "'#{@sheetName}'", {major_dimension: "ROWS", values: sheetContent.unshift(newHeaders)}, value_input_option: 'USER_ENTERED')
+
+    end
+  end
+
+  class Document
+    def initialize(documentId)
+      @id = documentId
+      @document = SheetService.get_spreadsheet(documentId)
+    end
+    attr_reader :id
+
+    def sheet(sheetName)
+      @sheetName = sheetName
+
+      sheet = @document.sheets.find{|sheet| sheet.properties.title.downcase == sheetName.downcase}
+      if !sheet
+        createSheet(sheetName)
+      end
+
+      return Sheet.new(self, sheetName)
+    end
+
+    private
+
+    def createSheet(sheetName)
+      batch_update_request = {requests: [{
+        add_sheet: {
+          properties: {
+            title: sheetName
+          }
+        }
+      }]}
+      SheetService.batch_update_spreadsheet(@id, batch_update_request, {})
+    end
+  end
+end

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification
+name: sheetsapi
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Phusion
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-03-08 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.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+description: A simple API for writing to Google Sheets
+email:
+- team@phusion.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/sheetsAPI.rb
+homepage: https://github.com/phusion/SheetsAPI
+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.6.10
+signing_key: 
+specification_version: 4
+summary: A simple API for writing to Google Sheets
+test_files: []