swagger-serializer 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8b5999b543f38d6b343d1b788895eb70ca6510fd3d1be4a640ec1f4f9aeeb598
+  data.tar.gz: 426e6c6d4e1ddac1a033f577a5e1531b59b8b8f5a791cda738ec11e5dc97e2fd
+SHA512:
+  metadata.gz: 2801936e0147191a061513a68fc783770515a90d506f368124deaacad1fb0b4411ae7341b898647187e59b59389a616324c5de017cb7bb6b52e16c796242b5a0
+  data.tar.gz: 385677aed112aeb96f2e7399c9698f35886886d5e39a1bd7e2c2f1b767589329b41b1ac1f92eda5289e0008dfcdf64cc370a28b665b26c77f6a74e1aeae44b81

data/.gitignore

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

data/.prettierrc

@@ -0,0 +1,3 @@
+printWidth: 120
+addTrailingCommas: true
+preferSingleQuotes: false

data/.rspec

@@ -0,0 +1,4 @@
+--format documentation
+--color
+--require rspec-power_assert
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,25 @@
+inherit_from:
+  - .rubocop_airbnb.yml
+inherit_gem:
+  rubocop-config-prettier: config/rubocop.yml
+# prettier
+Style/PercentLiteralDelimiters:
+  Description: Use `%`-literal delimiters consistently
+  StyleGuide: https://github.com/rubocop-hq/ruby-style-guide#percent-literal-braces
+  Enabled: false
+  PreferredDelimiters:
+    ! '%': ()
+    ! '%i': ()
+    ! '%q': ()
+    ! '%Q': ()
+    ! '%r': ! '{}'
+    ! '%s': ()
+    ! '%w': ()
+    ! '%W': ()
+    ! '%x': ()
+Airbnb/SimpleModifierConditional:
+  Enabled: false
+Airbnb/OptArgParameters:
+  Enabled: false
+RSpec/EmptyExampleGroup:
+  Enabled: false

data/.rubocop_airbnb.yml

@@ -0,0 +1,2 @@
+require:
+  - rubocop-airbnb

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.5
+before_install: gem install bundler -v 1.17.2

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 swagger-serializer.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2019 Narazaka
+
+This software is provided 'as-is', without any express or implied
+warranty. In no event will the authors be held liable for any damages
+arising from the use of this software.
+
+Permission is granted to anyone to use this software for any purpose,
+including commercial applications, and to alter it and redistribute it
+freely, subject to the following restrictions:
+
+   1. The origin of this software must not be misrepresented; you must not
+   claim that you wrote the original software. If you use this software
+   in a product, an acknowledgment in the product documentation would be
+   appreciated but is not required.
+
+   2. Altered source versions must be plainly marked as such, and must not be
+   misrepresented as being the original software.
+
+   3. This notice may not be removed or altered from any source
+   distribution.

data/README.md

@@ -0,0 +1,162 @@
+# Swagger::Serializer
+
+Swagger (OpenAPI 3) schema based serializer.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'swagger-serializer'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install swagger-serializer
+
+## Usage
+
+### Rails
+
+Write your OpenAPI spec.
+
+```yaml
+# swagger.yml
+openapi: "3.0"
+info:
+  title: example api
+  version: 0.1.0
+components:
+  User: &User
+    title: User
+    type: object
+    properties:
+      id:
+        type: integer
+      name:
+        type: string
+    required: [id]
+paths:
+  /users:
+    get:
+      responses:
+        200:
+          content:
+            application/json:
+              schema:
+                type: array
+                items: *User
+  /users/{id}:
+    get:
+      responses:
+        200:
+          content:
+            application/json:
+              schema: *User
+
+```
+
+Load it in initializer.
+
+```ruby
+# config/initializers/swagger_serializer.rb
+
+Swagger::Schema.load_file_to_current(
+  __dir__ + "/../../swagger.yml",
+)
+
+# Swagger::Schema accepts lazy load. So your swagger schema data instance may also be accepted.
+#
+# class SwaggerData
+#   def paths
+#     load_paths_now
+#   end
+# end
+#
+# Swagger::Schema.current = Swagger::Schema.new(SwaggerData.new)
+```
+
+Use it in controllers.
+
+```ruby
+# app/controllers/application_controller.rb
+class ApplicationController < ActionController::Base
+  include Swagger::Serializer::RailsController
+
+  def render_ok(data)
+    render_as_schema 200, :json, data
+  end
+end
+```
+
+```ruby
+# app/controllers/users_controller.rb
+class UsersController < ApplicationController
+  def index
+    render_ok User.all
+  end
+
+  def show
+    render_ok User.find(params[:id])
+  end
+end
+```
+
+Would you want to customize serialization?
+
+```ruby
+# app/serializers/base_serializer.rb
+class BaseSerializer
+  include Swagger::Serializer
+end
+```
+
+```ruby
+# app/serializers/user_serializer.rb
+class UserSerializer < BaseSerializer
+  def name
+    "#{@model.name}!!!!"
+  end
+end
+```
+
+```ruby
+# app/models/user.rb
+require_dependency "./app/serializers/user_serializer"
+
+class User < ApplicationRecord
+end
+```
+
+Now you can get `{ "id" => 42, "name" => "me!!!!" }`.
+
+This serializer class detection uses the schema's `title` key.
+If you want to use `Foo::BarSerializer`, set `Foo::Bar` to `title` key.
+The key is configurable by `Swagger::Serializer::Store.current.inject_key = "my_inject_key"`.
+
+Sometimes model needs direct serialize.
+
+```ruby
+# app/models/application_record.rb
+class ApplicationRecord < ActiveRecord::Base
+  self.abstract_class = true
+  
+  include Swagger::Serializer::Model
+end
+```
+
+Now you can get serialized result by `p User.first.serialize`.
+
+## 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/Narazaka/swagger-serializer.

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require "yard"
+require "yard/rake/yardoc_task"
+
+RSpec::Core::RakeTask.new(:spec)
+YARD::Rake::YardocTask.new
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "swagger/serializer"
+
+# 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.
+
+require "pry"
+Pry.start

data/bin/fmt

@@ -0,0 +1,9 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle exec rubocop -a
+bundle exec rbprettier --write "**/*.rb" "**/*.rake" "**/*.gemspec"
+
+# Do any other automated setup that you need to do here

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/swagger/schema/component.rb

@@ -0,0 +1,17 @@
+require "json/schema/serializer"
+
+module Swagger
+  class Schema
+    class Component
+      attr_reader :schema
+
+      def initialize(schema)
+        @schema = schema
+      end
+
+      def serializer(options = {})
+        JSON::Schema::Serializer.new(@schema, options)
+      end
+    end
+  end
+end

data/lib/swagger/schema/content.rb

@@ -0,0 +1,25 @@
+require_relative "./util"
+require_relative "./media_type"
+
+module Swagger
+  class Schema
+    class Content
+      def initialize(schema)
+        @schema = schema
+      end
+
+      def [](type)
+        schema = Util.try_hash(@schema, type)
+        MediaType.new(schema) if schema
+      end
+
+      def self.shortcut(name, type)
+        define_method(name) { self[type] }
+      end
+
+      shortcut :json, "application/json"
+      shortcut :xml, "application/xml"
+      shortcut :plain, "text/plain"
+    end
+  end
+end

data/lib/swagger/schema/handle_servers.rb

@@ -0,0 +1,20 @@
+require_relative "./util"
+require_relative "./server"
+
+module Swagger
+  class Schema
+    module HandleServers
+      def servers
+        Util.try_hash(@schema, :servers)
+      end
+
+      def server(index)
+        Server.new(servers[index])
+      end
+
+      def server_by_description(description)
+        Server.new(servers.find { |server| server.description == description })
+      end
+    end
+  end
+end

data/lib/swagger/schema/header.rb

@@ -0,0 +1,7 @@
+require_relative "./parameter_base"
+
+module Swagger
+  class Schema
+    class Header < ParameterBase; end
+  end
+end

data/lib/swagger/schema/headers.rb

@@ -0,0 +1,37 @@
+require_relative "./util"
+require_relative "./header"
+
+module Swagger
+  class Schema
+    class Headers
+      def initialize(schema)
+        @schema = schema
+      end
+
+      def [](name)
+        header = Util.try_hash(@schema, name)
+        Header.new(header) if header
+      end
+
+      def to_json_schema
+        return { "type" => "object" } unless @schema
+
+        properties = {}
+        required = []
+        @schema.each do |_name, param|
+          name = _name.to_s
+          header = Header.new(param)
+          properties[name] = header.to_json_schema
+          required << name if header.required
+          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
+    end
+  end
+end

data/lib/swagger/schema/media_type/deserializer.rb

@@ -0,0 +1,12 @@
+require "json/schema/serializer"
+require_relative "../util"
+
+module Swagger
+  class Schema
+    class MediaType
+      class Deserializer < JSON::Schema::Serializer
+        alias_method :deserialize, :serialize
+      end
+    end
+  end
+end

data/lib/swagger/schema/media_type/validator.rb

@@ -0,0 +1,18 @@
+require_relative "../util"
+
+module Swagger
+  class Schema
+    class MediaType
+      class Validator
+        def initialize(schema)
+          @schema = schema
+        end
+
+        def validate(data)
+          @parameters.to_json_schema
+          # validate
+        end
+      end
+    end
+  end
+end

data/lib/swagger/schema/media_type.rb

@@ -0,0 +1,30 @@
+require "json/schema/serializer"
+require_relative "./schema_accessor"
+require_relative "./media_type/deserializer"
+require_relative "./media_type/validator"
+
+module Swagger
+  class Schema
+    class MediaType
+      extend SchemaAccessor
+
+      def initialize(schema)
+        @schema = schema
+      end
+
+      define_schema_accessor :schema, :example, :examples, :encoding
+
+      def serializer(options = {})
+        JSON::Schema::Serializer.new(schema, options)
+      end
+
+      def deserializer
+        Deserializer.new(schema)
+      end
+
+      def validator
+        Validator.new(schema)
+      end
+    end
+  end
+end

data/lib/swagger/schema/operation.rb

@@ -0,0 +1,35 @@
+require_relative "./util"
+require_relative "./path_item"
+require_relative "./schema_accessor"
+require_relative "./parameters"
+require_relative "./request_body"
+require_relative "./responses"
+
+module Swagger
+  class Schema
+    class Operation
+      extend SchemaAccessor
+
+      def initialize(schema, path_item = nil)
+        @schema = schema
+        @path_item = path_item
+      end
+
+      define_schema_accessor %i[tags summary description externalDocs operationId deprecated callbacks security]
+
+      def parameters
+        Parameters.new((@path_item&.parameters || []) + (Util.try_hash(@schema, :parameters) || []))
+      end
+
+      def requestBody
+        RequestBody.new(Util.try_hash(@schema, :requestBody))
+      end
+
+      alias_method :request_body, :requestBody
+
+      def responses
+        Responses.new(Util.try_hash(@schema, :responses))
+      end
+    end
+  end
+end

data/lib/swagger/schema/parameter.rb

@@ -0,0 +1,15 @@
+require_relative "./util"
+require_relative "./schema_accessor"
+require_relative "./parameter_base"
+
+module Swagger
+  class Schema
+    class Parameter < ParameterBase
+      extend SchemaAccessor
+
+      define_schema_accessor :name, :in
+
+      %w[path query header cookie].each { |name| define_method(:"#{name}?") { self.in.to_s == name } }
+    end
+  end
+end

data/lib/swagger/schema/parameter_base.rb

@@ -0,0 +1,31 @@
+require_relative "./util"
+require_relative "./schema_accessor"
+
+module Swagger
+  class Schema
+    class ParameterBase
+      extend SchemaAccessor
+
+      def initialize(schema)
+        @schema = schema
+      end
+
+      define_schema_accessor %i[
+                               description
+                               required
+                               deprecated
+                               allowEmptyValue
+                               style
+                               explode
+                               allowReserved
+                               schema
+                               example
+                               examples
+                             ].freeze
+
+      def to_json_schema
+        schema
+      end
+    end
+  end
+end

data/lib/swagger/schema/parameters/deserializer.rb

@@ -0,0 +1,33 @@
+require "json/schema/serializer"
+require_relative "../util"
+
+module Swagger
+  class Schema
+    class Parameters < Array
+      class Deserializer
+        def initialize(parameters)
+          @parameters = parameters
+        end
+
+        def data(data)
+          DataDeserializer.new(@parameters, @data)
+        end
+
+        class DataDeserializer
+          def initialize(parameters, data)
+            @parameters = parameters
+            @data = data
+          end
+
+          def [](name)
+            parameter = @parameters.by_name(name)
+            value = Util.try_hash(data, name)
+            return nil if value.nil? && !parameter.required && !parameter.path?
+
+            JSON::Schema::Serializer.new(parameter.to_json_schema).serialize(value)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/swagger/schema/parameters/validator.rb

@@ -0,0 +1,18 @@
+require_relative "../util"
+
+module Swagger
+  class Schema
+    class Parameters < Array
+      class Validator
+        def initialize(parameters)
+          @parameters = parameters
+        end
+
+        def validate(data)
+          @parameters.to_json_schema
+          # validate
+        end
+      end
+    end
+  end
+end