swagger-serializer 0.1.0

data/lib/swagger/schema/parameters.rb

@@ -0,0 +1,73 @@
+require "json/schema/serializer"
+require_relative "./util"
+require_relative "./parameter"
+require_relative "./parameters/deserializer"
+require_relative "./parameters/validator"
+
+module Swagger
+  class Schema
+    class Parameters < Array
+      def [](index)
+        parameter = super(index)
+        Parameter.new(parameter) if parameter
+      end
+
+      def by_name(name)
+        name_str = name.to_s
+        parameter = find { |param| Util.try_hash(param, :name).to_s == name_str }
+        Parameter.new(parameter) if parameter
+      end
+
+      def query
+        select_by("query")
+      end
+
+      def header
+        select_by("header")
+      end
+
+      def path
+        select_by("path")
+      end
+
+      def cookie
+        select_by("cookie")
+      end
+
+      def select_by(in_place)
+        in_place_str = in_place.to_s
+        Parameters.new(select { |param| Util.try_hash(param, :in).to_s == in_place_str })
+      end
+
+      def to_json_schema
+        properties = {}
+        required = []
+        each do |param|
+          parameter = Parameter.new(param)
+          name = parameter.name.to_s
+          properties[name] = parameter.to_json_schema
+          required << name if parameter.required || parameter.path?
+          if Util.try_hash(properties[name], :type).to_s == "string" && !parameter.allowEmptyValue &&
+               Util.try_hash(properties[name], :minLength).nil?
+            properties[name]["minLength"] = 1
+          end
+        end
+        schema = { "type" => "object", "properties" => properties }
+        schema["required"] = required unless required.empty?
+        schema
+      end
+
+      def serializer(options = {})
+        JSON::Schema::Serializer.new(to_json_schema, options)
+      end
+
+      def deserializer
+        Deserializer.new(self)
+      end
+
+      def validator
+        Validator.new(self)
+      end
+    end
+  end
+end

data/lib/swagger/schema/path_item.rb

@@ -0,0 +1,33 @@
+require_relative "./util"
+require_relative "./operation"
+require_relative "./schema_accessor"
+require_relative "./parameters"
+require_relative "./handle_servers"
+
+module Swagger
+  class Schema
+    class PathItem
+      extend SchemaAccessor
+      include HandleServers
+
+      METHODS = %i[get put post delete options head patch trace].freeze
+
+      def initialize(schema)
+        @schema = schema
+      end
+
+      define_schema_accessor :summary, :description
+
+      def parameters
+        Parameters.new(Util.try_hash(@schema, :parameters) || [])
+      end
+
+      METHODS.each do |method|
+        define_method(method) do
+          operation = Util.try_hash(@schema, method)
+          Operation.new(operation, self) if operation
+        end
+      end
+    end
+  end
+end

data/lib/swagger/schema/request_body.rb

@@ -0,0 +1,21 @@
+require_relative "./util"
+require_relative "./schema_accessor"
+require_relative "./content"
+
+module Swagger
+  class Schema
+    class RequestBody
+      extend SchemaAccessor
+
+      def initialize(schema)
+        @schema = schema
+      end
+
+      define_schema_accessor :description, :required
+
+      def content
+        Content.new(Util.try_hash(@schema, :content))
+      end
+    end
+  end
+end

data/lib/swagger/schema/response.rb

@@ -0,0 +1,31 @@
+require_relative "./util"
+require_relative "./schema_accessor"
+require_relative "./content"
+require_relative "./headers"
+
+module Swagger
+  class Schema
+    class Response
+      extend SchemaAccessor
+
+      def initialize(schema)
+        @schema = schema
+      end
+
+      define_schema_accessor :description, :required
+
+      def headers
+        Headers.new(Util.try_hash(@schema, :headers) || [])
+      end
+
+      def content
+        Content.new(Util.try_hash(@schema, :content))
+      end
+
+      def links
+        # TODO
+        Util.try_hash(@schema, :links)
+      end
+    end
+  end
+end

data/lib/swagger/schema/responses.rb

@@ -0,0 +1,16 @@
+require_relative "./util"
+require_relative "./response"
+
+module Swagger
+  class Schema
+    class Responses
+      def initialize(schema)
+        @schema = schema
+      end
+
+      def [](code)
+        Response.new(Util.try_hash_with_integer(@schema, code))
+      end
+    end
+  end
+end

data/lib/swagger/schema/schema_accessor.rb

@@ -0,0 +1,23 @@
+require_relative "./util"
+require "snake_camel/methods"
+
+module Swagger
+  class Schema
+    module SchemaAccessor
+      private
+
+      def define_schema_accessor(*camel_names)
+        camel_names.flatten.each do |name|
+          define_method(name) { Util.try_hash(@schema, name) }
+
+          alias_case name
+        end
+      end
+
+      def alias_case(camel)
+        snake = SnakeCamel::Methods.snakecase(camel.to_s)
+        alias_method snake, camel unless snake == camel
+      end
+    end
+  end
+end

data/lib/swagger/schema/server.rb

@@ -0,0 +1,25 @@
+require_relative "./util"
+require_relative "./schema_accessor"
+
+module Swagger
+  class Schema
+    class Server
+      extend SchemaAccessor
+
+      def initialize(schema)
+        @schema = schema
+      end
+
+      define_schema_accessor :url, :description, :variables
+
+      def complete_url(url_variables = {})
+        use_url = url
+        (variables || {}).each do |name, options|
+          variable = Util.try_hash(url_variables, name) || Util.try_hash(options, :default)
+          use_url.gsub!("{#{name}}", variable.to_s)
+        end
+        use_url
+      end
+    end
+  end
+end

data/lib/swagger/schema/util.rb

@@ -0,0 +1,23 @@
+module Swagger
+  class Schema
+    class Util
+      class << self
+        def try_hash(obj, name)
+          if obj.respond_to?(:"[]")
+            obj[name] || obj[name.is_a?(Symbol) ? name.to_s : name.to_sym]
+          elsif obj.respond_to?(name)
+            obj.send(name)
+          end
+        end
+
+        def try_hash_with_integer(obj, name)
+          if obj.respond_to?(:"[]")
+            obj[name.to_i] || obj[name.to_s] || obj[name.to_s.to_sym]
+          elsif obj.respond_to?(name)
+            obj.send(name)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/swagger/schema.rb

@@ -0,0 +1,44 @@
+require_relative "./schema/component"
+require_relative "./schema/path_item"
+require_relative "./schema/server"
+require_relative "./schema/schema_accessor"
+require_relative "./schema/handle_servers"
+require_relative "./schema/util"
+
+module Swagger
+  class Schema
+    extend SchemaAccessor
+    include HandleServers
+
+    attr_reader :schema
+    attr_reader :lazy_schema
+
+    class << self
+      attr_accessor :current
+
+      def load_file(filepath)
+        new(YAML.load_file(filepath)) # rubocop:disable Airbnb/UnsafeYamlMarshal
+      end
+
+      def load_file_to_current(file_path)
+        @current = load_file(file_path)
+      end
+    end
+
+    def initialize(schema)
+      @schema = schema
+    end
+
+    define_schema_accessor :paths, :components
+
+    def path(path)
+      path_item = Util.try_hash(paths, path)
+      PathItem.new(path_item) if path_item
+    end
+
+    def component(name)
+      component = Util.try_hash(components, name)
+      Component.new(component) if component
+    end
+  end
+end

data/lib/swagger/serializer/model.rb

@@ -0,0 +1,7 @@
+module Swagger::Serializer::Model
+  def serialize(name = self.class.name)
+    serializer =
+      Swagger::Schema.current.component(name).serializer(Swagger::Serializer::Store.current.serializer_options)
+    serializer.serialize(self)
+  end
+end

data/lib/swagger/serializer/rails_controller.rb

@@ -0,0 +1,18 @@
+module Swagger::Serializer::RailsController
+  private
+
+  def render_as_schema(code, format, data)
+    route = swagger_schema_route_from_request
+    operation = Swagger::Schema.current.path(route[:path]).send(route[:method])
+    response_obj = operation.responses[code]
+    serializer = response_obj.content.send(format).serializer(Swagger::Serializer::Store.current.serializer_options)
+    render format => serializer.serialize(data)
+  end
+
+  def swagger_schema_route_from_request
+    Rails.application.routes.router.recognize(request) do |route|
+      path = route.path.spec.to_s.sub("(.:format)", "").gsub(/:(\w+)/, "{\\1}")
+      return { path: path, method: request.method.underscore }
+    end
+  end
+end

data/lib/swagger/serializer/store.rb

@@ -0,0 +1,27 @@
+module Swagger
+  module Serializer
+    class Store
+      class << self
+        def current
+          @current ||= new
+        end
+      end
+
+      attr_reader :serializers
+      attr_accessor :inject_key
+
+      def initialize(serializers = {}, inject_key = "title")
+        @serializers = serializers
+        @inject_key = inject_key
+      end
+
+      def serializer_options
+        { inject_key: inject_key, injectors: @serializers }
+      end
+
+      def <<(klass)
+        @serializers[klass.name.sub(/Serializer$/, "")] = klass
+      end
+    end
+  end
+end

data/lib/swagger/serializer/version.rb

@@ -0,0 +1,5 @@
+module Swagger
+  module Serializer
+    VERSION = "0.1.0".freeze
+  end
+end

data/lib/swagger/serializer.rb

@@ -0,0 +1,36 @@
+require_relative "./serializer/version"
+require_relative "./serializer/rails_controller"
+require_relative "./serializer/model"
+require_relative "./serializer/store"
+require_relative "./schema"
+require "yaml"
+
+module Swagger
+  module Serializer
+    def self.included(klass)
+      Store.current << klass
+
+      def klass.inherited(klass)
+        Store.current << klass
+      end
+    end
+
+    def initialize(model)
+      @model = model
+    end
+
+    def respond_to_missing?(name, include_private)
+      if name == :"[]"
+        false
+      elsif @model.respond_to?(name)
+        true
+      else
+        false
+      end
+    end
+
+    def method_missing(name, *args)
+      @model.public_send(name, *args)
+    end
+  end
+end

data/swagger-serializer.gemspec

@@ -0,0 +1,44 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "swagger/serializer/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "swagger-serializer"
+  spec.version = Swagger::Serializer::VERSION
+  spec.authors = %w[Narazaka]
+  spec.email = %w[info@narazaka.net]
+
+  spec.summary = "Swagger (OpenAPI 3) schema based Serializer"
+  spec.homepage = "https://github.com/Narazaka/swagger-serializer"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = "https://github.com/Narazaka/swagger-serializer.git"
+    spec.metadata["changelog_uri"] = "https://github.com/Narazaka/swagger-serializer/blob/master/CHANGELOG.md"
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files =
+    Dir.chdir(File.expand_path("..", __FILE__)) do
+      `git ls-files -z`.split("\x0").reject { |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 = %w[lib]
+
+  spec.add_dependency "json-schema-serializer", "~> 1.2"
+  spec.add_dependency "snake_camel", "~> 1.1"
+  spec.add_development_dependency "bundler", "~> 2"
+  spec.add_development_dependency "rake", "~> 10.5"
+  spec.add_development_dependency "rspec", "~> 3.9"
+  spec.add_development_dependency "rspec-power_assert", "~> 1.1"
+  spec.add_development_dependency "rubocop", "~> 0.76"
+  spec.add_development_dependency "rubocop-airbnb", "~> 3"
+  spec.add_development_dependency "prettier", ">= 0.16"
+  spec.add_development_dependency "rubocop-config-prettier", "~> 0.1"
+  spec.add_development_dependency "pry-byebug", "~> 3.7"
+  spec.add_development_dependency "yard", "~> 0.9"
+end

metadata

@@ -0,0 +1,255 @@
+--- !ruby/object:Gem::Specification
+name: swagger-serializer
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Narazaka
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-11-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json-schema-serializer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: snake_camel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.5'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+- !ruby/object:Gem::Dependency
+  name: rspec-power_assert
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.76'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.76'
+- !ruby/object:Gem::Dependency
+  name: rubocop-airbnb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: prettier
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.16'
+- !ruby/object:Gem::Dependency
+  name: rubocop-config-prettier
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+description: 
+email:
+- info@narazaka.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".prettierrc"
+- ".rspec"
+- ".rubocop.yml"
+- ".rubocop_airbnb.yml"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/fmt
+- bin/setup
+- lib/swagger/schema.rb
+- lib/swagger/schema/component.rb
+- lib/swagger/schema/content.rb
+- lib/swagger/schema/handle_servers.rb
+- lib/swagger/schema/header.rb
+- lib/swagger/schema/headers.rb
+- lib/swagger/schema/media_type.rb
+- lib/swagger/schema/media_type/deserializer.rb
+- lib/swagger/schema/media_type/validator.rb
+- lib/swagger/schema/operation.rb
+- lib/swagger/schema/parameter.rb
+- lib/swagger/schema/parameter_base.rb
+- lib/swagger/schema/parameters.rb
+- lib/swagger/schema/parameters/deserializer.rb
+- lib/swagger/schema/parameters/validator.rb
+- lib/swagger/schema/path_item.rb
+- lib/swagger/schema/request_body.rb
+- lib/swagger/schema/response.rb
+- lib/swagger/schema/responses.rb
+- lib/swagger/schema/schema_accessor.rb
+- lib/swagger/schema/server.rb
+- lib/swagger/schema/util.rb
+- lib/swagger/serializer.rb
+- lib/swagger/serializer/model.rb
+- lib/swagger/serializer/rails_controller.rb
+- lib/swagger/serializer/store.rb
+- lib/swagger/serializer/version.rb
+- swagger-serializer.gemspec
+homepage: https://github.com/Narazaka/swagger-serializer
+licenses: []
+metadata:
+  homepage_uri: https://github.com/Narazaka/swagger-serializer
+  source_code_uri: https://github.com/Narazaka/swagger-serializer.git
+  changelog_uri: https://github.com/Narazaka/swagger-serializer/blob/master/CHANGELOG.md
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Swagger (OpenAPI 3) schema based Serializer
+test_files: []