grape-swagger-representable 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 302c6de45081fa17e58c7c98afc4ce8e4a94da9e
+  data.tar.gz: 62c98b4e833dd0fe23ac3336b2d67283a3937323
+SHA512:
+  metadata.gz: 72522b40d6499e2bad6cbcd71109532b778e4b9ee24f919c87f65ebc46c4ce447b06ea71deb915967d3d9618e41844e2f9933d7496685c12e158c250b3c791d2
+  data.tar.gz: a353a4b2c38cecad85fb66ae60a5c3b6bd583619d1da2ed18af87d14601feb3f77d8215d75a87b071482e33b8b02a8d89924fd7ab01d0d1d5cd6445fb7173881

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/.rubocop.yml

@@ -0,0 +1,5 @@
+AllCops:
+  Exclude:
+    - vendor/**/*
+
+inherit_from: .rubocop_todo.yml

data/.rubocop_todo.yml

@@ -0,0 +1,38 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2016-05-08 06:18:31 +0300 using RuboCop version 0.39.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 2
+Metrics/AbcSize:
+  Max: 30
+
+# Offense count: 2
+Metrics/CyclomaticComplexity:
+  Max: 11
+
+# Offense count: 65
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes.
+# URISchemes: http, https
+Metrics/LineLength:
+  Max: 152
+
+# Offense count: 2
+# Configuration parameters: CountComments.
+Metrics/MethodLength:
+  Max: 36
+
+# Offense count: 2
+Metrics/PerceivedComplexity:
+  Max: 14
+
+# Offense count: 2
+Style/Documentation:
+  Exclude:
+    - 'spec/**/*'
+    - 'test/**/*'
+    - 'lib/grape-swagger/representable.rb'
+    - 'lib/grape-swagger/representable/parser.rb'

data/.travis.yml

@@ -0,0 +1,17 @@
+language: ruby
+
+cache: bundler
+
+matrix:
+  include:
+    - rvm: 2.3.0
+    - rvm: 2.2
+    - rvm: 2.1
+    - rvm: ruby-head
+    - rvm: jruby-head
+    - rvm: jruby-19mode
+    - rvm: rbx-2
+  allow_failures:
+    - rvm: ruby-head
+    - rvm: jruby-head
+before_install: gem install bundler -v 1.12.1

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in grape-swagger-representable.gemspec
+gemspec
+
+gem 'grape-swagger', github: 'Bugagazavr/grape-swagger', branch: 'representers'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Kirill Zaitsev
+
+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,34 @@
+# GrapeSwagger::Representable [![Build Status](https://travis-ci.org/Bugagazavr/grape-swagger-representable.svg)](https://travis-ci.org/Bugagazavr/grape-swagger-representable)
+
+A simple grape-swagger adapter to allow parse representers as response model
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'grape-swagger-representable'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install grape-swagger-representable
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rspec` to run the tests. You can also run `bin/pry` 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/[USERNAME]/grape-swagger-representable.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

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/pry

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'grape-swagger/representable'
+
+# 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 'pry'
+Pry.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/grape-swagger-representable.gemspec

@@ -0,0 +1,34 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'grape-swagger/representable/version'
+
+Gem::Specification.new do |s|
+  s.name          = 'grape-swagger-representable'
+  s.version       = GrapeSwagger::Representable::VERSION
+  s.authors       = ['Kirill Zaitsev']
+  s.email         = ['kirik910@gmail.com']
+
+  s.summary       = 'Grape swagger adapter to support representable object parsing'
+  s.homepage      = 'https://github.com/Bugagazavr/grape-swagger-representable'
+  s.license       = 'MIT'
+
+  s.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  s.bindir        = 'exe'
+  s.executables   = s.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  s.require_paths = ['lib']
+
+  s.add_runtime_dependency 'grape-swagger', '>= 0.20.2'
+  s.add_runtime_dependency 'representable'
+
+  s.add_development_dependency 'bundler', '~> 1.12'
+  s.add_development_dependency 'rake', '~> 10.0'
+  s.add_development_dependency 'rspec', '~> 3.0'
+  s.add_development_dependency 'rack-test'
+  s.add_development_dependency 'rack-cors'
+  s.add_development_dependency 'rubocop'
+  s.add_development_dependency 'redcarpet' unless RUBY_PLATFORM.eql?('java') || RUBY_ENGINE.eql?('rbx')
+  s.add_development_dependency 'rouge' unless RUBY_PLATFORM.eql?('java') || RUBY_ENGINE.eql?('rbx')
+  s.add_development_dependency 'pry' unless RUBY_PLATFORM.eql?('java') || RUBY_ENGINE.eql?('rbx')
+  s.add_development_dependency 'pry-byebug' unless RUBY_PLATFORM.eql?('java') || RUBY_ENGINE.eql?('rbx')
+end

data/lib/grape-swagger/representable.rb

@@ -0,0 +1,14 @@
+require 'grape-swagger'
+require 'representable'
+
+require 'grape-swagger/representable/version'
+require 'grape-swagger/representable/parser'
+
+module Grape
+  module Swagger
+    module Representable
+    end
+  end
+end
+
+GrapeSwagger.model_parsers.register(::GrapeSwagger::Representable::Parser, ::Representable::Decorator)

data/lib/grape-swagger/representable/parser.rb

@@ -0,0 +1,103 @@
+module GrapeSwagger
+  module Representable
+    class Parser
+      attr_reader :model
+      attr_reader :endpoint
+
+      def initialize(model, endpoint)
+        @model = model
+        @endpoint = endpoint
+      end
+
+      def call
+        parse_representer(model)
+      end
+
+      private
+
+      def parse_representer_property(property)
+        is_a_collection = property.is_a?(::Representable::Hash::Binding::Collection)
+        documentation = property[:documentation] ? property[:documentation].dup : {}
+
+        if property[:decorator] && property[:nested]
+          representer_mapping(property[:decorator], documentation, is_a_collection, false, property[:nested])
+        elsif property[:decorator]
+          representer_mapping(property[:decorator], documentation, is_a_collection, true)
+        elsif property[:nested]
+          representer_mapping(property[:nested], documentation, is_a_collection)
+        else
+          memo = {
+            description: documentation[:desc] || ''
+          }
+
+          data_type = GrapeSwagger::DocMethods::DataType.call(documentation[:type])
+          if GrapeSwagger::DocMethods::DataType.primitive?(data_type)
+            data = GrapeSwagger::DocMethods::DataType.mapping(data_type)
+            memo[:type] = data.first
+            memo[:format] = data.last
+          else
+            memo[:type] = data_type
+          end
+
+          memo[:enum] = documentation[:values] if documentation[:values].is_a?(Array)
+
+          if is_a_collection || documentation[:is_array]
+            memo = {
+              type: :array,
+              items: memo
+            }
+          end
+
+          memo
+        end
+      end
+
+      def representer_mapping(representer, documentation, is_a_collection = false, is_a_decorator = false, nested = nil)
+        if nested.nil? && is_a_decorator
+          name = endpoint.send(:expose_params_from_model, representer)
+
+          if is_a_collection || documentation[:is_array]
+            {
+              type: :array,
+              items: {
+                '$ref' => "#/definitions/#{name}"
+              },
+              description: documentation[:desc] || ''
+            }
+          else
+            {
+              '$ref' => "#/definitions/#{name}",
+              description: documentation[:desc] || ''
+            }
+          end
+        else
+          attributes = parse_representer(representer)
+          attributes = attributes.deep_merge!(parse_representer(nested)) if nested
+
+          if is_a_collection
+            {
+              type: :array,
+              items: {
+                type: :object,
+                properties: attributes
+              },
+              description: documentation[:desc] || ''
+            }
+          else
+            {
+              type: :object,
+              properties: attributes,
+              description: documentation[:desc] || ''
+            }
+          end
+        end
+      end
+
+      def parse_representer(representer)
+        representer.map.each_with_object({}) do |value, property|
+          property[value.name] = parse_representer_property(value)
+        end
+      end
+    end
+  end
+end

data/lib/grape-swagger/representable/version.rb

@@ -0,0 +1,5 @@
+module GrapeSwagger
+  module Representable
+    VERSION = '0.1.0'.freeze
+  end
+end

metadata

@@ -0,0 +1,227 @@
+--- !ruby/object:Gem::Specification
+name: grape-swagger-representable
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Kirill Zaitsev
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-05-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: grape-swagger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.20.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.20.2
+- !ruby/object:Gem::Dependency
+  name: representable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  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: rack-cors
+  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: rubocop
+  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: redcarpet
+  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: rouge
+  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: 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: pry-byebug
+  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: 
+email:
+- kirik910@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/pry
+- bin/setup
+- grape-swagger-representable.gemspec
+- lib/grape-swagger/representable.rb
+- lib/grape-swagger/representable/parser.rb
+- lib/grape-swagger/representable/version.rb
+homepage: https://github.com/Bugagazavr/grape-swagger-representable
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Grape swagger adapter to support representable object parsing
+test_files: []