swagger_model 0.3.6 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4703ab809c83f9384d2d89a6cdc8b3aa3fc8d688
-  data.tar.gz: 8a560e09d06920fbba375d0ad6218f7390ba8db4
+  metadata.gz: 7f7c65359fa58890e69ebd599e538474dfaae1ac
+  data.tar.gz: 0635b5d20453ea7cb40225142af9a7bd6e611f5d
 SHA512:
-  metadata.gz: 3d8ed511dcf4fc9a79216204a1b2e9241bf22ca61bd9bf90ac5d5a8de42ce10abac408b9029ea839ce93f3f43cb50f5640beef12712c1e950b0918c7e19b72c6
-  data.tar.gz: afda4beac21ccc536a3f9d56a022b8d5b348d517e3123351643f3a05effab56fb7779111492f680d6eb3bceeef7c0250ee3ab7f172f09e5a7d11d4802664c888
+  metadata.gz: 0ee8642f285940a7503b119817dee9bd41f167129f9606228a17467830ab4adcd76f33995b4ea4a241abc93dc79b3a403a32c07390f98a0f4aff0f367eab824b
+  data.tar.gz: a94348c709d7195b3f1a253fc4135fb829faa11dec6674bc9c9a40ee178804f31ad73aede8e20d5ab3fd170b958452a7a757d6d05b11b44617a34e53dc044c76

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    swagger_model (0.3.6)
+    swagger_model (0.4.0)
 
 GEM
   remote: https://rubygems.org/

data/lib/swagger_model/attributes.rb

@@ -0,0 +1,127 @@
+require_relative 'relationships'
+
+module SwaggerModel
+  module SwaggerV2
+    class Attributes
+      def initialize(hash, model_name, suffix='Attributes')
+        @attributes = []
+        @suffix = suffix
+        @model_name = model_name
+        hash.keys.each do |key|
+          value = hash[key]
+          attribute = get_attribute(value, key)
+          attribute['key'] = key
+          @attributes.push(attribute)
+        end
+      end
+
+      def to_swagger_hash(model)
+        hash = {
+          'type' => 'object'
+        }
+        properties = {}
+        @attributes.each do |e|
+          attribute = get_attribute_swagger(e, model)
+          properties[e['key']] = attribute
+        end
+        hash['properties'] = properties
+        hash['required'] = properties.keys
+        name = @model_name + @suffix
+        model[name] = hash
+        {
+          '$ref': "#/definitions/#{name}"
+        }
+      end
+
+      private
+      def get_attribute_swagger(e, model)
+        attribute = {}
+        type = e['type']
+        key = e['key']
+        case e['type']
+        when 'object'
+          name = ActiveSupport::Inflector.classify(key.gsub('-', '_'))
+          attribute_name = @model_name + name + 'Attributes'
+          attribute['$ref'] = "#/definitions/#{attribute_name}"
+          e['attributes'].to_swagger_hash(model)
+        when 'array'
+          attribute['type'] = e['type']
+          attribute['items'] = get_attribute_swagger(e['item'], model)
+        else
+          attribute['type'] = e['type']
+          attribute['format'] = e['format'] unless e['format'].nil?
+          attribute['example'] = e['example'] unless e['fexample'].nil?
+        end
+        attribute
+      end
+      def date_time_valid?(str)
+        if (!! Date.parse(str) rescue false)
+          date = Date._parse(str)
+          !date[:zone].nil? && !date[:hour].nil? && !date[:min].nil? && !date[:sec].nil? && !date[:year].nil? && !date[:mon].nil?
+        else
+          false
+        end
+      end
+      def get_attribute(value, key)
+        attribute = {}
+        type = get_type(value)
+        case type
+        when 'date-time'
+          attribute = {
+            'type' => 'string',
+            'format' => 'date-time',
+            'example' => value
+          }
+        when 'float'
+          attribute = {
+            'type' => 'number',
+            'format' => 'float',
+            'example' => value
+          }
+        when nil
+          attribute = {}
+        when 'object'
+          name = ActiveSupport::Inflector.classify(key.gsub('-', '_'))
+          attribute = {
+            'type' => 'object',
+            'attributes' => Attributes.new(value, @model_name + name)
+          }
+        when 'array'
+          item = value.first
+          attribute = {
+            'type' => 'array',
+            'item' => get_attribute(item)
+          }
+        else
+          attribute = {
+            'type' => type
+          }
+        end
+        attribute
+      end
+      def get_type(value)
+        type_class = value.class.to_s
+        case type_class
+        when 'Hash'
+          'object'
+        when 'Array'
+          'array'
+        when 'String'
+          if date_time_valid?(value)
+            'date-time'
+          else
+            'string'
+          end
+        when 'Fixnum'
+          'integer'
+        when 'TrueClass', 'FalseClass'
+          'boolean'
+        when 'Float'
+          'float'
+        else
+          nil
+        end
+      end
+    end
+  end
+end

data/lib/swagger_model/included.rb

@@ -0,0 +1,15 @@
+module SwaggerModel
+  module SwaggerV2
+    class Included
+      def initialize(array)
+        @models = array.map { |e| Model.new(e) }
+      end
+
+      def models_to_swagger_hash(model)
+        @models.each do |e|
+          e.to_swagger_hash(model)
+        end
+      end
+    end
+  end
+end

data/lib/swagger_model/links.rb

@@ -0,0 +1,38 @@
+module SwaggerModel
+  module SwaggerV2
+    class Links
+      def self.template
+        {
+          'type' => 'object',
+          'properties' => {
+            'self' => {
+              'type' => "string",
+              'example' => "http://example.com?page=2"
+            },
+            'first' => {
+              'type' => "string",
+              'example' => "http://example.com?page=1"
+            },
+            'prev' => {
+              'type' => "string",
+              'example' => "http://example.com?page=1"
+            },
+            'next' => {
+              'type' => "string",
+              'example' => "http://example.com?page=3"
+            },
+            'last' => {
+              'type' => "string",
+              'example' => "http://example.com?page=100"
+            }
+          },
+          'required' => [
+            'self',
+            'first',
+            'last'
+          ]
+        }
+      end
+    end
+  end
+end

data/lib/swagger_model/model.rb

@@ -0,0 +1,43 @@
+require_relative 'relationships'
+require_relative 'attributes'
+
+module SwaggerModel
+  module SwaggerV2
+    class Model
+      def initialize(hash)
+        @id = hash['id']
+        @type = hash['type']
+        @model_name = ActiveSupport::Inflector.classify(@type.gsub('-', '_'))
+        @attributes = Attributes.new(hash['attributes'], @model_name)
+        if !hash['relationships'].nil?
+          @relationships = Relationships.new(hash['relationships'])
+        end
+      end
+
+      def to_swagger_hash(model)
+        model[@model_name] = {}
+        aModel = model[@model_name]
+        hash = {
+          'type' => 'object',
+          'properties' => {
+            'id' => {
+              'type' => 'string',
+              'example' => @id
+            },
+            'type' => {
+              'type' => 'string',
+              'example' => @type
+            },
+            'attributes' => @attributes.to_swagger_hash(aModel)
+          }
+        }
+        hash['properties']['relationships'] = @relationships.to_swagger_hash(aModel, @model_name) unless @relationships.nil?
+        aModel[@model_name] = hash
+
+        {
+          '$ref' => "#/definitions/#{@model_name}"
+        }
+      end
+    end
+  end
+end

data/lib/swagger_model/relation.rb

@@ -0,0 +1,19 @@
+require 'active_support'
+require 'active_support/core_ext'
+
+module SwaggerModel
+  module SwaggerV2
+    class Relation
+      def initialize(hash)
+        @type = hash['type']
+      end
+
+      def to_swagger_hash
+        model_name = ActiveSupport::Inflector.classify(@type.gsub('-', '_'))
+        {
+            '$ref' => "#/definitions/#{model_name}"
+        }
+      end
+    end
+  end
+end

data/lib/swagger_model/relation_data.rb

@@ -0,0 +1,21 @@
+module SwaggerModel
+  module SwaggerV2
+    class RelationData
+      def initialize(hash)
+        @relation = Relation.new(hash)
+      end
+
+      def to_swagger_hash(key, parent_name)
+        name = parent_name + ActiveSupport::Inflector.classify(key.gsub('-', '_')) + 'Data'
+        {
+          name => {
+            'type' => 'object',
+            'properties' => {
+              'data' => @relation.to_swagger_hash
+            }
+          }
+        }
+      end
+    end
+  end
+end

data/lib/swagger_model/relation_data_array.rb

@@ -0,0 +1,26 @@
+require_relative 'relation'
+
+module SwaggerModel
+  module SwaggerV2
+    class RelationDataArray
+      def initialize(array)
+        @relation = Relation.new(array.first)
+      end
+
+      def to_swagger_hash(key, parent_name)
+        name = parent_name + ActiveSupport::Inflector.classify(key.gsub('-', '_')) + 'Data'
+        {
+          name => {
+            'type' => 'object',
+            'properties' => {
+              'data' => {
+                'type' => 'array',
+                'items' => @relation.to_swagger_hash
+              }
+            }
+          }
+        }
+      end
+    end
+  end
+end

data/lib/swagger_model/relationships.rb

@@ -0,0 +1,50 @@
+require_relative 'relation_data'
+require_relative 'relation_data_array'
+
+module SwaggerModel
+  module SwaggerV2
+    class Relationships
+      def initialize(hash)
+        @relationships = []
+        hash.keys.each do |key|
+          relation_data = hash[key]['data']
+          data = ''
+          case relation_data.class.to_s
+          when 'Hash'
+            data = RelationData.new(relation_data)
+          when 'Array'
+            data = RelationDataArray.new(relation_data)
+          end
+          relationship = {
+            'key' => key,
+            'data' => data
+          }
+          @relationships.push(relationship)
+        end
+      end
+      def to_swagger_hash(model, model_name)
+        hash = {
+          'type' => 'object'
+        }
+        properties = {}
+        @relationships.each do |r|
+          parent_name = model_name + 'Relationships'
+          swagger_hash = r['data'].to_swagger_hash(r['key'], parent_name)
+          name = swagger_hash.keys.first
+          properties[r['key']] = {
+            '$ref' => "#/definitions/#{name}"
+          }
+          model[name] = swagger_hash[name]
+        end
+        hash['properties'] = properties
+        hash['required'] = properties.keys
+        name = model_name + 'Relationships'
+        model[name] = hash
+
+        {
+          '$ref' => "#/definitions/#{name}"
+        }
+      end
+    end
+  end
+end

data/lib/swagger_model/version.rb

@@ -1,3 +1,3 @@
 module SwaggerModel
-  VERSION = "0.3.6"
+  VERSION = "0.4.0"
 end

data/lib/swagger_model.rb

@@ -7,6 +7,12 @@ require 'active_support/core_ext'
 require 'fileutils'
 require 'logger'
 
+require_relative 'swagger_model/links'
+require_relative 'swagger_model/relationships'
+require_relative 'swagger_model/model'
+require_relative 'swagger_model/included'
+require_relative 'swagger_model/attributes'
+
 module SwaggerModel
   module OpenAPIv3
     def self.date_time_valid?(str)
@@ -229,16 +235,8 @@ module SwaggerModel
           end
           obj['$ref'] = '#/definitions/' + model_name
         elsif key == 'relationships'
-          object = parse_object(value, model, root_key)
-          properties = object['properties']
-          model_name = root_key + 'Relationships'
-          model[root_key][model_name] = {}
-          model[root_key][model_name]['type'] = 'object'
-          model[root_key][model_name]['properties'] = properties
-          if object['required'].size > 0
-            model[root_key][model_name]['required'] = object['required']
-          end
-          obj['$ref'] = '#/definitions/' + model_name
+          relationships = Relationships.new(value)
+          obj = relationships.to_swagger_hash(model, root_key)
         else
           object = parse_object(value, model, root_key)
           properties = object['properties']
@@ -326,54 +324,54 @@ module SwaggerModel
       response_model = {}
       response_model[response_name] = {}
       response_model[response_name]['type'] = "object"
+      response_model[response_name]['properties'] = {}
       model = {}
-      object = parse_object(response, model, response_name)
-      properties = object['properties']
-      if properties.has_key?('included')
-        properties.delete('included')
+
+      # Create response data
+      if response.has_key?('data')
+        data = response['data']
+        case data.class.to_s
+        when 'Hash'
+          m = Model.new(data)
+          response_model[response_name]['properties']['data'] = m.to_swagger_hash(model)
+        when 'Array'
+          m = Model.new(data.first)
+          response_model[response_name]['properties']['data'] = {
+            'type' => 'array',
+            'items' => m.to_swagger_hash(model)
+          }
+        end
       end
-      if properties.has_key?('links')
+
+      # Create included key models but not add included key to response
+      if response.has_key?('included')
+        included = Included.new(response['included'])
+        included.models_to_swagger_hash(model)
+      end
+
+      # Create links from template
+      if response.has_key?('links')
         links = {}
         links['$ref'] = '#/definitions/Links'
-        properties['links'] = links
+        response_model[response_name]['properties']['links'] = links
         if response_model['Links'].nil?
-          response_model['Links'] = {
-            'self' => {
-              'type' => "string",
-              'example' => "https://contents.kurashiru.com/api/v1/videos?page%5Bnumber%5D=2&page%5Bsize%5D=20"
-            },
-            'first' => {
-              'type' => "string",
-              'example' => "https://contents.kurashiru.com/api/v1/videos?page%5Bnumber%5D=1&page%5Bsize%5D=20"
-            },
-            'prev' => {
-              'type' => "string",
-              'example' => "https://contents.kurashiru.com/api/v1/videos?page%5Bnumber%5D=1&page%5Bsize%5D=20"
-            },
-            'next' => {
-              'type' => "string",
-              'example' => "https://contents.kurashiru.com/api/v1/videos?page%5Bnumber%5D=3&page%5Bsize%5D=20"
-            },
-            'last' => {
-              'type' => "string",
-              'example' => "https://contents.kurashiru.com/api/v1/videos?page%5Bnumber%5D=100&page%5Bsize%5D=20"
-            }
-          }
+          response_model['Links'] = Links.template
         end
       end
-      if properties.has_key?('meta')
+
+      # Create Meta
+      if response.has_key?('meta')
         meta_name = response_name + 'Meta'
-        response_model[meta_name] = properties['meta']
+        meta = Attributes.new(response['meta'], meta_name, '')
+        meta.to_swagger_hash(response_model)
         meta = {}
         meta['$ref'] = '#/definitions/' + meta_name
-        properties['meta'] = meta
-      end
-      response_model[response_name]['properties'] = properties
-      if object['required'].size > 0
-        object['required'].delete('included')
-        response_model[response_name]['required'] = object['required']
+        response_model[response_name]['properties']['meta'] = meta
       end
 
+      # Set required
+      response_model[response_name]['required'] = response_model[response_name]['properties'].keys
+
       # add example
       response_model[response_name]['example'] = response
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: swagger_model
 version: !ruby/object:Gem::Version
-  version: 0.3.6
+  version: 0.4.0
 platform: ruby
 authors:
 - marumemomo
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-06-26 00:00:00.000000000 Z
+date: 2018-07-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -83,6 +83,14 @@ files:
 - bin/setup
 - example/Example.json
 - lib/swagger_model.rb
+- lib/swagger_model/attributes.rb
+- lib/swagger_model/included.rb
+- lib/swagger_model/links.rb
+- lib/swagger_model/model.rb
+- lib/swagger_model/relation.rb
+- lib/swagger_model/relation_data.rb
+- lib/swagger_model/relation_data_array.rb
+- lib/swagger_model/relationships.rb
 - lib/swagger_model/version.rb
 - swagger_model.gemspec
 homepage: https://github.com/marumemomo/swagger_model