dry_open_api 0.1.0

data/lib/dry_open_api/security_requirement.rb

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

data/lib/dry_open_api/security_schema.rb

@@ -0,0 +1,35 @@
+require 'dry-initializer'
+
+module DryOpenApi
+  # https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.1.md#security-scheme-object
+  class SecuritySchema
+    prepend EquatableAsContent
+    extend Dry::Initializer
+
+    option :type, proc(&:to_s)
+    option :name, proc(&:to_s)
+    option :in, proc(&:to_s)
+    option :scheme, proc(&:to_s)
+    option :flows
+    option :open_id_connect_url, proc(&:to_s)
+    option :bearer_format, proc(&:to_s), default: proc { nil }
+    option :description, proc(&:to_s), default: proc { nil }
+
+    # rubocop:disable Metrics/MethodLength
+    def self.load(hash)
+      return unless hash
+
+      new(
+        type: hash['type'],
+        description: hash['description'],
+        name: hash['name'],
+        in: hash['in'],
+        scheme: hash['scheme'],
+        bearer_format: hash['bearerFormat'],
+        flows: OAuthFlows.load(hash['flows']),
+        open_id_connect_url: hash['openIdConnectUrl']
+      )
+    end
+    # rubocop:enable Metrics/MethodLength
+  end
+end

data/lib/dry_open_api/serializers.rb

@@ -0,0 +1,7 @@
+require 'dry_open_api/serializers/yaml_serializer'
+
+module DryOpenApi
+  # initializes the serializers module
+  module Serializers
+  end
+end

data/lib/dry_open_api/serializers/yaml_serializer.rb

@@ -0,0 +1,17 @@
+require 'yaml'
+
+module DryOpenApi
+  module Serializers
+    class YamlSerializer
+      def serialize(specification)
+        hash = specification.serializable_hash
+        YAML.dump(hash)
+      end
+
+      def deserialize(yaml_string)
+        hash = YAML.load(yaml_string)
+        Specification.load(hash)
+      end
+    end
+  end
+end

data/lib/dry_open_api/server.rb

@@ -0,0 +1,21 @@
+require 'dry-initializer'
+
+module DryOpenApi
+  # https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.1.md#server-object
+  class Server
+    prepend EquatableAsContent
+    extend Dry::Initializer
+
+    option :url, proc(&:to_s)
+    option :description, proc(&:to_s), default: proc { nil }
+    option :variables, default: proc { nil }
+
+    def self.load(hash)
+      new(
+        url: hash['url'],
+        description: hash['description'],
+        variables: hash['variables']&.map { |h| ServerVariable.load(h) }
+      )
+    end
+  end
+end

data/lib/dry_open_api/server_variable.rb

@@ -0,0 +1,21 @@
+require 'dry-initializer'
+
+module DryOpenApi
+  # https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.1.md#server-variable-object
+  class ServerVariable
+    prepend EquatableAsContent
+    extend Dry::Initializer
+
+    option :default
+    option :enum, default: proc { nil }
+    option :description, proc(&:to_s), default: proc { nil }
+
+    def self.load(hash)
+      new(
+        enum: hash['enum'],
+        default: hash['default'],
+        description: hash['description']
+      )
+    end
+  end
+end

data/lib/dry_open_api/specification.rb

@@ -0,0 +1,44 @@
+require 'dry-initializer'
+
+module DryOpenApi
+  # https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.1.md#oasObject
+  class Specification
+    prepend EquatableAsContent
+    extend Dry::Initializer
+
+    option :openapi, proc(&:to_s)
+    option :info
+    option :paths
+    option :servers, default: proc { nil }
+    option :components, default: proc { nil }
+    option :security, default: proc { nil }
+    option :tags, default: proc { nil }
+    option :external_docs, default: proc { nil }
+
+    def serializable_hash
+      {
+        'openapi' => openapi,
+        'info' => info.serializable_hash,
+        'paths' => paths.serializable_hash,
+        'components' => components&.serializable_hash,
+        'security' => security&.map(&:serializable_hash),
+        'tags' => tags&.map(&:serializable_hash),
+        'externalDocs' => external_docs&.serializable_hash
+      }.compact
+    end
+
+    def self.load(hash)
+      return unless hash
+
+      new(
+        openapi: hash['openapi'],
+        info: Info.load(hash['info']),
+        paths: Paths.load(hash['paths']),
+        components: Components.load(hash['components']),
+        security: hash['security']&.map { |requirement_hash| SecurityRequirement.load(requirement_hash) },
+        tags: hash['tags']&.map { |tag_hash| Tag.load(tag_hash) },
+        external_docs: ExternalDocumentation.load(hash['externalDocs'])
+      )
+    end
+  end
+end

data/lib/dry_open_api/tag.rb

@@ -0,0 +1,23 @@
+require 'dry-initializer'
+
+module DryOpenApi
+  # https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.1.md#tagObject
+  class Tag
+    prepend EquatableAsContent
+    extend Dry::Initializer
+
+    option :name, proc(&:to_s)
+    option :description, proc(&:to_s), default: proc { nil }
+    option :external_docs, default: proc { nil }
+
+    def self.load(hash)
+      return unless hash
+
+      new(
+        name: hash['name'],
+        description: hash['description'],
+        external_docs: ExternalDocumentation.load(hash['externalDocs']),
+      )
+    end
+  end
+end

data/lib/dry_open_api/version.rb

@@ -0,0 +1,3 @@
+module DryOpenApi
+  VERSION = '0.1.0'.freeze
+end

data/lib/dry_open_api/xml.rb

@@ -0,0 +1,26 @@
+require 'dry-initializer'
+
+module DryOpenApi
+  # https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.1.md#xml-object
+  class Xml
+    extend Dry::Initializer
+
+    option :name, proc(&:to_s), default: proc { nil }
+    option :namespace, proc(&:to_s), default: proc { nil }
+    option :prefix, proc(&:to_s), default: proc { nil }
+    option :attribute, default: proc { false }
+    option :wrapped, default: proc { false }
+
+    def self.load(hash)
+      return unless hash
+
+      new(
+        name: hash['name'],
+        namespace: hash['namespace'],
+        prefix: hash['prefix'],
+        attribute: hash['attribute'],
+        wrapped: hash['wrapped']
+      )
+    end
+  end
+end

metadata

@@ -0,0 +1,211 @@
+--- !ruby/object:Gem::Specification
+name: dry_open_api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Andy Ruck
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-01-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: dry-initializer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bump
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: It provides a dried PORO of OpenAPI specification.
+email:
+- devops@talentplatforms.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/ISSUE_TEMPLATE/Custom.md"
+- ".gitignore"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- dry_open_api.gemspec
+- lib/dry_open_api.rb
+- lib/dry_open_api/callback.rb
+- lib/dry_open_api/components.rb
+- lib/dry_open_api/contact.rb
+- lib/dry_open_api/data_types.rb
+- lib/dry_open_api/discriminator.rb
+- lib/dry_open_api/encoding.rb
+- lib/dry_open_api/equatable_as_content.rb
+- lib/dry_open_api/example.rb
+- lib/dry_open_api/external_documentation.rb
+- lib/dry_open_api/header.rb
+- lib/dry_open_api/info.rb
+- lib/dry_open_api/license.rb
+- lib/dry_open_api/link.rb
+- lib/dry_open_api/media_type.rb
+- lib/dry_open_api/o_auth_flow.rb
+- lib/dry_open_api/o_auth_flows.rb
+- lib/dry_open_api/operation.rb
+- lib/dry_open_api/parameter.rb
+- lib/dry_open_api/path_item.rb
+- lib/dry_open_api/paths.rb
+- lib/dry_open_api/reference.rb
+- lib/dry_open_api/request_body.rb
+- lib/dry_open_api/response.rb
+- lib/dry_open_api/responses.rb
+- lib/dry_open_api/schema.rb
+- lib/dry_open_api/security_requirement.rb
+- lib/dry_open_api/security_schema.rb
+- lib/dry_open_api/serializers.rb
+- lib/dry_open_api/serializers/yaml_serializer.rb
+- lib/dry_open_api/server.rb
+- lib/dry_open_api/server_variable.rb
+- lib/dry_open_api/specification.rb
+- lib/dry_open_api/tag.rb
+- lib/dry_open_api/version.rb
+- lib/dry_open_api/xml.rb
+homepage: https://github.com/talentplatforms/dry_open_api
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Dry-PORO OpenAPI 3.x
+test_files: []