dry_open_api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 410e041fe43bb48c3197f1d98e29254c4ed8d9f19f507db94b4a852f198f1702
+  data.tar.gz: 6d51949d99fafddf33b4898632f6ce7eb28fb35eff823e96017bd09b704150c7
+SHA512:
+  metadata.gz: 2d066ca3f18976236fe0436f1058970f2d2a91153984fbda787ef5fa484395505a1a0957c67fe5be70bc8d48221994be3edf7233fc517dbf1f96926d900f4557
+  data.tar.gz: 9804d55aed8fda7e00eff30ffea814e72676e4dba002b1facb1fda454562edb9d13e711f58313ac3a8f25d824080515564aa0321569e9df88cc33cdb20f399dd

data/.github/ISSUE_TEMPLATE/Custom.md

@@ -0,0 +1,10 @@
+---
+name: Why and What
+about: Write reasons first, Then write specific content.
+
+---
+
+## Why
+
+
+## What

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+.rubocop-https---raw-githubusercontent-com-talentplatforms-shared-rubocop-master--talentplatforms-rubocop-yml

data/.rubocop.yml

@@ -0,0 +1,10 @@
+# these files cascade and build the base config of our linting
+inherit_from:
+  - https://raw.githubusercontent.com/talentplatforms/shared-rubocop/master/.talentplatforms-rubocop.yml
+  # - .rubocop_todo.yml
+
+# service specifics start below
+
+# if we need to turn of rules, shut up about it!
+Lint/RedundantCopEnableDirective:
+  Enabled: false

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/Gemfile.lock

@@ -0,0 +1,68 @@
+PATH
+  remote: .
+  specs:
+    dry_open_api (0.1.0)
+      activesupport (~> 6.0)
+      dry-initializer (~> 3.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (6.0.2.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2)
+    bump (0.8.0)
+    coderay (1.1.2)
+    concurrent-ruby (1.1.5)
+    diff-lcs (1.3)
+    docile (1.3.2)
+    dry-initializer (3.0.3)
+    i18n (1.8.1)
+      concurrent-ruby (~> 1.0)
+    json (2.3.0)
+    method_source (0.9.2)
+    minitest (5.13.0)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rake (10.5.0)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.0)
+      rspec-support (~> 3.9.0)
+    rspec-expectations (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.0)
+    simplecov (0.17.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    thread_safe (0.3.6)
+    tzinfo (1.2.6)
+      thread_safe (~> 0.1)
+    zeitwerk (2.2.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bump
+  bundler (~> 2.0.2)
+  dry_open_api!
+  pry
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  simplecov
+
+BUNDLED WITH
+   2.0.2

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,85 @@
+`dry_open_api`
+
+Providing a [dry](https://dry-rb.org/) version of th [open_api gem](https://github.com/ngtk/open_api).
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'dry_open_api'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install dry_open_api
+
+## Usage
+It has two use case:
+
+1. Serializing from PORO to yaml
+2. Deserializing yaml to PORO
+
+### Serializing
+
+```rb
+spec = DryOpenApi::Specification.new(
+  openapi: "3.0.1",
+  info: DryOpenApi::Info.new(
+    title: "Awesome API",
+    description: "It provides something awesome",
+    version: "1.0.0",
+  ),
+  paths: DryOpenApi::Paths.new(
+    "/pets": DryOpenApi::PathItem.new(
+      get: DryOpenApi::Operation.new(
+        description: "Returns all pets from the system that the user has access to",
+        responses: DryOpenApi::Responses.new(
+          "200": DryOpenApi::Response.new(
+            description: "A list of pets.",
+            content: {
+              "application/json": DryOpenApi::MediaType.new(
+                schema: DryOpenApi::Schema.new(
+                  type: "array",
+                  items: DryOpenApi::Reference.new(ref: "#/components/schemas/pet"),
+                )
+              )
+            }
+          )
+        )
+      )
+    )
+  )
+)
+
+yaml = DryOpenApi::Serializers::YamlSerializer.serialize(spec)
+File.write("spec.yml", yaml)
+```
+
+### Deserializing
+
+```rb
+yaml = File.read("spec.yml")
+spec = DryOpenApi::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, run `bundle exec rake bump:patch` to update the version, 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/talentplatforms/dry_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/talentplatforms/dry_open_api/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require "bump/tasks"
+
+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/dry_open_api.gemspec

@@ -0,0 +1,32 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "dry_open_api/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "dry_open_api"
+  spec.version       = DryOpenApi::VERSION
+  spec.authors       = ["Andy Ruck"]
+  spec.email         = ["devops@talentplatforms.net"]
+
+  spec.summary       = "Dry-PORO OpenAPI 3.x"
+  spec.description   = "It provides a dried PORO of OpenAPI specification."
+  spec.homepage      = "https://github.com/talentplatforms/dry_open_api"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activesupport", "~> 6.0"
+  spec.add_runtime_dependency "dry-initializer", "~> 3.0"
+
+  spec.add_development_dependency "bundler", "~> 2.0.2", ">= 2.0.2"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "bump"
+end

data/lib/dry_open_api.rb

@@ -0,0 +1,49 @@
+# Dependant libraries
+require 'active_support'
+require 'active_support/core_ext/hash'
+require 'active_support/core_ext/string/inflections'
+require 'active_support/core_ext/object/inclusion'
+
+# dry_open_api/*
+require 'dry_open_api/equatable_as_content'
+require 'dry_open_api/version'
+require 'dry_open_api/data_types'
+
+# Models
+require 'dry_open_api/specification'
+require 'dry_open_api/info'
+require 'dry_open_api/contact'
+require 'dry_open_api/license'
+require 'dry_open_api/server'
+require 'dry_open_api/server_variable'
+require 'dry_open_api/components'
+require 'dry_open_api/paths'
+require 'dry_open_api/path_item'
+require 'dry_open_api/operation'
+require 'dry_open_api/external_documentation'
+require 'dry_open_api/parameter'
+require 'dry_open_api/request_body'
+require 'dry_open_api/media_type'
+require 'dry_open_api/encoding'
+require 'dry_open_api/responses'
+require 'dry_open_api/response'
+require 'dry_open_api/callback'
+require 'dry_open_api/example'
+require 'dry_open_api/link'
+require 'dry_open_api/header'
+require 'dry_open_api/tag'
+require 'dry_open_api/reference'
+require 'dry_open_api/schema'
+require 'dry_open_api/discriminator'
+require 'dry_open_api/xml'
+require 'dry_open_api/security_schema'
+require 'dry_open_api/o_auth_flows'
+require 'dry_open_api/o_auth_flow'
+require 'dry_open_api/security_requirement'
+
+# Serializer
+require 'dry_open_api/serializers'
+
+# the base module ;)
+module DryOpenApi
+end

data/lib/dry_open_api/callback.rb

@@ -0,0 +1,23 @@
+# open api spec
+module DryOpenApi
+  # 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