jsonapi_swagger_helpers 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b1b29089e312228c47932a15abdab6101c4333f0
+  data.tar.gz: b796543726b7546998ce7506914acb976ac7b4b6
+SHA512:
+  metadata.gz: f9ea55809a9cda5a9344aba41453daed0d01e0c91a24947a7e19e320612d6d784631d7e6592d007a67ac48c7c1307431b11e97d7e5d6ee1b5daf931f6fb37896
+  data.tar.gz: 2ea9c3543e2282678de72f05f9852e74ea8d09b90aee1fd60c6475aea9b768f210d5b8fd0b3ab2b97928f80d11da51200b5d5dadea8a3a859180566fc69bbfbe

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.12.5

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in jsonapi_swagger_helpers.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Lee Richmond
+
+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,3 @@
+# JsonapiSwaggerHelpers
+
+[![Build Status](https://travis-ci.org/jsonapi-suite/jsonapi_swagger_helpers.svg?branch=master)](https://travis-ci.org/jsonapi-suite/jsonapi_swagger_helpers)

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 "jsonapi_swagger_helpers"
+
+# 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

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/jsonapi_swagger_helpers.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'jsonapi_swagger_helpers/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "jsonapi_swagger_helpers"
+  spec.version       = JsonapiSwaggerHelpers::VERSION
+  spec.authors       = ["Lee Richmond"]
+  spec.email         = ["lrichmond1@bloomberg.net"]
+
+  spec.summary       = %q{Swagger helpers for jsonapi.org-compatible APIs}
+  spec.description   = %q{Requires jsonapi_suite of libraries}
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'swagger-blocks', '~> 1.3'
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/jsonapi_swagger_helpers.rb

@@ -0,0 +1,122 @@
+require 'swagger/blocks'
+require "jsonapi_swagger_helpers/version"
+require "jsonapi_swagger_helpers/schema_helpers"
+require "jsonapi_swagger_helpers/strong_resource_mixin"
+require "jsonapi_swagger_helpers/resource_mixin"
+require "jsonapi_swagger_helpers/docs_controller_mixin"
+
+module JsonapiSwaggerHelpers
+  def self.prepended(klass)
+    klass.send(:include, StrongResourceMixin)
+  end
+
+  def self.docs_controller
+    @docs_controller ||= ::DocsController
+  end
+
+  def self.docs_controller=(controller)
+    @docs_controller = controller
+  end
+
+  def jsonapi_link
+    "<br/><p><a href='http://jsonapi.org'>JSONAPI-compliant</a> endpoint.</p><br />"
+  end
+
+  def validation_messages(messages)
+    string = "<p><b>Validations:</b><ul>"
+    messages.each do |message|
+      string << "<li>#{message}</li>"
+    end
+    string << "</ul></p>"
+  end
+
+  def jsonapi_index(controller)
+    jsonapi_includes(controller, :index)
+    jsonapi_filters(controller)
+    jsonapi_pagination
+    jsonapi_sorting
+  end
+
+  def jsonapi_show(controller)
+    id_in_url
+    jsonapi_includes(controller, :show)
+  end
+
+  def id_in_url
+    parameter do
+      key :name, :id
+      key :in, :path
+      key :type, :string
+      key :required, true
+      key :description, 'record id'
+    end
+  end
+
+  def jsonapi_filters(controller)
+    filter_names = []
+    controller._jsonapi_compliable.filters.each_pair do |name, opts|
+      filter_names << name
+    end
+
+    filter_names.each do |filter_name|
+      parameter do
+        key :name, "filter[#{filter_name}]"
+        key :in, :query
+        key :type, :string
+        key :required, false
+        key :description, "<a href='http://jsonapi.org/format/#fetching-filtering'>JSONAPI filter</a>"
+
+        items do
+          key :model, :string
+        end
+      end
+    end
+  end
+
+  def jsonapi_pagination
+    parameter do
+      key :name, "page[size]"
+      key :in, :query
+      key :type, :string
+      key :required, false
+      key :description, "<a href='http://jsonapi.org/format/#fetching-pagination'>JSONAPI page size</a>"
+    end
+
+    parameter do
+      key :name, "page[number]"
+      key :in, :query
+      key :type, :string
+      key :required, false
+      key :description, "<a href='http://jsonapi.org/format/#fetching-pagination'>JSONAPI page number</a>"
+    end
+  end
+
+  def jsonapi_sorting
+    parameter do
+      key :name, :sort
+      key :in, :query
+      key :type, :string
+      key :required, false
+      key :description, "<a href='http://jsonapi.org/format/#fetching-sorting'>JSONAPI sort</a>"
+    end
+  end
+
+  def jsonapi_includes(controller, action)
+    includes = controller._jsonapi_compliable.sideloads[:whitelist]
+
+    if includes
+      directive = includes[action]
+      includes  = directive.to_string
+
+      parameter do
+        key :name, :include
+        key :in, :query
+        key :type, :string
+        key :required, false
+        key :description, "<a href='http://jsonapi.org/format/#fetching-includes'>JSONAPI includes</a>: \"#{includes}\""
+      end
+    end
+  end
+end
+
+Swagger::Blocks::OperationNode.prepend(JsonapiSwaggerHelpers)

data/lib/jsonapi_swagger_helpers/docs_controller_mixin.rb

@@ -0,0 +1,13 @@
+module JsonapiSwaggerHelpers
+  module DocsControllerMixin
+    def self.included(klass)
+      klass.send(:include, Swagger::Blocks)
+      klass.extend(ResourceMixin)
+    end
+
+    def index
+      klasses = [self.class, JsonapiSwaggerHelpers::StrongResourceMixin::Schemas]
+      render json: Swagger::Blocks.build_root_json(klasses)
+    end
+  end
+end

data/lib/jsonapi_swagger_helpers/resource_mixin.rb

@@ -0,0 +1,76 @@
+module JsonapiSwaggerHelpers
+  module ResourceMixin
+
+    def jsonapi_resource(base_path, tags: [], descriptions: {}, only: [], except: [])
+      actions   = [:index, :show, :create, :update, :destroy]
+
+      unless only.empty?
+        actions.select! { |a| only.include?(a) }
+      end
+
+      unless except.empty?
+        actions.reject! { |a| except.include?(a) }
+      end
+
+      prefix     = @swagger_root_node.data[:basePath]
+      full_path  = [prefix, base_path].join('/').gsub('//', '/')
+      controller = controller_for(full_path)
+
+      if [:create, :index].any? { |a| actions.include?(a) }
+        swagger_path base_path do
+          if actions.include?(:index)
+            operation :get do
+              key :tags, tags
+              key :description, descriptions[:index]
+              jsonapi_index(controller)
+            end
+          end
+
+          if actions.include?(:create)
+            operation :post do
+              key :tags, tags
+              key :description, descriptions[:create]
+              strong_resource(controller, :create)
+            end
+          end
+        end
+      end
+
+      if [:show, :update, :destroy].any? { |a| actions.include?(a) }
+        swagger_path "#{base_path}/{id}" do
+          if actions.include?(:show)
+            operation :get do
+              key :tags, tags
+              key :description, descriptions[:show]
+              jsonapi_show(controller)
+            end
+          end
+
+          if actions.include?(:update)
+            operation :put do
+              key :tags, tags
+              key :description, descriptions[:update]
+              id_in_url
+              strong_resource(controller, :update)
+            end
+          end
+
+          if actions.include?(:destroy)
+            operation :delete do
+              key :tags, tags
+              key :description, descriptions[:destroy]
+              id_in_url
+            end
+          end
+        end
+      end
+    end
+
+    def controller_for(path)
+      path = path.sub('{id}', '1')
+      route = Rails.application.routes.recognize_path(path)
+      "#{route[:controller]}_controller".classify.constantize
+    end
+
+  end
+end

data/lib/jsonapi_swagger_helpers/schema_helpers.rb

@@ -0,0 +1,78 @@
+module JsonapiSwaggerHelpers
+  class SchemaHelpers
+    def self.attributes_schema
+      lambda do |attributes|
+        property :attributes do
+          key :type, :object
+
+          attributes.each_pair do |name, attr_type|
+            property name do
+              key :name, name
+              key :type, attr_type
+            end
+          end
+        end
+      end
+    end
+
+    def self.relationships_schema
+      lambda do |relationships|
+        property :relationships do
+          key :type, :object
+
+          relationships.each_pair do |relation_name, opts|
+            property relation_name do
+              property :data do
+                if opts[:array]
+                  key :type, :array
+                  items do
+                    if opts[:id]
+                      property :id do
+                        key :type, :string
+                      end
+                    end
+
+                    property :type do
+                      key :type, :string
+                      key :required, true
+                      key :enum, [opts[:jsonapi_type]]
+                    end
+
+                    if opts[:attributes]
+                      instance_exec(opts[:attributes], &SchemaHelpers.attributes_schema)
+                    end
+
+                    if opts[:relationships]
+                      instance_exec(opts[:relationships], &SchemaHelpers.relationships_schema)
+                    end
+                  end
+                else
+                  if opts[:id]
+                    property :id do
+                      key :type, :string
+                    end
+                  end
+
+                  property :type do
+                    key :type, :string
+                    key :required, true
+                    key :enum, [opts[:jsonapi_type]]
+                  end
+
+                  if opts[:attributes]
+                    instance_exec(opts[:attributes], &SchemaHelpers.attributes_schema)
+                  end
+
+                  if opts[:relationships]
+                    instance_exec(opts[:relationships], &SchemaHelpers.relationships_schema)
+                  end
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+
+  end
+end

data/lib/jsonapi_swagger_helpers/strong_resource_mixin.rb

@@ -0,0 +1,120 @@
+module JsonapiSwaggerHelpers
+  module StrongResourceMixin
+
+    class Schemas
+      include Swagger::Blocks
+
+      def self.schema(name, &blk)
+        swagger_schema(name, &blk)
+      end
+    end
+
+    def strong_resource(controller, action)
+      update   = action == :update
+      resource = controller._strong_resources[action]
+      opts     = { jsonapi_type: resource.jsonapi_type }
+
+      if (attributes = strong_resource_attributes(resource, update)).present?
+        opts[:attributes] = attributes
+      end
+
+      if (relationships = strong_resource_relationships(resource, update)).present?
+        opts[:relationships] = relationships
+      end
+
+      jsonapi_payload(SecureRandom.uuid.to_sym, opts)
+    end
+
+    def strong_resource_attributes(resource, is_update = false)
+      attributes = {}
+      resource.attributes.each_pair do |name, opts|
+        type = StrongResources.config.strong_params[opts[:type]][:swagger]
+        attributes[name] = type
+
+        if is_update
+          if resource.destroy?
+            attributes[:_destroy] = :boolean
+          end
+
+          if resource.delete?
+            attributes[:_delete] = :boolean
+          end
+        end
+      end
+
+      attributes = attributes.slice(*resource.only) if !!resource.only
+      attributes = attributes.except(*resource.except) if !!resource.except
+      attributes
+    end
+
+    def strong_resource_relationships(resource, is_update = false)
+      {}.tap do |relations|
+        resource.relations.each_pair do |relation_name, opts|
+          resource = opts[:resource]
+
+          payload = {
+            jsonapi_type: resource.jsonapi_type,
+            id: true,
+            array: resource.has_many?
+          }
+
+          if (attributes = strong_resource_attributes(resource, is_update)).present?
+            payload[:attributes] = attributes
+          end
+
+          if (relationships = strong_resource_relationships(resource, is_update)).present?
+            payload[:relationships] = relationships
+          end
+
+          relations[relation_name] = payload
+        end
+      end
+    end
+
+    def jsonapi_payload(schema_name, payload)
+      jsonapi_input_schema(schema_name, payload)
+
+      parameter do
+        key :name, :payload
+        key :in, :body
+
+        schema do
+          key :'$ref', schema_name
+        end
+      end
+    end
+
+    def jsonapi_input_schema(schema_name,
+                                id: false,
+                                jsonapi_type:,
+                                attributes: nil,
+                                relationships: nil)
+      Schemas.schema(schema_name) do
+        property :data do
+          key :type, :object
+
+          property :type do
+            key :type, :string
+            key :required, true
+            key :enum, [jsonapi_type]
+          end
+
+          if id
+            property :id do
+              key :type, :string
+            end
+          end
+
+          if attributes
+            instance_exec(attributes, &SchemaHelpers.attributes_schema)
+          end
+
+          if relationships
+            instance_exec(relationships, &SchemaHelpers.relationships_schema)
+          end
+        end
+      end
+    end
+
+  end
+end

data/lib/jsonapi_swagger_helpers/version.rb

@@ -0,0 +1,3 @@
+module JsonapiSwaggerHelpers
+  VERSION = "0.1.2"
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: jsonapi_swagger_helpers
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- Lee Richmond
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-09-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: swagger-blocks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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'
+description: Requires jsonapi_suite of libraries
+email:
+- lrichmond1@bloomberg.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- jsonapi_swagger_helpers.gemspec
+- lib/jsonapi_swagger_helpers.rb
+- lib/jsonapi_swagger_helpers/docs_controller_mixin.rb
+- lib/jsonapi_swagger_helpers/resource_mixin.rb
+- lib/jsonapi_swagger_helpers/schema_helpers.rb
+- lib/jsonapi_swagger_helpers/strong_resource_mixin.rb
+- lib/jsonapi_swagger_helpers/version.rb
+homepage: 
+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.4.5.1
+signing_key: 
+specification_version: 4
+summary: Swagger helpers for jsonapi.org-compatible APIs
+test_files: []
+has_rdoc: