michael_taylor_sdk 1.0.1 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '03613032665901e43dc7312cdda7a49d87b9f83b64b7dfcdbdf770f4bfcc738c'
-  data.tar.gz: c38a19752db68e459cf04cc60e1ce40a0799f8728e4d2a8d9489544bcdbcb08b
+  metadata.gz: e8b30e7ccf6f6bcc18a63d8b787177de07471fd211875f9eb6ef70ededcda393
+  data.tar.gz: '08e0c2cd9ca02dfe355a4f65badd24e9a634fbe8f0ca699d21d3abe978293836'
 SHA512:
-  metadata.gz: eb0ff8e3afeba6adbda9fe7384dc84f46609d9787e69b7680e486b0dd16c2e44d7b6a124e1aae4f2cf8769275fb06e4a5531a1fcf6d97fed29c7583e338385dc
-  data.tar.gz: b36786f16696fe52fbc8497792efd5b4cd0da946f205f6d8b5268ef5448416685042a5e2a089117a6d340bd2de7790881c7668cdda842263a26a52d40f5fc9bb
+  metadata.gz: d39d2fde766489ddd234a1d2109a0584aa6f57cd4b283e70dcd93e69ead8902e777dfd436888262a74eb533f0f9a2d48e37ea06d0c215fa46cc8fec3476387f7
+  data.tar.gz: a517a4361b6b0cd34b69763acfaba649570696d63dbaddf2ddce08b60ea7f31e09b7179256b50316473aad61ba2655ce9af4c5da5ccf526a6567bfd9346f1a8b

data/.rubocop.yml

@@ -1,3 +1,7 @@
+plugins:
+  - rubocop-rspec
+  - rubocop-rake
+
 AllCops:
   TargetRubyVersion: 3.0
   NewCops: enable
@@ -35,3 +39,9 @@ Metrics/BlockLength:
 Metrics/MethodLength:
   Exclude:
     - spec/**/*.rb
+
+RSpec/ExampleLength:
+  Enabled: false
+
+RSpec/MultipleExpectations:
+  Enabled: false

data/.ruby-version

@@ -1 +1 @@
-3.2.1
+3.4.2

data/Gemfile

@@ -2,11 +2,16 @@
 
 source "https://rubygems.org"
 
-# Specify your gem's dependencies in michael_taylor_sdk.gemspec
 gemspec
 
-gem "rake", "~> 13.0"
+group :test, :development do
+  gem "rake", "~> 13.2"
 
-gem "rspec", "~> 3.12"
+  gem "rspec", "~> 3.13"
 
-gem "rubocop", "~> 1.48"
+  gem "rubocop", "~> 1.72"
+
+  gem "rubocop-rake", "~> 0.7.1"
+
+  gem "rubocop-rspec", "~> 3.5"
+end

data/Gemfile.lock

@@ -1,57 +1,71 @@
 PATH
   remote: .
   specs:
-    michael_taylor_sdk (1.0.0)
+    michael_taylor_sdk (1.0.3)
 
 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)
+    diff-lcs (1.6.0)
+    json (2.10.1)
+    language_server-protocol (3.17.0.4)
+    lint_roller (1.1.0)
+    parallel (1.26.3)
+    parser (3.3.7.1)
       ast (~> 2.4.1)
+      racc
+    racc (1.8.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)
+    rake (13.2.1)
+    regexp_parser (2.10.0)
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.3)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.3)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.12.0)
-    rspec-mocks (3.12.4)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.12.0)
-    rspec-support (3.12.0)
-    rubocop (1.48.1)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.2)
+    rubocop (1.72.2)
       json (~> 2.3)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.1.0)
       parallel (~> 1.10)
-      parser (>= 3.2.0.0)
+      parser (>= 3.3.0.2)
       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)
+      regexp_parser (>= 2.9.3, < 3.0)
+      rubocop-ast (>= 1.38.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)
+      unicode-display_width (>= 2.4.0, < 4.0)
+    rubocop-ast (1.38.0)
+      parser (>= 3.3.1.0)
+    rubocop-rake (0.7.1)
+      lint_roller (~> 1.1)
+      rubocop (>= 1.72.1)
+    rubocop-rspec (3.5.0)
+      lint_roller (~> 1.1)
+      rubocop (~> 1.72, >= 1.72.1)
     ruby-progressbar (1.13.0)
-    unicode-display_width (2.4.2)
+    unicode-display_width (3.1.4)
+      unicode-emoji (~> 4.0, >= 4.0.4)
+    unicode-emoji (4.0.4)
 
 PLATFORMS
   x86_64-linux
 
 DEPENDENCIES
   michael_taylor_sdk!
-  rake (~> 13.0)
-  rspec (~> 3.12)
-  rubocop (~> 1.48)
+  rake (~> 13.2)
+  rspec (~> 3.13)
+  rubocop (~> 1.72)
+  rubocop-rake (~> 0.7.1)
+  rubocop-rspec (~> 3.5)
 
 BUNDLED WITH
    2.4.6

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2023 Michael Taylor
+Copyright (c) 2025 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

data/design.md

@@ -0,0 +1,18 @@
+This SDK is designed around a pipeline that transforms an SDK method call
+into an HTTP request and transforms the response into an easy to use result.
+Each pipeline stage is defined under the pipeline directory.
+
+Each pipeline stage is designed to have a simple transformation on the input and/or output.
+ * paginate add pagination parameters to the input and adds the returned pagination properties into the output
+ * filter adds query parameters to the input for queries like name=Movie Name
+ * json converts the output from a string to a Ruby Hash by parsing the string as JSON
+ * response_body pulls the body from the HTTP response and ensures it is present and not empty
+ * set_path adds the path information that will later be appended to the base URL
+ * retry runs a retry strategy to attempt to resolve server errors
+ * raise_http_errors converts the HTTP response classes into errors for 4XX and 5XX response codes
+ * get_request is the final stage that makes the HTTP request
+
+The main SDK object has methods that provide access to the API paths. These are defined under the api_paths directory.
+Currently there is just `.movies` but it could be expanded to include other paths like `.books` or `.characters`
+by adding new subclasses of MichaelTaylorSdk::ApiPaths::Base. These subclasses only need to define the main path used
+in the API and any custom queries that abstract away complexity from the user by adding filters or combining related calls.

data/lib/michael_taylor_sdk/api_paths/movies.rb

@@ -27,6 +27,8 @@ module MichaelTaylorSdk::ApiPaths
           execute_pipeline(paginated_pipeline, {})
         end
       end
+      raise "Movie named #{name} not found" if movies[:items].empty?
+
       matching_movie = movies[:items][0]
       quotes_from_movie(matching_movie[:_id])
     end

data/lib/michael_taylor_sdk/errors.rb

@@ -29,7 +29,7 @@ module MichaelTaylorSdk::Errors
   # Errors related to processing the returned content
   class ContentError < StandardError
     def initialize(msg = nil)
-      super(msg)
+      super
     end
   end
 

data/lib/michael_taylor_sdk/version.rb

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

data/lib/michael_taylor_sdk.rb

@@ -30,7 +30,6 @@ module MichaelTaylorSdk
       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 {

data/michael_taylor_sdk.gemspec

@@ -26,10 +26,4 @@ Gem::Specification.new do |spec|
   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

metadata

@@ -1,16 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: michael_taylor_sdk
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.3
 platform: ruby
 authors:
 - Michael Taylor
-autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-03-15 00:00:00.000000000 Z
+date: 2025-02-21 00:00:00.000000000 Z
 dependencies: []
-description: 
 email:
 - mwtaylor@users.noreply.github.com
 executables: []
@@ -25,6 +23,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- design.md
 - lib/michael_taylor_sdk.rb
 - lib/michael_taylor_sdk/api_paths/all_paths.rb
 - lib/michael_taylor_sdk/api_paths/base.rb
@@ -52,7 +51,6 @@ licenses:
 metadata:
   rubygems_mfa_required: 'true'
   github_repo: https://github.com/mwtaylor/MichaelTaylor-SDK
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -67,8 +65,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.6
-signing_key: 
+rubygems_version: 3.6.2
 specification_version: 4
 summary: SDK for the Lord of the Rings API
 test_files: []