api_schema 0.1.9.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d2f3fa661280ba4f60948f92da8669f4013e1b63
-  data.tar.gz: 22769f27db184bb796ee0be2ba99dea47e3e03dc
+  metadata.gz: ce61bc89fdc9a8d2447e7f959c2403984663af40
+  data.tar.gz: 04c4b334df2e0ee12b56701119da990e054c1848
 SHA512:
-  metadata.gz: 52520e379c716b67a84f75a8903e2c89996db60b312017a57e7859f13ab4f77261c0452d8f26f6ee9a7cce085c8f885e05632b35f29663ff22204ebd92c982cc
-  data.tar.gz: fe7b458da9aee9e783cfaf5422896bc1bcae82968c79077580dd1df4d357abbd2831d214bd16dd5aff556e5487a34d7ecc06395b6854a7fb8294827bf4d6ac56
+  metadata.gz: dd6866e8eda8b81328f14e72934efc3a5cf7d685b576fd90bb54bd43088a429f8c1b17e0950cbdbd0f874c1051bf1539dc76ffd0f0e4e078fca6778a37d997d8
+  data.tar.gz: 0f5d08c060d02c8803ad3885f7e3a94d8472029e8b69803fa3a229d89e1a12144ea2132fce6400002c038a821cc7761f42fb246ac3590aa1705b7253756eaeb0

data/api_schema.gemspec

@@ -28,4 +28,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.14"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry", "~> 0.11.3"
 end

data/lib/api_schema/api_version.rb

@@ -1,11 +1,95 @@
+require 'pry'
 module ApiSchema
   class ApiVersion
-    attr_accessor :configuration, :resources, :serializers
+    attr_accessor :configuration, :resources, :serializers, :imported_versions, :errors
 
     def initialize(configuration)
       @configuration = configuration
       @resources = []
       @serializers = []
+      @imported_versions = []
+      @errors = {}
+    end
+
+
+    def check_consistency
+      check_serializers_consistency
+      check_resources_consistency
+
+      raise UndefinedSerializersError, error_message  unless errors.empty?
+    end
+
+    private
+
+    def check_serializers_consistency
+      serializers.each do |serializer|
+        serializer.prior_references.each do |reference|
+          add_errors(:undefined_reference, reference) unless find_or_import(reference.id)
+        end
+      end
+    end
+
+    def check_resources_consistency
+      resources.each do |resource|
+        add_errors(:undefined_body, resource) unless find_or_import(resource.body_param)
+        add_errors(:undefined_response, resource) unless find_or_import(resource.resp.model)
+      end
+    end
+
+    def find_or_import(serializer_id)
+      return true unless serializer_id
+      return true if find_in_version(self, serializer_id)
+      return true if find_in_another_version(serializer_id)
+    end
+
+    def find_in_another_version(serializer_id)
+      imported_versions.each do |import|
+        version = imported_version(import)
+        serializer = find_in_version(version, serializer_id)
+        return serializers << serializer if serializer
+      end
+
+      false
+    end
+
+    def find_in_version(version, serializer_id)
+      version.serializers.detect { |s| s.id == serializer_id }
+    end
+
+    def imported_version(import)
+      "#{import.name.capitalize}::#{import.version.capitalize}::BaseDocs".constantize.api_version
+    end
+
+    def add_errors(key, object)
+      errors[key] ||= []
+      errors[key] << object
+    end
+
+    def error_message
+      message = errors.reduce([]) do |memo, (key, errors)|
+        case key
+        when :undefined_body
+          memo += errors.map(&self.method(:body_error))
+        when :undefined_response
+          memo += errors.map(&self.method(:response_error))
+        when :undefined_reference
+          memo += errors.map(&self.method(:reference_error))
+        end
+      end
+
+      message.join(" \n")
+    end
+
+    def body_error(object)
+      "There is no '#{object.body_param}' body parameter defined for #{object.base_path} resource. Please define it with 'request_body' method"
+    end
+
+    def response_error(object)
+      "There is no '#{object.resp.model}' response defined for '#{object.summary}' resource. Please define it with 'serializer' method"
+    end
+
+    def reference_error(object)
+      "Reference #{object.id} is not defined"
     end
   end
 end

data/lib/api_schema/exceptions/undefined_serializers_error.rb

@@ -0,0 +1,5 @@
+class UndefinedSerializersError < StandardError
+  def initialize(msg)
+    super
+  end
+end

data/lib/api_schema/resource_definition.rb

@@ -68,16 +68,6 @@ module ApiSchema
       !!body_param
     end
 
-    def body_defined?
-      return true if api_version.serializers.detect {|s| s.id == body_param }
-      raise "There is no '#{body_param}' body parameter defined for #{full_path} resource. Please define it with 'request_body' method"
-    end
-
-    def response_defined?
-      return true if resp.model.nil? || api_version.serializers.detect {|s| s.id == resp.model }
-      raise "There is no '#{resp.model}' response defined for ''#{summary} resource'. Please define it with 'serializer' method"
-    end
-
     def with_errors?
       !errors.empty?
     end
@@ -112,7 +102,7 @@ module ApiSchema
             security do
               key :authorization, []
             end
-            body_param(r.body_param) if r.with_body? && r.body_defined?
+            body_param(r.body_param) if r.with_body?
 
             r.header_params.each do |p|
               header_param(p.name, p.type, p.required)
@@ -124,7 +114,7 @@ module ApiSchema
               query_param(p.name, p.type, p.required)
             end
 
-            success_response(r.resp.code, r.resp.model, r.resp.fields) if r.response_defined?
+            success_response(r.resp.code, r.resp.model, r.resp.fields)
             error_responses(error_model, error_desc, *r.errors) if r.with_errors?
           end
         end

data/lib/api_schema/root_methods.rb

@@ -18,6 +18,11 @@ module ApiSchema
       @version_serializers = {}
     end
 
+    def import_serializers_from(name, version)
+      @api_version.imported_versions << OpenStruct.new(name: name,
+                                                       version: version)
+    end
+
     def api_version
       @api_version
     end
@@ -32,6 +37,10 @@ module ApiSchema
 
     def generate_json
       @api_version.configuration.build
+      @api_version.serializers.each { |s| s.build_references(version_serializers) }
+
+      @api_version.check_consistency
+
       @api_version.serializers.each { |s| s.build(version_serializers) }
       @api_version.resources.each { |r| r.build(version_resources) }
 

data/lib/api_schema/serializer_definition.rb

@@ -5,7 +5,7 @@ module ApiSchema
     PriorReference = ::Struct.new(:id, :type, :desc)
 
     attr_reader :id, :fields, :references, :parent
-    attr_accessor :type, :name, :description
+    attr_accessor :type, :name, :description, :prior_references
 
     def initialize(id, type, serializers, name=nil, parent_id = nil)
       @id = id

data/lib/api_schema/version.rb

@@ -1,3 +1,3 @@
 module ApiSchema
-  VERSION = "0.1.9.2"
+  VERSION = "0.2.0"
 end

data/lib/api_schema.rb

@@ -14,6 +14,7 @@ require "api_schema/serializer_definition"
 require "api_schema/serializer_methods"
 require "api_schema/resource_definition"
 require "api_schema/resource_methods"
+require "api_schema/exceptions/undefined_serializers_error.rb"
 require "api_schema/version"
 
 module ApiSchema

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: api_schema
 version: !ruby/object:Gem::Version
-  version: 0.1.9.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Dmitry Chopey
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-02-20 00:00:00.000000000 Z
+date: 2018-03-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -80,6 +80,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.3
 description: |-
   api_schema provides a framework and DSL for describing APIs
                             and generate swagger json using minimalistic, schema.db-like syntax.
@@ -103,6 +117,7 @@ files:
 - lib/api_schema.rb
 - lib/api_schema/api_version.rb
 - lib/api_schema/configuration.rb
+- lib/api_schema/exceptions/undefined_serializers_error.rb
 - lib/api_schema/field.rb
 - lib/api_schema/patches/operation_node.rb
 - lib/api_schema/patches/property_node.rb