juggy-theone-sdk 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: da7f42a21a902e51b523d1d4af3b57db4cef3ca2d22dfd99b9d0c93f629d7300
+  data.tar.gz: ca2acfec738fefe0118e4f5167402679189178988a8f1445d7d384662d31bd49
+SHA512:
+  metadata.gz: f9d1e5ba53c45fa6998310d9d10e674f10683216b5956063c1e7505925069faa51a06c8f18838d0d3d6b089b933168b2f880322e464b812858d7ea06f6286388
+  data.tar.gz: 3f0231c9f9cffde3c03c7d7883855b9137a0b93e18f473c19c49c3dfb594ceb01a83e02ee002e12ebafbe60ded2d20fc05f987bde82de505303366f1947309d6

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,23 @@
+AllCops:
+  TargetRubyVersion: 2.7
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Enabled: false
+  Max: 120
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/BlockLength:
+  Enabled: false

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,68 @@
+PATH
+  remote: .
+  specs:
+    juggy-theone-sdk (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.8.4)
+      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)
+    json (2.6.3)
+    parallel (1.23.0)
+    parser (3.2.2.1)
+      ast (~> 2.4.1)
+    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.50.2)
+      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.0)
+      parser (>= 3.2.1.0)
+    ruby-progressbar (1.13.0)
+    unicode-display_width (2.4.2)
+    webmock (3.18.1)
+      addressable (>= 2.8.0)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  x86_64-darwin-21
+
+DEPENDENCIES
+  juggy-theone-sdk!
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.21)
+  webmock (~> 3.18)
+
+BUNDLED WITH
+   2.3.24

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Julien Guimont
+
+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,81 @@
+# Theone
+
+Ruby SDK implementation for [The One API](https://the-one-api.dev/documentation)
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add juggy-theone-sdk
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install juggy-theone-sdk
+
+## Usage
+
+Once the gem is installed, you can query movies and quotes like so:
+
+```
+sdk = Theone::Sdk.new(access_token: "my access token")
+```
+
+The SDK can be configured with different endpoint and api version as such
+
+```
+sdk = Theone::Sdk.new(
+        access_token: "my access token"
+        endpoint: "https://example.com",
+        version: "v3"
+    )
+```
+This can be useful if you plan on using a test endpoint or an image hosted elsewhere.
+
+Once you have a valid SDK object, you can access Movies:
+
+```
+# get all movies, pagination is handled for you.
+sdk.movies
+
+# get a specific movie
+my_movie = sdk.movie(movie_id)
+
+# access the movie attributes like so
+my_movie.name
+# or all movie attributes
+my_movie.attributes
+```
+
+Or Quotes:
+```
+# get all quotes, pagination is handled for you.
+sdk.quotes
+
+# get a specific quote
+my_quote = sdk.quote(quote_id)
+
+# access the quote attributes like so
+my_quote.name
+# or all quote attributes
+my_quote.attributes
+```
+
+You can also get all quotes from a specific movie:
+```
+my_movie = sdk.movie(movie_id)
+my_movie.quotes.first
+```
+
+## 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/juggy/juggy-theone-sdk.
+
+## 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,16 @@
+# Design
+
+## Dependencies
+
+This gem uses the default Ruby HTTP client and JSON parser. It was a concious decision to avoid forcing the consumer to bring more dependencies in order to use the SDK.
+
+## Object Model
+
+The object model uses a base class and can handle any type of data. The base class relies on `method_missing` to link the json attributes to real method calls. There is no further interpretation of the JSON data. In fact each type (Movie or Quote) does not implement specific logic for the data. A differenciation can be added in the futur as the types are loaded and defined.
+
+## Pagination
+
+The pagination is handled using an `Enumerator` which makes it transparent to the SDK consumer. A nice side effect of using an `Enumerator` is that the data is lazily loaded. This allows for a better use of resources.
+
+It also provides a central place to implement throtling mitigation (as the API is limited to 100 calls per 10 minutes). This would be a futur improvement.
+

data/juggy-theone-sdk.gemspec

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require_relative "lib/theone/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "juggy-theone-sdk"
+  spec.version = Theone::VERSION
+  spec.authors = ["Julien Guimont"]
+  spec.email = ["julien.guimont@gmail.com"]
+
+  spec.summary = "SDK implementation for The One API"
+  spec.description = "https://the-one-api.dev/documentation"
+  spec.homepage = "http://github.com/juggy/juggy-theone-sdk"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.7.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "http://github.com/juggy/juggy-theone-sdk"
+
+  # 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(__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 "example-gem", "~> 1.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/lib/theone/base.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Theone
+  # Base class to provide access to the json data
+  class Base
+    attr_reader :attributes, :client
+
+    def initialize(client, json)
+      @client = client
+      @attributes = json
+    end
+
+    def method_missing(att, *_args, &_block)
+      return attributes["_id"] if att == :id
+
+      attributes.key?(att.to_s) ? attributes[att.to_s] : super
+    end
+
+    def respond_to_missing?(att, _)
+      att = :_id if att == :id
+      attributes.key?(att.to_s) || super
+    end
+  end
+end

data/lib/theone/client.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require "net/http"
+require "JSON"
+
+module Theone
+  # HTTP client to connect to the One API
+  class Client
+    DEFAULT_ENDPOINT = "https://the-one-api.dev/"
+    VERSION = "v2"
+    ALLOWED_QUERY_KEYS = %i[page limit offset].freeze
+
+    attr_reader :access_token, :endpoint, :version
+
+    def initialize(access_token:, endpoint: DEFAULT_ENDPOINT, version: VERSION)
+      @endpoint = endpoint
+      @access_token = access_token
+      @version = version
+    end
+
+    def api_request(path, query = {})
+      query_string = ALLOWED_QUERY_KEYS.intersection(query.keys).map { |k| "#{k}=#{query[k]}" }.join("&")
+      uri = URI("#{endpoint}#{version}#{path}?#{query_string}")
+
+      headers = {
+        "Authorization" => "Bearer #{access_token}",
+        "Content-Type" => "application/json",
+        "Accept" => "application/json"
+      }
+
+      http = Net::HTTP.new(uri.hostname, uri.port)
+      http.use_ssl = uri.instance_of? URI::HTTPS
+      res = http.get(uri.request_uri, headers)
+
+      # value (weird name) will raise if the response code is not 200
+      res.value
+      JSON.parse(res.body)["docs"]
+    end
+  end
+end

data/lib/theone/movie.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require_relative "base"
+require_relative "quote"
+require_relative "paginator"
+
+module Theone
+  # Movie API def
+  class Movie < Base
+    BASE_PATH = "/movie"
+
+    class << self
+      def all(client)
+        Paginator.paginate(client, BASE_PATH) { |movie_json| Movie.new(client, movie_json) }
+      end
+
+      def one(client, id)
+        movie_json = client.api_request("#{BASE_PATH}/#{id}").first
+        Movie.new(client, movie_json)
+      end
+    end
+
+    def quotes
+      Paginator.paginate(client, "#{BASE_PATH}/#{id}/quote") { |quote_json| Quote.new(client, quote_json) }
+    end
+  end
+end

data/lib/theone/paginator.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Theone
+  # iterator class to provide transparent pagination
+  module Paginator
+    def self.paginate(client, path, page: 1, limit: 10, &block)
+      Enumerator.new do |y|
+        loop do
+          data = client.api_request(path, page: page, limit: limit)
+
+          data.each do |element|
+            object = block.call element
+            y.yield object
+          end
+
+          # stop if empty
+          break if data.empty? || data.size < limit
+
+          # go to next page
+          page += 1
+        end
+      end
+    end
+  end
+end

data/lib/theone/quote.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require_relative "base"
+require_relative "paginator"
+
+module Theone
+  # Quote API def
+  class Quote < Base
+    BASE_PATH = "/quote"
+
+    class << self
+      def all(client)
+        Paginator.paginate(client, BASE_PATH) { |quote_json| Quote.new(client, quote_json) }
+      end
+
+      def one(client, id)
+        quote_json = client.api_request("#{BASE_PATH}/#{id}").first
+        Quote.new(client, quote_json)
+      end
+    end
+  end
+end

data/lib/theone/version.rb

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

data/lib/theone.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require_relative "theone/version"
+require_relative "theone/client"
+require_relative "theone/quote"
+require_relative "theone/movie"
+
+module Theone
+  # Main SDK entry point
+  class Sdk
+    attr_reader :client
+
+    def initialize(options)
+      @client = Client.new(options)
+    end
+
+    def movies
+      Movie.all(client)
+    end
+
+    def movie(id)
+      Movie.one(client, id)
+    end
+
+    def quotes
+      Quote.all(client)
+    end
+
+    def quote(id)
+      Quote.one(client, id)
+    end
+  end
+end

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification
+name: juggy-theone-sdk
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Julien Guimont
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-04-26 00:00:00.000000000 Z
+dependencies: []
+description: https://the-one-api.dev/documentation
+email:
+- julien.guimont@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- design.md
+- juggy-theone-sdk.gemspec
+- lib/.DS_Store
+- lib/theone.rb
+- lib/theone/.DS_Store
+- lib/theone/base.rb
+- lib/theone/client.rb
+- lib/theone/movie.rb
+- lib/theone/paginator.rb
+- lib/theone/quote.rb
+- lib/theone/version.rb
+homepage: http://github.com/juggy/juggy-theone-sdk
+licenses:
+- MIT
+metadata:
+  homepage_uri: http://github.com/juggy/juggy-theone-sdk
+  source_code_uri: http://github.com/juggy/juggy-theone-sdk
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key:
+specification_version: 4
+summary: SDK implementation for The One API
+test_files: []