scorpio 0.6.1 → 0.6.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8f20e932b016747b1bfa5a3d45711d3b06c1362894bad9496fc002420f6b4678
-  data.tar.gz: 96aa91530d7fb3e8b58b8c8002ea83faf9d7c10c3f660279e235a8cfccdf15b2
+  metadata.gz: 82437b6c802e013a8b001d837d74fc53df3a79a036308402baa958473282e2da
+  data.tar.gz: 5d27bec750c90aba761158e41e8a3396af9bf08a0ca1bb03ad6fe5d88f12b139
 SHA512:
-  metadata.gz: 13858da58324b2648053d7c16c78ed1d5f4f5754a348d0ad442c2dd517fd13c9a6cdbb3f1295658795d9dae1ddd7eac7399028d9a1f087909c6b95de2d6a4ded
-  data.tar.gz: 2ed8c1fd1a150fd00fdee372bf0ff98624458826986f67f28daa76a5db428efa346615afd1e5aa9aa2d085f3841dbb1e5ad26fe843368c89e1380d9e8371a5b4
+  metadata.gz: 077caed57f2e2d38c46f7b56f17328f732929404ba1bed3a6bead041cb6449dabe61b32ca7c1fc6bc0b30eac9c8c1b0a58ebf47f9aa74ff852595243213b3b2e
+  data.tar.gz: d995f27814a468e9652de92b5b7e4579a3ca0626798be1cf56b155a5bb83dcbf38e60158c225ecc55c455672fb1d5efb4327615725da5745e1cd5ef26802399b

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+# v0.6.3
+
+- JSI = v0.8.0
+
+# v0.6.2
+- replace deprecated calls to JSI
+
 # v0.6.1
 - compatibility
   - JSI 0.7

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::Typelike.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::Typelike.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
@@ -212,7 +214,7 @@ module Scorpio
             end.call(openapi)
           end
         end
-        JSI::Typelike.as_json(openapi)
+        JSI::Util.as_json(openapi)
       end
     end
   end

data/lib/scorpio/openapi/operation.rb

@@ -165,22 +165,29 @@ 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(**config, &b)
+        @request_class ||= Scorpio::Request.request_class_by_operation(self)
+        @request_class.new(**config, &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(**config, &b)
+        build_request(**config, &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(**config, &b)
+        build_request(**config, &b).run
+      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

@@ -25,8 +25,8 @@ module Scorpio
         'documents/github.com/OAI/OpenAPI-Specification/blob/oas3-schema/schemas/v3.0/schema.yaml'
       )))
 
-      # the schema represented by Scorpio::OpenAPI::V3::Schema will describe schemas itself, so we set it
-      # include on its schema module the jsi_schema_instance_modules that implement schema functionality.
+      # the schema represented by Scorpio::OpenAPI::V3::Schema will describe schemas itself.
+      # JSI::Schema#describes_schema! enables this to implement the functionality of schemas.
       describe_schema = [
         openapi_document_schema.definitions['Schema'],
         openapi_document_schema.definitions['SchemaReference'],
@@ -40,7 +40,7 @@ module Scorpio
         # a problem, and this way also applies when none of the anyOf match due to schema errors.)
         openapi_document_schema.definitions['Schema'].properties['additionalProperties'],
       ]
-      describe_schema.each { |s| s.jsi_schema_instance_modules = [JSI::Schema::Draft04] }
+      describe_schema.each { |s| s.describes_schema!([JSI::Schema::Draft04]) }
 
       Document = openapi_document_schema.jsi_schema_module
 
@@ -118,14 +118,14 @@ module Scorpio
         'documents/swagger.io/v2/schema.json'
       ).read))
 
-      # the schema represented by Scorpio::OpenAPI::V2::Schema will describe schemas itself, so we set it to
-      # include on its schema module the jsi_schema_instance_modules that implement schema functionality.
+      # the schema represented by Scorpio::OpenAPI::V2::Schema will describe schemas itself.
+      # JSI::Schema#describes_schema! enables this to implement the functionality of schemas.
       describe_schema = [
         openapi_document_schema.definitions['schema'],
         # comments above on v3's definitions['Schema'].properties['additionalProperties'] apply here too
         openapi_document_schema.definitions['schema'].properties['additionalProperties'],
       ]
-      describe_schema.each { |s| s.jsi_schema_instance_modules = [JSI::Schema::Draft04] }
+      describe_schema.each { |s| s.describes_schema!([JSI::Schema::Draft04]) }
 
       Document = openapi_document_schema.jsi_schema_module
 

data/lib/scorpio/request.rb

@@ -71,7 +71,7 @@ module Scorpio
         return @body if instance_variable_defined?(:@body)
         if instance_variable_defined?(:@body_object)
           if content_type && content_type.json?
-            JSON.pretty_generate(JSI::Typelike.as_json(body_object))
+            JSON.pretty_generate(JSI::Util.as_json(body_object))
           elsif content_type && content_type.form_urlencoded?
             URI.encode_www_form(body_object)
 
@@ -129,13 +129,21 @@ 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
@@ -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

data/lib/scorpio/resource_base.rb

@@ -324,7 +324,7 @@ module Scorpio
             else
               jsi = operation.request_schema.new_jsi(o)
             end
-            jsi.jsi_select_children_leaf_first do |node|
+            jsi.jsi_select_descendents_leaf_first do |node|
               # we want to specifically reject only nodes described (only) by a false schema.
               # note that for OpenAPI schemas, false is only a valid schema as a value
               # of `additionalProperties`
@@ -418,7 +418,7 @@ module Scorpio
       end
 
       def as_json(*opt)
-        JSI::Typelike.as_json(contained_object, *opt)
+        JSI::Util.as_json(contained_object, *opt)
       end
 
       def inspect
@@ -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.1".freeze
+  VERSION = "0.6.3".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.0"
+  spec.add_dependency "ur", "~> 0.2.4"
   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.1
+  version: 0.6.3
 platform: ruby
 authors:
 - Ethan
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-01-12 00:00:00.000000000 Z
+date: 2024-06-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jsi
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: 0.7.0
+        version: 0.8.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: 0.7.0
+        version: 0.8.0
 - !ruby/object:Gem::Dependency
   name: ur
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.1
+        version: 0.2.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.1
+        version: 0.2.4
 - !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