gslide 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3b59859f25a2ec7a2e3477e43f1fd9130c2f39cac573da00949db781721e0c00
+  data.tar.gz: 3931e3260c7230dc6661baab6b5411c372aef15732a336738dc829f5fa27794f
+SHA512:
+  metadata.gz: 7c04e204a3469bbaf902cc32f631476ca8af0d20138f38cfcf146d21ecb0491831333a262418b0eb3e5d95b1d3ab498f1de037d45b7fb34e6bf6360e08b9e5ba
+  data.tar.gz: d79224b147b6f6f6dabbfedd9e3f1ab2d49093b2e7622e9333edbe1c41a1d2b59e16b099230ceeee5ff4be11467fc4343971ec444b611c9fe800d30839e39e80

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2025-03-31
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Kang-Kyu Lee
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,103 @@
+# 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.
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+bundle add gslide --github 'lininglink/gslide'
+bundle install
+```
+
+## Usage
+
+- Get a token with related scopes: `presentations` `presentations.readonly` `drive` `drive.readonly` `drive.file`.
+- Get it from Google Developers [OAuth 2.0 Playground](https://developers.google.com/oauthplayground) for test.
+
+```rb
+token = "ya29.a0AXeO8..."
+id = "1nNv3fyCIrvAs754Zd5c6klCjMhP7D2rmX3T9nFpjW4Q"
+editor = Gslide::Editor.new(token)
+pres = Gslide::Presentation.new(id, auth: editor)
+pres.get
+#=> parsed json of the Google Slides file
+```
+
+```rb
+editor = Gslide::Editor.new(token)
+editor.insert_presentation(title: "Once upon a time")
+#=> <Gslide::Models::Presentation:0x000000013e6d4108
+#   @id="1itXwmlLbyTRa1QKhrsO16OhJPEJUK6eh2d1nqsQfuqY">
+pres = _
+```
+
+```rb
+pres.batch_update({
+  requests: [
+    {
+      create_slide: {
+        slide_layout_reference: {
+          predefined_layout: "BLANK"
+        }
+      }
+    }
+  ]
+})
+#=> true
+
+pres.get_slide_ids
+#=> ["p", "SLIDES_API778986045_0"]
+
+pres.batch_update({
+  requests: [
+    {
+      create_image: {
+        url: "https://drive.usercontent.google.com/download?id=1fus5psRLzIJjG3A5GAfbqu22cdEczNZQ&authuser=0",
+        element_properties: {
+          page_object_id: "SLIDES_API778986045_0",
+          size: {
+            height: { magnitude: 200, unit: "PT" },
+            width: { magnitude: 300, unit: "PT" }
+          },
+          transform: {
+            scale_x: 1,
+            scale_y: 1,
+            translate_x: 100,
+            translate_y: 100,
+            unit: "PT"
+          }
+        }
+      }
+    }
+  ]
+})
+#=> true
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+Install the gem (a local copy) and add to the application's Gemfile by executing:
+
+```bash
+bundle add gslide --path '../gslide'
+```
+
+To install this gem onto your local machine, run `bundle install`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/lininglink/gslide. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/lininglink/gslide/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Gslide project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/lininglink/gslide/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "minitest/test_task"
+
+Minitest::TestTask.create
+
+task default: :test

data/lib/gslide/concerns/requests.rb

@@ -0,0 +1,28 @@
+require "net/http"
+
+module Gslide
+  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|
+          http.request(req)
+        end
+      end
+
+      def post_request(uri, auth_token: "", body: {})
+        req = Net::HTTP::Post.new(uri.to_s)
+        req.initialize_http_header 'Content-Type' => 'application/json'
+        req['Authorization'] = "Bearer #{auth_token}"
+
+        req.body = body
+
+        Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
+          http.request(req)
+        end
+      end
+    end
+  end
+end

data/lib/gslide/models/editor.rb

@@ -0,0 +1,36 @@
+require "gslide/concerns/requests"
+
+module Gslide
+  module Models
+
+    class Editor
+      include Concerns::Requests
+
+      attr_reader :token
+
+      def initialize(token)
+        if token.to_s.empty?
+          raise ArgumentError.new("Auth Token must be present")
+        end
+
+        @token = token
+      end
+
+      # @param [Hash] options the body for the POST request.
+      # @return [Gslide::Models::Presentation] presentation id.
+      # @see https://developers.google.com/slides/api/reference/rest/v1/presentations/create#request-body
+      def insert_presentation(options = {})
+        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
+        Presentation.new response_body["presentationId"], auth: self
+      end
+    end
+  end
+end

data/lib/gslide/models/models.rb

@@ -0,0 +1,12 @@
+require "gslide/models/editor"
+require "gslide/models/presentation"
+require "gslide/models/spreadsheet"
+
+module Gslide
+  module Models
+    GOOGLE_SLIDES = "https://slides.googleapis.com/v1/presentations"
+    GOOGLE_SHEETS = "https://sheets.googleapis.com/v4/spreadsheets"
+  end
+
+  include Models
+end

data/lib/gslide/models/presentation.rb

@@ -0,0 +1,50 @@
+require "gslide/concerns/requests"
+
+module Gslide
+  module Models
+    class Presentation
+      include Concerns::Requests
+
+      attr_reader :id
+
+      def initialize(id, auth: nil)
+        @id = id
+        @auth = auth
+      end
+
+      # @return [Hash] data from a Google Slides presentation.
+      # @see https://developers.google.com/slides/api/reference/rest/v1/presentations/get
+      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 }
+      end
+
+      def link_url
+        "https://docs.google.com/presentation/d/#{@id}/edit"
+      end
+
+      # @param [Hash] options the request body.
+      # @return True when update successful.
+      # @see https://developers.google.com/slides/api/reference/rest/v1/presentations/batchUpdate#request-body
+      def batch_update(options = {})
+        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["presentationId"] == @id
+      end
+
+      def get_slide_ids
+        parsed_body = get
+        parsed_body[:slides].collect { |slide| slide[:object_id] }
+      end
+    end
+  end
+end

data/lib/gslide/models/spreadsheet.rb

@@ -0,0 +1,88 @@
+require "gslide/concerns/requests"
+
+module Gslide
+  module Models
+    class Spreadsheet
+      include Concerns::Requests
+
+      attr_reader :id
+
+      def initialize(id, auth: nil)
+        @id = id
+        @auth = auth
+      end
+
+      # @return [Hash] data from a Google Sheets spreadsheet.
+      # @see https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets/get
+      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 }
+      end
+
+      def link_url
+        "https://docs.google.com/spreadsheets/d/#{@id}/edit"
+      end
+
+      # @param [Hash] options the request body.
+      # @return True when update successful.
+      # @see https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets/batchUpdate
+      def batch_update(options = {})
+        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["spreadsheetId"] == @id
+      end
+
+      def get_sheets
+        parsed_body = get
+        parsed_body[:sheets].collect { |h| Sheet.new(h) }
+      end
+    end
+
+    class SpreadsheetDraft
+      include Concerns::Requests
+
+      def initialize(auth: nil)
+        @auth = auth
+      end
+
+      def create(options = {})
+        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
+        spreadsheet_id = response_body["spreadsheetId"]
+        Spreadsheet.new(spreadsheet_id, auth: @auth)
+      end
+    end
+
+    class Sheet
+      attr_reader :id, :charts
+
+      def initialize(options = {})
+        @id = options[:properties][:sheet_id]
+        @charts = options[:charts].collect { |h| Chart.new(h) } if options[:charts]
+      end
+    end
+
+    class Chart
+      attr_reader :id
+
+      def initialize(options = {})
+        @id = options[:chart_id]
+      end
+    end
+  end
+end

data/lib/gslide/version.rb

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

data/lib/gslide.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require_relative "gslide/version"
+require_relative "string"
+
+require "gslide/models/models"
+
+module Gslide
+  class Error < StandardError; end
+
+end

data/lib/string.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+class String
+  def snake_case
+    gsub(/::/, '/').
+    gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+    gsub(/([a-z\d])([A-Z])/,'\1_\2').
+    tr("-", "_").
+    downcase
+  end
+
+  def lower_camel_case
+    split('_').inject { |m, p| m + p.capitalize }
+  end
+end
+
+class Object
+  def convert_keys(&blk)
+    case self
+      when Array
+        self.map { |v| v.convert_keys(&blk) }
+      when Hash
+        self.map { |k, v| [blk.call(k), v.convert_keys(&blk)] }.to_h
+      else
+        self
+    end
+  end
+end
+
+# Now, you can do options.convert_keys { |k| k.lower_camel_case }

data/sig/gslide.rbs

@@ -0,0 +1,4 @@
+module Gslide
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,58 @@
+--- !ruby/object:Gem::Specification
+name: gslide
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Kang-Kyu Lee
+bindir: exe
+cert_chain: []
+date: 2025-03-31 00:00:00.000000000 Z
+dependencies: []
+description: Allows to modify a Google Slides file by API requests.
+email:
+- kangkyu1111@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/gslide.rb
+- lib/gslide/concerns/requests.rb
+- lib/gslide/models/editor.rb
+- lib/gslide/models/models.rb
+- lib/gslide/models/presentation.rb
+- lib/gslide/models/spreadsheet.rb
+- lib/gslide/version.rb
+- lib/string.rb
+- sig/gslide.rbs
+homepage: https://github.com/lininglink/gslide
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/lininglink/gslide
+  source_code_uri: https://github.com/lininglink/gslide
+  changelog_uri: https://github.com/lininglink/gslide/blob/master/CHANGELOG.md
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.6
+specification_version: 4
+summary: Google Slides API client.
+test_files: []