scorpio 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f65533b3372858d91ff71a0ec3847179a8f50a1d825e5f77e94632a249692ecc
-  data.tar.gz: 7dab437fe9bbe813f2b8a24417d0232fdf39dc861c2723b7f5df74764cf92797
+  metadata.gz: 603bcc3914e849b35e8c4519682588fc7f56dda8d52c188fde80eef20bf7b34f
+  data.tar.gz: aecb035dd48a48c8f97e7ca60ffb560abde598385db4cbaf4d0444226708a7ef
 SHA512:
-  metadata.gz: 13c15b82acc7509c807336037993fa6e97bd7308a37e552974ae259b2665230a78a83235d455df485b51c318c76e8f64ed2e4397bcdc24b4ede52b32e58945f2
-  data.tar.gz: c25e928331ff2e0a00904c0e7db4fef1fd5d3ed77331acd6e3b2e59905301ef1d958ec3346eca92f98298c8b2a1ef1e3b537eaf874d87e128c933108d31fcea5
+  metadata.gz: e462291e8caca9542c8de14c81402be9bb004571c93d2af7ce92d842ee22861df92a10e9be941149950d017d7751d41e70d6ada8bb17fb2822c0ba85a0a8cbd9
+  data.tar.gz: 6cc6ebc90878d29cc2861c7c48e2231cd5554b7ed569efcbe529295275969d772f9bb1c328039d539ef4e579489f37269ae2003bd6a2d15da90645548cedafe9

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+# v0.4.1
+- Request#param_for
+- Operation#human_id
+- bugfixes
+
 # v0.4.0
 - Scorpio::OpenAPI v3 classes updated from OAI/OpenAPI-Specification branch oas3-schema
 - any uniquely-named request parameter will have accessors on Request and can be passed as config to #initialize

data/bin/documents_to_yml.rb

@@ -4,7 +4,13 @@ require 'pathname'
 require 'json'
 require 'yaml'
 
-Pathname.glob(Pathname.new(__FILE__).dirname.join('../documents/**/*')).select { |p| p.file? && !['.yml', '.yaml'].include?(p.extname) }.each do |file|
+root = Pathname.new(__FILE__).dirname.join('..')
+
+document_dirs = [root.join('documents'), root.join('test/documents')]
+documents = document_dirs.map { |d| Pathname.glob(d.join('**/*')) }.inject([], &:+)
+json_documents = documents.select { |p| p.file? && !['.yml', '.yaml'].include?(p.extname) }
+
+json_documents.each do |file|
   begin
     json_contents = JSON.parse(file.read)
     yaml = YAML.dump(json_contents, line_width: -1)

data/lib/scorpio.rb

@@ -97,6 +97,8 @@ module Scorpio
   class ConfigError < Error
     attr_accessor :name
   end
+  class ParameterError < ConfigError
+  end
   class AmbiguousParameter < ConfigError
   end
 

data/lib/scorpio/openapi.rb

@@ -1,5 +1,13 @@
 module Scorpio
   module OpenAPI
+    # an error in the semantics of this openapi document. for example, an Operation with
+    # two body parameters (in v2, not possible in v3) is a semantic error.
+    #
+    # an instance of a SemanticError may or may not correspond to a validation error of
+    # an OpenAPI document against the OpenAPI schema.
+    class SemanticError
+    end
+
     autoload :Operation, 'scorpio/openapi/operation'
     autoload :Document, 'scorpio/openapi/document'
     autoload :OperationsScope, 'scorpio/openapi/operations_scope'

data/lib/scorpio/openapi/operation.rb

@@ -97,6 +97,21 @@ module Scorpio
         end
       end
 
+      # @return [String] a short identifier for this operation appropriate for an error message
+      def human_id
+        operationId || "path: #{path_template_str}, method: #{http_method}"
+      end
+
+      # @return [Scorpio::OpenAPI::V3::Response, Scorpio::OpenAPI::V2::Response]
+      def oa_response(status: )
+        status = status.to_s if status.is_a?(Numeric)
+        if self.responses
+          _, oa_response = self.responses.detect { |k, v| k.to_s == status }
+          oa_response ||= self.responses['default']
+        end
+        oa_response
+      end
+
       # this method is not intended to be API-stable at the moment.
       #
       # @return [#to_ary<#to_h>] the parameters specified for this operation, plus any others
@@ -141,7 +156,7 @@ module Scorpio
       end
 
       def build_request(*a, &b)
-        request = Scorpio::Request.new(self, *a, &b)
+        Scorpio::Request.new(self, *a, &b)
       end
 
       def run_ur(*a, &b)
@@ -192,28 +207,26 @@ module Scorpio
 
         def request_schema(media_type: self.request_media_type)
           # TODO typechecking on requestBody & children
-          requestBody &&
+          schema_object = requestBody &&
             requestBody['content'] &&
             requestBody['content'][media_type] &&
-            requestBody['content'][media_type]['schema'] &&
-            requestBody['content'][media_type]['schema'].deref
+            requestBody['content'][media_type]['schema']
+          schema_object ? JSI::Schema.from_object(schema_object) : nil
         end
 
         def request_schemas
           if requestBody && requestBody['content']
             # oamt is for Scorpio::OpenAPI::V3::MediaType
-            requestBody['content'].values.map { |oamt| oamt['schema'] }.compact.map(&:deref)
+            oamts = requestBody['content'].values.select { |oamt| oamt.key?('schema') }
+            oamts.map { |oamt| JSI::Schema.from_object(oamt['schema']) }
+          else
+            []
           end
         end
 
         # @return JSI::Schema
         def response_schema(status: , media_type: )
-          status = status.to_s if status.is_a?(Numeric)
-          if self.responses
-            # Scorpio::OpenAPI::V3::Response
-            _, oa_response = self.responses.detect { |k, v| k.to_s == status }
-            oa_response ||= self.responses['default']
-          end
+          oa_response = self.oa_response(status: status)
           oa_media_types = oa_response ? oa_response['content'] : nil # Scorpio::OpenAPI::V3::MediaTypes
           oa_media_type = oa_media_types ? oa_media_types[media_type] : nil # Scorpio::OpenAPI::V3::MediaType
           oa_schema = oa_media_type ? oa_media_type['schema'] : nil # Scorpio::OpenAPI::V3::Schema
@@ -257,7 +270,8 @@ module Scorpio
           elsif body_parameters.size == 1
             body_parameters.first
           else
-            raise(Bug, "multiple body parameters on operation #{operation.pretty_inspect.chomp}") # TODO BLAME
+            # TODO blame
+            raise(OpenAPI::SemanticError, "multiple body parameters on operation #{operation.pretty_inspect.chomp}")
           end
         end
 
@@ -275,12 +289,7 @@ module Scorpio
 
         # @return JSI::Schema
         def response_schema(status: , media_type: nil)
-          status = status.to_s if status.is_a?(Numeric)
-          if self.responses
-            # Scorpio::OpenAPI::V2::Response
-            _, oa_response = self.responses.detect { |k, v| k.to_s == status }
-            oa_response ||= self.responses['default']
-          end
+          oa_response = self.oa_response(status: status)
           oa_response_schema = oa_response ? oa_response['schema'] : nil # Scorpio::OpenAPI::V2::Schema
           oa_response_schema ? JSI::Schema.new(oa_response_schema) : nil
         end

data/lib/scorpio/request.rb

@@ -62,7 +62,7 @@ module Scorpio
             if body_object.respond_to?(:to_str)
               body_object
             else
-              raise(NotImplementedError)
+              raise(NotImplementedError, "Scorpio does not know how to generate the request body with media_type = #{media_type.respond_to?(:to_str) ? media_type : media_type.inspect} for operation: #{operation.human_id}. Scorpio supports media types: #{SUPPORTED_REQUEST_MEDIA_TYPES.join(', ')}. body_object was: #{body_object.pretty_inspect.chomp}")
             end
           end
         else
@@ -128,14 +128,8 @@ module Scorpio
       end
       # then do other top-level params
       configuration.reject { |name, _| params_set.include?(name) }.each do |name, value|
-        params = operation.inferred_parameters.select { |p| p['name'] == name }
-        if params.size == 1
-          set_param_from(params.first['in'], name, value)
-        elsif params.size == 0
-          raise(ArgumentError, "unrecognized configuration value passed: #{name.inspect}")
-        else
-          raise(AmbiguousParameter.new("There are multiple parameters named #{name.inspect} - cannot use it as a configuration key").tap { |e| e.name = name })
-        end
+        param = param_for(name) || raise(ArgumentError, "unrecognized configuration value passed: #{name.inspect}")
+        set_param_from(param['in'], param['name'], value)
       end
 
       extend operation.request_accessor_module
@@ -170,12 +164,12 @@ module Scorpio
       path_params = JSI.stringify_symbol_keys(self.path_params)
       missing_variables = path_template.variables - path_params.keys
       if missing_variables.any?
-        raise(ArgumentError, "path #{operation.path_template_str} for operation #{operation.operationId} requires path_params " +
+        raise(ArgumentError, "path #{operation.path_template_str} for operation #{operation.human_id} requires path_params " +
           "which were missing: #{missing_variables.inspect}")
       end
       empty_variables = path_template.variables.select { |v| path_params[v].to_s.empty? }
       if empty_variables.any?
-        raise(ArgumentError, "path #{operation.path_template_str} for operation #{operation.operationId} requires path_params " +
+        raise(ArgumentError, "path #{operation.path_template_str} for operation #{operation.human_id} requires path_params " +
           "which were empty: #{empty_variables.inspect}")
       end
 
@@ -248,13 +242,8 @@ module Scorpio
     # @return [Object] echoes the value param
     # @raise [Scorpio::AmbiguousParameter] if more than one paramater has the given name
     def set_param(name, value)
-      name = name.to_s if name.is_a?(Symbol)
-      params = operation.inferred_parameters.select { |p| p['name'] == name }
-      if params.size == 1
-        set_param_from(params.first['in'], name, value)
-      else
-        raise(AmbiguousParameter.new("There are multiple parameters named #{name}; cannot use #set_param").tap { |e| e.name = name })
-      end
+      param = param_for!(name)
+      set_param_from(param['in'], param['name'], value)
       value
     end
 
@@ -262,15 +251,32 @@ module Scorpio
     # @return [Object] the value of the named parameter on this request
     # @raise [Scorpio::AmbiguousParameter] if more than one paramater has the given name
     def get_param(name)
+      param = param_for!(name)
+      get_param_from(param['in'], param['name'])
+    end
+
+    # @param name [String, Symbol] the 'name' property of one applicable parameter
+    # @return [#to_hash, nil]
+    def param_for(name)
       name = name.to_s if name.is_a?(Symbol)
       params = operation.inferred_parameters.select { |p| p['name'] == name }
       if params.size == 1
-        get_param_from(params.first['in'], name)
+        params.first
+      elsif params.size == 0
+        nil
       else
-        raise(AmbiguousParameter.new("There are multiple parameters named #{name}; cannot use #get_param").tap { |e| e.name = name })
+        raise(AmbiguousParameter.new(
+          "There are multiple parameters for #{name}. matched parameters were: #{params.pretty_inspect.chomp}"
+        ).tap { |e| e.name = name })
       end
     end
 
+    # @param name [String, Symbol] the name or {in}.{name} (e.g. "query.search") for the applicable parameter.
+    # @return [#to_hash]
+    def param_for!(name)
+      param_for(name) || raise(ParameterError, "There is no parameter named #{name} on operation #{operation.human_id}:\n#{operation.pretty_inspect.chomp}")
+    end
+
     # @param in [String, Symbol] one of 'path', 'query', 'header', or 'cookie' - where to apply the named value
     # @param name [String, Symbol] the parameter name to apply the value to
     # @param value [Object] the value
@@ -305,7 +311,8 @@ module Scorpio
       elsif param_in == 'query'
         query_params ? query_params[name] : nil
       elsif param_in == 'header'
-        headers[name]
+        _, value = headers.detect { |headername, _| headername.downcase == name.downcase }
+        value
       elsif param_in == 'cookie'
         raise(NotImplementedError, "cookies not implemented: #{name.inspect}")
       else

data/lib/scorpio/resource_base.rb

@@ -116,10 +116,7 @@ module Scorpio
             raise(ArgumentError, "openapi_document may not be overridden on subclass #{self.inspect} after it was set on #{openapi_document_class.inspect}")
           end
         end
-        update_dynamic_methods
-
         # TODO blame validate openapi_document
-
         update_dynamic_methods
       end
 
@@ -129,9 +126,8 @@ module Scorpio
 
       def tag_name=(tag_name)
         unless tag_name.respond_to?(:to_str)
-          raise(TypeError)
+          raise(TypeError, "tag_name must be a string; got: #{tag_name.inspect}")
         end
-        set_on_class = self
         tag_name = tag_name.to_str
 
         begin
@@ -187,7 +183,9 @@ module Scorpio
         return false unless operation_for_resource_class?(operation)
 
         # define an instance method if the request schema is for this model 
-        request_resource_is_self = operation.request_schema && represented_schemas.include?(operation.request_schema)
+        request_resource_is_self = operation.request_schemas.any? do |request_schema|
+          represented_schemas.include?(request_schema)
+        end
 
         # also define an instance method depending on certain attributes the request description 
         # might have in common with the model's schema attributes
@@ -222,6 +220,7 @@ module Scorpio
             tag_name_match = tag_name &&
               operation.tags.respond_to?(:to_ary) && # TODO maybe operation.tags.valid?
               operation.tags.include?(tag_name) &&
+              operation.operationId &&
               operation.operationId.match(/\A#{Regexp.escape(tag_name)}\.(\w+)\z/)
 
             if tag_name_match
@@ -360,11 +359,11 @@ module Scorpio
               if schema
                 if schema['type'] == 'object'
                   # TODO code dup with response_object_to_instances
-                  if schema['properties'] && schema['properties'][key]
+                  if schema['properties'].respond_to?(:to_hash) && schema['properties'][key]
                     subschema = schema['properties'][key]
                     include_pair = true
                   else
-                    if schema['patternProperties']
+                    if schema['patternProperties'].respond_to?(:to_hash)
                       _, pattern_schema = schema['patternProperties'].detect do |pattern, _|
                         key =~ Regexp.new(pattern) # TODO map pattern to ruby syntax
                       end
@@ -375,8 +374,7 @@ module Scorpio
                     else
                       if schema['additionalProperties'] == false
                         include_pair = false
-                      elsif schema['additionalProperties'] == nil
-                        # TODO decide on this (can combine with `else` if treating nil same as schema present)
+                      elsif [nil, true].include?(schema['additionalProperties'])
                         include_pair = true
                         subschema = nil
                       else

data/lib/scorpio/ur.rb

@@ -20,7 +20,7 @@ module Scorpio
         HTTPError
       end
       if error_class
-        message = "Error calling operation #{scorpio_request.operation.operationId}:\n" + response.body
+        message = "Error calling operation #{scorpio_request.operation.human_id}:\n" + response.body
         raise(error_class.new(message).tap do |e|
           e.ur = self
           e.response_object = response.body_object

data/lib/scorpio/version.rb

@@ -1,3 +1,3 @@
 module Scorpio
-  VERSION = "0.4.0"
+  VERSION = "0.4.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: scorpio
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Ethan
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-04-27 00:00:00.000000000 Z
+date: 2019-05-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jsi