michael_taylor_sdk 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: '03613032665901e43dc7312cdda7a49d87b9f83b64b7dfcdbdf770f4bfcc738c'
+  data.tar.gz: c38a19752db68e459cf04cc60e1ce40a0799f8728e4d2a8d9489544bcdbcb08b
+SHA512:
+  metadata.gz: eb0ff8e3afeba6adbda9fe7384dc84f46609d9787e69b7680e486b0dd16c2e44d7b6a124e1aae4f2cf8769275fb06e4a5531a1fcf6d97fed29c7583e338385dc
+  data.tar.gz: b36786f16696fe52fbc8497792efd5b4cd0da946f205f6d8b5268ef5448416685042a5e2a089117a6d340bd2de7790881c7668cdda842263a26a52d40f5fc9bb

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,37 @@
+AllCops:
+  TargetRubyVersion: 3.0
+  NewCops: enable
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Style/TrailingCommaInHashLiteral:
+  Enabled: true
+  EnforcedStyleForMultiline: comma
+
+Style/TrailingCommaInArrayLiteral:
+  Enabled: true
+  EnforcedStyleForMultiline: comma
+
+Layout/LineLength:
+  Max: 120
+
+Metrics/AbcSize:
+  Exclude:
+    - spec/**/*.rb
+
+Metrics/BlockLength:
+  Exclude:
+    - spec/**/*.rb
+
+Metrics/MethodLength:
+  Exclude:
+    - spec/**/*.rb

data/.ruby-version

@@ -0,0 +1 @@
+3.2.1

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,57 @@
+PATH
+  remote: .
+  specs:
+    michael_taylor_sdk (1.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    diff-lcs (1.5.0)
+    json (2.6.3)
+    parallel (1.22.1)
+    parser (3.2.1.1)
+      ast (~> 2.4.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.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (1.48.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.26.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.27.0)
+      parser (>= 3.2.1.0)
+    ruby-progressbar (1.13.0)
+    unicode-display_width (2.4.2)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  michael_taylor_sdk!
+  rake (~> 13.0)
+  rspec (~> 3.12)
+  rubocop (~> 1.48)
+
+BUNDLED WITH
+   2.4.6

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Michael Taylor
+
+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,61 @@
+# MichaelTaylorSdk
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add michael_taylor_sdk
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install michael_taylor_sdk
+
+## Usage
+
+An access key is required to use this SDK. Visit [The One API sign up](https://the-one-api.dev/sign-up) to get one.
+
+Start using the SDK by passing the access key to get an instance of the SDK.
+
+    lotr_sdk = MichaelTaylorSdk::LordOfTheRings.new("YOUR_ACCESS_KEY")
+
+Access one type of data by calling the appropriate method on the SDK, such as `.movies` to get information about one or more movies.
+
+    lotr_sdk.movies.list # Get all movies
+    lotr_sdk.movies.get("#{movie_id}") # Get one movie by ID
+
+The SDK behavior can be changed with modifier methods. These can be chained.
+
+    # Return at most 10 results
+    lotr_sdk.paginated(limit: 10).movies.list
+
+    # Try to make the call up to 3 times
+    exponential_backoff = MichaelTaylorSdk::RetryStrategy::ExponentialBackoff.new(3)
+    lotr_sdk.with_retry_strategy(exponential_backoff).movies.list
+    
+    # Both modifiers active
+    lotr_sdk.paginated(limit: 10).with_retry_strategy(exponential_backoff).movies.list
+
+    # Use modifiers more than once
+    lotr_sdk.paginated(limit: 10).with_retry_strategy(exponential_backoff) do |modified_sdk|
+        modified_sdk.movies.list
+        modified_sdk.movies.get("#{movie_id}")
+    end
+
+Quotes from a movie can be queried by movie ID or name
+
+    lotr_sdk.movies.quotes_from_movie("#{movie_id}")
+    lotr_sdk.movies.quotes_from_movie_name("#{movie_name}")
+
+## 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/mwtaylor/michael_taylor_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/lib/michael_taylor_sdk/api_paths/all_paths.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "michael_taylor_sdk/api_paths/movies"
+
+module MichaelTaylorSdk::ApiPaths
+  ##
+  # Mixin to add all available API paths to the parent object
+  module AllPaths
+    ##
+    # Provides queries related to movies
+    def movies
+      MichaelTaylorSdk::ApiPaths::Movies.new(@pipeline)
+    end
+  end
+end

data/lib/michael_taylor_sdk/api_paths/base.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+require "michael_taylor_sdk/pipeline/pipeline_modifiers"
+
+module MichaelTaylorSdk::ApiPaths
+  ##
+  # Provides common methods for all API paths
+  class Base
+    include MichaelTaylorSdk::Pipeline::PipelineModifiers
+
+    attr_reader :pipeline
+
+    def initialize(pipeline)
+      @pipeline = pipeline
+      @pipeline = replace_existing_stage(
+        @pipeline,
+        :set_path,
+        ->(next_stage) { MichaelTaylorSdk::Pipeline::SetPath.new(next_stage, path) }
+      )
+    end
+
+    ##
+    # List all items
+    def list
+      execute_pipeline(@pipeline, {})
+    end
+
+    def get(id)
+      with_path(@pipeline, id_path(id)) do |pipeline|
+        execute_pipeline(pipeline, {})
+      end
+    end
+
+    protected
+
+    def id_path(id)
+      "#{path}/#{id}"
+    end
+
+    def execute_pipeline(pipeline_initializer, input)
+      pipeline = pipeline_initializer.call
+      stage_initializers = pipeline[:stages].map { |stage_key| pipeline[stage_key] }
+      next_stage = initialize_pipeline_stages(stage_initializers)
+      next_stage.execute_http_request(input)
+      next_stage.result_hash
+    end
+
+    def initialize_pipeline_stages(stage_initializers)
+      next_stage = nil
+      stage_initializers.reverse.each do |stage_initializer|
+        next_stage = if next_stage.nil?
+                       stage_initializer.call
+                     else
+                       stage_initializer.call(next_stage)
+                     end
+      end
+      next_stage
+    end
+  end
+end

data/lib/michael_taylor_sdk/api_paths/movies.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require_relative("base")
+
+require "michael_taylor_sdk/pipeline/set_path"
+require "michael_taylor_sdk/constants"
+
+module MichaelTaylorSdk::ApiPaths
+  ##
+  # Queries related to /movie
+  class Movies < Base
+    include MichaelTaylorSdk::Constants
+
+    ##
+    # Find all quotes for a given movie
+    def quotes_from_movie(id)
+      with_path(@pipeline, quote_path(id)) do |pipeline|
+        execute_pipeline(pipeline, {})
+      end
+    end
+
+    ##
+    # Lookup a movie by name and get all quotes from it
+    def quotes_from_movie_name(name)
+      movies = with_filters(@pipeline, ["name=#{name}"]) do |filtered_pipeline|
+        with_pagination(filtered_pipeline, limit: 1) do |paginated_pipeline|
+          execute_pipeline(paginated_pipeline, {})
+        end
+      end
+      matching_movie = movies[:items][0]
+      quotes_from_movie(matching_movie[:_id])
+    end
+
+    protected
+
+    def path
+      MOVIE_PATH
+    end
+
+    def quote_path(id)
+      "#{MOVIE_PATH}/#{id}/#{QUOTE_PATH}"
+    end
+  end
+end

data/lib/michael_taylor_sdk/constants.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module MichaelTaylorSdk
+  module Constants
+    MOVIE_PATH = "movie"
+    QUOTE_PATH = "quote"
+
+    EXPONENTIAL_BACKOFF_TIME_DIVISOR = 20
+  end
+end

data/lib/michael_taylor_sdk/errors.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module MichaelTaylorSdk::Errors
+  ##
+  # Errors related to HTTP response codes
+  class HttpError < StandardError
+    def initialize(message_prefix, response)
+      super("(#{message_prefix}) #{response.code}: #{response.message}")
+    end
+  end
+
+  ##
+  # Errors in the HTTP 5XX range
+  class ServerError < HttpError
+    def initialize(response)
+      super("Server Error", response)
+    end
+  end
+
+  ##
+  # Errors in the HTTP 4XX range
+  class ClientError < HttpError
+    def initialize(response)
+      super("Client Error", response)
+    end
+  end
+
+  ##
+  # Errors related to processing the returned content
+  class ContentError < StandardError
+    def initialize(msg = nil)
+      super(msg)
+    end
+  end
+
+  ##
+  # Error caused by a JSON parser error
+  class JsonParseError < ContentError
+  end
+
+  ##
+  # Error caused by no content being returned by the server
+  class NoContentError < ContentError
+  end
+end

data/lib/michael_taylor_sdk/modified_sdk.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require "michael_taylor_sdk/api_paths/all_paths"
+require "michael_taylor_sdk/pipeline/pipeline_modifiers"
+
+module MichaelTaylorSdk
+  ##
+  # All modifiers that can modify the SDK behavior
+  module Modifiers
+    ##
+    # Replaces the default retry strategy
+    def with_retry_strategy(retry_strategy)
+      new_retry_stage = lambda { |next_stage|
+        MichaelTaylorSdk::Pipeline::Retry.new(next_stage, retry_strategy)
+      }
+      new_pipeline = replace_existing_stage(@pipeline, :retry, new_retry_stage)
+      modified_sdk = MichaelTaylorSdk::ModifiedSdk.new(new_pipeline)
+      if block_given?
+        yield(modified_sdk)
+      else
+        modified_sdk
+      end
+    end
+
+    def paginated(limit: nil, page: nil, offset: nil)
+      with_pagination(@pipeline, limit: limit, page: page, offset: offset) do |paginated_pipeline|
+        modified_sdk = MichaelTaylorSdk::ModifiedSdk.new(paginated_pipeline)
+        if block_given?
+          yield(modified_sdk)
+        else
+          modified_sdk
+        end
+      end
+    end
+  end
+
+  ##
+  # An instance of the SDK with modified behavior
+  class ModifiedSdk
+    include Modifiers
+    include MichaelTaylorSdk::ApiPaths::AllPaths
+    include MichaelTaylorSdk::Pipeline::PipelineModifiers
+
+    def initialize(pipeline)
+      @pipeline = pipeline
+    end
+  end
+end

data/lib/michael_taylor_sdk/pipeline/filters.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module MichaelTaylorSdk::Pipeline
+  ##
+  # Pipeline stage that adds filters to list requests
+  class Filters
+    def initialize(next_pipeline_stage, filters)
+      @next_pipeline_stage = next_pipeline_stage
+      @filters = filters
+    end
+
+    def execute_http_request(request_details)
+      request_details[:query_parameters] = {} unless request_details.key?(:query_parameters)
+      @filters.each do |filter|
+        request_details[:query_parameters][filter] = nil
+      end
+
+      @next_pipeline_stage.execute_http_request(request_details)
+    end
+
+    def result_hash
+      @next_pipeline_stage.result_hash
+    end
+  end
+end

data/lib/michael_taylor_sdk/pipeline/get_request.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require "uri"
+require "net/http"
+
+module MichaelTaylorSdk::Pipeline
+  ##
+  # Final pipeline stage that sends an HTTP request to the server
+  class GetRequest
+    HEADER_AUTHORIZATION = "Authorization"
+    AUTHENTICATION_SCHEME_BEARER = "Bearer"
+
+    def initialize(base_url, authorization_token)
+      @base_url = base_url
+      @authorization_token = authorization_token
+    end
+
+    def execute_http_request(request_details)
+      request = Net::HTTP::Get.new(uri(request_details))
+      add_headers(request)
+
+      @response = Net::HTTP.start(request.uri.hostname, use_ssl: true) do |http|
+        http.request(request)
+      end
+    end
+
+    def http_response
+      @response
+    end
+
+    private
+
+    def query_string(request_details)
+      request_details[:query_parameters]
+        .map { |key, value| value.nil? ? key : "#{key}=#{value}" }
+        .join("&")
+    end
+
+    def uri(request_details)
+      uri = "#{@base_url}/#{request_details[:path]}"
+      if request_details.key?(:query_parameters) && !request_details[:query_parameters].empty?
+        uri += "?#{query_string(request_details)}"
+      end
+      URI(uri)
+    end
+
+    def add_headers(request)
+      request[HEADER_AUTHORIZATION] = "#{AUTHENTICATION_SCHEME_BEARER} #{@authorization_token}"
+    end
+  end
+end

data/lib/michael_taylor_sdk/pipeline/json.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require "json"
+
+module MichaelTaylorSdk::Pipeline
+  ##
+  # Pipeline stage to transform an HTTP body to JSON
+  class Json
+    def initialize(next_pipeline_stage)
+      @next_pipeline_stage = next_pipeline_stage
+    end
+
+    def execute_http_request(request_details)
+      @result = @next_pipeline_stage.execute_http_request(request_details)
+    end
+
+    def result_hash
+      JSON.parse(@next_pipeline_stage.http_body, symbolize_names: true)
+    rescue JSON::ParserError => e
+      raise MichaelTaylorSdk::Errors::JsonParseError, "JSON response could not be parsed: #{e.message}"
+    end
+  end
+end

data/lib/michael_taylor_sdk/pipeline/paginate.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module MichaelTaylorSdk::Pipeline
+  ##
+  # Pipeline stage that adds pagination parameters and adds pagination details into response
+  class Paginate
+    def initialize(next_pipeline_stage, limit: nil, page: nil, offset: nil)
+      @next_pipeline_stage = next_pipeline_stage
+      @limit = limit
+      @page = page
+      @offset = offset
+    end
+
+    def execute_http_request(request_details)
+      request_details[:query_parameters] = {} unless request_details.key?(:query_parameters)
+      request_details[:query_parameters]["limit"] = @limit unless @limit.nil?
+      request_details[:query_parameters]["page"] = @page unless @page.nil?
+      request_details[:query_parameters]["offset"] = @offset unless @offset.nil?
+
+      @next_pipeline_stage.execute_http_request(request_details)
+    end
+
+    def result_hash
+      next_result = @next_pipeline_stage.result_hash
+
+      {
+        items: next_result[:docs],
+        pagination: next_result.slice(:total, :limit, :offset, :page, :pages),
+      }
+    end
+  end
+end

data/lib/michael_taylor_sdk/pipeline/pipeline_modifiers.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module MichaelTaylorSdk::Pipeline
+  ##
+  # Common methods to work with pipelines
+  module PipelineModifiers
+    ##
+    # Replace a stage in a pipeline with a modified version with different parameters
+    def replace_existing_stage(pipeline, next_stage_key, next_stage_lambda)
+      lambda {
+        modified_pipeline = pipeline.call
+        modified_pipeline[next_stage_key] = next_stage_lambda
+        modified_pipeline
+      }
+    end
+
+    def with_path(pipeline, path)
+      yield replace_existing_stage(
+        pipeline,
+        :set_path,
+        ->(next_stage) { MichaelTaylorSdk::Pipeline::SetPath.new(next_stage, path) }
+      )
+    end
+
+    def with_filters(pipeline, filters)
+      yield replace_existing_stage(
+        pipeline,
+        :filter,
+        ->(next_stage) { MichaelTaylorSdk::Pipeline::Filters.new(next_stage, filters) }
+      )
+    end
+
+    def with_pagination(pipeline, limit: nil, page: nil, offset: nil)
+      new_paginate_stage = lambda { |next_stage|
+        MichaelTaylorSdk::Pipeline::Paginate.new(next_stage, limit: limit, page: page, offset: offset)
+      }
+      yield replace_existing_stage(pipeline, :paginate, new_paginate_stage)
+    end
+  end
+end

data/lib/michael_taylor_sdk/pipeline/raise_http_errors.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require "michael_taylor_sdk/errors"
+
+module MichaelTaylorSdk::Pipeline
+  ##
+  # Pipeline stage that raises errors when the HTTP response is a 4xx or 5xx error
+  class RaiseHttpErrors
+    def initialize(next_pipeline_stage)
+      @next_pipeline_stage = next_pipeline_stage
+    end
+
+    def execute_http_request(request_details)
+      response = @next_pipeline_stage.execute_http_request(request_details)
+      if response.is_a? Net::HTTPServerError
+        raise MichaelTaylorSdk::Errors::ServerError, response
+      elsif response.is_a? Net::HTTPClientError
+        raise MichaelTaylorSdk::Errors::ClientError, response
+      end
+    end
+
+    def http_response
+      @next_pipeline_stage.http_response
+    end
+  end
+end

data/lib/michael_taylor_sdk/pipeline/response_body.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module MichaelTaylorSdk::Pipeline
+  ##
+  # Pipeline stage to get body content from HTTP response
+  class ResponseBody
+    def initialize(next_pipeline_stage)
+      @next_pipeline_stage = next_pipeline_stage
+    end
+
+    def execute_http_request(request_details)
+      @next_pipeline_stage.execute_http_request(request_details)
+    end
+
+    def http_body
+      body = @next_pipeline_stage.http_response.body
+      raise MichaelTaylorSdk::Errors::NoContentError, "Server response was empty" if body.empty?
+
+      body
+    end
+  end
+end

data/lib/michael_taylor_sdk/pipeline/retry.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require "michael_taylor_sdk/retry_strategy/one_try"
+
+module MichaelTaylorSdk::Pipeline
+  ## Pipeline stage to run a given retry strategy
+  class Retry
+    def initialize(next_pipeline_stage, retry_strategy)
+      @next_pipeline_stage = next_pipeline_stage
+      @retry_strategy = retry_strategy
+    end
+
+    def execute_http_request(request_details)
+      @retry_strategy.run(-> { @next_pipeline_stage.execute_http_request(request_details) })
+    end
+
+    def http_response
+      @next_pipeline_stage.http_response
+    end
+  end
+end

data/lib/michael_taylor_sdk/pipeline/set_path.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module MichaelTaylorSdk::Pipeline
+  ##
+  # Pipeline stage to set the path into the HTTP request
+  class SetPath
+    def initialize(next_pipeline_stage, path)
+      @next_pipeline_stage = next_pipeline_stage
+      @path = path
+    end
+
+    def execute_http_request(request_details)
+      request_details[:path] = @path
+
+      @next_pipeline_stage.execute_http_request(request_details)
+    end
+
+    def http_response
+      @next_pipeline_stage.http_response
+    end
+  end
+end

data/lib/michael_taylor_sdk/retry_strategy/exponential_backoff.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require "michael_taylor_sdk/constants"
+
+module MichaelTaylorSdk::RetryStrategy
+  ##
+  # Retry strategy for exponential backoffs
+  #
+  # This will rerun an HTTP call up to max_tries times. Each retry will be delayed.
+  # The delay will have an exponential backoff that makes each delay about twice as long as the previous delay.
+  # The delay will also have a random jitter added to avoid overloading the server from many clients
+  # retrying simultaneously.
+  class ExponentialBackoff
+    include MichaelTaylorSdk::Constants
+
+    def initialize(max_tries)
+      @max_tries = max_tries
+    end
+
+    def run(do_request)
+      tries = 0
+      begin
+        tries += 1
+        do_request.call
+      rescue MichaelTaylorSdk::Errors::ServerError
+        raise if tries == @max_tries
+
+        jittered_sleep(tries)
+
+        retry
+      end
+    end
+
+    private
+
+    def jittered_sleep(tries)
+      max_sleep_seconds = Float(2**tries) / EXPONENTIAL_BACKOFF_TIME_DIVISOR
+      sleep(rand((0.5 * max_sleep_seconds)..max_sleep_seconds))
+    end
+  end
+end

data/lib/michael_taylor_sdk/retry_strategy/one_try.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module MichaelTaylorSdk::RetryStrategy
+  ##
+  # The default retry strategy that just runs a request once and passes along any errors
+  class OneTry
+    def run(do_request)
+      do_request.call
+    end
+  end
+end

data/lib/michael_taylor_sdk/version.rb

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

data/lib/michael_taylor_sdk.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require "michael_taylor_sdk/version"
+
+require "michael_taylor_sdk/pipeline/pipeline_modifiers"
+require "michael_taylor_sdk/pipeline/paginate"
+require "michael_taylor_sdk/pipeline/filters"
+require "michael_taylor_sdk/pipeline/json"
+require "michael_taylor_sdk/pipeline/response_body"
+require "michael_taylor_sdk/pipeline/retry"
+require "michael_taylor_sdk/pipeline/raise_http_errors"
+require "michael_taylor_sdk/pipeline/get_request"
+require "michael_taylor_sdk/api_paths/all_paths"
+require "michael_taylor_sdk/modified_sdk"
+require "michael_taylor_sdk/constants"
+
+module MichaelTaylorSdk
+  ##
+  # Entry point into the SDK
+  class LordOfTheRings
+    include MichaelTaylorSdk::Pipeline::PipelineModifiers
+    include MichaelTaylorSdk::ApiPaths::AllPaths
+    include MichaelTaylorSdk::Modifiers
+
+    DEFAULT_BASE_URL = "https://the-one-api.dev/v2"
+
+    # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
+    def initialize(
+      access_token,
+      base_url: DEFAULT_BASE_URL,
+      default_retry_strategy: MichaelTaylorSdk::RetryStrategy::OneTry.new
+    )
+
+      raise "Access token must be given as a string" unless access_token.is_a? String
+
+      @default_pipeline = lambda {
+        {
+          paginate: ->(next_stage) { MichaelTaylorSdk::Pipeline::Paginate.new(next_stage) },
+          filter: ->(next_stage) { MichaelTaylorSdk::Pipeline::Filters.new(next_stage, []) },
+          json: ->(next_stage) { MichaelTaylorSdk::Pipeline::Json.new(next_stage) },
+          response_body: ->(next_stage) { MichaelTaylorSdk::Pipeline::ResponseBody.new(next_stage) },
+          set_path: ->(next_stage) {},
+          retry: ->(next_stage) { MichaelTaylorSdk::Pipeline::Retry.new(next_stage, default_retry_strategy) },
+          raise_http_errors: ->(next_stage) { MichaelTaylorSdk::Pipeline::RaiseHttpErrors.new(next_stage) },
+          get_request: -> { MichaelTaylorSdk::Pipeline::GetRequest.new(base_url, access_token) },
+          stages: %i[paginate filter json response_body set_path retry raise_http_errors get_request],
+        }
+      }
+
+      @pipeline = @default_pipeline
+    end
+    # rubocop:enable Metrics/MethodLength, Metrics/AbcSize
+  end
+end

data/michael_taylor_sdk.gemspec

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require_relative "lib/michael_taylor_sdk/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "michael_taylor_sdk"
+  spec.version = MichaelTaylorSdk::VERSION
+  spec.authors = ["Michael Taylor"]
+  spec.email = ["mwtaylor@users.noreply.github.com"]
+
+  spec.summary = "SDK for the Lord of the Rings API"
+  spec.homepage = "https://github.com/mwtaylor/MichaelTaylor-SDK"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 3.0.0"
+
+  spec.metadata["rubygems_mfa_required"] = "true"
+  spec.metadata["github_repo"] = "https://github.com/mwtaylor/MichaelTaylor-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|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/sig/michael_taylor_sdk.rbs

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

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification
+name: michael_taylor_sdk
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Michael Taylor
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2023-03-15 00:00:00.000000000 Z
+dependencies: []
+description: 
+email:
+- mwtaylor@users.noreply.github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/michael_taylor_sdk.rb
+- lib/michael_taylor_sdk/api_paths/all_paths.rb
+- lib/michael_taylor_sdk/api_paths/base.rb
+- lib/michael_taylor_sdk/api_paths/movies.rb
+- lib/michael_taylor_sdk/constants.rb
+- lib/michael_taylor_sdk/errors.rb
+- lib/michael_taylor_sdk/modified_sdk.rb
+- lib/michael_taylor_sdk/pipeline/filters.rb
+- lib/michael_taylor_sdk/pipeline/get_request.rb
+- lib/michael_taylor_sdk/pipeline/json.rb
+- lib/michael_taylor_sdk/pipeline/paginate.rb
+- lib/michael_taylor_sdk/pipeline/pipeline_modifiers.rb
+- lib/michael_taylor_sdk/pipeline/raise_http_errors.rb
+- lib/michael_taylor_sdk/pipeline/response_body.rb
+- lib/michael_taylor_sdk/pipeline/retry.rb
+- lib/michael_taylor_sdk/pipeline/set_path.rb
+- lib/michael_taylor_sdk/retry_strategy/exponential_backoff.rb
+- lib/michael_taylor_sdk/retry_strategy/one_try.rb
+- lib/michael_taylor_sdk/version.rb
+- michael_taylor_sdk.gemspec
+- sig/michael_taylor_sdk.rbs
+homepage: https://github.com/mwtaylor/MichaelTaylor-SDK
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+  github_repo: https://github.com/mwtaylor/MichaelTaylor-SDK
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.6
+signing_key: 
+specification_version: 4
+summary: SDK for the Lord of the Rings API
+test_files: []