Initial

kzaitsev · kzaitsev · commit 39863c60bca7 · 2016-05-08T01:57:36.000+03:00
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
diff --git a/.rspec b/.rspec
@@ -0,0 +1,2 @@
+--format documentation
+--color
diff --git a/.rubocop.yml b/.rubocop.yml
@@ -0,0 +1,5 @@
+AllCops:
+  Exclude:
+    - vendor/**/*
+
+inherit_from: .rubocop_todo.yml
diff --git a/.rubocop_todo.yml b/.rubocop_todo.yml
@@ -0,0 +1,38 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2016-05-08 01:57:12 +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: 69
+
+# Offense count: 1
+Metrics/CyclomaticComplexity:
+  Max: 16
+
+# Offense count: 51
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes.
+# URISchemes: http, https
+Metrics/LineLength:
+  Max: 136
+
+# Offense count: 1
+# Configuration parameters: CountComments.
+Metrics/MethodLength:
+  Max: 27
+
+# Offense count: 1
+Metrics/PerceivedComplexity:
+  Max: 19
+
+# Offense count: 2
+Style/Documentation:
+  Exclude:
+    - 'spec/**/*'
+    - 'test/**/*'
+    - 'lib/grape-swagger/entity.rb'
+    - 'lib/grape-swagger/entity/parser.rb'
diff --git a/.travis.yml b/.travis.yml
@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.12.1
diff --git a/Gemfile b/Gemfile
@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in grape-swagger-entity.gemspec
+gemspec
+
+gem 'grape-swagger', github: 'Bugagazavr/grape-swagger', branch: 'representers'
diff --git a/LICENSE.txt b/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.
diff --git a/README.md b/README.md
@@ -0,0 +1,34 @@
+# GrapeSwagger::Entity [![Build Status](https://travis-ci.org/Bugagazavr/grape-swagger-entity.svg)](https://travis-ci.org/Bugagazavr/grape-swagger-entity)
+
+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-entity'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install grape-swagger-entity
+
+## 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-entity.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
diff --git a/Rakefile b/Rakefile
@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec
diff --git a/bin/pry b/bin/pry
@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'grape-swagger/entity'
+
+# 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
diff --git a/bin/setup b/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
diff --git a/grape-swagger-entity.gemspec b/grape-swagger-entity.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/entity/version'
+
+Gem::Specification.new do |s|
+  s.name          = 'grape-swagger-entity'
+  s.version       = GrapeSwagger::Entity::VERSION
+  s.authors       = ['Kirill Zaitsev']
+  s.email         = ['kirik910@gmail.com']
+
+  s.summary       = 'Grape swagger adapter to support grape-entity object parsing'
+  s.homepage      = 'https://github.com/Bugagazavr/grape-swagger-entity'
+  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 'grape-entity'
+
+  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
diff --git a/lib/grape-swagger/entity.rb b/lib/grape-swagger/entity.rb
@@ -0,0 +1,12 @@
+require 'grape-swagger'
+require 'grape-entity'
+
+require 'grape-swagger/entity/version'
+require 'grape-swagger/entity/parser'
+
+module GrapeSwagger
+  module Entity
+  end
+end
+
+GrapeSwagger.model_parsers.register(::GrapeSwagger::Entity::Parser, ::Grape::Entity)
diff --git a/lib/grape-swagger/entity/parser.rb b/lib/grape-swagger/entity/parser.rb
@@ -0,0 +1,74 @@
+module GrapeSwagger
+  module Entity
+    class Parser
+      attr_reader :model
+      attr_reader :endpoint
+
+      def initialize(model, endpoint)
+        @model = model
+        @endpoint = endpoint
+      end
+
+      def call
+        # TODO: this should only be a temporary hack ;)
+        if ::GrapeEntity::VERSION =~ /0\.4\.\d/
+          parameters = model.exposures ? model.exposures : model.documentation
+        elsif ::GrapeEntity::VERSION =~ /0\.5\.\d/
+          parameters = model.root_exposures.each_with_object({}) do |value, memo|
+            memo[value.attribute] = value.send(:options)
+          end
+        end
+
+        parse_grape_entity_params(parameters)
+      end
+
+      private
+
+      def parse_grape_entity_params(params)
+        return if params.nil?
+
+        params.each_with_object({}) do |x, memo|
+          next if x[1].fetch(:documentation, {}).fetch(:in, nil).to_s == 'header'
+          x[0] = x.last[:as] if x.last[:as]
+
+          model = x.last[:using] if x.last[:using].present?
+          model ||= x.last[:documentation][:type] if x.last[:documentation] && could_it_be_a_model?(x.last[:documentation])
+
+          if model
+            name = endpoint.send(:expose_params_from_model, model)
+            memo[x.first] = if x.last[:documentation] && x.last[:documentation][:is_array]
+                              { 'type' => 'array', 'items' => { '$ref' => "#/definitions/#{name}" } }
+                            else
+                              { '$ref' => "#/definitions/#{name}" }
+                            end
+          else
+            documented_type = x.last[:type]
+            documented_type ||= x.last[:documentation][:type] if x.last[:documentation]
+            data_type = GrapeSwagger::DocMethods::DataType.call(documented_type)
+
+            if GrapeSwagger::DocMethods::DataType.primitive?(data_type)
+              data = GrapeSwagger::DocMethods::DataType.mapping(data_type)
+              memo[x.first] = { type: data.first, format: data.last }
+            else
+              memo[x.first] = { type: data_type }
+            end
+
+            memo[x.first][:enum] = x.last[:values] if x.last[:values] && x.last[:values].is_a?(Array)
+          end
+          memo[x.first][:description] = x.last[:documentation][:desc] if x.last[:documentation] && x.last[:documentation][:desc]
+        end
+      end
+
+      def could_it_be_a_model?(value)
+        (
+          value[:type].to_s.include?('Entity') || value[:type].to_s.include?('Entities')
+        ) || (
+          value[:type] &&
+          value[:type].is_a?(Class) &&
+          !GrapeSwagger::DocMethods::DataType.primitive?(value[:type].name.downcase) &&
+          !value[:type] == Array
+        )
+      end
+    end
+  end
+end
diff --git a/lib/grape-swagger/entity/version.rb b/lib/grape-swagger/entity/version.rb
@@ -0,0 +1,5 @@
+module GrapeSwagger
+  module Entity
+    VERSION = '0.1.0'.freeze
+  end
+end
diff --git a/spec/grape-swagger/entities/response_model_spec.rb b/spec/grape-swagger/entities/response_model_spec.rb
diff --git a/spec/grape-swagger/entity_spec.rb b/spec/grape-swagger/entity_spec.rb
diff --git a/spec/spec_helper.rb b/spec/spec_helper.rb
