gslide 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3b59859f25a2ec7a2e3477e43f1fd9130c2f39cac573da00949db781721e0c00
-  data.tar.gz: 3931e3260c7230dc6661baab6b5411c372aef15732a336738dc829f5fa27794f
+  metadata.gz: c60628d84c354c773b26428a27bf090324f9d480e7fbaa21f61b9eff373afcfd
+  data.tar.gz: 35dfbc790360627c4829f6747e9e25532ab0342d8044c61259e77bf050e85f2c
 SHA512:
-  metadata.gz: 7c04e204a3469bbaf902cc32f631476ca8af0d20138f38cfcf146d21ecb0491831333a262418b0eb3e5d95b1d3ab498f1de037d45b7fb34e6bf6360e08b9e5ba
-  data.tar.gz: d79224b147b6f6f6dabbfedd9e3f1ab2d49093b2e7622e9333edbe1c41a1d2b59e16b099230ceeee5ff4be11467fc4343971ec444b611c9fe800d30839e39e80
+  metadata.gz: 3998d8e6e183a9a7f1bc4164284a26fa4296c11187dcbf848f8dbe0f75ba6fdc5bb6b9e4407007d1cd7a11d6fd3f5c46b023b7fcda9000a23f3c2fdf0c88eddf
+  data.tar.gz: '086712b43b87c1a09ee7563c028af143282dc22f3fd74762c0e0dd2d99c81f8d78268affa80be92b1f3eb6e5fe98700356132d8d7f97f6d59ed9e50535333228'

data/CHANGELOG.md

@@ -1,4 +1,11 @@
-## [Unreleased]
+## [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](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/README.md

@@ -1,10 +1,24 @@
+[![Yard Docs](http://img.shields.io/badge/yard-docs-blue.svg)](https://rubydoc.info/gems/gslide)
+[![Gem](https://img.shields.io/gem/v/gslide)](https://rubygems.org/gems/gslide)
+
 # Gslide
 
 Welcome to Gslide! This is an approach to build a Google Slides file for practical use.
 
 ## Installation
 
-> Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+```sh
+gem install gslide
+```
+
+- Use [bundler](https://bundler.io/)
+
+```bash
+bundle add gslide
+bundle install
+```
+
+- From Github
 
 Install the gem and add to the application's Gemfile by executing:
 

data/lib/gslide/concerns/requests.rb

@@ -7,9 +7,21 @@ module Gslide
         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 +31,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,8 +7,10 @@ module Gslide
 
       attr_reader :id
 
-      def initialize(id, auth: nil)
-        @id = id
+      PRESENTATION_PATTERN = %r[/presentation/d/([a-zA-Z0-9\-_]+)?]
+
+      def initialize(id_or_url, auth: nil)
+        @id = (url_id = id_or_url.match(PRESENTATION_PATTERN)) ? url_id[1] : id_or_url
         @auth = auth
       end
 
@@ -17,8 +19,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
@@ -29,16 +31,21 @@ module Gslide
       # @return True when update successful.
       # @see https://developers.google.com/slides/api/reference/rest/v1/presentations/batchUpdate#request-body
       def batch_update(options = {})
+        retries ||= 0
+
         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)
+        response_body = post_request(uri, auth_token: @auth.token, body: request_body)
+        response_body["presentationId"] == @id
+      rescue Gslide::QuotaExceededError
+        if (retries += 1) < 3
+          sleep 10 + retries * retries * 10
 
-        if response_body["error"]
-          raise Gslide::Error.new(response_body["error"]["message"])
+          retry
         end
-        response_body["presentationId"] == @id
+        # 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
 
@@ -58,11 +53,8 @@ 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

data/lib/gslide/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Gslide
-  VERSION = "0.1.0"
+  VERSION = "0.1.2"
 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,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: gslide
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Kang-Kyu Lee
 bindir: exe
 cert_chain: []
-date: 2025-03-31 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies: []
 description: Allows to modify a Google Slides file by API requests.
 email:
@@ -52,7 +52,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.6
+rubygems_version: 3.6.7
 specification_version: 4
 summary: Google Slides API client.
 test_files: []