precious-sdk 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ca7de38c76a751b58ac46d8942654e3fe69fb3a0ffde5c4f1e1964201c3ba0b4
+  data.tar.gz: 42e235af2d2ddd3cd66f176d4e3239958b26ea3c7db1419023db9093f8e424a8
+SHA512:
+  metadata.gz: e5004aa90cf81863831bf4ef100cec8811df1b1faaf9f6478efd089302e733b7ed10151ee2abeeae5e1544d965d98dbeb209ae1105027fb16d0d2499fdbaf7eb
+  data.tar.gz: ac00ecb9edc73e169273619ae8126a27af557939e944bd94c8678330554c64d61e1d47cf8b13f5a4a2720402cc1179fb946789b86d47212e9e95a40055b18757

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] - 2022-04-09
+
+- Initial release

data/Gemfile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in precious.gemspec
+gemspec
+
+gem "faraday", "~> 0.15"
+gem "oj", "~> 2.5"
+gem "rake", "~> 13.0"
+gem "rspec", "~> 3.0"
+gem "vcr", "~> 3.0"
+gem "rubocop", "~> 1.21"
+gem "webmock", "~> 3.0"

data/Gemfile.lock

@@ -0,0 +1,76 @@
+PATH
+  remote: .
+  specs:
+    precious-sdk (0.1.0)
+      faraday (~> 0.15)
+      oj (~> 2.5)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.8.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    ast (2.4.2)
+    crack (0.4.5)
+      rexml
+    diff-lcs (1.5.0)
+    faraday (0.17.5)
+      multipart-post (>= 1.2, < 3)
+    hashdiff (1.0.1)
+    multipart-post (2.1.1)
+    oj (2.18.5)
+    parallel (1.22.1)
+    parser (3.1.1.0)
+      ast (~> 2.4.1)
+    public_suffix (4.0.6)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.3.0)
+    rexml (3.2.5)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+    rubocop (1.27.0)
+      parallel (~> 1.10)
+      parser (>= 3.1.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.16.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.17.0)
+      parser (>= 3.1.1.0)
+    ruby-progressbar (1.11.0)
+    unicode-display_width (2.1.0)
+    vcr (3.0.3)
+    webmock (3.14.0)
+      addressable (>= 2.8.0)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  x86_64-darwin-21
+
+DEPENDENCIES
+  faraday (~> 0.15)
+  oj (~> 2.5)
+  precious-sdk!
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.21)
+  vcr (~> 3.0)
+  webmock (~> 3.0)
+
+BUNDLED WITH
+   2.3.5

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Michael Bastos
+
+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,65 @@
+# Precious
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/precious`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'precious'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install precious
+
+## Usage
+
+Making sure you first require the gem in your code or console
+
+```
+require 'precious'
+```
+
+An Example of fetching books without an API key
+
+```
+books = Precious::API::V2::Books.new
+
+books.get_books
+```
+
+An Example of fetching movies with an API key
+```
+movies = Precious::API::V2::Movies.new(API_KEY)
+
+movies.get_movies
+```
+
+An Example of fetching character quotes with an API key
+```
+characters = Precious::API::V2::Characters.new(API_KEY)
+
+characters.get_character_quotes(id: '5cdbe73516d496d2c2940848')
+```
+
+## 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/[USERNAME]/precious.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

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,15 @@
+# SDK Design
+
+I tried keeping the design pretty simple, function over form, and it allows the user to reuse many of the different elements while getting just a usable hash back.
+
+## Returning a Hash instead of an object
+
+I like using complex map, reduce, select and even delete_if functions in my data manipulation so any library I get I tend to prefer just receiving a hash that makes it easier for me to implement in my own models but I understand that in other languages real objects are more desirable. 
+
+## VCR for testing
+
+One of the things I really like about the Rspec and Ruby ecosystem is the simplicity of testing existing API end points with real payloads, I was able to obfuscate the API_KEY itself in order to show that one can fetch data and test an API live without having to risk things such as keys and passwords etc. This can become important in automating testing.
+
+## Breaking each end point down into it's own namespace
+
+It was important that I break each end point into it's own seperate namespace, ideally I would also limit the loading to the specific namespace someone needs but I felt this approach was sufficient to mimic the API as it stands.

data/lib/precious/base.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Precious
+  module API
+    module V2
+      class Base
+        API_ENDPOINT = "https://the-one-api.dev/v2/"
+
+        attr_reader :api_key
+
+        def initialize(api_key = nil)
+          @api_key = api_key
+        end
+
+        private
+
+        def request(http_method:, endpoint:, params: {})
+          response = client.public_send(http_method, endpoint, params)
+          Oj.load(response.body)
+        end
+
+        def client
+          Faraday.new(API_ENDPOINT) do |client|
+            client.request :url_encoded
+            client.adapter Faraday.default_adapter
+            client.headers["Content-Type"] = "application/json"
+            client.headers["Authorization"] = "Bearer #{api_key}" unless api_key&.nil?
+          end
+        end
+
+        def set_params(limit:, page:, offset:)
+          params = {}
+          params = params.merge(limit: limit) if limit.positive?
+          params = params.merge(page: page) if page.positive?
+          params = params.merge(offset: offset) if offset.positive?
+          params
+        end
+      end
+    end
+  end
+end

data/lib/precious/books.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Precious
+  module API
+    module V2
+      class Books < Base
+        # GET https://the-one-api.dev/v2/book
+        def get_books(limit: 0, page: 0, offset: 0)
+          params = set_params(limit: limit, page: page, offset: offset)
+
+          request(
+            http_method: :get,
+            endpoint: "book",
+            params: params
+          )
+        end
+
+        # GET https://the-one-api.dev/v2/book/{id}
+        def get_book(id:)
+          params = {
+            _id: id
+          }
+
+          request(
+            http_method: :get,
+            endpoint: "book",
+            params: params
+          )
+        end
+
+        # GET https://the-one-api.dev/v2/book/{id}/chapters
+        def get_book_chapters(id:, limit: 0, page: 0, offset: 0)
+          params = set_params(limit: limit, page: page, offset: offset)
+
+          request(
+            http_method: :get,
+            endpoint: "book/#{id}/chapter",
+            params: params
+          )
+        end
+      end
+    end
+  end
+end

data/lib/precious/chapters.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Precious
+  module API
+    module V2
+      class Chapters < Base
+        # GET https://the-one-api.dev/v2/chapter
+        def get_chapters(limit: 0, page: 0, offset: 0)
+          params = set_params(limit: limit, page: page, offset: offset)
+
+          request(
+            http_method: :get,
+            endpoint: "chapter",
+            params: params
+          )
+        end
+
+        # GET https://the-one-api.dev/v2/chapter/{id}
+        def get_chapter(id:)
+          params = {
+            _id: id
+          }
+
+          request(
+            http_method: :get,
+            endpoint: "chapter",
+            params: params
+          )
+        end
+      end
+    end
+  end
+end

data/lib/precious/characters.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Precious
+  module API
+    module V2
+      class Characters < Base
+        # GET https://the-one-api.dev/v2/character
+        def get_characters(limit: 0, page: 0, offset: 0)
+          params = set_params(limit: limit, page: page, offset: offset)
+
+          request(
+            http_method: :get,
+            endpoint: "character",
+            params: params
+          )
+        end
+
+        # GET https://the-one-api.dev/v2/character/{id}
+        def get_character(id:)
+          params = {
+            _id: id
+          }
+
+          request(
+            http_method: :get,
+            endpoint: "character",
+            params: params
+          )
+        end
+
+        # GET https://the-one-api.dev/v2/character/{id}/quote
+        def get_character_quotes(id:, limit: 0, page: 0, offset: 0)
+          params = set_params(limit: limit, page: page, offset: offset)
+
+          request(
+            http_method: :get,
+            endpoint: "character/#{id}/quote",
+            params: params
+          )
+        end
+      end
+    end
+  end
+end

data/lib/precious/movies.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Precious
+  module API
+    module V2
+      class Movies < Base
+        # GET https://the-one-api.dev/v2/movie
+        def get_movies(limit: 0, page: 0, offset: 0)
+          params = set_params(limit: limit, page: page, offset: offset)
+
+          request(
+            http_method: :get,
+            endpoint: "movie",
+            params: params
+          )
+        end
+
+        # GET https://the-one-api.dev/v2/movie/{id}
+        def get_movie(id:)
+          params = {
+            _id: id
+          }
+
+          request(
+            http_method: :get,
+            endpoint: "movie",
+            params: params
+          )
+        end
+
+        # GET https://the-one-api.dev/v2/character/{id}/quote
+        def get_movie_quotes(id:, limit: 0, page: 0, offset: 0)
+          params = set_params(limit: limit, page: page, offset: offset)
+
+          request(
+            http_method: :get,
+            endpoint: "movie/#{id}/quote",
+            params: params
+          )
+        end
+      end
+    end
+  end
+end

data/lib/precious/quotes.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Precious
+  module API
+    module V2
+      class Quotes < Base
+        # GET https://the-one-api.dev/v2/quote
+        def get_quotes(limit: 0, page: 0, offset: 0)
+          params = set_params(limit: limit, page: page, offset: offset)
+
+          request(
+            http_method: :get,
+            endpoint: "quote",
+            params: params
+          )
+        end
+
+        # GET https://the-one-api.dev/v2/quote/{id}
+        def get_quote(id:)
+          params = {
+            _id: id
+          }
+
+          request(
+            http_method: :get,
+            endpoint: "quote",
+            params: params
+          )
+        end
+      end
+    end
+  end
+end

data/lib/precious/version.rb

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

data/lib/precious.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "faraday"
+require "oj"
+require_relative "precious/base"
+require_relative "precious/books"
+require_relative "precious/chapters"
+require_relative "precious/characters"
+require_relative "precious/movies"
+require_relative "precious/quotes"
+require_relative "precious/version"
+
+module Precious
+  class Error < StandardError; end
+end

data/precious.gemspec

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require_relative "lib/precious/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "precious-sdk"
+  spec.version = Precious::VERSION
+  spec.authors = ["Michael Bastos"]
+  spec.email = ["bastosmichael@gmail.com"]
+
+  spec.summary = "SDK for an existing Lord of the Rings API"
+  spec.description = "Well, if you don't know or neither like 'The Lord of the Rings', the epic masterpiece epos by J.R.R. Tolkien, then this API is most likely not for you. But if you do, this massive database will provide you with information about the books, the movie trilogy, many characters and quotes. You are welcome to use the data in your own apps, mixups and (fun) projects — like I did with creating this API. This project is totally non-profit and fan-made!"
+  spec.homepage = "https://github.com/bastosmichael/precious-gem"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  # spec.metadata["allowed_push_host"] = "TODO: Set to your gem server 'https://example.com'"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/bastosmichael/precious-gem"
+  spec.metadata["changelog_uri"] = "https://github.com/bastosmichael/precious-gem/blob/main/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  spec.add_dependency "faraday", "~> 0.15"
+  spec.add_dependency "oj", "~> 2.5"
+
+  spec.add_development_dependency "rspec", "~> 3.2"
+  spec.add_development_dependency "vcr", "~> 3.0"
+  spec.add_development_dependency "webmock", "~> 3.0"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/sig/precious.rbs

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

metadata

@@ -0,0 +1,140 @@
+--- !ruby/object:Gem::Specification
+name: precious-sdk
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Michael Bastos
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-04-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+- !ruby/object:Gem::Dependency
+  name: oj
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Well, if you don't know or neither like 'The Lord of the Rings', the
+  epic masterpiece epos by J.R.R. Tolkien, then this API is most likely not for you.
+  But if you do, this massive database will provide you with information about the
+  books, the movie trilogy, many characters and quotes. You are welcome to use the
+  data in your own apps, mixups and (fun) projects — like I did with creating this
+  API. This project is totally non-profit and fan-made!
+email:
+- bastosmichael@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- design.md
+- lib/precious.rb
+- lib/precious/base.rb
+- lib/precious/books.rb
+- lib/precious/chapters.rb
+- lib/precious/characters.rb
+- lib/precious/movies.rb
+- lib/precious/quotes.rb
+- lib/precious/version.rb
+- precious.gemspec
+- sig/precious.rbs
+homepage: https://github.com/bastosmichael/precious-gem
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/bastosmichael/precious-gem
+  source_code_uri: https://github.com/bastosmichael/precious-gem
+  changelog_uri: https://github.com/bastosmichael/precious-gem/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.2.22
+signing_key:
+specification_version: 4
+summary: SDK for an existing Lord of the Rings API
+test_files: []