lotr-sdk 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e14a3db3f517bd80e87a7dd2a42c403f2077bb2527475bfdc2a65053eedf4abc
+  data.tar.gz: 69c14fa3df2b62893b5d94cbeabbe6cc87851c629328f8cbfb7ddd3aafb9bdde
+SHA512:
+  metadata.gz: 03c474b7e6faab9c3a348eb44191d2e8416047ac69d041052211fa255d219b9dbb3787e3dabd4c05bc33100ae37a4a59885b130a46feb0cb33ecdc8d15aad089
+  data.tar.gz: 1ff4d9706a7b333ab72748d383121e159fd17452bcaced949c205bc6b41a26131972504a02a62bc14224fa9429bc6203a26904db21aca5cd48f4a69d4fe43726

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  TargetRubyVersion: 2.6
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2023-05-22
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# 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, 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 e-mail 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 joseph.h.wan@gmail.com. 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.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in lotr-sdk.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+
+gem "rubocop", "~> 1.21"

data/Gemfile.lock

@@ -0,0 +1,90 @@
+PATH
+  remote: .
+  specs:
+    lotr-sdk (0.1.1)
+      http (~> 5.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.8.4)
+      public_suffix (>= 2.0.2, < 6.0)
+    ast (2.4.2)
+    coderay (1.1.3)
+    diff-lcs (1.5.0)
+    domain_name (0.5.20190701)
+      unf (>= 0.0.5, < 1.0.0)
+    ffi (1.15.5)
+    ffi-compiler (1.0.1)
+      ffi (>= 1.0.0)
+      rake
+    http (5.1.1)
+      addressable (~> 2.8)
+      http-cookie (~> 1.0)
+      http-form_data (~> 2.2)
+      llhttp-ffi (~> 0.4.0)
+    http-cookie (1.0.5)
+      domain_name (~> 0.5)
+    http-form_data (2.3.0)
+    json (2.6.3)
+    llhttp-ffi (0.4.0)
+      ffi-compiler (~> 1.0)
+      rake (~> 13.0)
+    method_source (1.0.0)
+    parallel (1.23.0)
+    parser (3.2.2.1)
+      ast (~> 2.4.1)
+    pry (0.14.2)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    public_suffix (5.0.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.8.0)
+    rexml (3.2.5)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.2)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.5)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (1.51.0)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.2.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.28.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.28.1)
+      parser (>= 3.2.1.0)
+    ruby-progressbar (1.13.0)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.8.2)
+    unicode-display_width (2.4.2)
+    yard (0.9.34)
+
+PLATFORMS
+  x86_64-darwin-22
+  x86_64-linux
+
+DEPENDENCIES
+  lotr-sdk!
+  pry (~> 0.14)
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.21)
+  yard (~> 0.6)
+
+BUNDLED WITH
+   2.4.13

data/MIT-LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2023, Joseph Wan
+
+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,59 @@
+# Lotr::Sdk
+
+`lotr-sdk` is a Ruby gem that provides a SDK to help The Lord of the Rings lovers consume data about the epic books by J. R. R. Tolkien and the official movie adaptions by Peter Jackson. This SDK leverages [The One API](https://the-one-api.dev) the one API to rule them all.
+
+This SDK currently implements methods to work with movies and movie quotes
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add lotr-sdk
+
+## Usage
+
+Get an access token by signing up for an account at [The One API](https://the-one-api.dev/sign-up).
+
+```
+# Provide API access token
+# If you do not provide an access token, Lotr::Sdk looks for checks if you set `THE_ONE_ACCESS_TOKEN` environment variable.
+client = Lotr::Sdk::Client.new(access_token: 'personal_access_token')
+
+# Fetch all movies
+movies = client.movies
+
+# Fetch quotes belonging to a movie
+client.movie_quotes_from_movie(movie.first)
+
+# Note: The One API only provides quotes from these movies:
+  - The Fellowship of the Ring (id: "5cd95395de30eff6ebccde5c")
+  - The Two Towers (id: "5cd95395de30eff6ebccde5b")
+  - The Return of the King (id: "5cd95395de30eff6ebccde5d")
+  This version of the API will raise an error if you try to retrieve quotes from other movies. To disable this check, set the `DISABLE_MOVIE_CHECK` env variable to `1`
+
+# Fetch all quotes
+client.quotes
+```
+
+You can see the list of available methods with more details by generating and viewing the documentation:
+```
+bin/yard
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Testing
+
+Before running tests, set your access token to `THE_ONE_ACCESS_TOKEN` environment variable.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/joseph1wan/joseph-sdk. 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/joseph1wan/joseph-sdk/blob/main/CODE_OF_CONDUCT.md).
+
+## Code of Conduct
+
+Everyone interacting in the Lotr::Sdk project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/joseph1wan/joseph-sdk/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: %i[spec]

data/design.md

@@ -0,0 +1,36 @@
+# SDK Design
+
+## Philosophy
+
+I modeled the SDK design after the Octokit philosophy of keeping the SDK
+structure close to the original API. The classes provide getter methods with Ruby-convention naming. I originally planned to allow users to fetch quotes from movies (`Movie.quotes`) and vice-versa, but ultimately removed that functionality since those methods can be costly in API calls if the developer is not careful. Instead, developers should use the Client for all API calls (`Client.movie_quotes(movie_id)`).
+
+## Objectives:
+One of my main objectives in this API design is to prevent my users from running into some of the problem I ran into:
+- Receiving an empty response for a movie that didn't exist
+- Getting a 500 error when the ID wasn't a 24-char string
+- Partial movie-name matching not working until converted to Regex
+
+Another important objective of the design was clarity. I spent a good portion of development time writing tests and making sure all methods were documented.
+
+## Areas of improvement
+
+### Schema validation
+Implementing schema validation on the response from The One API would:
+1. Give early warning about API changes.
+2. Provide useful data about what changed.
+3. Make it trivial to update and release a new version of the SDK.
+
+### Meta programming
+Using meta-programming, we could programmatically create class methods with Ruby-convention naming using the keys of the JSON response. 
+
+For example, we could potentially take advantage of Ruby's `NoMethodError` and infer that `runtime_in_minutes` would be `runtimeInMinutes` and access the data using that key. Essentially defining this method without writing code:
+
+```
+def runtime_in_minutes
+    @data["runtimeinMinutes"]
+end
+```
+
+However, I find that this can create more headache than help, depending on edge cases. It also makes it much harder to generate documentation from code (can't use YARD). But it would be handle changes in the source API response with very little
+code change.

data/lib/lotr/sdk/client.rb

@@ -0,0 +1,133 @@
+# frozen_string_literal: true
+
+module Lotr
+  module Sdk
+    # Client instantiates an HTTP client and makes all API calls
+    class Client
+      ID_REGEX = /^[0-9a-f]{24}$/i.freeze
+      MOVIES_WITH_QUOTES = %w[5cd95395de30eff6ebccde5c 5cd95395de30eff6ebccde5b 5cd95395de30eff6ebccde5d"].freeze # IDs for the original trilogy
+
+      # Initialize client with an access token
+      #   1. Sign up at https://the-one-api.dev/sign-up
+      #   2. Provide the access token.
+      #        You can pass in you token as a parameter
+      #          or
+      #        Set the token to the THE_ONE_ACCESS_TOKEN env variable
+      def initialize(access_token: nil)
+        @api_url = "https://the-one-api.dev/v2"
+        if access_token.nil?
+          access_token = ENV["THE_ONE_ACCESS_TOKEN"]
+        end
+        raise Exception::MissingAccessTokenError if access_token.nil?
+
+        @client = HTTP.headers(accept: "application/json").auth("Bearer #{access_token}")
+      end
+
+      # Fetch all movies
+      # @param q [Object] Hash of query parameters. For example: { name: "Series" }
+      # @return [Array<Movie>] A list of all movies
+      def movies(q: {})
+        endpoint = "movie"
+        if q.any?
+          endpoint += "?" + transform_query_parameters(q)
+        end
+        uri = URI("#{@api_url}/#{endpoint}")
+        response = JSON.parse(@client.get(uri).body)
+        response["docs"].map do |movie_data|
+          Movie.new(movie_data)
+        end
+      end
+
+      # Fetch a specified movie
+      # @param id [String] A 24-char string identifying the movie
+      # @return [Movie] The movie corresponding to the ID
+      def movie(id)
+        id = validate_id(id)
+        endpoint = "movie/#{id}"
+        uri = URI("#{@api_url}/#{endpoint}")
+        response = JSON.parse(@client.get(uri).body)
+        raise Exception::ResourceNotFoundError.new(:movie, id) if response["total"].zero?
+
+        movie_data = response["docs"].first
+        Movie.new(movie_data)
+      end
+
+      # Fetch all quotes
+      # @param q [Object] Hash of query and pagination parameters. For example: { dialog: "Oooh", page: 2 }
+      # @return [Array<Movie>] A list of all movies
+      def quotes(q: {})
+        endpoint = "/quote"
+        if q.any?
+          endpoint += "?" + transform_query_parameters(q)
+        end
+        uri = URI("#{@api_url}/#{endpoint}")
+        response = JSON.parse(@client.get(uri).body)
+        response["docs"].map do |quote_data|
+          Quote.new(quote_data)
+        end
+      end
+
+      # Fetch all quotes belonging to a movie.
+      # Only Lord of the Rings movie are supported. These movies are:
+      #   The Fellowship of the Ring
+      #   The Two Towers
+      #   The Return of the King
+      # @return [Array<Quote>] All quotes belonging to the movie
+      def movie_quotes(movie_id, movie = nil)
+        raise Exception::MovieNotSupportedError.new(MOVIES_WITH_QUOTES) unless ENV["DISABLE_MOVIE_CHECK"] || MOVIES_WITH_QUOTES.include?(movie_id)
+
+        endpoint = "/movie/#{movie_id}/quote"
+        uri = URI("#{@api_url}/#{endpoint}")
+        response = JSON.parse(@client.get(uri).body)
+        response["docs"].map do |quote_data|
+          Quote.new(quote_data)
+        end
+      end
+
+      # Fetch all quotes belonging to a movie.
+      # Uses movie_quotes with same limitations
+      # @return [Array<Quote>] All quotes belonging to the movie
+      def movie_quotes_from_movie(movie)
+        movie_quotes(movie.id, movie)
+      end
+
+      # Fetch a specified quote
+      # @param id [String] A 24-char string identifying the quote
+      # @return [Movie] The quote corresponding to the ID
+      def quote(id)
+        quote_id = validate_id(id)
+        endpoint = "/quote/#{quote_id}"
+        uri = URI("#{@api_url}/#{endpoint}")
+        response = JSON.parse(@client.get(uri).body)
+
+        raise Exception::ResourceNotFoundError.new(:quote, id) if response["total"].zero?
+
+        quote_data = response["docs"].first
+        Quote.new(quote_data)
+      end
+
+      private
+
+        # Makes sure ID is a 24-char string
+        # return [String]
+        def validate_id(id)
+          raise Exception::InvalidIdError.new(id) unless ID_REGEX.match?(id.to_s.downcase)
+
+          id
+        end
+
+        # Transforms query params from hash to string
+        # return [String]
+        def transform_query_parameters(params)
+          pagination_keys = %i[limit page offset]
+          params.map do |k, v|
+            if pagination_keys.include?(k)
+              "#{k}=#{v}"
+            else
+              "#{k}=/.*#{v}.*/"
+            end
+          end.join("&")
+        end
+    end
+  end
+end

data/lib/lotr/sdk/exception/invalid_id_error.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Lotr
+  module Sdk
+    module Exception
+      class InvalidIdError < StandardError
+        def initialize(id)
+          super("#{id} is an invalid ID. Provide a valid id")
+        end
+      end
+    end
+  end
+end

data/lib/lotr/sdk/exception/missing_access_token_error.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Lotr
+  module Sdk
+    module Exception
+      class MissingAccessTokenError < StandardError
+        def initialize
+          super("Provide client with an access token or set your token to the THE_ONE_ACCESS_TOKEN env variable")
+        end
+      end
+    end
+  end
+end

data/lib/lotr/sdk/exception/movie_not_supported_error.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Lotr
+  module Sdk
+    module Exception
+      class MovieNotSupportedError < StandardError
+        def initialize(supported_movies)
+          msg = "This movie ID is not supported. Supported movies are: #{supported_movies.join(" ")}"
+          super(msg)
+        end
+      end
+    end
+  end
+end

data/lib/lotr/sdk/exception/resource_not_found_error.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Lotr
+  module Sdk
+    module Exception
+      class ResourceNotFoundError < StandardError
+        def initialize(resource_type, id)
+          super("Could not find #{resource_type} quote with id: #{id}. Check your ID and try again or provide a valid ID")
+        end
+      end
+    end
+  end
+end

data/lib/lotr/sdk/exception.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require_relative "exception/invalid_id_error"
+require_relative "exception/missing_access_token_error"
+require_relative "exception/movie_not_supported_error"
+require_relative "exception/resource_not_found_error"
+
+module Lotr
+  module Sdk
+    module Exception; end
+  end
+end

data/lib/lotr/sdk/movie.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module Lotr
+  module Sdk
+    # Movie represents the data of a movie.
+    class Movie
+      attr_reader :data, :quotes
+
+      def initialize(data)
+        @data = data
+        @quotes = []
+      end
+
+      # Represents the movie ID
+      # @return [String]
+      def id
+        @data["_id"]
+      end
+
+      # Represents the movie title
+      # @return [String]
+      def name
+        @data["name"]
+      end
+
+      # Represents the movie length
+      # @return [Integer]
+      def run_time_minutes(format: false)
+        @data["runtimeInMinutes"]
+      end
+
+      # Represents the movie budget in milions
+      # @return [Integer]
+      def budget_millions
+        @data["budgetInMillions"]
+      end
+
+      # Represents the movie revenue in milions
+      # @return [Integer]
+      def revenue_millions
+        @data["boxOfficeRevenueInMillions"]
+      end
+
+      # Represents the number of Academy Award nominations
+      # @return [Integer]
+      def academy_award_nominations
+        @data["academyAwardNominations"]
+      end
+
+      # Represents the number of Academy Awards won
+      # @return [Integer]
+      def academy_award_wins
+        @data["academyAwardWins"]
+      end
+
+      # Represents the score out of 100 on Rotten Tomatoes
+      # @return [Integer]
+      def rotten_tomatoes_score
+        @data["rottenTomatoesScore"]
+      end
+    end
+  end
+end

data/lib/lotr/sdk/quote.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Lotr
+  module Sdk
+    # Quote represents the data of a quote.
+    class Quote
+      attr_reader :data
+
+      def initialize(data)
+        @data = data
+      end
+
+      # Represents the quote ID
+      # @return [String]
+      def id
+        @data["_id"]
+      end
+
+      # Represents the quote text
+      # @return [String]
+      def dialog
+        @data["dialog"]
+      end
+
+      # Fetch the ID of the movie the quote comes from
+      # @return [String]
+      def movie
+        @data["movie"]
+      end
+
+      # Represents the character that spoke the quote
+      # Characters are not supported in this version of the SDK
+      # @return [String]
+      def character
+        @data["character"]
+      end
+    end
+  end
+end

data/lib/lotr/sdk/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Lotr
+  module Sdk
+    VERSION = "0.1.1"
+  end
+end

data/lib/lotr/sdk.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require "http"
+require_relative "sdk/client"
+require_relative "sdk/exception"
+require_relative "sdk/movie"
+require_relative "sdk/quote"
+require_relative "sdk/version"
+
+module Lotr
+  module Sdk
+  end
+end

data/sig/lotr/sdk.rbs

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

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: lotr-sdk
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Joseph Wan
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-05-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+description: Consume information about the Lord of the Rings trilogy
+email:
+- joseph.h.wan@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- MIT-LICENSE
+- README.md
+- Rakefile
+- design.md
+- lib/lotr/sdk.rb
+- lib/lotr/sdk/client.rb
+- lib/lotr/sdk/exception.rb
+- lib/lotr/sdk/exception/invalid_id_error.rb
+- lib/lotr/sdk/exception/missing_access_token_error.rb
+- lib/lotr/sdk/exception/movie_not_supported_error.rb
+- lib/lotr/sdk/exception/resource_not_found_error.rb
+- lib/lotr/sdk/movie.rb
+- lib/lotr/sdk/quote.rb
+- lib/lotr/sdk/version.rb
+- sig/lotr/sdk.rbs
+homepage: https://github.com/joseph1wan/joseph-sdk
+licenses: []
+metadata:
+  homepage_uri: https://github.com/joseph1wan/joseph-sdk
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.13
+signing_key:
+specification_version: 4
+summary: Consume information about the Lord of the Rings trilogy
+test_files: []