googlesheets 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8943510443e9c7f239448ca1f51f24aef69623a55943cccd9cca909ed898fc0a
+  data.tar.gz: 1af91f45355e465b6576c722a5fbc9a1cd2371dbd6706d76dd61a019c4e933e7
+SHA512:
+  metadata.gz: 6d149d61718cf93b2a4e8c373a4cbe30b9f462591b1a603a26a5a455cc14ea03742f65125b9ca61ef5d83213530f958304c69eb501a2f1c00ab17912156b8a8a
+  data.tar.gz: a3d4744b72f90b29bbc7c9fa85c27f81b7f5bb0c4e317f454d48ab856d9cba83af8be5f533ea550f7f2c55f1a43bc8af7ec6f51c016c0e7dc953c0de58b92132

data/.ruby-version

@@ -0,0 +1 @@
+2.6

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+gemspec
+
+gem "google-api-client", "~> 0.37.0"
+gem "googleauth", "~> 0.10.0"

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Steve Shreeve
+
+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,3 @@
+# googlesheets
+
+Ruby gem for Google Sheets API

data/googlesheets.gemspec

@@ -0,0 +1,13 @@
+# encoding: utf-8
+
+Gem::Specification.new do |s|
+  s.name        = "googlesheets"
+  s.version     = "0.1.0"
+  s.author      = "Steve Shreeve"
+  s.email       = "steve.shreeve@gmail.com"
+  s.summary     = "Ruby gem for Google Sheets"
+  s.description = "This gem allows easy access to Google Sheets API V4."
+  s.homepage    = "https://github.com/shreeve/googlesheets"
+  s.license     = "MIT"
+  s.files       = `git ls-files`.split("\n") - %w[.gitignore]
+end

data/lib/googlesheets.rb

@@ -0,0 +1,181 @@
+require "google/apis/sheets_v4"
+require "googleauth"
+require "googleauth/stores/file_token_store"
+
+module Enumerable
+  def first_result
+    block_given? ? each {|item| result = (yield item) and return result} && nil : find {|item| item}
+  end
+end
+
+class GoogleSheets
+  attr_accessor :api
+
+  def initialize(ssid, **opts)
+    @ssid = ssid
+
+    @json = opts[:credentials] || 'credentials.json'
+    @yaml = opts[:token      ] || 'token.yaml'
+
+    if opts[:debug] == true
+      $stdout.sync = true
+      Google::Apis.logger = Logger.new(STDERR)
+      Google::Apis.logger.level = Logger::DEBUG
+    end
+
+    @api = Google::Apis::SheetsV4::SheetsService.new
+    @api.client_options.application_name    = opts[:app] || "Ruby"
+    @api.client_options.application_version = opts[:ver] || "1.0.0"
+    @api.authorization = authorize
+  end
+
+  def authorize
+    idno = Google::Auth::ClientId.from_file(@json)
+    repo = Google::Auth::Stores::FileTokenStore.new(file: @yaml)
+    auth = Google::Auth::UserAuthorizer.new(idno, Google::Apis::SheetsV4::AUTH_SPREADSHEETS, repo)
+    oobs = 'urn:ietf:wg:oauth:2.0:oob'
+    user = 'default'
+    info = auth.get_credentials(user) || begin
+      href = auth.get_authorization_url(base_url: oobs)
+      puts "Open the following URL and paste the code here:\n" + href
+      info = auth.get_and_store_credentials_from_code(user_id: user, code: gets, base_url: oobs)
+    end
+  end
+
+  def rgb2hex(color=nil)
+    color or return
+    r = ((color.red   || 0) * 255).to_i
+    g = ((color.green || 0) * 255).to_i
+    b = ((color.blue  || 0) * 255).to_i
+    "#%02x%02x%02x" % [r, g, b]
+  end
+
+  def hex2rgb(color=nil)
+    color =~ /\A#?(?:(\h\h)(\h\h)(\h\h)|(\h)(\h)(\h))\z/ or return
+    r, g, b = $1 ? [$1, $2, $3] : [$4*2, $5*2, $6*2]
+    r = "%.2f" % (r.hex / 255.0)
+    g = "%.2f" % (g.hex / 255.0)
+    b = "%.2f" % (b.hex / 255.0)
+    { red: r, green: g, blue: b }
+  end
+
+  def biject(x) # a=1, z=26, aa=27, az=52, ba=53, aaa=703
+    case x
+    when String
+      x.each_char.inject(0) {|n,c| (n * 26) + (c.ord & 31) }
+    when Integer
+      s = []
+      s << (((x -= 1) % 26) + 65).chr && x /= 26 while x > 0
+      s.reverse.join
+    end
+  end
+
+  def range(area)
+    sh, rc = area.split('!', 2); rc, sh = sh, nil if sh.nil?
+    as, ae = rc.split(':', 2); ae ||= as
+    cs, rs = as.split(/(?=\d)/, 2); cs = biject(cs) - 1; rs = rs.to_i - 1
+    ce, re = ae.split(/(?=\d)/, 2); ce = biject(ce) - 1; re = re.to_i - 1
+    {
+      sheet_id:           sh ? sheet_id(sh) : nil,
+      start_column_index: cs,
+      start_row_index:    rs,
+      end_column_index:   ce + 1,
+      end_row_index:      re + 1,
+    }.compact
+  end
+
+  def sheets
+    @sheets ||= api.get_spreadsheet(@ssid).sheets.map {|item| item.properties }
+  end
+
+  def sheets!
+    @sheets = nil
+    sheets
+  end
+
+  def sheet_list
+    sheets.map do |item|
+      {
+        id:    item.sheet_id,
+        name:  item.title,
+        color: rgb2hex(item.tab_color),
+      }.compact
+    end
+  end
+
+  def sheet_id(obj)
+    case obj
+      when /^#(\d+)$/ then sheets[$1.to_i - 1].sheet_id
+      when Integer    then obj
+      else sheets.first_result {|item| item.sheet_id if item.title == obj}
+    end
+  end
+
+  def sheet_name(obj)
+    case obj
+      when /^#(\d+)$/ then sheets[$1.to_i - 1].title
+      when Integer    then sheets.first_result {|item| item.title if item.sheet_id == obj}
+      else obj
+    end
+  end
+
+  def sheet_color(pick, color=nil) # NOTE: ignores alpha
+    reqs = []
+    reqs.push(update_sheet_properties: {
+      properties: {
+        sheet_id: sheet_id(pick),
+        tab_color: hex2rgb(color),
+      },
+      fields: 'tab_color',
+    })
+    resp = api.batch_update_spreadsheet(@ssid, { requests: reqs }, {})
+    true
+  end
+
+  def sheet_filter(area)
+    range = range(area)
+    reqs = []
+    reqs.push(clear_basic_filter: { sheet_id: range[:sheet_id] })
+    reqs.push(set_basic_filter: { filter: { range: range } })
+    resp = api.batch_update_spreadsheet(@ssid, { requests: reqs }, {})
+    true
+  end
+
+  def sheet_format(area, pattern)
+    reqs = []
+    reqs.push(repeat_cell: {
+      range: range(area),
+      cell: {
+        user_entered_format: {
+          number_format: {
+            type: "NUMBER",
+            pattern: pattern,
+          },
+        },
+      },
+      fields: 'user_entered_format.number_format',
+    })
+    resp = api.batch_update_spreadsheet(@ssid, { requests: reqs }, {})
+    true
+  end
+
+  def sheet_clear(area)
+    api.clear_values(@ssid, area)
+  end
+
+  def sheet_read(area)
+    api.get_spreadsheet_values(@ssid, area).values
+  end
+
+  def sheet_save(area, rows, log=false)
+    area.sub!(/^(#\d+)(?=!)/) {|num| sheet_name(num)}
+    gasv = Google::Apis::SheetsV4::ValueRange.new(range: area, values: rows)
+    done = api.update_spreadsheet_value(@ssid, area, gasv, value_input_option: "USER_ENTERED")
+    puts "#{done.updated_cells} cells updated." if log
+    done.updated_cells
+  end
+
+  def sheet_save!(area, rows)
+    sheet_save(area, rows, true)
+  end
+end

metadata

@@ -0,0 +1,48 @@
+--- !ruby/object:Gem::Specification
+name: googlesheets
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Steve Shreeve
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-03-10 00:00:00.000000000 Z
+dependencies: []
+description: This gem allows easy access to Google Sheets API V4.
+email: steve.shreeve@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".ruby-version"
+- Gemfile
+- LICENSE
+- README.md
+- googlesheets.gemspec
+- lib/googlesheets.rb
+homepage: https://github.com/shreeve/googlesheets
+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: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Ruby gem for Google Sheets
+test_files: []