open_api 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4dcb8f55e33a66045af98794ffb7683361538f73cfb33f5602a9979541ee772d
-  data.tar.gz: 2d7be42cd44216f877d533404c79ce74e8294ef2622530d0ecbd3a2e1cf21a3e
+  metadata.gz: 9cb3780237e228de5aba05e77e13f1e7ad7699a0fa7e0f7650c6a959b533a248
+  data.tar.gz: 1f85ba19940b862a3829e02e8db6c10a1fd31028b43771c417578d0fc869c765
 SHA512:
-  metadata.gz: d140ad5540fadce4e2a212fec19b40b5b2cb82094566e0dc44c1eec1a1eaa306f2cf8fe1295f09e353811412389526c309cec052221dfe97625ee263d25ea9ca
-  data.tar.gz: d912b8d7a8db740c79ddb5239931ff376d5f94253a086b86b5f107ee5c1cb415338a84ba4fa1a1e81766e5ac0ba511b3e4cceffb2c95558f0a9efe358337398b
+  metadata.gz: 4acc8b5ab843a7aa5fa47ec5f528ba4d42851f7577ed02ac797c6940f77e06eb183a43cc2a885dad2451ce96f1631338bffa66b61bdda264c56f45672c79bdd8
+  data.tar.gz: 2487a600e7d723351712d83b0307960a61c1caaad328c57333a52540ee658220418647d8acd9ca226b1c41d9fc0db1aacc0eefa327cd80a6ba5e28b2129e47f0

data/CHANGELOG.md

@@ -0,0 +1,11 @@
+## 0.2.0
+* Allow Schema to behave like OpenStruct 5a698cf796f0467b726062bcd7c2cf2c20693950
+* Allow to serialize `schema.properties` fb6f2a0a5d58de7c0bfb113b3a6636a50df7de3d
+* Fix dir for `open_api/schema` 1e8d9ffcccd89d89844af7eecb418e352ad6b5f3
+
+
+## 0.1.0
+First release
+
+* Implement all classes for OpenAPI v3.0.1
+* Allow to YAML serializing/deserializing

data/README.md

@@ -1,4 +1,4 @@
-# OpenApi [![Build Status](https://travis-ci.org/ngtk/open_api.svg?branch=master)](https://travis-ci.org/ngtk/open_api) [![Maintainability](https://api.codeclimate.com/v1/badges/dc4713a3cb67f6edce65/maintainability)](https://codeclimate.com/github/ngtk/open_api/maintainability) [![Test Coverage](https://api.codeclimate.com/v1/badges/dc4713a3cb67f6edce65/test_coverage)](https://codeclimate.com/github/ngtk/open_api/test_coverage)
+# OpenApi [![Gem Version](https://badge.fury.io/rb/open_api.svg)](https://badge.fury.io/rb/open_api) [![Build Status](https://travis-ci.org/ngtk/open_api.svg?branch=master)](https://travis-ci.org/ngtk/open_api) [![Maintainability](https://api.codeclimate.com/v1/badges/dc4713a3cb67f6edce65/maintainability)](https://codeclimate.com/github/ngtk/open_api/maintainability) [![Test Coverage](https://api.codeclimate.com/v1/badges/dc4713a3cb67f6edce65/test_coverage)](https://codeclimate.com/github/ngtk/open_api/test_coverage)
 
 `open_api` provides PORO and serializers for OpenAPI and it supports OpenAPI v3.0.1.
 

data/lib/open_api/components.rb

@@ -20,15 +20,15 @@ module OpenApi
       return unless hash
 
       new(
-        schemas: hash["schemas"]&.map { |k, v| [k, Reference.load(v) || Schema.load(v)] }.to_h,
-        responses: hash["responses"]&.map { |k, v| [k, Reference.load(v) || Response.load(v)] }.to_h,
-        parameters: hash["parameters"]&.map { |k, v| [k, Reference.load(v) || Parameter.load(v)] }.to_h,
-        examples: hash["examples"]&.map { |k, v| [k, Reference.load(v) || Example.load(v)] }.to_h,
-        request_bodies: hash["requestBodies"]&.map { |k, v| [k, Reference.load(v) || RequestBody.load(v)] }.to_h,
-        headers: hash["headers"]&.map { |k, v| [k, Reference.load(v) || Header.load(v)] }.to_h,
-        security_schemes: hash["securitySchemes"]&.map { |k, v| [k, Reference.load(v) || SecuritySchema.load(v)] }.to_h,
-        links: hash["links"]&.map { |k, v| [k, Reference.load(v) || Link.load(v)] }.to_h,
-        callbacks: hash["callbacks"]&.map { |k, v| [k, Reference.load(v) || Callback.load(v)] }.to_h,
+        schemas: hash["schemas"]&.map { |k, v| [k, Reference.load(v) || Schema.load(v)] }&.to_h,
+        responses: hash["responses"]&.map { |k, v| [k, Reference.load(v) || Response.load(v)] }&.to_h,
+        parameters: hash["parameters"]&.map { |k, v| [k, Reference.load(v) || Parameter.load(v)] }&.to_h,
+        examples: hash["examples"]&.map { |k, v| [k, Reference.load(v) || Example.load(v)] }&.to_h,
+        request_bodies: hash["requestBodies"]&.map { |k, v| [k, Reference.load(v) || RequestBody.load(v)] }&.to_h,
+        headers: hash["headers"]&.map { |k, v| [k, Reference.load(v) || Header.load(v)] }&.to_h,
+        security_schemes: hash["securitySchemes"]&.map { |k, v| [k, Reference.load(v) || SecuritySchema.load(v)] }&.to_h,
+        links: hash["links"]&.map { |k, v| [k, Reference.load(v) || Link.load(v)] }&.to_h,
+        callbacks: hash["callbacks"]&.map { |k, v| [k, Reference.load(v) || Callback.load(v)] }&.to_h,
       )
     end
   end

data/lib/open_api/schema.rb

@@ -0,0 +1,108 @@
+module OpenApi
+  class Schema
+    prepend EquatableAsContent
+
+    attr_accessor :nullable, :discriminator, :read_only, :write_only, :xml, :external_docs, :example, :deprecated
+
+    def initialize(nullable: false, discriminator: nil, read_only: false, write_only: false, xml: nil, external_docs: nil, example: nil, deprecated: false, **other_fields_hash)
+      self.nullable = nullable
+      self.discriminator = discriminator
+      self.read_only = read_only
+      self.write_only = write_only
+      self.xml = xml
+      self.external_docs = external_docs
+      self.example = example
+      self.deprecated = deprecated
+      self.other_fields_hash = other_fields_hash.symbolize_keys
+
+      other_fields_hash.keys.each { |name| new_field(name) }
+    end
+
+    def method_missing(mid, *args)
+      len = args.length
+      if mname = mid[/.*(?==\z)/m]
+        if len != 1
+          raise ArgumentError, "wrong number of arguments (#{len} for 1)", caller(1)
+        end
+        new_field(mname)
+        other_fields_hash[mname.to_sym] = args[0]
+      elsif len == 0
+        if other_fields_hash.key?(mname.to_s)
+          new_field(mname)
+          other_fields_hash[mname]
+        end
+      else
+        begin
+          super
+        rescue NoMethodError => err
+          err.backtrace.shift
+          raise
+        end
+      end
+    end
+
+    def new_field(name)
+      name = name.to_sym
+      define_singleton_method(name) { other_fields_hash[name] }
+      define_singleton_method("#{name}=") { |value| other_fields_hash[name] = value }
+    end
+
+    def serializable_hash
+      converted_other_fields_hash = other_fields_hash.map { |k, v|
+        value =
+          case k.to_sym
+          when :items then v.serializable_hash
+          when :properties then v.map { |k, v| [k.to_s, v.serializable_hash] }.to_h
+          else
+            v
+          end
+        [k.to_s, value]
+      }.to_h
+
+      {
+        "nullable" => nullable == false ? nil : nullable,
+        "discriminator" => discriminator&.serializable_hash,
+        "readOnly" => read_only == false ? nil : read_only,
+        "writeOnly" => write_only == false ? nil : write_only,
+        "xml" => xml&.serializable_hash,
+        "externalDocs" => external_docs&.serializable_hash,
+        "example" => example,
+        "deprecated" => deprecated == false ? nil : deprecated,
+      }
+        .merge(converted_other_fields_hash)
+        .compact
+    end
+
+    def self.load(hash)
+      other_fields_hash = hash.reject { |key|
+        key.to_sym.in?([:nullable, :discriminator, :readOnly, :writeOnly, :xml, :externalDocs, :example, :deprecated])
+      }.map { |k, v|
+        loaded_value =
+          case k.to_sym
+          when :items then Reference.load(v)
+          when :properties then v.map { |k, v| [k, Reference.new(v) || Schema.new(v)] }.to_h
+          else
+            v
+          end
+
+        [k, loaded_value]
+      }.to_h
+
+      new(
+        nullable: hash["nullable"].nil? ? false : hash["nullable"],
+        discriminator: hash["discriminator"],
+        read_only: hash["readOnly"].nil? ? false : hash["readOnly"],
+        write_only: hash["writeOnly"].nil? ? false : hash["writeOnly"],
+        xml: Xml.load(hash["xml"]),
+        external_docs: ExternalDocumentation.load(hash["externalDocs"]),
+        example: Example.load(hash["example"]),
+        deprecated: hash["deprecated"].nil? ? false : hash["deprecated"],
+        **other_fields_hash.symbolize_keys,
+      )
+    end
+
+    private
+
+    attr_accessor :other_fields_hash
+  end
+end

data/lib/open_api/version.rb

@@ -1,3 +1,3 @@
 module OpenApi
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: open_api
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Kent Nagata
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-05-07 00:00:00.000000000 Z
+date: 2018-05-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -105,6 +105,7 @@ files:
 - ".rspec"
 - ".ruby-version"
 - ".travis.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
@@ -136,6 +137,7 @@ files:
 - lib/open_api/request_body.rb
 - lib/open_api/response.rb
 - lib/open_api/responses.rb
+- lib/open_api/schema.rb
 - lib/open_api/security_requirement.rb
 - lib/open_api/security_schema.rb
 - lib/open_api/serializers.rb