open_api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4dcb8f55e33a66045af98794ffb7683361538f73cfb33f5602a9979541ee772d
+  data.tar.gz: 2d7be42cd44216f877d533404c79ce74e8294ef2622530d0ecbd3a2e1cf21a3e
+SHA512:
+  metadata.gz: d140ad5540fadce4e2a212fec19b40b5b2cb82094566e0dc44c1eec1a1eaa306f2cf8fe1295f09e353811412389526c309cec052221dfe97625ee263d25ea9ca
+  data.tar.gz: d912b8d7a8db740c79ddb5239931ff376d5f94253a086b86b5f107ee5c1cb415338a84ba4fa1a1e81766e5ac0ba511b3e4cceffb2c95558f0a9efe358337398b

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+Gemfile.lock

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.ruby-version

@@ -0,0 +1 @@
+2.5.0

data/.travis.yml

@@ -0,0 +1,15 @@
+env:
+  global:
+    - CC_TEST_REPORTER_ID=618e64226e212a5824797037cb1a71487cdbfb3aa664bddc42a7189fb027f73a
+sudo: false
+language: ruby
+rvm:
+  - 2.4.4
+  - 2.5.1
+before_install: gem install bundler -v 1.16.1
+before_script:
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+  - ./cc-test-reporter before-build
+after_script:
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at ngtknt@me.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in open_api.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Kent Nagata
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,86 @@
+# 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)
+
+`open_api` provides PORO and serializers for OpenAPI and it supports OpenAPI v3.0.1.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'open_api'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install open_api
+
+## Usage
+It has two use case:
+
+1. Serializing from PORO to yaml
+2. Deserializing yaml to PORO
+
+### Serializing
+
+```rb
+spec = OpenApi::Specification.new(
+  openapi: "3.0.1",
+  info: OpenApi::Info.new(
+    title: "Awesome API",
+    description: "It provides something awesome",
+    version: "1.0.0",
+  ),
+  paths: OpenApi::Paths.new(
+    "/pets": OpenApi::PathItem.new(
+      get: OpenApi::Operation.new(
+        description: "Returns all pets from the system that the user has access to",
+        responses: OpenApi::Responses.new(
+          "200": OpenApi::Response.new(
+            description: "A list of pets.",
+            content: {
+              "application/json": OpenApi::MediaType.new(
+                schema: OpenApi::Schema.new(
+                  type: "array",
+                  items: OpenApi::Reference.new(ref: "#/components/schemas/pet"),
+                )
+              )
+            }
+          )
+        )
+      )
+    )
+  )
+)
+
+yaml = OpenApi::Serializers::YamlSerializer.serialize(spec)
+File.write("spec.yml", yaml)
+```
+
+### Deserializing
+
+```rb
+yaml = File.read("spec.yml")
+spec = OpenApi::Serializers::YamlSerializer.deserialize(yaml)
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/ngtk/open_api. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the OpenApi project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/ngtk/open_api/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "open_api"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/open_api/callback.rb

@@ -0,0 +1,22 @@
+module OpenApi
+  # https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.1.md#callback-object
+  class Callback
+    extend Forwardable
+
+    def initialize(**hash)
+      self.hash = hash.with_indifferent_access
+    end
+
+    def_delegator :hash, :[]
+
+    def self.load(hash)
+      return unless hash
+
+      new(**hash.symbolize_keys)
+    end
+
+    private
+
+    attr_accessor :hash
+  end
+end

data/lib/open_api/components.rb

@@ -0,0 +1,35 @@
+module OpenApi
+  class Components
+    prepend EquatableAsContent
+
+    attr_accessor :schemas, :responses, :parameters, :examples, :request_bodies, :headers, :security_schemes, :links, :callbacks
+
+    def initialize(schemas: nil, responses: nil, parameters: nil, examples: nil, request_bodies: nil, headers: nil, security_schemes: nil, links: nil, callbacks: nil)
+      self.schemas = schemas
+      self.responses = responses
+      self.parameters = parameters
+      self.examples = examples
+      self.request_bodies = request_bodies
+      self.headers = headers
+      self.security_schemes = security_schemes
+      self.links = links
+      self.callbacks = callbacks
+    end
+
+    def self.load(hash)
+      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,
+      )
+    end
+  end
+end

data/lib/open_api/contact.rb

@@ -0,0 +1,23 @@
+module OpenApi
+  # https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.1.md#contactObject
+  class Contact
+    prepend EquatableAsContent
+
+    attr_accessor :name, :url, :email
+
+    def initialize(name: nil, url: nil, email: nil)
+      self.name = name
+      self.url = url
+      self.email = email
+    end
+
+    def self.load(hash)
+      return unless hash
+      new(
+        name: hash["name"]&.to_s,
+        url: hash["url"]&.to_s,
+        email: hash["email"]&.to_s,
+      )
+    end
+  end
+end

data/lib/open_api/discriminator.rb

@@ -0,0 +1,40 @@
+module OpenApi
+  # https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.1.md#discriminatorObject
+  class Discriminator
+    prepend EquatableAsContent
+
+    attr_accessor :property_name, :mapping
+
+    def initialize(property_name: nil, mapping: {}, **other_fields_hash)
+      self.property_name = property_name
+      self.mapping = mapping.with_indifferent_access
+      self.other_fields_hash = other_fields_hash
+
+      other_fields_hash.keys.each do |field_name|
+        define_singleton_method(field_name) do
+          other_fields_hash[field_name]
+        end
+        define_singleton_method("#{field_name}=") do |value|
+          other_fields_hash[field_name] = value
+        end
+      end
+    end
+
+    def self.load(hash)
+      return unless hash
+
+      fixed_field_names = %w(propertyName mapping)
+      other_fields_hash = hash.reject { |key| key.to_s.in?(fixed_field_names) }
+
+      new(
+        property_name: hash["propertyName"].to_s,
+        mapping: hash["mapping"],
+        **other_fields_hash.symbolize_keys,
+      )
+    end
+
+    private
+
+    attr_accessor :other_fields_hash
+  end
+end

data/lib/open_api/encoding.rb

@@ -0,0 +1,26 @@
+module OpenApi
+  # https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.1.md#encodingObject
+  class Encoding
+    prepend EquatableAsContent
+
+    attr_accessor :content_type, :headers, :style, :explode, :allow_reserved
+
+    def initialize(content_type: nil, headers: nil, style: nil, explode: nil, allow_reserved: false)
+      self.content_type = content_type
+      self.headers = headers
+      self.style = style
+      self.explode = explode
+      self.allow_reserved = allow_reserved
+    end
+
+    def self.load(hash)
+      new(
+        content_type: hash["contentType"]&.to_s,
+        headers: hash["headers"]&.map { |k, v| [k, Reference.load(v) || Header.load(v)] }.to_h,
+        style: hash["style"]&.to_s,
+        explode: hash["explode"],
+        allow_reserved: hash["allowReserved"].nil? ? false : hash["allowReserved"],
+      )
+    end
+  end
+end

data/lib/open_api/equatable_as_content.rb

@@ -0,0 +1,13 @@
+module OpenApi
+  module EquatableAsContent
+    def ==(other)
+      self.all_instance_variables == other.all_instance_variables
+    end
+
+    protected
+
+    def all_instance_variables
+      instance_variables.map { |name| instance_variable_get(name) }
+    end
+  end
+end

data/lib/open_api/example.rb

@@ -0,0 +1,24 @@
+module OpenApi
+  # https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.1.md#exampleObject
+  class Example
+    attr_accessor :summary, :description, :value, :external_value
+
+    def initialize(summary: nil, description: nil, value: nil, external_value: nil)
+      self.summary = summary
+      self.description = description
+      self.value = value
+      self.external_value = external_value
+    end
+
+    def self.load(hash)
+      return unless hash
+
+      new(
+        summary: hash["summary"]&.to_s,
+        description: hash["description"]&.to_s,
+        value: hash["value"],
+        external_value: hash["externalValue"],
+      )
+    end
+  end
+end

data/lib/open_api/external_documentation.rb

@@ -0,0 +1,20 @@
+module OpenApi
+  # https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.1.md#externalDocumentationObject
+  class ExternalDocumentation
+    attr_accessor :description, :url
+
+    def initialize(description: nil, url:)
+      self.description = description
+      self.url = url
+    end
+
+    def self.load(hash)
+      return unless hash
+
+      new(
+        description: hash["description"]&.to_s,
+        url: hash["url"].to_s,
+      )
+    end
+  end
+end

data/lib/open_api/header.rb

@@ -0,0 +1,42 @@
+module OpenApi
+  # https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.1.md#header-object
+  class Header
+    prepend EquatableAsContent
+
+    attr_accessor :description, :required, :deprecated, :allow_empty_value
+
+    def initialize(description: nil, required: false, deprecated: nil, allow_empty_value: false, **other_fields_hash)
+      self.description = description
+      self.required = required
+      self.deprecated = deprecated
+      self.allow_empty_value = allow_empty_value
+      self.other_fields_hash = other_fields_hash.with_indifferent_access
+
+      other_fields_hash.keys.each do |field_name|
+        define_singleton_method(field_name) do
+          other_fields_hash[field_name]
+        end
+        define_singleton_method("#{field_name}=") do |value|
+          other_fields_hash[field_name] = value
+        end
+      end
+    end
+
+    def self.load(hash)
+      fixed_field_names = [:description, :required, :deprecated, :allowEmptyValue]
+      other_fields_hash = hash.reject { |key| key.to_sym.in?(fixed_field_names) }
+
+      new(
+        description: hash["description"],
+        required: hash["required"].nil? ? false : hash["required"],
+        deprecated: hash["deprecated"].nil? ? false : hash["deprecated"],
+        allow_empty_value: hash["allowEmptyValue"].nil? ? false : hash["allowEmptyValue"],
+        **other_fields_hash.symbolize_keys,
+      )
+    end
+
+    private
+
+    attr_accessor :other_fields_hash
+  end
+end

data/lib/open_api/info.rb

@@ -0,0 +1,39 @@
+module OpenApi
+  # https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.1.md#info-object
+  class Info
+    prepend EquatableAsContent
+
+    attr_accessor :title, :description, :terms_of_service, :contact, :license, :version
+
+    def initialize(title:, description: nil, terms_of_service: nil, contact: nil, license: nil, version:)
+      self.title = title
+      self.description = description
+      self.terms_of_service = terms_of_service
+      self.contact = contact
+      self.license = license
+      self.version = version
+    end
+
+    def serializable_hash
+      {
+        "title" => title.to_s,
+        "description" => description&.to_s,
+        "termsOfService" => terms_of_service&.to_s,
+        "contact" => contact&.serializable_hash,
+        "license" => license&.serializable_hash,
+        "version" => version.to_s,
+      }.compact
+    end
+
+    def self.load(hash)
+      new(
+        title: hash["title"].to_s,
+        description: hash["description"]&.to_s,
+        terms_of_service: hash["termsOfService"]&.to_s,
+        contact: Contact.load(hash["contact"]),
+        license: License.load(hash["license"]),
+        version: hash["version"].to_s,
+      )
+    end
+  end
+end

data/lib/open_api/license.rb

@@ -0,0 +1,20 @@
+module OpenApi
+  # https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.1.md#license-object
+  class License
+    attr_accessor :name, :url
+
+    def initialize(name:, url: nil)
+      self.name = name
+      self.url = url
+    end
+
+    def self.load(hash)
+      return unless hash
+
+      new(
+        name: hash["name"],
+        url: hash["url"],
+      )
+    end
+  end
+end

data/lib/open_api/link.rb

@@ -0,0 +1,50 @@
+module OpenApi
+  # https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.1.md#link-object
+  class Link
+    prepend EquatableAsContent
+
+    attr_accessor :operation_ref, :operation_id, :parameters, :request_body, :description, :server
+
+    def initialize(operation_ref: nil, operation_id: nil, parameters: nil, request_body: nil, description: nil, server: nil, **other_fields_hash)
+      self.operation_ref = operation_ref
+      self.operation_id = operation_id
+      self.parameters = parameters
+      self.request_body = request_body
+      self.description = description
+      self.server = server
+      self.other_fields_hash = other_fields_hash.with_indifferent_access
+
+      other_fields_hash.keys.each do |field_name|
+        define_singleton_method(field_name) do
+          other_fields_hash[field_name]
+        end
+        define_singleton_method("#{field_name}=") do |value|
+          other_fields_hash[field_name] = value
+        end
+      end
+    end
+
+    def self.load(hash)
+      return unless hash
+
+      fixed_field_names = [:operationRef, :operationId, :parameters, :requestBody, :description, :server]
+      other_fields_hash = hash.reject { |key|
+        key.to_sym.in?(fixed_field_names)
+      }.symbolize_keys
+
+      new(
+        operation_ref: hash["operationRef"]&.to_s,
+        operation_id: hash["operationId"]&.to_s,
+        parameters: hash["parameters"],
+        request_body: RequestBody.load(hash["requestBody"]),
+        description: hash["description"]&.to_s,
+        server: Server.load(hash["server"]),
+        **other_fields_hash,
+      )
+    end
+
+    private
+
+    attr_accessor :other_fields_hash
+  end
+end

data/lib/open_api/media_type.rb

@@ -0,0 +1,34 @@
+module OpenApi
+  class MediaType
+    prepend EquatableAsContent
+
+    attr_accessor :schema, :example, :examples, :encoding
+
+    def initialize(schema: nil, example: nil, examples: nil, encoding: nil)
+      self.schema = schema
+      self.example = example
+      self.examples = examples
+      self.encoding = encoding
+    end
+
+    def serializable_hash
+      {
+        "schema" => schema&.serializable_hash,
+        "example" => example,
+        "examples" => examples&.map { |k, v| [k.to_s, v.serializable_hash] }&.to_hash,
+        "encoding" => encoding&.map { |k, v| [k.to_s, v.serializable_hash] }&.to_hash,
+      }.compact
+    end
+
+    def self.load(hash)
+      return unless hash
+
+      new(
+        schema: Reference.load(hash["schema"]) || Schema.load(hash["schema"]),
+        example: hash["example"],
+        examples: hash["examples"]&.map { |k, v| [k, Reference.load(v) || Example.load(v)] }&.to_h,
+        encoding: hash["encoding"]&.map { |k, v| [k, Encoding.load(v)] }&.to_h
+      )
+    end
+  end
+end