scorpio 0.6.3 → 0.6.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 82437b6c802e013a8b001d837d74fc53df3a79a036308402baa958473282e2da
-  data.tar.gz: 5d27bec750c90aba761158e41e8a3396af9bf08a0ca1bb03ad6fe5d88f12b139
+  metadata.gz: ad4505d3bd4e9dc299b95b21ce5305e7864200fb0481be3f2600f75c3476f73d
+  data.tar.gz: 613abb854fffaf49a45f8c9e19a0f150f0fef9b7500e50cf20dc2a6f58023347
 SHA512:
-  metadata.gz: 077caed57f2e2d38c46f7b56f17328f732929404ba1bed3a6bead041cb6449dabe61b32ca7c1fc6bc0b30eac9c8c1b0a58ebf47f9aa74ff852595243213b3b2e
-  data.tar.gz: d995f27814a468e9652de92b5b7e4579a3ca0626798be1cf56b155a5bb83dcbf38e60158c225ecc55c455672fb1d5efb4327615725da5745e1cd5ef26802399b
+  metadata.gz: 26cd883ee719f0e2683ac53c1be85d9296c90b92e80a799d938cf361c431ca486dd4e6a2db73539d7f133fa162fd104f85f4d9c9ec89b7f74e2187e8218b543b
+  data.tar.gz: 945afcb210c0b0ea8801393a3586b83045f82bcb94724021e3c69a6320ba32c23ddbeb6652644a6c3ea063830550f97e3001e661251662a8e6d976bc2cfdce62

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+# v0.6.4
+
+- JSI ~> v0.8.1
+- OpenAPI::Operation#each_link_page
+
 # v0.6.3
 
 - JSI = v0.8.0

data/README.md

@@ -172,11 +172,9 @@ pet_by_id = pet_store_doc.operations['getPetById'].run(petId: pet['id'])
 
 # unlike ResourceBase instances above, JSI instances have stricter
 # equality and the pets returned from different operations are not
-# equal, though the underlying JSON instance is.
+# equal, because they are in different JSON documents.
 pet_by_id == pet
 # => false
-pet_by_id.jsi_instance == pet.jsi_instance
-# => true
 
 # let's name the pet after ourself
 pet.name = ENV['USER']
@@ -210,7 +208,7 @@ A class which subclasses Scorpio::ResourceBase directly (such as PetStore::Resou
 
 A model representing a resource needs to be configured, minimally, with:
 
-- the OpenAPI document for the REST API
+- the OpenAPI document describing the API
 - the schemas that represent instances of the model, if any
 
 If the resource has HTTP operations associated with it (most, but not all resources will):

data/lib/scorpio/openapi/operation.rb

@@ -165,23 +165,62 @@ module Scorpio
       # instantiates a {Scorpio::Request} for this operation.
       # parameters are all passed to {Scorpio::Request#initialize}.
       # @return [Scorpio::Request]
-      def build_request(**config, &b)
+      def build_request(configuration = {}, &b)
         @request_class ||= Scorpio::Request.request_class_by_operation(self)
-        @request_class.new(**config, &b)
+        @request_class.new(configuration, &b)
       end
 
       # runs a {Scorpio::Request} for this operation, returning a {Scorpio::Ur}.
       # parameters are all passed to {Scorpio::Request#initialize}.
       # @return [Scorpio::Ur] response ur
-      def run_ur(**config, &b)
-        build_request(**config, &b).run_ur
+      def run_ur(configuration = {}, &b)
+        build_request(configuration, &b).run_ur
       end
 
       # runs a {Scorpio::Request} for this operation - see {Scorpio::Request#run}.
       # parameters are all passed to {Scorpio::Request#initialize}.
       # @return response body object
-      def run(**config, &b)
-        build_request(**config, &b).run
+      def run(configuration = {}, &b)
+        build_request(configuration, &b).run
+      end
+
+      # Runs this operation with the given request config, and yields the resulting {Scorpio::Ur}.
+      # If the response contains a `Link` header with a `next` link (and that link's URL
+      # corresponds to this operation), this operation is run again to that link's URL, that
+      # request's Ur yielded, and a `next` link in that response is followed.
+      # This repeats until a response does not contain a `Link` header with a `next` link.
+      #
+      # @param configuration (see Scorpio::Request#initialize)
+      # @yield [Scorpio::Ur]
+      # @return [Enumerator, nil]
+      def each_link_page(configuration = {}, &block)
+        init_request = build_request(configuration)
+        next_page = proc do |last_page_ur|
+          nextlinks = last_page_ur.response.links.select { |link| link.rel?('next') }
+          if nextlinks.size == 0
+            # no next link; we are at the end
+            nil
+          elsif nextlinks.size == 1
+            nextlink = nextlinks.first
+            # we do not use Addressable::URI#join as the paths should just be concatenated, not resolved.
+            # we use File.join just to deal with consecutive slashes.
+            template = Addressable::Template.new(File.join(init_request.base_url, path_template_str))
+            target_uri = nextlink.absolute_target_uri
+            path_params = template.extract(target_uri.merge(query: nil))
+            unless path_params
+              raise("the URI of the link to the next page did not match the URI of this operation")
+            end
+            query_params = target_uri.query_values
+            run_ur(
+              path_params: path_params,
+              query_params: query_params,
+            )
+          else
+            # TODO better error class / context / message
+            raise("response included multiple links with rel=next")
+          end
+        end
+        init_request.each_page_ur(next_page: next_page, &block)
       end
 
       private

data/lib/scorpio/openapi.rb

@@ -21,7 +21,7 @@ module Scorpio
     autoload :OperationsScope, 'scorpio/openapi/operations_scope'
 
     module V3
-      openapi_document_schema = JSI::JSONSchemaOrgDraft04.new_schema(::YAML.load_file(Scorpio.root.join(
+      openapi_document_schema = JSI::JSONSchemaDraft04.new_schema(::YAML.load_file(Scorpio.root.join(
         'documents/github.com/OAI/OpenAPI-Specification/blob/oas3-schema/schemas/v3.0/schema.yaml'
       )))
 

data/lib/scorpio/request.rb

@@ -149,7 +149,7 @@ module Scorpio
       # do the Configurables first
       configuration.each do |name, value|
         if Configurables.public_method_defined?("#{name}=")
-          Configurables.instance_method("#{name}=").bind_call(self, value)
+          Configurables.instance_method("#{name}=").bind(self).call(value)
           params_set << name
         end
       end
@@ -390,12 +390,17 @@ module Scorpio
       ur.response.body_object
     end
 
-    # todo make a proper iterator interface
+    # Runs this request, passing the resulting Ur to the given block.
+    # The `next_page` callable is then called with that Ur and results in the next page's Ur, or nil.
+    # This repeats until the `next_page` call results in nil.
+    #
+    # See {OpenAPI::Operation#each_link_page} for integration with an OpenAPI Operation.
+    #
     # @param next_page [#call] a callable which will take a parameter `page_ur`, which is a {Scorpio::Ur},
     #   and must result in an Ur representing the next page, which will be yielded to the block.
     # @yield [Scorpio::Ur] yields the first page, and each subsequent result of calls to `next_page` until
     #   that results in nil
-    # @return [void]
+    # @return [Enumerator, nil]
     def each_page_ur(next_page: , raise_on_http_error: true)
       return to_enum(__method__, next_page: next_page, raise_on_http_error: raise_on_http_error) unless block_given?
       page_ur = run_ur

data/lib/scorpio/resource_base.rb

@@ -211,7 +211,7 @@ module Scorpio
       end
 
       # @private
-      # @param name [Scorpio::OpenAPI::Operation]
+      # @param operation [Scorpio::OpenAPI::Operation]
       # @return [String, nil]
       def api_method_name_by_operation(operation)
         raise(ArgumentError, operation.pretty_inspect) unless operation.is_a?(Scorpio::OpenAPI::Operation)

data/lib/scorpio/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Scorpio
-  VERSION = "0.6.3".freeze
+  VERSION = "0.6.4".freeze
 end

data/scorpio.gemspec

@@ -23,8 +23,8 @@ Gem::Specification.new do |spec|
 
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "jsi", "= 0.8.0"
-  spec.add_dependency "ur", "~> 0.2.4"
+  spec.add_dependency "jsi", "~> 0.8.1"
+  spec.add_dependency "ur", "~> 0.2.5"
   spec.add_dependency "faraday", "< 3.0"
   spec.add_dependency "addressable", '~> 2.3'
 end

metadata

@@ -1,43 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: scorpio
 version: !ruby/object:Gem::Version
-  version: 0.6.3
+  version: 0.6.4
 platform: ruby
 authors:
 - Ethan
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-06-25 00:00:00.000000000 Z
+date: 2024-07-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jsi
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.0
+        version: 0.8.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.0
+        version: 0.8.1
 - !ruby/object:Gem::Dependency
   name: ur
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.4
+        version: 0.2.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.4
+        version: 0.2.5
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement