gslide 0.1.1 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 52da391c6d99b7a6c04b766ec32349d41409af6a568f6b3dad3bc300f9e362b4
-  data.tar.gz: 0adf949984afb45f782c8a4bef5d516b68550bd499b382dfa2e993b008b7402c
+  metadata.gz: 8fe444ca4bdef588c1e0aadf54db33d2024612b4d3450c4da243bd7ea3538055
+  data.tar.gz: 5416cb52420d81d5c5f8e4f99a13d2745e405a372c780314debb67c64e4c1b61
 SHA512:
-  metadata.gz: 788294f12da41010e96ecb1576983e51cbd57de78970971b7940a60a325563685a2a494395925998c936ea2b862467d8971c6dbcfa62dd21442bafd81d7b83be
-  data.tar.gz: 5c18a8c54b79bdff0da9c8f896d7aa31a2388cc7a86b9ad6e5a6c4a4425236a6915cde046dfee446e1a80ec5d8966b487e59c9356dbc4b5e54c8052f66f4736e
+  metadata.gz: 5477601ab8d237e62853bf974c1e3961fbd60e5197822754cdfe1d903a2bc37983395c412b674b27c8405fa3883d6b48291b384c49a619c7c4334f7bab719256
+  data.tar.gz: 518e86e5a3ececa73d696c737f3d0672f21fae300f5e57b2aa53c1de8fde8a9d925e1cadbbfd3c2048d9af90d41a3cd0765cd61f445bd9a78bc39c1183aafccd

data/CHANGELOG.md

@@ -1,7 +1,15 @@
+## [0.1.3] - 2026-08-19
+
+- Add `Gslide::Presentation::PRESENTATION_ID_PATTERN` and `Gslide::Presentation.file_id_in`, so callers can validate a presentation id without repeating the pattern
+
+## [0.1.2] - 2025-05-09
+
+- Add `Gslide::HTTPError`, `Gslide::UnauthorizedError` and `Gslide::QuotaExceededError` #10
+
 ## [0.1.1] - 2025-04-14
 
-- Use a regular expression for finding a presentation id from url #8
-- Add retry logic for slide batch_update #7
+- Use a regular expression for finding a presentation id from url [#8](https://github.com/lininglink/gslide/pull/8)
+- Add retry logic for slide batch_update [#7](https://github.com/lininglink/gslide/pull/7)
 
 ## [0.1.0] - 2025-03-31
 

data/lib/gslide/concerns/requests.rb

@@ -1,15 +1,29 @@
 require "net/http"
 
 module Gslide
+
+  # @private
   module Concerns
     module Requests
       def get_request(uri, auth_token: "")
         req = Net::HTTP::Get.new(uri.to_s)
         req['Authorization'] = "Bearer #{auth_token}"
 
-        Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
+        res = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
           http.request(req)
         end
+        response_body = JSON(res.body)
+
+        case res
+        when Net::HTTPSuccess
+          response_body
+        when Net::HTTPUnauthorized
+          msg = response_body["error"] ? response_body["error"]["message"] : "Unauthorized"
+          raise Gslide::UnauthorizedError, msg
+        else
+          msg = response_body["error"] ? response_body["error"]["message"] : "HTTPError"
+          raise Gslide::HTTPError, msg
+        end
       end
 
       def post_request(uri, auth_token: "", body: {})
@@ -19,9 +33,29 @@ module Gslide
 
         req.body = body
 
-        Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
+        res = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
           http.request(req)
         end
+
+        response_body = JSON(res.body)
+
+        case res
+        when Net::HTTPSuccess
+          response_body
+        when Net::HTTPUnauthorized
+          msg = response_body["error"] ? response_body["error"]["message"] : "Unauthorized"
+          raise Gslide::UnauthorizedError, msg
+        when Net::HTTPTooManyRequests
+          # "Quota exceeded for quota metric 'Write requests' and limit 'Write requests per minute per user' of service 'slides.googleapis.com' for consumer 'project_number:012345678901'."
+          if response_body["error"] && response_body["error"]["message"] =~ /Quota exceeded/
+            raise Gslide::QuotaExceededError, msg
+          else
+            raise Gslide::HTTPError, msg || "TooManyRequests"
+          end
+        else
+          msg = response_body["error"] ? response_body["error"]["message"] : "HTTPError"
+          raise Gslide::HTTPError, msg
+        end
       end
     end
   end

data/lib/gslide/models/editor.rb

@@ -23,12 +23,7 @@ module Gslide
         uri = URI(GOOGLE_SLIDES + "")
 
         # "title" is the only allowed field in the request body
-        res = post_request(uri, auth_token: @token, body: options.to_json)
-        response_body = JSON(res.body)
-
-        if response_body["error"]
-          raise Gslide::Error.new(response_body["error"]["message"])
-        end
+        response_body = post_request(uri, auth_token: @token, body: options.to_json)
         Presentation.new response_body["presentationId"], auth: self
       end
     end

data/lib/gslide/models/presentation.rb

@@ -7,10 +7,17 @@ module Gslide
 
       attr_reader :id
 
-      PRESENTATION_PATTERN = %r[/presentation/d/([a-zA-Z0-9\-_]+)?]
+      PRESENTATION_ID_PATTERN = /[a-zA-Z0-9\-_]+/
+      PRESENTATION_PATTERN = %r[/presentation/d/(#{PRESENTATION_ID_PATTERN})?]
+
+      # @param [String] id_or_url a presentation id, or a sharing url holding one.
+      # @return [String] the presentation id, or the argument when it is not a url.
+      def self.file_id_in(id_or_url)
+        (url_id = id_or_url.match(PRESENTATION_PATTERN)) ? url_id[1] : id_or_url
+      end
 
       def initialize(id_or_url, auth: nil)
-        @id = (url_id = id_or_url.match(PRESENTATION_PATTERN)) ? url_id[1] : id_or_url
+        @id = self.class.file_id_in(id_or_url)
         @auth = auth
       end
 
@@ -19,8 +26,8 @@ module Gslide
       def get
         uri = URI(GOOGLE_SLIDES + "/#{@id}")
 
-        res = get_request(uri, auth_token: @auth.token)
-        JSON(res.body).convert_keys {|k| k.snake_case.to_sym }
+        response_body = get_request(uri, auth_token: @auth.token)
+        response_body.convert_keys {|k| k.snake_case.to_sym }
       end
 
       def link_url
@@ -36,23 +43,16 @@ module Gslide
         uri = URI(GOOGLE_SLIDES + "/#{@id}:batchUpdate")
         request_body = options.convert_keys { |k| k.to_s.lower_camel_case }.to_json
 
-        res = post_request(uri, auth_token: @auth.token, body: request_body)
-        response_body = JSON(res.body)
-
-        if response_body["error"]
-          raise Gslide::Error.new(response_body["error"]["message"])
-        end
+        response_body = post_request(uri, auth_token: @auth.token, body: request_body)
         response_body["presentationId"] == @id
-
-      rescue Gslide::Error => e
-        if e.message =~ /Quota exceeded/ && (retries += 1) < 3
-          # "Quota exceeded for quota metric 'Write requests' and limit 'Write requests per minute per user' of service 'slides.googleapis.com' for consumer 'project_number:012345678901'."
+      rescue Gslide::QuotaExceededError
+        if (retries += 1) < 3
           sleep 10 + retries * retries * 10
 
           retry
         end
-        # all retries failed, re-raise exception
-        raise e
+        # all retries failed, raise exception
+        raise
       end
 
       def get_slide_ids

data/lib/gslide/models/spreadsheet.rb

@@ -17,8 +17,8 @@ module Gslide
       def get
         uri = URI(GOOGLE_SHEETS + "/#{@id}")
 
-        res = get_request(uri, auth_token: @auth.token)
-        JSON(res.body).convert_keys {|k| k.snake_case.to_sym }
+        response_body = get_request(uri, auth_token: @auth.token)
+        response_body.convert_keys {|k| k.snake_case.to_sym }
       end
 
       def link_url
@@ -32,12 +32,7 @@ module Gslide
         uri = URI(GOOGLE_SHEETS + "/#{@id}:batchUpdate")
         request_body = options.convert_keys { |k| k.to_s.lower_camel_case }.to_json
 
-        res = post_request(uri, auth_token: @auth.token, body: request_body)
-        response_body = JSON(res.body)
-
-        if response_body["error"]
-          raise Gslide::Error.new(response_body["error"]["message"])
-        end
+        response_body = post_request(uri, auth_token: @auth.token, body: request_body)
         response_body["spreadsheetId"] == @id
       end
 
@@ -45,6 +40,23 @@ module Gslide
         parsed_body = get
         parsed_body[:sheets].collect { |h| Sheet.new(h) }
       end
+
+      # @param [Hash] options the request body.
+      # @see https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets.values/append
+      def values_append(notation, options = {})
+        uri = url_escape_uri(GOOGLE_SHEETS + "/#{@id}/values/'#{notation}':append?valueInputOption=USER_ENTERED")
+        request_body = options.convert_keys { |k| k.to_s.lower_camel_case }.to_json
+
+        response_body = post_request(uri, auth_token: @auth.token, body: request_body)
+        response_body
+      end
+
+      private
+
+      def url_escape_uri(uri_string)
+        parser = URI::Parser.new
+        URI parser.escape(uri_string)
+      end
     end
 
     class SpreadsheetDraft
@@ -58,21 +70,19 @@ module Gslide
         request_body = options.convert_keys { |k| k.to_s.lower_camel_case }.to_json
 
         uri = URI(GOOGLE_SHEETS)
-        res = post_request(uri, auth_token: @auth.token, body: request_body)
-        response_body = JSON(res.body)
-        if response_body["error"]
-          raise Gslide::Error.new(response_body["error"]["message"])
-        end
+        response_body = post_request(uri, auth_token: @auth.token, body: request_body)
+
         spreadsheet_id = response_body["spreadsheetId"]
         Spreadsheet.new(spreadsheet_id, auth: @auth)
       end
     end
 
     class Sheet
-      attr_reader :id, :charts
+      attr_reader :id, :title, :charts
 
       def initialize(options = {})
         @id = options[:properties][:sheet_id]
+        @title = options[:properties][:title]
         @charts = options[:charts].collect { |h| Chart.new(h) } if options[:charts]
       end
     end

data/lib/gslide/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Gslide
-  VERSION = "0.1.1"
+  VERSION = "0.1.3"
 end

data/lib/gslide.rb

@@ -7,5 +7,7 @@ require "gslide/models/models"
 
 module Gslide
   class Error < StandardError; end
-
+  class HTTPError < Error; end
+  class UnauthorizedError < HTTPError; end
+  class QuotaExceededError < HTTPError; end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gslide
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.3
 platform: ruby
 authors:
 - Kang-Kyu Lee
@@ -52,7 +52,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.7
+rubygems_version: 4.0.6
 specification_version: 4
 summary: Google Slides API client.
 test_files: []