googlesheets 0.2.3 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d8f5d17077c83d17f62a0c18e129e1a1b88cfe1059606b22ca012b349b6ec682
-  data.tar.gz: 34029b089e78a8e32cd1572971c248e5ff05d4e1e9d772754df26bfd5d6a3461
+  metadata.gz: 0aefe530c8bfd81c39a9117a0ae9fd698070e2886961c74e2c80a0ddb21aefeb
+  data.tar.gz: e623d3db0855c721127f56a463b79b4d2eb68d51e88d4ba8bce49da8c440a459
 SHA512:
-  metadata.gz: bd7ff047f1181c713132bb09b6ac4b876c681b8fc6c89d657e2d2cf0a63aa2dc3bef9f973f8f92419f89035eb290d9b2f8a47ef020ad29326532eec2a41de57c
-  data.tar.gz: 1bb3e0cc4fec63b073698ff2a33638d70e04a008a92a9d067d0f2c6de7d6b57a8e89caac3d9a83951cea41ace67f59eed0e1f557b83714ddf8e1e8f1ab863f82
+  metadata.gz: 130fed8b81b90818069b02343ebf919f8aaa0ca90a33a0278552287e65e2c410cf583c969498fe6e4cb73fd884eb9e1ec69a43b4b263badba17bd47d0d11a7d3
+  data.tar.gz: 0cc8e0f830615ca7708800900e0bfbc8307f7032f21740a961bc1047d6fd9aa10f43b5bbdf9e5684984b90b2a3ca5f84df825f61afb7ba02e3a92b1e130d5529

data/googlesheets.gemspec

@@ -2,12 +2,14 @@
 
 Gem::Specification.new do |s|
   s.name        = "googlesheets"
-  s.version     = "0.2.3"
+  s.version     = `grep -m 1 '^\s*VERSION' lib/googlesheets.rb | head -1 | cut -f 2 -d '"'`
   s.author      = "Steve Shreeve"
   s.email       = "steve.shreeve@gmail.com"
-  s.summary     = "Ruby gem for Google Sheets"
+  s.summary     = "Ruby library 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]
+  s.executables = `cd bin && git ls-files .`.split("\n")
+  s.add_runtime_dependency "google-api-client", "~> 0.53.0"
 end

data/lib/googlesheets.rb

@@ -2,6 +2,13 @@ require "google/apis/sheets_v4"
 require "googleauth"
 require "googleauth/stores/file_token_store"
 
+class Object
+  def blank?
+    respond_to?(:empty?) or return !self
+    empty? or respond_to?(:strip) && strip.empty?
+  end
+end
+
 module Enumerable
   def first_result
     block_given? ? each {|item| result = (yield item) and return result} && nil : find {|item| item}
@@ -11,13 +18,17 @@ end
 # https://googleapis.dev/ruby/google-api-client/latest/Google/Apis/SheetsV4/Request.html
 
 class GoogleSheets
+  VERSION = "0.5.1"
+
   attr_accessor :api
 
   def initialize(ssid, **opts)
-    @ssid = ssid =~ /^https?:/ ? ssid.split('/')[5] : ssid
+    @ssid = ssid =~ /^https?:/ ? ssid.split("/")[5] : ssid # spreadsheet id
+    @wsid = ssid =~ /(?<=#gid=)(\d+)(?:!([a-z\d:]+))?$/i ? $1.to_i : "#1" # worksheet id
+    @rect = $2 ? $2.sub(/(?<=\D):/, "1:") : "A:ZZ"
 
-    @json = opts[:credentials] || 'credentials.json'
-    @yaml = opts[:token      ] || 'token.yaml'
+    @json = opts[:credentials] || "credentials.json"
+    @yaml = opts[:token      ] || "token.yaml"
 
     if opts[:debug] == true
       $stdout.sync = true
@@ -35,8 +46,8 @@ class GoogleSheets
     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'
+    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
@@ -86,8 +97,8 @@ class GoogleSheets
   end
 
   def range(area)
-    sh, rc = area.split('!', 2); rc, sh = sh, nil if sh.nil?
-    as, ae = rc.split(':', 2); ae ||= as
+    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
     {
@@ -126,16 +137,29 @@ class GoogleSheets
     end
   end
 
-  def sheet_name(obj)
-    case obj
+  def sheet_name(obj=nil)
+    case obj ||= @wsid
       when /^#(\d+)$/ then sheets[$1.to_i - 1].title
-      when Integer    then sheets.first_result {|item| item.title if item.sheet_id == obj}
+      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_sheet(area)
-    area.sub(/^(#\d+)(?=!)/) {|num| sheet_name(num)}
+  def resolve_area(area)
+    if area.blank?
+      wsid = sheet_name
+    elsif area =~ /!/
+      wsid = sheet_name($`)
+      rect = $'
+    elsif area =~ /:/ or area =~ /^[a-z]{1,3}\d+$/i
+      wsid = sheet_name
+      rect = area
+    else
+      wsid = sheet_name(area)
+    end
+    rect = rect ? rect.sub(/(?<=\D):/, "1:") : @rect
+    "#{wsid}!#{rect}"
   end
 
   def sheet_rename(pick, name=nil)
@@ -148,7 +172,7 @@ class GoogleSheets
         sheet_id: shid,
         title: name,
       },
-      fields: 'title',
+      fields: "title",
     })
     resp = api.batch_update_spreadsheet(@ssid, { requests: reqs }, {})
     true
@@ -161,14 +185,14 @@ class GoogleSheets
         sheet_id: sheet_id(pick),
         tab_color: hex2rgb(color),
       },
-      fields: 'tab_color',
+      fields: "tab_color",
     })
     resp = api.batch_update_spreadsheet(@ssid, { requests: reqs }, {})
     true
   end
 
   def sheet_filter(area, want=nil)
-    area = resolve_sheet(area)
+    area = resolve_area(area)
     range = range(area)
     criteria = filter_criteria(want) if want
     reqs = []
@@ -179,7 +203,7 @@ class GoogleSheets
   end
 
   def sheet_format(area, pattern)
-    area = resolve_sheet(area)
+    area = resolve_area(area)
     reqs = []
     reqs.push(repeat_cell: {
       range: range(area),
@@ -191,26 +215,24 @@ class GoogleSheets
           },
         },
       },
-      fields: 'user_entered_format.number_format',
+      fields: "user_entered_format.number_format",
     })
     resp = api.batch_update_spreadsheet(@ssid, { requests: reqs }, {})
     true
   end
 
   def sheet_clear(area)
-    area = resolve_sheet(area)
-    area.sub!(/^(#\d+)(?=!)/) {|num| sheet_name(num)}
+    area = resolve_area(area)
     api.clear_values(@ssid, area)
   end
 
-  def sheet_read(area)
-    area = resolve_sheet(area)
-    area.sub!(/^(#\d+)(?=!)/) {|num| sheet_name(num)}
+  def sheet_read(area=nil)
+    area = resolve_area(area)
     api.get_spreadsheet_values(@ssid, area).values
   end
 
   def sheet_save(area, rows, log=false)
-    area = resolve_sheet(area)
+    area = resolve_area(area)
     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

metadata

@@ -1,22 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: googlesheets
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.5.1
 platform: ruby
 authors:
 - Steve Shreeve
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-09-18 00:00:00.000000000 Z
-dependencies: []
+date: 2023-03-15 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.53.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.53.0
 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
@@ -41,8 +54,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.16
+rubygems_version: 3.4.8
 signing_key:
 specification_version: 4
-summary: Ruby gem for Google Sheets
+summary: Ruby library for Google Sheets
 test_files: []

data/.ruby-version

@@ -1 +0,0 @@
-2.6.5