the_one_api 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eab63a106b4736953d1eaf773cfef554b7fe9a83984a7cd41596451e31c01834
-  data.tar.gz: 6be4a461d074122e439f9a6bb08cdb3018917d81c0a717d43239610e9b58d7d8
+  metadata.gz: a1f9c32daa2104160e59593e3854d4e33cb0b6401f0e1600c97625a4166fcabe
+  data.tar.gz: 105c1e4ea840549ea4434e479d9d740331a845668a707e459e3936d749d6d5fa
 SHA512:
-  metadata.gz: fade730fc33c878c40b9d1fad97f63385d64217ddfd7fb3a0902288476638b1cbae460e253d8fb8977d7761bbae069edf8799ee46285281561f28987eb23dbec
-  data.tar.gz: 7ce96e59be310e63a6c70f04e44ec11f26ef04c61aba60ef3d8e61728b127359387e0d404fd942dcf501a0c1bf65567d5ae2d30522d393d3d93b27d10f0dd126
+  metadata.gz: 54d754600927c9a5b3a470c0f7b09f22d0e9df490317a20c9fa4bd35cc15387146e776b3f91e54d826a28ce7566de8584fcd09545eba110551373f9ef0eb11c1
+  data.tar.gz: f981d550128609b811e385ead09d58f2820369bb680d19cdaf82f42612d9cb9f7165b57f024f7ee2dece0cf76b9ddc206a72f6d70450c7a6bc97554ace02cd9f

data/README.md

@@ -4,22 +4,20 @@ This is a Ruby gem that provides an SDK for interacting with [The One API](https
 
 ## Installation
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
-
 You don't need this source code unless you want to modify the gem. If you just want to use the package, just run:
 
-    $ gem install UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+    $ gem install the_one_api
 
 
 If you want to build the gem from source:
 
-    $ gem build UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+    $ gem build the_one_api
 
 ### Installing with Bundler
 
 Install the gem and add to the application's Gemfile by executing:
 
-    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+    $ bundle add the_one_api
 
 ### Requirements
 
@@ -60,6 +58,19 @@ movie.runtime_in_minutes
 
 ```
 
+Query nested API resources (e.g. `/movie/{id}/quotes`) through method on the client named for the kind of entity you want to retrieve chained with a method using the `list_for_` naming convetion:
+
+```ruby
+require 'the_one_api'
+
+client = TheOneApi::Client.new("your-API-key")
+
+quotes = client.quote.list_for_movie("5cd95395de30eff6ebccde5b")
+quotes.size
+#=> 1000
+```
+
+
 ### Errors
 
 The client will raise `TheOneApi::HttpResponseError` when a request returns a bad status code:
@@ -80,15 +91,20 @@ end
 
 ## Supported API Features
 
-### Currently Supported Root Level Endpoints/Operations
+### Currently Supported Endpoints/Operations
 
-+ `/movie` - list all movies, find a movie by id
+| Endpoint            | SDK Entry Point                                | Operation                               |
+| ------------------- | ---------------------------------------------- | --------------------------------------- |
+| `/movie`            | `TheOneApi::Client.movie.list`                 | list all movies                         |
+| `/movie/{id}`       | `TheOneApi::Client.movie.find({id})`           | find a movie by id                      |
+| `/movie/{id}/quote` | `TheOneApi::Client.quote.list_for_movie({id})` | list all quotes from a particular movie |
+| `/quote`            | `TheOneApi::Client.quote.list`                 | list all quotes                         |
+| `/quote/{id}`       | `TheOneApi::Client.quote.find({id}`            | find a quote by id                      |
 
 ### Currently Unsupported Features
 
 The SDK currently does not explicitly support
-+ root level endpoints not listed above
-+ nested endpoints - e.g. `/movie/{id}/quote`
++ endpoints not listed above
 + Pagination, Sorting and Filtering as described [here](https://the-one-api.dev/documentation#5)
 
 However, you can supply custom query parameters as a hash to any of the named resource methods on `TheOneApi::Client`, for example:

data/lib/the_one_api/client.rb

@@ -2,6 +2,7 @@
 
 require "the_one_api/resource_wrapper"
 require "the_one_api/resources/movie"
+require "the_one_api/resources/quote"
 
 module TheOneApi
   # A client for The One Api
@@ -20,5 +21,9 @@ module TheOneApi
     def movie
       @movie ||= ResourceWrapper.new(Movie, @api_key)
     end
+
+    def quote
+      @quote ||= ResourceWrapper.new(Quote, @api_key)
+    end
   end
 end

data/lib/the_one_api/resources/base_resource.rb

@@ -6,21 +6,24 @@ module TheOneApi
   # Helper class to implement and wire in the response
   # transformations needed by BaseResource (see below)
   class BaseResourceProxy < Flexirest::ProxyBase
-    # if this is a GET request to a single, non-nested resource by id
-    get(+"\\/[^\\/]+\\/[^\\/]+\\z") do
-      response = passthrough
-      translate(response) do |body|
-        # give back the entity instead of an array of one entity
-        body["docs"] && body["docs"][0] ? body["docs"][0] : body
-      end
-    end
-    # if this is a GET request to a root-level resource
-    get(+"\\/[^\\/]+\\z") do
-      response = passthrough
-      translate(response) do |body|
-        # give back the array of returned entities instead of the envelope
-        # structure that surrounds it
-        body["docs"] || body
+    get(+".+") do
+      if @request.method[:method] == :get
+        # if this is a GET request to list multiple items
+        if @request.method[:name].match? "list"
+          response = passthrough
+          translate(response) do |body|
+            # give back the array of returned entities instead of the envelope
+            # structure that surrounds it
+            body["docs"] || body
+          end
+        # if this is a GET request to a single resource by id
+        elsif @request.method[:name].match? "find"
+          response = passthrough
+          translate(response) do |body|
+            # give back the entity instead of an array of one entity
+            body["docs"] && body["docs"][0] ? body["docs"][0] : body
+          end
+        end
       end
     end
   end
@@ -28,7 +31,7 @@ module TheOneApi
   # Common functionality for all API resources, including:
   #   + Adding authentication header
   #   + Unwrapping the `docs` array
-  #       when listing all entities from a resource
+  #       when listing multiple items from a resource
   #   + Unwrapping the one item returned in the `docs` array
   #       when requesting a single entity by id
   class BaseResource < Flexirest::Base

data/lib/the_one_api/resources/movie.rb

@@ -5,8 +5,6 @@ require "the_one_api/resources/base_resource"
 module TheOneApi
   # Resource definition for Movies
   class Movie < BaseResource
-    before_request :add_authentication_header
-
     get :list, "/movie", rubify_names: true
     get :find, "/movie/:id", rubify_names: true
   end

data/lib/the_one_api/resources/quote.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "the_one_api/resources/base_resource"
+
+module TheOneApi
+  # Resource definition for Quotes
+  class Quote < BaseResource
+    get :list, "/quote", rubify_names: true
+    get :find, "/quote/:id", rubify_names: true
+    get :list_for_movie, "/movie/:id/quote", rubify_names: true
+  end
+end

data/lib/the_one_api/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: the_one_api
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Joshua Samberg
@@ -114,6 +114,7 @@ files:
 - lib/the_one_api/resource_wrapper.rb
 - lib/the_one_api/resources/base_resource.rb
 - lib/the_one_api/resources/movie.rb
+- lib/the_one_api/resources/quote.rb
 - lib/the_one_api/version.rb
 homepage: https://github.com/iceberg901/joshua-samberg-sdk
 licenses:
@@ -134,7 +135,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.4.14
 signing_key:
 specification_version: 4
 summary: An Ruby gem providing an SDK for interacting with The One API