googlesheets 0.2.2 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9d0fb6e33bdfbb0e0e82efa3be32d26166be4bf4199d894e0dd555b0c568a4f5
-  data.tar.gz: fb113fecb311579662e9b2aa0d5cea4443c20218b0cb129741a757de242d1241
+  metadata.gz: 484ead7c7ddf83bd062e24d8edb28fb0da072cbbe348f598974c7dcc6fc81687
+  data.tar.gz: 224d0e6b86d115a4b9aff60faba79a174686f65f551dff9322bb8ff22d0445ce
 SHA512:
-  metadata.gz: d30a91e91a3eaa552c0a84eb5f77e885d1da7fcdf6ee750f030e1b3b494a8f43a01cbc1838b8f9c4154558375b57ae985f531b37bfd4c0c1744598d7b3362c28
-  data.tar.gz: c7143744964858819f57fc6105fb0dccd9b680b3f1c485264c3162931fd8a4455b5a0e3fc098eaa036a9ff5aff690bc3df023c40c8503cdb3d1300054046aab6
+  metadata.gz: 38d00ab0cd8ac505238f604542e0f56f814d397cdf8d606c0a64cba8bf022afcd58173cf5af5e23cbf38590b18c49bc849001c231c23b509aee8b384a62b4580
+  data.tar.gz: a34dc14942dd9433331221804a95f940104a58b08c2830e1a6866c046db9b35c9ec220c91fd9c26aedc8b98b54a96274d007f045f0434c3db10fcf804543f670

data/googlesheets.gemspec

@@ -2,12 +2,14 @@
 
 Gem::Specification.new do |s|
   s.name        = "googlesheets"
-  s.version     = "0.2.2"
+  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,16 @@ end
 # https://googleapis.dev/ruby/google-api-client/latest/Google/Apis/SheetsV4/Request.html
 
 class GoogleSheets
+  VERSION = "0.5.0"
+
   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+)$/] && $1.to_i # default worksheet id
 
-    @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 +45,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 +96,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,14 +136,30 @@ class GoogleSheets
     end
   end
 
-  def sheet_name(obj)
-    case obj
+  def sheet_name(obj=nil)
+    case obj ||= @wsid || "#1"
       when /^#(\d+)$/ then sheets[$1.to_i - 1].title
-      when Integer    then sheets.first_result {|item| item.title if item.sheet_id == obj}
+      when Integer    then sheets.first_result {|item| item.title if item.sheet_id == obj }
+      when "", nil     then sheets.first.title
       else obj
     end
   end
 
+  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
+    "#{wsid}!#{rect || 'A:ZZ'}"
+  end
+
   def sheet_rename(pick, name=nil)
     shid = sheet_id(pick)
     name ||= yield(sheet_name(shid)) if block_given?
@@ -144,7 +170,7 @@ class GoogleSheets
         sheet_id: shid,
         title: name,
       },
-      fields: 'title',
+      fields: "title",
     })
     resp = api.batch_update_spreadsheet(@ssid, { requests: reqs }, {})
     true
@@ -157,13 +183,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_area(area)
     range = range(area)
     criteria = filter_criteria(want) if want
     reqs = []
@@ -174,6 +201,7 @@ class GoogleSheets
   end
 
   def sheet_format(area, pattern)
+    area = resolve_area(area)
     reqs = []
     reqs.push(repeat_cell: {
       range: range(area),
@@ -185,22 +213,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_area(area)
     api.clear_values(@ssid, area)
   end
 
-  def sheet_read(area)
+  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.sub!(/^(#\d+)(?=!)/) {|num| sheet_name(num)}
+    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.2
+  version: 0.5.0
 platform: ruby
 authors:
 - Steve Shreeve
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-06-16 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