lotr 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fcd353deec930c674b8286a9c513c8599c04052d04832f29ba720dec0d7e80c6
+  data.tar.gz: 57fda492ff53fca8c2318e757896abf8fb1a7bc77459e510a6a46ae222dad4e1
+SHA512:
+  metadata.gz: 41925c416d4cda61a3e888d75e8273178560ba9ad78384fae57ba99cddfb09a05f9bc67179cf932369e0caac9608ff75773a0deb539a72a47ad690381781423f
+  data.tar.gz: 15ba5f558c2b2a5af3bca68a8c87e2d6f7f2823e893b480f72cc53b8e9da423699b331c311cdd855ed33f4510a0370315d304dd537179395d13e55ca4d5f35f7

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-02-15
+
+- 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 fawwazally@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.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+
+gem "rubocop", "~> 1.21"

data/Gemfile.lock

@@ -0,0 +1,76 @@
+PATH
+  remote: .
+  specs:
+    lotr (0.1.0)
+      httparty
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.8.1)
+      public_suffix (>= 2.0.2, < 6.0)
+    ast (2.4.2)
+    crack (0.4.5)
+      rexml
+    diff-lcs (1.5.0)
+    hashdiff (1.0.1)
+    httparty (0.21.0)
+      mini_mime (>= 1.0.0)
+      multi_xml (>= 0.5.2)
+    json (2.6.3)
+    mini_mime (1.1.2)
+    multi_xml (0.6.0)
+    parallel (1.22.1)
+    parser (3.2.1.0)
+      ast (~> 2.4.1)
+    public_suffix (5.0.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.7.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.1)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (1.45.1)
+      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.24.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.26.0)
+      parser (>= 3.2.1.0)
+    ruby-progressbar (1.11.0)
+    unicode-display_width (2.4.2)
+    vcr (6.1.0)
+    webmock (3.18.1)
+      addressable (>= 2.8.0)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  x86_64-darwin-22
+
+DEPENDENCIES
+  lotr!
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.21)
+  vcr (~> 6.1)
+  webmock (~> 3.18.1)
+
+BUNDLED WITH
+   2.3.26

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Fawaz Farid
+
+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,99 @@
+# Lotr
+
+Ruby SDK for the [The Lord of the Rings API](https://the-one-api.dev/).
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add lotr
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install lotr
+
+## Usage
+
+### Making requests
+
+```ruby
+require 'lotr'
+
+# Initialize the client and provide authentication credentials
+client = Lotr::Client.new(api_key: 'your_api_key')
+
+# List all movies
+client.movies # or client.get_movies
+
+# Retrieve a movie
+client.movie("5cd95395de30eff6ebccde5b") # or client.get_movie("5cd95395de30eff6ebccde5b")
+
+# List all movie quotes for one specific movie
+client.quotes_for_movie("5cd95395de30eff6ebccde5b") # or client.get_quotes_for_movie("5cd95395de30eff6ebccde5b")
+```
+
+### Additional query parameters
+
+```ruby
+# Paginate movie quotes
+client.quotes_for_movie("5cd95395de30eff6ebccde5b", page: 2, limit: 5)
+
+# Sort movie quotes, sort by character asc
+client.quotes_for_movie("5cd95395de30eff6ebccde5b", sort: 'dialog', order: 'asc')
+```
+
+### Consuming resources
+
+The API methods return a Resource open struct object which provides dot notation and [] access for fields returned in the API response e.g.
+
+```ruby
+movie = client.movie("5cd95395de30eff6ebccde5b")
+puts movie['name']
+# => "The Two Towers"
+puts movie[:academy_award_wins]
+# => 2
+puts movie.runtime_in_minutes
+# => 179
+```
+
+### Error handling
+
+The API methods raise an error if the API returns an error response. The error object is a subclass of `Lotr::Error` e.g:
+
+```ruby
+client = Lotr::Client.new(api_key: "invalidAPKey")
+begin
+  client.movies
+# handle specific errors
+rescue Lotr::Unauthorized => e
+  puts e.message
+  # => "Unauthorized"
+rescue Lotr::Error => e
+  # could be any other error e.g. Lotr::Unauthorized, Lotr::Forbidden, Lotr::BadRequest, Lotr::InternalServerError, Lotr::ServiceUnavailable
+  # or any other error that might be raised by the underlying HTTP client.
+
+  # log the error, notify user, retry the request, etc.
+end
+```
+
+### Design
+
+See [DESIGN.md](DESIGN.md) for more details on the design of the SDK.
+
+## 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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/FawazFarid/fawaz-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/https://github.com/FawazFarid/fawaz-SDK/blob/main/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 Lotr project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/FawazFarid/fawaz-SDK/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

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

data/design.md

@@ -0,0 +1,132 @@
+# Design decisions
+
+## Choice of libraries
+
+- **Testing framework**: [RSpec](https://rspec.info/) - mostly because I'm familiar with it and very readable DSL.
+
+- **HTTP client**: [HTTPParty](https://github.com/jnunemaker/httparty) - Who doesn't like to party? :tada: :tada: :tada: Just kidding, I chose this because it's simple and easy to use. I considered [Faraday](https://lostisland.github.io/faraday/) but I just needed a library that can do simple http requests, nothing fancy and easier to use than `Net::HTTP`.
+
+- I chose `vcr` gem for recording and replaying HTTP responses and `webmock` for stubbing HTTP requests and responses.
+
+## Making requests
+
+I thought about going with a class-based approach for getting info about resources from the API. for example:
+
+```ruby
+require 'lotr'
+
+# List all movies
+Lotr::Movie.all
+
+# Retrieve a movie
+Lotr::Movie.find("5cd95395de30eff6ebccde5b")
+
+# List all movie quotes for one specific movie
+Lotr::Movie.find("5cd95395de30eff6ebccde5b").quotes
+
+# Paginate movie quotes
+Lotr::Movie.find("5cd95395de30eff6ebccde5b").quotes(page: 2, limit: 5)
+
+# Sort movie quotes, sort by character asc
+Lotr::Movie.find("5cd95395de30eff6ebccde5b").quotes(sort: 'character', order: 'asc')
+
+```
+
+I love the readability of this approach but I figured this might be time consuming in terms of writing the implementation, error handling, testing, etc. Also this closely mirrors how [ActiveRecord](https://guides.rubyonrails.org/active_record_basics.html#read) models work which might be confusing to some users who might think we are retrieving results from a local datastore.
+
+So I went with a simpler approach, where API calls are available as instance methods of a single class.
+
+```ruby
+require 'lotr'
+
+# Initialize the client and provide authentication credentials
+client = Lotr::Client.new(api_key: 'your_api_key')
+
+# List all movies
+client.movies
+```
+
+Also provided alias methods for the API endpoints:
+
+```ruby
+# List all movies
+client.get_movies # same as client.movies
+```
+
+## Accessing resources
+
+At the moment The One API endpoints return a JSON response where `docs` is an array of objects whether we are fetching a single resource (`/movies/:id`) or a collection (`/movies`):
+
+```json
+{
+  "docs": [
+    {
+      "_id": "5cd95395de30eff6ebccde5b",
+      "name": "The Two Towers",
+      "runtimeInMinutes": 179,
+      "budgetInMillions": 94,
+      "boxOfficeRevenueInMillions": 342,
+      "academyAwardNominations": 7,
+      "academyAwardWins": 2,
+      "rottenTomatoesScore": 89
+    }
+  ],
+  "total": 1,
+  "limit": 10,
+  "page": 1,
+  "pages": 1
+}
+```
+
+This looks like anti-pattern to me. I think it would be better if the API returned a single object for single resources and an array of objects for collections. This would make it easier for the client to consume the API. I also don't undertstand why the API returns a `docs`, `page`, `pages`, `limit` and `total` fields, especially for single resources.
+
+In my opinion SDKs should follow the language's conventions and idioms and also make it easier for the application developer to consume the API. So, I decided to return an `OpenStruct` object for single resources and an array of `OpenStruct` objects for collections and transformed the keys from `camelCase` to `snake_case` so that users can access the data using dot notation or `[]` for fields returned in the API response e.g:
+
+```ruby
+movie = client.movie("5cd95395de30eff6ebccde5b")
+puts movie['name']
+# => "The Two Towers"
+puts movie[:academy_award_wins]
+# => 2
+puts movie.runtime_in_minutes
+# => 179
+```
+
+With that being said, I think we can also give the user an option to access the raw response from the API. This would be useful for debugging and for users who want to access the `docs`, `page`, `pages`, `limit` and `total` fields. This can be done by providing the following methods inside the `Lotr::Client` class:
+
+```ruby
+movie = client.movie("5cd95395de30eff6ebccde5b")
+response  = client.last_response # returns the last HTTP response where the movie was being fetched
+headers   = response.headers
+body      = response.body
+```
+
+I didn't get around to doing this. This can be done in a future release.
+
+## Configuring the client
+
+I wanted to enhance how we can configure this SDK by using configuration block. I noticed this pattern with the Airbrake gem and really liked it:
+
+I liked the way Airbrake did it and wanted to implement the same pattern:
+
+```ruby
+Lotr.configure do |config|
+  config.api_key = 'frodo_was_here'
+  config.api_version = 'v2' # In case of future API versions or if you want to use v1
+  config.auto_paginate = true # enable auto pagination
+  config.per_page = 10 # Default number of results per page for paginated endpoints
+end
+```
+
+Clean internal implementation and easy for the application developer to understand. This could be used in `config/initializers/lotr.rb` in a Rails app and gives our users multiple options for configuring the SDK.
+
+I decided to go with a simpler approach for now and just allow the user to pass in the API key as an argument to the `Lotr::Client` constructor.
+
+```ruby
+client = Lotr::Client.new(api_key: 'easy_peasy')
+```
+
+## Some other stuff I'd like to add (If I had more time)
+
+- Implement sorting for `/movie` and `/quote` endpoints but it doesn't seem to be supported by the API
+- fetching API key from local .env file using [dotenv](https://github.com/bkeepers/dotenv) gem.

data/lib/lotr/client.rb

@@ -0,0 +1,59 @@
+require "httparty"
+require "lotr/response"
+
+module Lotr
+  # Client for the Lord of the Rings API
+  class Client
+    include HTTParty
+    base_uri "https://the-one-api.dev/v2"
+
+    def initialize(options = {})
+      @headers = { "Authorization" => "Bearer #{options[:api_key]}" }
+    end
+
+    def version
+      Lotr::VERSION
+    end
+
+    def movies(options = {})
+      resp = self.class.get("/movie", headers: @headers, query: parse_query_params(options))
+      handle_response(resp, multiple_items: true)
+    end
+    alias get_movies movies
+
+    def movie(movie_id)
+      resp = self.class.get("/movie/#{movie_id}", headers: @headers)
+      handle_response(resp)
+    end
+    alias get_movie movie
+
+    def quotes_for_movie(movie_id, options = {})
+      resp = self.class.get("/movie/#{movie_id}/quote", headers: @headers, query: parse_query_params(options))
+      handle_response(resp, multiple_items: true)
+    end
+    alias get_quotes_for_movie quotes_for_movie
+
+    private
+
+    def handle_response(resp, multiple_items: false)
+      handle_error_response(resp) unless resp.success?
+
+      docs = resp["docs"]
+      return Lotr::Response.parse_to_object!(docs.first) unless multiple_items
+
+      docs.map { |item| Lotr::Response.parse_to_object!(item) }
+    end
+
+    def handle_error_response(resp)
+      error = Lotr::Error.from_response(resp)
+      raise error
+    end
+
+    def parse_query_params(options)
+      # merge the sort and order params into one e.g sort=name:asc
+      options[:sort] = "#{options[:sort]}:#{options[:order]}" if options[:order] && options[:sort]
+      options.delete(:order)
+      options
+    end
+  end
+end

data/lib/lotr/error.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+module Lotr
+  class Error < StandardError
+    # Returns the appropriate Lotr::Error subclass based
+    # on status and response message
+    #
+    # @param [Hash] response HTTP response
+    # @return [Lotr::Error]
+    def self.from_response(response)
+      status = response.code
+      klass = case status
+              when 400      then Lotr::BadRequest
+              when 401      then Lotr::Unauthorized
+              when 403      then Lotr::Forbidden
+              when 404      then Lotr::NotFound
+              when 422      then Lotr::UnprocessableEntity
+              when 429      then Lotr::TooManyRequests
+              when 400..499 then Lotr::ClientError
+              when 500      then Lotr::InternalServerError
+              when 501      then Lotr::NotImplemented
+              when 502      then Lotr::BadGateway
+              when 503      then Lotr::ServiceUnavailable
+              when 500..599 then Lotr::ServerError
+              end
+      klass.new(response.message)
+    end
+  end
+
+  # Raised on errors in the 400-499 range
+  class ClientError < Error; end
+
+  # Raised when The One API returns a 400 HTTP status code
+  class BadRequest < ClientError; end
+
+  # Raised when The One API returns a 401 HTTP status code
+  class Unauthorized < ClientError; end
+
+  # Raised when The One API returns a 403 HTTP status code
+  class Forbidden < ClientError; end
+
+  # Raised when The One API returns a 404 HTTP status code
+  class NotFound < ClientError; end
+
+  # Raised when The One API returns a 422 HTTP status code
+  class UnprocessableEntity < ClientError; end
+
+  # Raised when The One API returns a 429 HTTP status code
+  class TooManyRequests < ClientError; end
+
+  # Raised on errors in the 500-599 range
+  class ServerError < Error; end
+
+  # Raised when The One API returns a 500 HTTP status code
+  class InternalServerError < ServerError; end
+
+  # Raised when The One API returns a 501 HTTP status code
+  class NotImplemented < ServerError; end
+
+  # Raised when The One API returns a 502 HTTP status code
+  class BadGateway < ServerError; end
+
+  # Raised when The One API returns a 503 HTTP status code
+  class ServiceUnavailable < ServerError; end
+
+  # Raised when a API key is required but none is provided
+  class MissingAPIKey < StandardError; end
+end

data/lib/lotr/response.rb

@@ -0,0 +1,28 @@
+module Lotr
+  class Response
+    # Parse the hash, convert the keys to snake_case and define a method dynamically for each key
+    def self.parse_to_object!(hash)
+      hash.transform_keys! do |k|
+        # convert the key to string
+        k = k.to_s
+        # remove the leading underscore from the key e.g _id => id
+        k = k.gsub(/^_/, "")
+        # convert the key to snake case
+        k.underscore!
+        k
+      end
+
+      # define a method for every key to access their respective value
+      OpenStruct.new(hash)
+    end
+  end
+end
+
+# underscore! method is not available outside of Rails, had to write a simple implementation
+class String
+  # ruby mutation methods have the expectation to return self if a mutation occurred, nil otherwise. (see http://www.ruby-doc.org/core-1.9.3/String.html#method-i-gsub-21)
+  def underscore!
+    gsub!(/(.)([A-Z])/, '\1_\2')
+    downcase!
+  end
+end

data/lib/lotr/version.rb

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

data/lib/lotr.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require "lotr/client"
+require "lotr/error"
+require "lotr/version"
+
+module Lotr
+  class Error < StandardError; end
+end

data/sig/lotr.rbs

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

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: lotr
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Fawaz Farid
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-02-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.1'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.18.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.18.1
+description: This gem provides access to the Lord of the Rings API. (https://the-one-api.dev/)
+email:
+- fawwazally@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- design.md
+- lib/lotr.rb
+- lib/lotr/client.rb
+- lib/lotr/error.rb
+- lib/lotr/response.rb
+- lib/lotr/version.rb
+- sig/lotr.rbs
+homepage: https://github.com/FawazFarid/fawaz-SDK
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/FawazFarid/fawaz-SDK
+  source_code_uri: https://github.com/FawazFarid/fawaz-SDK
+  changelog_uri: https://github.com/FawazFarid/fawaz-SDK/blob/main/CHANGELOG.md
+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.3.26
+signing_key:
+specification_version: 4
+summary: This gem provides access to the Lord of the Rings API. (https://the-one-api.dev/)
+test_files: []