apiture 0.2.3 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 987570957cf2e6c779b9c3ccb5fa06a52f008ef8
-  data.tar.gz: 058c845cfc7ae48422c7f1122c0eacc485099032
+  metadata.gz: 6e2623ed6a8ed5d4afb84de3468a2477c7d38d50
+  data.tar.gz: 8a5b0a97a0580bae322cbf5039ca6a680cc0f025
 SHA512:
-  metadata.gz: 3efce36770c2060e613adf6c5491015ac85dcdf420b6a00a99c0dc76c7f4419c594b10c1d1b8acb5cd677c21a744d193c68776090f8e80b29c24294dac8cc72e
-  data.tar.gz: b5fdd0338d28917d4c55982822386ad251f852a1cb1e7697b8313503bdf9515fa04d9b6bf544fe874970f83e9e3b2f523451520a725503bb7f148d4fcad6f487
+  metadata.gz: e7fd65d16903202142aa64920f1422f539c4c065ce4ef33533d0397e968a10667c870a408d83716dec25ffba25612208aee286cb3c516a4efe7e324f0f9b6243
+  data.tar.gz: 80634719998c8acdf7546472e8c280ecca41bc0037d99f83f4883c20293bb16962cd76a54d764560ce22dbb5be761bca94837f7ccfa5796839f230889adfedb9

data/lib/apiture/api_builder.rb

@@ -2,7 +2,7 @@ require 'apiture/version'
 require 'apiture/api_error'
 require 'apiture/utils/inflections'
 require 'apiture/api_base'
-require 'apiture/data_model'
+require 'apiture/definition_value_renderer'
 require 'apiture/uri'
 
 require 'apiture/middleware/debug'
@@ -63,8 +63,7 @@ module Apiture
 
       def build_endpoints
         spec = specification
-        data_models = self.data_models
-
+        definitions = self.definition_renderers
         spec.paths.map do |path, path_model|
           path_model.operations_map.map do |(method, operation)|
             endpoint_name = underscore(operation.operation_id)
@@ -149,15 +148,16 @@ module Apiture
                   middleware_opts = {name: parameter.name}
                   if parameter.schema?
                     schema = parameter.schema
-                    if schema.kind_of? String
-                      schema = data_models[parameter.schema]
+                    renderer = nil
+                    if schema.kind_of? Swagger::DefinitionReference
+                      renderer = definitions[schema.definitionId]
+                      unless renderer
+                        raise APIError, "Unspecified schema: #{parameter.schema}; parameter=#{parameter.name}"
+                      end
                     else
-                      schema = DataModel.new(schema)
-                    end
-                    unless schema
-                      raise APIError, "Unspecified schema: #{parameter.schema}; parameter=#{parameter.name}"
+                      renderer = DefinitionValueRenderer.new(schema, definitions)
                     end
-                    middleware_opts[:schema] = schema
+                    middleware_opts[:renderer] = renderer
                   end
                   if spec.extensions[:version_parameter] && spec.extensions[:version_parameter]["name"] == parameter.name
                     middleware_opts[:default] = spec.extensions[:version_parameter]["version"]
@@ -174,15 +174,17 @@ module Apiture
         end.flatten.compact
       end
 
-      def data_models
-        @data_models ||= build_data_models
+      def definition_renderers
+        @definition_renderers ||= build_definition_renderers
       end
 
-      def build_data_models
-        specification.definitions.reduce({}) do |m, (name, definition)|
-          m[name] = DataModel.new(definition)
+      def build_definition_renderers
+        definitions = {}
+        specification.definitions.reduce(definitions) do |m, (name, definition)|
+          m[name] = DefinitionValueRenderer.new(definition, definitions)
           m
         end
+        definitions
       end
 
       def create_class_name(name)

data/lib/apiture/definition_value_renderer.rb

@@ -0,0 +1,42 @@
+module Apiture
+
+  class DefinitionValueRenderer
+
+    def initialize(definition, all_definitions)
+      @definition = definition
+      @all_definitions = all_definitions
+    end
+
+    def render_parameter(parameter_name, env)
+      context = env[:context]
+      h = context.get_attribute(parameter_name)
+      return nil unless h
+      render(h)
+    end
+
+    def render(data)
+      if @definition.kind_of? Swagger::ObjectDefinition
+        render_object_def(data)
+      elsif @definition.kind_of? Swagger::ArrayDefinition
+        render_array_def(data)
+      else
+        raise Apiture::APIError, "Unsupported definition: #{@definition}"
+      end
+    end
+
+    def render_object_def(hash)
+      @definition.properties.reduce({}) do |memo, (name, _)|
+        name = name.to_sym
+        if hash[name]
+          memo[name] = hash[name]
+        end
+        memo
+      end
+    end
+
+    def render_array_def(array)
+      array.dup
+    end
+
+  end
+end

data/lib/apiture/middleware/set_parameter_base.rb

@@ -5,7 +5,7 @@ module Apiture
       def initialize(app, options)
         @app = app
         @name = options[:name]
-        @schema = options[:schema]
+        @renderer = options[:renderer]
         @default = options[:default]
       end
 
@@ -21,8 +21,8 @@ module Apiture
       protected
 
         def find_parameter_value(env)
-          if @schema
-            @schema.build(@name, env)
+          if @renderer
+            @renderer.render_parameter(@name, env)
           else
             context = env[:context]
             context.get_attribute(@name)

data/lib/apiture/swagger/array_definition.rb

@@ -0,0 +1,17 @@
+require 'apiture/swagger/node'
+
+module Apiture
+  module Swagger
+    class ArrayDefinition < Node
+      attr_reader :id
+
+      attribute :items
+
+      def initialize(id)
+        super()
+        @id = id
+      end
+    end
+  end
+end
+

data/lib/apiture/swagger/definition_reference.rb

@@ -0,0 +1,16 @@
+module Apiture
+  module Swagger
+    class DefinitionReference < Node
+
+      attr_reader :ref
+
+      def initialize(ref)
+        @ref = ref
+      end
+
+      def definitionId
+        @ref.split('/').last
+      end
+    end
+  end
+end

data/lib/apiture/swagger/{definition.rb → object_definition.rb}

@@ -3,12 +3,13 @@ require 'apiture/swagger/property'
 
 module Apiture
   module Swagger
-    class Definition < Node
+    class ObjectDefinition < Node
       attr_reader :id
 
       attribute :required
       attribute :discriminator
 
+      hash :items
       hash :properties
 
       def initialize(id = "<Inline>")

data/lib/apiture/swagger/parser.rb

@@ -12,6 +12,11 @@ module Apiture
     class Parser
       include Apiture::Utils::Inflections
 
+      TYPE = 'type'.freeze
+      ARRAY = 'array'.freeze
+      DEFINITIONS = 'definitions'.freeze
+      REF = '$ref'.freeze
+
       def parse_json(spec)
         build_specification(MultiJson.load(spec))
       end
@@ -42,8 +47,7 @@ module Apiture
                 if param_json["schema"] && param_json["schema"].kind_of?(Hash)
                   trace.unshift("schema")
                   schema_json = param_json["schema"]
-                  param.schema = build_node(Definition, schema_json, trace: trace)
-                  build_schema_content(param.schema, schema_json)
+                  param.schema = build_definition_types(schema_json, "<Inline>", trace: trace)
                   trace.shift
                 end
                 trace.shift
@@ -56,18 +60,35 @@ module Apiture
           end
           trace.shift
         end
-        specification.definitions = build_node_hash(Definition, json, 'definitions') do |definition, def_json|
-          build_schema_content(definition, def_json)
+        specification.definitions = (json[DEFINITIONS] || {}).reduce({}) do |memo, (id, def_json)|
+          memo[id] = build_definition_types(def_json, id)
+          memo
         end
         specification
       end
 
       protected
 
-        def build_schema_content(definition, def_json)
-           definition.properties = build_node_hash(Property, def_json, 'properties') do |prop, prop_json|
-            prop.enum = prop_json["enum"]
-            prop.items = prop_json["items"]
+        def build_definition_types(def_json, id, options = {})
+          if definition_type = def_json[TYPE]
+            if definition_type == ARRAY
+              def_node = build_node(ArrayDefinition, def_json, constructor_args: [id], trace: options[:trace])
+              def_node.items = build_definition_types(def_json["items"], "<Inline>", options) if def_json["items"]
+              def_node
+            else
+              def_node = build_node(ObjectDefinition, def_json, constructor_args: [id], trace: options[:trace])
+              def_node.properties = build_node_hash(Property, def_json, 'properties') do |prop, prop_json|
+                prop.enum = prop_json["enum"]
+                if [:object, :array].include?(prop.type)
+                  prop.definition = build_definition_types(prop_json, "<Inline>", options)
+                end
+              end
+              def_node
+            end
+          elsif def_ref = def_json[REF]
+            DefinitionReference.new(def_ref)
+          else
+            def_json
           end
         end
 

data/lib/apiture/swagger/property.rb

@@ -5,6 +5,8 @@ module Apiture
     class Property < DataTypeField
       attr_reader :id
 
+      attribute :definition
+
       def initialize(id)
         super()
         @id = id

data/lib/apiture/swagger/specification.rb

@@ -3,7 +3,9 @@ require 'apiture/swagger/external_docs'
 require 'apiture/swagger/security'
 require 'apiture/swagger/security_definition'
 require 'apiture/swagger/path'
-require 'apiture/swagger/definition'
+require 'apiture/swagger/object_definition'
+require 'apiture/swagger/array_definition'
+require 'apiture/swagger/definition_reference'
 # require 'apiture/swagger/response'
 
 module Apiture

data/lib/apiture/version.rb

@@ -1,3 +1,3 @@
 module Apiture
-  VERSION = "0.2.3"
+  VERSION = "0.2.4"
 end

data/spec/apiture/swagger/parser_spec.rb

@@ -53,7 +53,8 @@ describe Apiture::Swagger::Parser do
     expect(param2.in).to eq :body
     expect(param2.name).to eq "story"
     expect(param2).to be_required
-    expect(param2.schema).to eq "NewStory"
+    expect(param2.schema).to be_kind_of Apiture::Swagger::DefinitionReference
+    expect(param2.schema.ref).to eq "#/definitions/NewStory"
 
     expect(specification.definitions.count).to eq 1
 
@@ -87,8 +88,8 @@ describe Apiture::Swagger::Parser do
 
     attachments_prop = payload.properties['attachments']
     expect(attachments_prop.type).to eq :array
-    expect(attachments_prop.items.count).to eq 1
-    expect(attachments_prop.items["$ref"]).to eq '#/definitions/Attachment'
+    expect(attachments_prop.definition).to be_kind_of Apiture::Swagger::ArrayDefinition
+    expect(attachments_prop.definition.items).to be_kind_of Apiture::Swagger::DefinitionReference
   end
 
   it "should parse a swagger specification with operation specific security" do
@@ -102,6 +103,7 @@ describe Apiture::Swagger::Parser do
     op = specification.paths["/messages/send.json"].post
     request_param = op.parameters.first
     expect(specification.consumes).to include "application/json"
-    expect(request_param.schema.class).to eq Apiture::Swagger::Definition
+    expect(request_param.schema.class).to eq Apiture::Swagger::ObjectDefinition
   end
+
 end

data/spec/files/pivotal_tracker.json

@@ -34,7 +34,9 @@
             "name": "story",
             "in": "body",
             "required": true,
-            "schema": "NewStory"
+            "schema": {
+              "$ref": "#/definitions/NewStory"
+            }
           }
         ]
       }

data/spec/files/slack.json

@@ -31,7 +31,9 @@
             "name": "payload",
             "in": "body",
             "required": true,
-            "schema": "Payload"
+            "schema": {
+              "$ref": "#/definitions/Payload"
+            }
           }
         ]
       }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: apiture
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.2.4
 platform: ruby
 authors:
 - Calvin Yu
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-15 00:00:00.000000000 Z
+date: 2016-09-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -142,7 +142,7 @@ files:
 - lib/apiture/api_builder.rb
 - lib/apiture/api_error.rb
 - lib/apiture/api_group.rb
-- lib/apiture/data_model.rb
+- lib/apiture/definition_value_renderer.rb
 - lib/apiture/endpoint.rb
 - lib/apiture/middleware/auth/api_key.rb
 - lib/apiture/middleware/auth/basic.rb
@@ -158,11 +158,13 @@ files:
 - lib/apiture/middleware_builder.rb
 - lib/apiture/middleware_stack.rb
 - lib/apiture/request_context.rb
+- lib/apiture/swagger/array_definition.rb
 - lib/apiture/swagger/data_type_field.rb
-- lib/apiture/swagger/definition.rb
+- lib/apiture/swagger/definition_reference.rb
 - lib/apiture/swagger/external_docs.rb
 - lib/apiture/swagger/info.rb
 - lib/apiture/swagger/node.rb
+- lib/apiture/swagger/object_definition.rb
 - lib/apiture/swagger/operation.rb
 - lib/apiture/swagger/parameter.rb
 - lib/apiture/swagger/parser.rb

data/lib/apiture/data_model.rb

@@ -1,24 +0,0 @@
-require 'multi_json'
-
-module Apiture
-  class DataModel
-    attr_reader :definition
-
-    def initialize(definition)
-      @definition = definition
-    end
-
-    def build(parameter_name, env)
-      context = env[:context]
-      h = context.get_attribute(parameter_name)
-      return nil unless h
-
-      json = definition.properties.reduce({}) do |m, (name, _)|
-        name = name.to_sym
-        m[name] = h[name] if h[name]; m
-      end
-
-      json
-    end
-  end
-end