api_schema 0.2.2.1 → 0.2.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3358bdecaec39f6472c13ae3e3fd1ea154ec2a0d
-  data.tar.gz: a79b3e5828f4ab3fc5149b755967668339ee4329
+  metadata.gz: d16c885ecc2244dedb62a305988a3119768c17dc
+  data.tar.gz: a3c607eb9ec54baea72f10b704ab02ceb4d5e595
 SHA512:
-  metadata.gz: ae92521c717add88eba74d5287f00d6ba493e53b1237e06ddfd0a678e10024a0e86ad4b9f5c86d685f0d3766dc3b743df115c546c41bba5313d34d2d73d27c07
-  data.tar.gz: 7bf634c99b23adfcb1ebf2c7809b26dcb8b8e760c5f050f669e932d196a4aa4fa8877d0c01fe82d423b05b40247125a90455b89b23c5a814046ca0c56b82e494
+  metadata.gz: 559137990458f47c04250aa5a8f125727fa075763ee84814c250b0b045c5f29ab358daeb88033c112050e781df59eba13377656b0d84fa54d80206d68a2195e7
+  data.tar.gz: 1fb654b77552faa11e16e85f8fc3b4cb0c728b59d4329b0e2f571cf99d669d087d3b4cfc32481b11125a5f11e51974d9f5d1def2638a718581d186f149f83349

data/lib/api_schema/api_version.rb

@@ -14,6 +14,7 @@ module ApiSchema
     def check_consistency
       check_serializers_consistency
       check_resources_consistency
+      check_desc_files_consistency
 
       raise UndefinedSerializersError, error_message  unless errors.empty?
     end
@@ -35,6 +36,18 @@ module ApiSchema
       end
     end
 
+    def check_desc_files_consistency
+      resources.each do |resource|
+        add_errors(:undefined_desc_file, resource) unless find_or_import_desc_file(resource)
+      end
+    end
+
+    def find_or_import_desc_file(resource)
+      return true unless resource.desc_file_name
+      return true if find_in_version_desc_file(self, resource)
+      return true if find_in_another_version_desc_file(resource)
+    end
+
     def find_or_import(serializer_id)
       return true unless serializer_id
       return true if find_in_version(self, serializer_id)
@@ -55,8 +68,23 @@ module ApiSchema
       version.serializers.detect { |s| s.id == serializer_id }
     end
 
+    def find_in_another_version_desc_file(resource)
+      imported_versions.each do |import|
+        version = imported_version(import)
+        return true if find_in_version_desc_file(version, resource)
+      end
+
+      false
+    end
+
+    def find_in_version_desc_file(version, resource)
+      file_path = "#{version.configuration.descriptions_path}/#{resource.desc_file_name}.md"
+      return resource.desc_file_path = file_path if File.file?(file_path)
+    end
+
     def imported_version(import)
-      "#{import.name.capitalize}::#{import.api_version.capitalize}::BaseDocs".constantize.api_version
+      "#{import.name.capitalize}::#{import.api_version.capitalize}::BaseDocs"
+        .constantize.api_version
     end
 
     def add_errors(key, object)
@@ -73,6 +101,8 @@ module ApiSchema
           memo += errors.map(&self.method(:response_error))
         when :undefined_reference
           memo += errors.map(&self.method(:reference_error))
+        when :undefined_desc_file
+          memo += errors.map(&self.method(:desc_file_error))
         end
       end
 
@@ -80,15 +110,21 @@ module ApiSchema
     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"
+      "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"
+      "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
+
+    def desc_file_error(object)
+      "The file '#{object.desc_file_name}' cannot be found"
+    end
   end
 end

data/lib/api_schema/resource_definition.rb

@@ -17,9 +17,11 @@ module ApiSchema
     PathParam = ::Struct.new(:name, :type, :required)
     QueryParam = ::Struct.new(:name, :type, :required)
 
-    attr_reader :method, :api_version, :summary, :description, :header_params, :body_param,
-    :path_params, :query_params, :resp,
-    :errors, :base_path, :extra_path, :full_path
+    attr_accessor :desc_file_path
+
+    attr_reader :method, :api_version, :summary, :description, :header_params,
+                :body_param, :path_params, :query_params, :resp, :errors,
+                :base_path, :extra_path, :full_path, :desc_file_name
 
     def name(name)
       @summary = name
@@ -29,8 +31,8 @@ module ApiSchema
       @description = desc
     end
 
-    def desc_file(desc_file)
-      @description = IO.read("#{api_version.configuration.descriptions_path}/#{desc_file}.md", encoding: 'utf-8')
+    def desc_file(desc_file_name)
+      @desc_file_name =  desc_file_name
     end
 
     def header(name, type, required: true)
@@ -77,6 +79,10 @@ module ApiSchema
       @full_path << "/#{extra_path}" if extra_path
     end
 
+    def build_description
+      @description = IO.read(desc_file_path, encoding: 'utf-8')
+    end
+
     def build_neighbors(neighbors)
       generate_full_path
       neighbors[full_path] ||= []
@@ -91,6 +97,8 @@ module ApiSchema
         '404' => "Not found",
         '422' => "Unprocessable Entity"
      }
+
+      build_description if desc_file_name
       resource = self
       swagger_path resource.full_path do
         neighbors[resource.full_path].each do |r|

data/lib/api_schema/version.rb

@@ -1,3 +1,3 @@
 module ApiSchema
-  VERSION = "0.2.2.1"
+  VERSION = "0.2.2.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: api_schema
 version: !ruby/object:Gem::Version
-  version: 0.2.2.1
+  version: 0.2.2.2
 platform: ruby
 authors:
 - Dmitry Chopey
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-03-09 00:00:00.000000000 Z
+date: 2018-03-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport