scorpio 0.6.2 → 0.6.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c63ccc2d793787385be12175b68b1aca1b68372ee72bae4cb78e434d931aa941
-  data.tar.gz: 3e9bec23f6ca7ad6905ca1fcd33ce185f1dd5741ad3a1097d0cbc82fea09fef1
+  metadata.gz: ad4505d3bd4e9dc299b95b21ce5305e7864200fb0481be3f2600f75c3476f73d
+  data.tar.gz: 613abb854fffaf49a45f8c9e19a0f150f0fef9b7500e50cf20dc2a6f58023347
 SHA512:
-  metadata.gz: c7f265f3e6f68c340a2720a1f09238cd0f95d4a1dcfa8fb225ad4afa6e211fbe715c337d37faf7d8037ab0267b142af523182cf1d7eecca4e4cd80af16956a54
-  data.tar.gz: 0a3601a2380269a73fde895e1a2d9c80617a2643ead58420866baa04f5d4a2bad5ce06c54b43f155283f53286b2c1bca09b527b2f7d494d9b766e9a188ae31b6
+  metadata.gz: 26cd883ee719f0e2683ac53c1be85d9296c90b92e80a799d938cf361c431ca486dd4e6a2db73539d7f133fa162fd104f85f4d9c9ec89b7f74e2187e8218b543b
+  data.tar.gz: 945afcb210c0b0ea8801393a3586b83045f82bcb94724021e3c69a6320ba32c23ddbeb6652644a6c3ea063830550f97e3001e661251662a8e6d976bc2cfdce62

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+# v0.6.4
+
+- JSI ~> v0.8.1
+- OpenAPI::Operation#each_link_page
+
+# v0.6.3
+
+- JSI = v0.8.0
+
 # v0.6.2
 - replace deprecated calls to JSI
 

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/google_api_document.rb

@@ -3,7 +3,7 @@
 module Scorpio
   module Google
     discovery_rest_description_doc = ::JSON.parse(Scorpio.root.join('documents/www.googleapis.com/discovery/v1/apis/discovery/v1/rest').read)
-    discovery_rest_description = JSI::MetaschemaNode.new(
+    discovery_rest_description = JSI::MetaSchemaNode.new(
       discovery_rest_description_doc,
       metaschema_root_ptr: JSI::Ptr['schemas']['JsonSchema'],
       root_schema_ptr: JSI::Ptr['schemas']['RestDescription'],
@@ -29,13 +29,16 @@ module Scorpio
     # google does a weird thing where it defines a schema with a $ref property where a json-schema is to be used in the document (method request and response fields), instead of just setting the schema to be the json-schema schema. we'll share a module across those schema classes that really represent schemas. is this confusingly meta enough?
     module SchemaLike
       def to_openapi
-        dup_doc = JSI::Util.as_json(self)
         # openapi does not want an id field on schemas
-        dup_doc.delete('id')
+        dup_doc = jsi_node_content.reject { |k, _| k == 'id' }
         if dup_doc['properties'].is_a?(Hash)
-          required_properties = dup_doc['properties'].select do |key, value|
-            value.is_a?(Hash) ? value.delete('required') : nil
-          end.keys
+          required_properties = []
+          dup_doc['properties'].each do |key, value|
+            if value.is_a?(Hash) && value.key?('required')
+              required_properties.push(key) if value['required']
+              dup_doc = dup_doc.merge({'properties' => value.reject { |vk, _| vk == 'required' }})
+            end
+          end
           # put required before properties
           unless required_properties.empty?
             dup_doc = dup_doc.map do |k, v|
@@ -55,8 +58,7 @@ module Scorpio
       end
 
       def to_openapi_hash(options = {})
-        # we will be modifying the api document (RestDescription). clone self and modify that one.
-        ad = self.class.new(JSI::Util.as_json(self))
+        ad = self
         ad_methods = []
         if ad['methods']
           ad_methods += ad['methods'].map do |mn, m|
@@ -164,7 +166,7 @@ module Scorpio
               #'url' => '',
             #},
           },
-          'host' => ad.rootUrl ? Addressable::URI.parse(ad.rootUrl).host : ad.baseUrl ? Addressable::URI.parse(ad.rootUrl).host : ad.name, # uhh ... got nothin' better 
+          'host' => ad.rootUrl ? Addressable::URI.parse(ad.rootUrl).host : ad.baseUrl ? Addressable::URI.parse(ad.baseUrl).host : ad.name, # uhh ... got nothin' better
           'basePath' => begin
             path = ad.servicePath || ad.basePath || (ad.baseUrl ? Addressable::URI.parse(ad.baseUrl).path : '/')
             path =~ %r(\A/) ? path : "/" + path

data/lib/scorpio/openapi/operation.rb

@@ -165,22 +165,68 @@ module Scorpio
       # instantiates a {Scorpio::Request} for this operation.
       # parameters are all passed to {Scorpio::Request#initialize}.
       # @return [Scorpio::Request]
-      def build_request(*a, &b)
-        Scorpio::Request.new(self, *a, &b)
+      def build_request(configuration = {}, &b)
+        @request_class ||= Scorpio::Request.request_class_by_operation(self)
+        @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(*a, &b)
-        build_request(*a, &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(*a, &b)
-        build_request(*a, &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
+
+      def jsi_object_group_text
+        [*super, http_method, path_template_str].freeze
       end
     end
 

data/lib/scorpio/openapi/reference.rb

@@ -6,10 +6,10 @@ module Scorpio
       # overrides JSI::Base#[] to implicitly dereference this Reference, except when
       # the given token is present in this Reference's instance (this should usually
       # only apply to the token '$ref')
-      def [](token, *a, &b)
+      def [](token, **kw)
         if respond_to?(:to_hash) && !key?(token)
           deref do |deref_jsi|
-            return deref_jsi[token]
+            return(deref_jsi[token, **kw])
           end
         end
         return super

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

@@ -129,19 +129,27 @@ module Scorpio
     end
     include Configurables
 
-    # @param operation [Scorpio::OpenAPI::Operation]
+    @request_class_by_operation = Hash.new do |h, op|
+      h[op] = Class.new(Request) do
+        define_method(:operation) { op }
+        include(op.request_accessor_module)
+      end
+    end
+
+    def self.request_class_by_operation(operation)
+      @request_class_by_operation[operation]
+    end
+
     # @param configuration [#to_hash] a hash keyed with configurable attributes for
     #   the request - instance methods of Scorpio::Request::Configurables, whose values
     #   will be assigned for those attributes.
-    def initialize(operation, configuration = {}, &b)
-      @operation = operation
-
+    def initialize(configuration = {}, &b)
       configuration = JSI::Util.stringify_symbol_keys(configuration)
       params_set = Set.new # the set of params that have been set
       # 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
@@ -151,8 +159,6 @@ module Scorpio
         set_param_from(param['in'], param['name'], value)
       end
 
-      extend operation.request_accessor_module
-
       if block_given?
         yield self
       end
@@ -384,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)
@@ -439,7 +439,7 @@ module Scorpio
         end
       end
 
-      include JSI::Util::FingerprintHash
+      include(JSI::Util::Private::FingerprintHash)
 
       def jsi_fingerprint
         {class: self.class, contained_object: as_json}
@@ -497,39 +497,92 @@ module Scorpio
 
   class ResourceBase
     class Container
-      @container_classes = Hash.new do |h, modules|
-        container_class = Class.new(Container)
-        modules.each do |mod|
-          container_class.include(mod)
+      @container_classes = Hash.new do |h, key|
+        modules, schemas = key[:modules], key[:schemas]
+
+        container_class = Class.new(Container) do
+          modules.each do |mod|
+            include(mod)
+          end
+
+          schemas.each do |schema|
+            include(JSI::SchemaClasses.schema_property_reader_module(schema, conflicting_modules: modules + [Container]))
+            include(JSI::SchemaClasses.schema_property_writer_module(schema, conflicting_modules: modules + [Container]))
+          end
         end
-        h[modules] = container_class
+        h[key] = container_class
       end
 
       class << self
         def new_container(object, openapi_document_class, options = {})
           container_modules = Set[]
 
-          # TODO this is JSI internals that scorpio shouldn't really be using
           if object.respond_to?(:to_hash)
-            container_modules << JSI::Base::HashNode
+            container_modules << Container::Hash
           end
           if object.respond_to?(:to_ary)
-            container_modules << JSI::Base::ArrayNode
+            container_modules << Container::Array
           end
 
-          container_modules += object.jsi_schemas.map do |schema|
-            JSI::SchemaClasses.accessor_module_for_schema(schema,
-              conflicting_modules: container_modules + [Container],
-            )
-          end
-
-          container_class = @container_classes[container_modules.freeze]
+          container_class = @container_classes[{modules: container_modules.freeze, schemas: object.jsi_schemas}]
 
           container_class.new(object, openapi_document_class, options)
         end
       end
     end
 
+    module Container::Hash
+      include(Enumerable)
+      include(JSI::Util::Hashlike) # TODO this is JSI internals that scorpio shouldn't really be using
+
+      def each(**kw, &block)
+        return(to_enum(__method__, **kw) { contained_object.size }) unless block
+        if block.arity > 1
+          contained_object.each_key { |k| yield(k, self[k, **kw]) }
+        else
+          contained_object.each_key { |k| yield([k, self[k, **kw]]) }
+        end
+        self
+      end
+
+      def to_hash(**kw)
+        hash = {}
+        contained_object.each_key { |k| hash[k] = self[k, **kw] }
+        hash
+      end
+
+      def as_json(options = {})
+        hash = {}
+        each_key do |k|
+          ks = k.is_a?(String) ? k :
+            k.is_a?(Symbol) ? k.to_s :
+            k.respond_to?(:to_str) && (kstr = k.to_str).is_a?(String) ? kstr :
+            raise(TypeError, "JSON object (Hash) cannot be keyed with: #{k.pretty_inspect.chomp}")
+          hash[ks] = JSI::Util.as_json(self[k], **options)
+        end
+        hash
+      end
+    end
+
+    module Container::Array
+      include(Enumerable)
+      include(JSI::Util::Arraylike) # TODO this is JSI internals that scorpio shouldn't really be using
+
+      def each(**kw, &block)
+        return(to_enum(__method__, **kw) { contained_object.size }) unless block
+        contained_object.each_index { |i| yield(self[i, **kw]) }
+        self
+      end
+
+      def to_ary(**kw)
+        to_a(**kw)
+      end
+
+      def as_json(options = {})
+        each_index.map { |i| JSI::Util.as_json(self[i], **options) }
+      end
+    end
+
     class Container
       include Containment
 

data/lib/scorpio/response.rb

@@ -26,7 +26,7 @@ module Scorpio
         end
 
         if response_schema && (body_object.respond_to?(:to_hash) || body_object.respond_to?(:to_ary))
-          body_object = response_schema.new_jsi(body_object)
+          body_object = response_schema.new_jsi(body_object, mutable: true)
         end
 
         body_object

data/lib/scorpio/version.rb

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

data/scorpio.gemspec

@@ -1,7 +1,4 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'scorpio/version'
+require_relative('lib/scorpio/version')
 
 Gem::Specification.new do |spec|
   spec.name          = "scorpio"
@@ -26,8 +23,8 @@ Gem::Specification.new do |spec|
 
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "jsi", "~> 0.7.0"
-  spec.add_dependency "ur", "~> 0.2.1"
+  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,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: scorpio
 version: !ruby/object:Gem::Version
-  version: 0.6.2
+  version: 0.6.4
 platform: ruby
 authors:
 - Ethan
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-01-28 00:00:00.000000000 Z
+date: 2024-07-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jsi
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.7.0
+        version: 0.8.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.7.0
+        version: 0.8.1
 - !ruby/object:Gem::Dependency
   name: ur
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.1
+        version: 0.2.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.1
+        version: 0.2.5
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
@@ -117,7 +117,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: Scorpio REST client