scorpio 0.6.0 → 0.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b089f79e383e48c4d73793ceb0b1f3a3a254aca6abc34176252d24828ca0a9d8
-  data.tar.gz: aa9f34563eacae7e07c68f757a66bc53504dbdde741c285f40b34f15a64a08a4
+  metadata.gz: c63ccc2d793787385be12175b68b1aca1b68372ee72bae4cb78e434d931aa941
+  data.tar.gz: 3e9bec23f6ca7ad6905ca1fcd33ce185f1dd5741ad3a1097d0cbc82fea09fef1
 SHA512:
-  metadata.gz: 3d87134df5c11b0157c861fddd25947d3f45cbd2b17c29d9de23d22e8dd70e4edc2b6b1378ef3f5cfee0e0bff7872e9179e76b5f97e824d14a231ef19fd068cd
-  data.tar.gz: f82dd97cdb8a8b2f0912d1d5e9a8198f5f7734dcb46c914b0c9cb25a3763d0c0a9d4c0c690a3598d53a8c62f065fde18dec0c42586f2257da289b776d091a3c2
+  metadata.gz: c7f265f3e6f68c340a2720a1f09238cd0f95d4a1dcfa8fb225ad4afa6e211fbe715c337d37faf7d8037ab0267b142af523182cf1d7eecca4e4cd80af16956a54
+  data.tar.gz: 0a3601a2380269a73fde895e1a2d9c80617a2643ead58420866baa04f5d4a2bad5ce06c54b43f155283f53286b2c1bca09b527b2f7d494d9b766e9a188ae31b6

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+# v0.6.2
+- replace deprecated calls to JSI
+
+# v0.6.1
+- compatibility
+  - JSI 0.7
+  - Faraday 2
+  - Ruby 3
+  - JRuby
+
 # v0.6.0
 - ResourceBase resources in responses may be contained anywhere in the response object contained in ResourceBase::Container
 - ResourceBase defines class methods for operations whose request or response schemas are represented by the resource

data/README.md

@@ -269,7 +269,7 @@ The detailed, machine-interpretable description of an API provided by a properly
 
 ## License
 
-[<img align="right" src="https://github.com/notEthan/scorpio/raw/master/resources/icons/AGPL-3.0.png">](https://www.gnu.org/licenses/agpl-3.0.html)
+[<img align="right" src="https://www.gnu.org/graphics/agplv3-155x51.png">](https://www.gnu.org/licenses/agpl-3.0.html)
 
 Scorpio is licensed under the terms of the [GNU Affero General Public License version 3](https://www.gnu.org/licenses/agpl-3.0.html).
 

data/lib/scorpio/google_api_document.rb

@@ -7,7 +7,7 @@ module Scorpio
       discovery_rest_description_doc,
       metaschema_root_ptr: JSI::Ptr['schemas']['JsonSchema'],
       root_schema_ptr: JSI::Ptr['schemas']['RestDescription'],
-      metaschema_instance_modules: [JSI::Schema::Draft04],
+      schema_implementation_modules: [JSI::Schema::Draft04],
     )
 
     # naming these is not strictly necessary, but is nice to have.
@@ -29,7 +29,7 @@ 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)
+        dup_doc = JSI::Util.as_json(self)
         # openapi does not want an id field on schemas
         dup_doc.delete('id')
         if dup_doc['properties'].is_a?(Hash)
@@ -56,7 +56,7 @@ module Scorpio
 
       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.class.new(JSI::Util.as_json(self))
         ad_methods = []
         if ad['methods']
           ad_methods += ad['methods'].map do |mn, m|
@@ -212,7 +212,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

@@ -224,11 +224,12 @@ module Scorpio
         # @return [JSI::Schema]
         def request_schema(media_type: self.request_media_type)
           # TODO typechecking on requestBody & children
-          schema_object = requestBody &&
-            requestBody['content'] &&
-            requestBody['content'][media_type] &&
-            requestBody['content'][media_type]['schema']
-          schema_object ? JSI::Schema.ensure_schema(schema_object) : nil
+          request_content = requestBody && requestBody['content']
+          return nil unless request_content
+          raise(ArgumentError, "please specify media_type for request_schema") unless media_type
+          schema = request_content[media_type] && request_content[media_type]['schema']
+          return nil unless schema
+          JSI::Schema.ensure_schema(schema)
         end
 
         # @return [JSI::SchemaSet]

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,12 +40,12 @@ 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
 
       # naming these is not strictly necessary, but is nice to have.
-      # generated: `puts Scorpio::OpenAPI::V3::Document.schema.definitions.select { |k,v| ['object', nil].include?(v['type']) }.keys.map { |k| "#{k[0].upcase}#{k[1..-1]} = Document.definitions['#{k}']" }`
+      # generated: `puts Scorpio::OpenAPI::V3::Document.schema.definitions.keys.map { |k| "#{k[0].upcase}#{k[1..-1]} = Document.definitions['#{k}']" }`
 
 
       Reference      = Document.definitions['Reference']
@@ -118,19 +118,19 @@ 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
 
       # naming these is not strictly necessary, but is nice to have.
-      # generated: `puts Scorpio::OpenAPI::V2::Document.schema.definitions.select { |k,v| ['object', nil].include?(v['type']) }.keys.map { |k| "#{k[0].upcase}#{k[1..-1]} = Document.definitions['#{k}']" }`
+      # generated: `puts Scorpio::OpenAPI::V2::Document.schema.definitions.keys.map { |k| "#{k[0].upcase}#{k[1..-1]} = Document.definitions['#{k}']" }`
 
 
       Info            = Document.definitions['info']
@@ -142,7 +142,8 @@ module Scorpio
       ResponseDefinitions = Document.definitions['responseDefinitions']
       ExternalDocs       = Document.definitions['externalDocs']
       Examples          = Document.definitions['examples']
-      Operation        = Document.definitions['operation']
+      MimeType         = Document.definitions['mimeType']
+      Operation       = Document.definitions['operation']
       PathItem         = Document.definitions['pathItem']
       Responses         = Document.definitions['responses']
       ResponseValue      = Document.definitions['responseValue']
@@ -159,7 +160,8 @@ module Scorpio
       Parameter               = Document.definitions['parameter']
       Schema                 = Document.definitions['schema']
       FileSchema            = Document.definitions['fileSchema']
-      PrimitivesItems        = Document.definitions['primitivesItems']
+      PrimitivesItems       = Document.definitions['primitivesItems']
+      Security               = Document.definitions['security']
       SecurityRequirement     = Document.definitions['securityRequirement']
       Xml                      = Document.definitions['xml']
       Tag                       = Document.definitions['tag']
@@ -171,19 +173,24 @@ module Scorpio
       Oauth2ApplicationSecurity = Document.definitions['oauth2ApplicationSecurity']
       Oauth2AccessCodeSecurity = Document.definitions['oauth2AccessCodeSecurity']
       Oauth2Scopes            = Document.definitions['oauth2Scopes']
-      Title                  = Document.definitions['title']
-      Description           = Document.definitions['description']
-      Default              = Document.definitions['default']
-      MultipleOf          = Document.definitions['multipleOf']
-      Maximum            = Document.definitions['maximum']
-      ExclusiveMaximum  = Document.definitions['exclusiveMaximum']
-      Minimum          = Document.definitions['minimum']
-      ExclusiveMinimum = Document.definitions['exclusiveMinimum']
-      MaxLength       = Document.definitions['maxLength']
-      MinLength      = Document.definitions['minLength']
-      Pattern       = Document.definitions['pattern']
-      MaxItems     = Document.definitions['maxItems']
-      MinItems    = Document.definitions['minItems']
+      MediaTypeList          = Document.definitions['mediaTypeList']
+      ParametersList         = Document.definitions['parametersList']
+      SchemesList             = Document.definitions['schemesList']
+      CollectionFormat         = Document.definitions['collectionFormat']
+      CollectionFormatWithMulti = Document.definitions['collectionFormatWithMulti']
+      Title                    = Document.definitions['title']
+      Description             = Document.definitions['description']
+      Default                = Document.definitions['default']
+      MultipleOf            = Document.definitions['multipleOf']
+      Maximum              = Document.definitions['maximum']
+      ExclusiveMaximum    = Document.definitions['exclusiveMaximum']
+      Minimum            = Document.definitions['minimum']
+      ExclusiveMinimum  = Document.definitions['exclusiveMinimum']
+      MaxLength        = Document.definitions['maxLength']
+      MinLength       = Document.definitions['minLength']
+      Pattern        = Document.definitions['pattern']
+      MaxItems      = Document.definitions['maxItems']
+      MinItems     = Document.definitions['minItems']
       UniqueItems = Document.definitions['uniqueItems']
       Enum         = Document.definitions['enum']
       JsonReference = Document.definitions['jsonReference']

data/lib/scorpio/request.rb

@@ -2,9 +2,18 @@
 
 module Scorpio
   class Request
-    SUPPORTED_REQUEST_MEDIA_TYPES = ['application/json'.freeze, 'application/x-www-form-urlencoded'.freeze].freeze
+    # media types for which Scorpio has implemented generating / parsing between body
+    # and body_object (see {Request#body} and {Response#body_object})
+    SUPPORTED_REQUEST_MEDIA_TYPES = %w(
+      application/json
+      application/x-www-form-urlencoded
+    ).map(&:freeze).freeze
+
     FALLBACK_CONTENT_TYPE = 'application/x-www-form-urlencoded'.freeze
 
+    # see also Faraday::Env::MethodsWithBodies
+    METHODS_WITH_BODIES = %w(post put patch options).map(&:freeze).freeze
+
     def self.best_media_type(media_types)
       if media_types.size == 1
         media_types.first
@@ -13,6 +22,13 @@ module Scorpio
       end
     end
 
+    # @param http_method [String]
+    # @return [Boolean]
+    def self.method_with_body?(http_method)
+      raise(ArgumentError) unless http_method.is_a?(String)
+      METHODS_WITH_BODIES.include?(http_method.downcase)
+    end
+
     module Configurables
       attr_writer :path_params
       def path_params
@@ -55,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)
 
@@ -310,7 +326,7 @@ module Scorpio
     #   the named value
     # @param name [String, Symbol] the parameter name
     # @return [Object]
-    # @raise [ArgumentError] invalid `param_in` parameter
+    # @raise [OpenAPI::SemanticError] invalid `param_in` parameter
     # @raise [NotImplementedError] cookies aren't implemented
     def get_param_from(param_in, name)
       if param_in == 'path'
@@ -323,7 +339,7 @@ module Scorpio
       elsif param_in == 'cookie'
         raise(NotImplementedError, "cookies not implemented: #{name.inspect}")
       else
-        raise(ArgumentError, "cannot get param from param_in = #{param_in.inspect} (name: #{name.pretty_inspect.chomp})")
+        raise(OpenAPI::SemanticError, "cannot get param from param_in = #{param_in.inspect} (name: #{name.pretty_inspect.chomp})")
       end
     end
 
@@ -341,14 +357,17 @@ module Scorpio
         else
           # I'd rather not have a default content-type, but if none is set then the HTTP adapter sets this to 
           # application/x-www-form-urlencoded and issues a warning about it.
-          headers['Content-Type'] = FALLBACK_CONTENT_TYPE
+          if METHODS_WITH_BODIES.include?(http_method.to_s)
+            headers['Content-Type'] = FALLBACK_CONTENT_TYPE
+          end
         end
       end
-      if self.headers
-        headers.update(self.headers)
-      end
+      headers.update(self.headers)
+      body = self.body
+
       ur = nil
-      faraday_connection(-> (yur) { ur = yur }).run_request(http_method.downcase.to_sym, url, body, headers)
+      conn = faraday_connection(-> (yur) { ur = yur })
+      conn.run_request(http_method.downcase.to_sym, url, body, headers)
       ur.scorpio_request = self
       ur
     end
@@ -375,6 +394,12 @@ module Scorpio
       return to_enum(__method__, next_page: next_page, raise_on_http_error: raise_on_http_error) unless block_given?
       page_ur = run_ur
       while page_ur
+        unless page_ur.is_a?(Scorpio::Ur)
+          raise(TypeError, [
+            "next_page must result in a #{Scorpio::Ur}",
+            "this should be the result of #run_ur from a #{OpenAPI::Operation} or #{Request}",
+          ].join("\n"))
+        end
         page_ur.raise_on_http_error if raise_on_http_error
         yield page_ur
         page_ur = next_page.call(page_ur)

data/lib/scorpio/resource_base.rb

@@ -1,8 +1,6 @@
 # frozen_string_literal: true
 
 module Scorpio
-  # see also Faraday::Env::MethodsWithBodies
-  METHODS_WITH_BODIES = %w(post put patch options).map(&:freeze).freeze
   class RequestSchemaFailure < Error
   end
 
@@ -265,7 +263,7 @@ module Scorpio
         call_params = JSI::Util.stringify_symbol_keys(call_params) if call_params.respond_to?(:to_hash)
         model_attributes = JSI::Util.stringify_symbol_keys(model_attributes || {})
 
-        request = Scorpio::Request.new(operation)
+        request = operation.build_request
 
         accessor_overridden = -> (accessor) do
           # an accessor is overridden if the default accessor getter (UnboundMethod) is the same
@@ -326,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`
@@ -344,7 +342,7 @@ module Scorpio
           end
         else
           if other_params
-            if METHODS_WITH_BODIES.any? { |m| m.to_s == operation.http_method.downcase.to_s }
+            if Request.method_with_body?(request.http_method)
               request.body_object = other_params
             else
               if other_params.respond_to?(:to_hash)
@@ -394,7 +392,7 @@ module Scorpio
 
   class ResourceBase
     module Containment
-      def [](key)
+      def [](key, _: nil) # unused keyword param lets an empty keyword hash be passed in older ruby versions
         sub = contained_object[key]
         if sub.is_a?(JSI::Base)
           # TODO avoid reinstantiating the container only to throw it away if it matches the memo
@@ -420,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
@@ -513,12 +511,10 @@ module Scorpio
 
           # TODO this is JSI internals that scorpio shouldn't really be using
           if object.respond_to?(:to_hash)
-            container_modules << Enumerable # TODO change next JSI when PathedHashNode includes Enumerable
-            container_modules << JSI::PathedHashNode
+            container_modules << JSI::Base::HashNode
           end
           if object.respond_to?(:to_ary)
-            container_modules << Enumerable # TODO change next JSI when PathedArrayNode includes Enumerable
-            container_modules << JSI::PathedArrayNode
+            container_modules << JSI::Base::ArrayNode
           end
 
           container_modules += object.jsi_schemas.map do |schema|

data/lib/scorpio/version.rb

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

data/scorpio.gemspec

@@ -26,8 +26,8 @@ Gem::Specification.new do |spec|
 
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "jsi", "~> 0.6.0"
+  spec.add_dependency "jsi", "~> 0.7.0"
   spec.add_dependency "ur", "~> 0.2.1"
-  spec.add_dependency "faraday", "< 2.0"
+  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.0
+  version: 0.6.2
 platform: ruby
 authors:
 - Ethan
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-02-28 00:00:00.000000000 Z
+date: 2023-01-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jsi
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: 0.7.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: 0.7.0
 - !ruby/object:Gem::Dependency
   name: ur
   requirement: !ruby/object:Gem::Requirement
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "<"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "<"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: addressable
   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.2
+rubygems_version: 3.1.6
 signing_key:
 specification_version: 4
 summary: Scorpio REST client