googlesheets 0.5.1 → 0.6.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0aefe530c8bfd81c39a9117a0ae9fd698070e2886961c74e2c80a0ddb21aefeb
-  data.tar.gz: e623d3db0855c721127f56a463b79b4d2eb68d51e88d4ba8bce49da8c440a459
+  metadata.gz: 337343bcb13d2a791f5aee8a239ce9f6fb176d9844da5d2d672efd98d21974d5
+  data.tar.gz: 68006ba26a382e5599a95822731e55261b7bb10b871c3536ecf4a2f0671d4755
 SHA512:
-  metadata.gz: 130fed8b81b90818069b02343ebf919f8aaa0ca90a33a0278552287e65e2c410cf583c969498fe6e4cb73fd884eb9e1ec69a43b4b263badba17bd47d0d11a7d3
-  data.tar.gz: 0cc8e0f830615ca7708800900e0bfbc8307f7032f21740a961bc1047d6fd9aa10f43b5bbdf9e5684984b90b2a3ca5f84df825f61afb7ba02e3a92b1e130d5529
+  metadata.gz: 250b28e880607001b70f71a1f417325cd73c301fe4cad19af54e390f17e08630dd9e7a44a2aaa537646d64c2bc8e0571aeadda02e3929561b88232f581700e04
+  data.tar.gz: 3e302a8611cd632225afac79f038ef000d3ea286e872de931640d43786b3de2acd7c325e9540a932be9b02dc6fc456f03b7dfb2e29092c0fa65703499990e9ff

data/bin/shat

@@ -0,0 +1,32 @@
+#!/usr/bin/env ruby
+
+version="0.0.1"
+
+STDOUT.sync = true
+
+begin
+  require "censive" 
+rescue LoadError
+  abort "#{File.basename($0)} needs another gem, run 'gem install censive'"
+end
+
+require "googlesheets"
+require "optparse"
+
+trap("INT" ) { abort "\n" }
+
+OptionParser.new.instance_eval do
+  @banner  = "usage: #{program_name} [options] <url>"
+
+  on "-h", "--help"                   , "Show help and command usage" do Kernel.abort to_s; end
+  on "-v", "--version"                , "Show version number" do Kernel.abort "#{program_name} #{version}"; end
+
+  self
+end.parse!(into: opts={}) rescue abort($!.message)
+
+link = ARGV.shift or abort("no url provided")
+
+goog = GoogleSheets.new(link)
+rows = goog.sheet_read
+
+Censive.writer {|csv| rows.each {|row| csv << row }}

data/lib/googlesheets.rb

@@ -1,3 +1,12 @@
+# ============================================================================
+# googlesheets - Ruby gem for Google Sheets
+#
+# Author: Steve Shreeve (steve.shreeve@gmail.com)
+#   Date: March 16, 2023
+# ============================================================================
+
+# See https://googleapis.dev/ruby/google-api-client/latest/Google/Apis/SheetsV4/Request.html
+
 require "google/apis/sheets_v4"
 require "googleauth"
 require "googleauth/stores/file_token_store"
@@ -6,19 +15,11 @@ class Object
   def blank?
     respond_to?(:empty?) or return !self
     empty? or respond_to?(:strip) && strip.empty?
-  end
+  end unless defined? blank?
 end
 
-module Enumerable
-  def first_result
-    block_given? ? each {|item| result = (yield item) and return result} && nil : find {|item| item}
-  end
-end
-
-# https://googleapis.dev/ruby/google-api-client/latest/Google/Apis/SheetsV4/Request.html
-
 class GoogleSheets
-  VERSION = "0.5.1"
+  VERSION = "0.6.3"
 
   attr_accessor :api
 
@@ -55,12 +56,15 @@ class GoogleSheets
     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]
+  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 hex2rgb(color=nil)
@@ -72,15 +76,12 @@ class GoogleSheets
     { 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
+  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 filter_criteria(hash)
@@ -110,6 +111,8 @@ class GoogleSheets
     }.compact
   end
 
+  # --------------------------------------------------------------------------
+
   def sheets
     @sheets ||= api.get_spreadsheet(@ssid).sheets.map {|item| item.properties }
   end
@@ -119,33 +122,6 @@ class GoogleSheets
     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=nil)
-    case obj ||= @wsid
-      when /^#(\d+)$/ then sheets[$1.to_i - 1].title
-      when "", 0, nil then sheets.first.title
-      when Integer    then sheets.first_result {|item| item.title if item.sheet_id == obj }
-      else obj
-    end
-  end
-
   def resolve_area(area)
     if area.blank?
       wsid = sheet_name
@@ -162,27 +138,25 @@ class GoogleSheets
     "#{wsid}!#{rect}"
   end
 
-  def sheet_rename(pick, name=nil)
-    shid = sheet_id(pick)
-    name ||= yield(sheet_name(shid)) if block_given?
+  def sheet_name(obj=nil)
+    case obj ||= @wsid
+      when /^#(\d+)(?:!?|$)/ then sheets[$1.to_i - 1].title
+      when "", 0, nil        then sheets.first.title
+      when Integer           then sheets.find {|item| item.sheet_id == obj}&.title
+      else obj
+    end
+  end
 
-    reqs = []
-    reqs.push(update_sheet_properties: {
-      properties: {
-        sheet_id: shid,
-        title: name,
-      },
-      fields: "title",
-    })
-    resp = api.batch_update_spreadsheet(@ssid, { requests: reqs }, {})
-    true
+  def sheet_clear(area)
+    area = resolve_area(area)
+    api.clear_values(@ssid, area)
   end
 
-  def sheet_color(pick, color=nil) # NOTE: ignores alpha
+  def sheet_color(curr, color=nil) # NOTE: ignores alpha
     reqs = []
     reqs.push(update_sheet_properties: {
       properties: {
-        sheet_id: sheet_id(pick),
+        sheet_id: sheet_id(curr),
         tab_color: hex2rgb(color),
       },
       fields: "tab_color",
@@ -191,10 +165,10 @@ class GoogleSheets
     true
   end
 
-  def sheet_filter(area, want=nil)
+  def sheet_filter(area, filt=nil)
     area = resolve_area(area)
     range = range(area)
-    criteria = filter_criteria(want) if want
+    criteria = filter_criteria(filt) if filt
     reqs = []
     reqs.push(clear_basic_filter: { sheet_id: range[:sheet_id] })
     reqs.push(set_basic_filter: { filter: { range: range, criteria: criteria}.compact })
@@ -221,9 +195,38 @@ class GoogleSheets
     true
   end
 
-  def sheet_clear(area)
-    area = resolve_area(area)
-    api.clear_values(@ssid, area)
+  def sheet_id(obj)
+    case obj
+      when /^#(\d+)(?:!?|$)/ then sheets[$1.to_i - 1].sheet_id
+      when Integer           then obj
+      else sheets.find {|item| item.title == obj}&.sheet_id
+    end
+  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_rename(curr, name=nil)
+    shid = sheet_id(curr)
+    name ||= yield(sheet_name(shid)) if block_given?
+
+    reqs = []
+    reqs.push(update_sheet_properties: {
+      properties: {
+        sheet_id: shid,
+        title: name,
+      },
+      fields: "title",
+    })
+    resp = api.batch_update_spreadsheet(@ssid, { requests: reqs }, {})
+    true
   end
 
   def sheet_read(area=nil)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: googlesheets
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.6.3
 platform: ruby
 authors:
 - Steve Shreeve
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-03-15 00:00:00.000000000 Z
+date: 2023-03-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-api-client
@@ -26,13 +26,15 @@ dependencies:
         version: 0.53.0
 description: This gem allows easy access to Google Sheets API V4.
 email: steve.shreeve@gmail.com
-executables: []
+executables:
+- shat
 extensions: []
 extra_rdoc_files: []
 files:
 - Gemfile
 - LICENSE
 - README.md
+- bin/shat
 - googlesheets.gemspec
 - lib/googlesheets.rb
 homepage: https://github.com/shreeve/googlesheets