michael_taylor_sdk 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '03613032665901e43dc7312cdda7a49d87b9f83b64b7dfcdbdf770f4bfcc738c'
-  data.tar.gz: c38a19752db68e459cf04cc60e1ce40a0799f8728e4d2a8d9489544bcdbcb08b
+  metadata.gz: 79136525a44549f8e47452b9f228e88fd65e80926d9673519bba0b4a0e1d308a
+  data.tar.gz: 89c130376085c61cca9ca719b554b809cf6caad9fd38ce1e780ff0cc63f598cf
 SHA512:
-  metadata.gz: eb0ff8e3afeba6adbda9fe7384dc84f46609d9787e69b7680e486b0dd16c2e44d7b6a124e1aae4f2cf8769275fb06e4a5531a1fcf6d97fed29c7583e338385dc
-  data.tar.gz: b36786f16696fe52fbc8497792efd5b4cd0da946f205f6d8b5268ef5448416685042a5e2a089117a6d340bd2de7790881c7668cdda842263a26a52d40f5fc9bb
+  metadata.gz: d01ded32ecfc55cf562636a86d43d547a5963a5cc2c902bf81899566889b4e5236506d21bcbd46eef7606ae9ea3506ba91a393ebdaa0a38dd0e2ceda36d13f01
+  data.tar.gz: 6d77bde7627237ce80058576473ab0062f6bb9c52c197505c5a90da79de782ffe132572e558ef6c73876aa06c4a3f14bab912e79240d205c68801913e7246a3b

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    michael_taylor_sdk (1.0.0)
+    michael_taylor_sdk (1.0.1)
 
 GEM
   remote: https://rubygems.org/

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,7 @@ 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/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: michael_taylor_sdk
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Michael Taylor
@@ -25,6 +25,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