swagger_roar 0.0.1.pre.alpha.pre.8

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NzhiYzNlMTMxNjVhZjg2OWZlMDY0MzJiMDMyNzQ4ZDhkNTgzYjUwZg==
+  data.tar.gz: !binary |-
+    ZDFmOWMyODVmYTE1YzU2ZDc3NzlkNWYxZmNlNDE3ODkwZjQxOGZjYQ==
+SHA512:
+  metadata.gz: !binary |-
+    YjAyNjRjODM5YjAxYjAxNThkYTI5N2YzY2RkZTQxYjI5OTVmNmY3YjY5MjM2
+    MjJhZjYxYzI2NDE1ODViMjIxNjgyNGM5NGQ0OGY2ZDhkZGM2NjJjYjM2MTk2
+    ZjRmYzc2NWE5OTZjZGRlNTQ4MjNlYzUxZWEzNWQwNTBjN2NjNzE=
+  data.tar.gz: !binary |-
+    NTYwZjkwOTdjNWNlNmU1NjhlOWQ3YWYwMTU4ZjZiMjYzYjdjNzczZDY2M2Q1
+    MDc3NDVhMzBmMzY5ZmY2MzgxYTE2NmU1MTQwMTRlOGIwOGViMTYwMjhiMzZh
+    ZDA4MDRkNzM5YzlhNTI5MzM2MzZjNzRhYTcyYjkwYTViMmVmOGE=

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.ruby-gemset
+.ruby-version

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,12 @@
+language: ruby
+rvm:
+- 1.9.3
+- 2.1.1
+- 2.0.0
+deploy:
+  provider: rubygems
+  api_key:
+    secure: fccKfNOKwv/CErzezggpOGhnZ1Cz/B8EL8jp6kBilfDKsyoL+gzmp+Z187feLQlJpVmV/JS3beGGC47Ih61FwmxlsPFv19hQuMp8K5AXuJCUQc8RqdaSl6FP0FbeqWjNgzm2HxgBukvJpyX/2XhtzREvTXKRcTu5vF6IkahJN8U=
+  gem: swagger_roar
+  on:
+    repo: ytaras/swagger_roar

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,24 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard :rspec do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+
+  # Rails example
+  watch(%r{^app/(.+)\.rb$})                           { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{^app/(.*)(\.erb|\.haml|\.slim)$})          { |m| "spec/#{m[1]}#{m[2]}_spec.rb" }
+  watch(%r{^app/controllers/(.+)_(controller)\.rb$})  { |m| ["spec/routing/#{m[1]}_routing_spec.rb", "spec/#{m[2]}s/#{m[1]}_#{m[2]}_spec.rb", "spec/acceptance/#{m[1]}_spec.rb"] }
+  watch(%r{^spec/support/(.+)\.rb$})                  { "spec" }
+  watch('config/routes.rb')                           { "spec/routing" }
+  watch('app/controllers/application_controller.rb')  { "spec/controllers" }
+
+  # Capybara features specs
+  watch(%r{^app/views/(.+)/.*\.(erb|haml|slim)$})     { |m| "spec/features/#{m[1]}_spec.rb" }
+
+  # Turnip features and steps
+  watch(%r{^spec/acceptance/(.+)\.feature$})
+  watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$})   { |m| Dir[File.join("**/#{m[1]}.feature")][0] || 'spec/acceptance' }
+end
+

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Yura Taras
+
+MIT License
+
+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,30 @@
+[![Build Status](https://travis-ci.org/ytaras/swagger_roar.svg?branch=master)](https://travis-ci.org/ytaras/swagger_roar)
+# SwaggerRoar
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'swagger_roar'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install swagger_roar
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,10 @@
+require "rspec/core/rake_task"
+require "bundler/gem_tasks"
+
+desc "Build"
+task :default => :spec
+
+desc "Run tests"
+RSpec::Core::RakeTask.new(:spec) do |task|
+  task.rspec_opts = %w(--color --format documentation)
+end

data/lib/swagger_roar.rb

@@ -0,0 +1,23 @@
+require "swagger_roar/version"
+
+module SwaggerRoar
+  def documentation
+    Hash[
+      attrs_hash.map { |k, v|
+        [k.to_sym, v[:documentation]]
+      }
+    ]
+  end
+
+  private
+
+  def attrs_hash
+    a = representable_attrs
+    return a.to_h if a.respond_to? :to_h
+    Hash[
+      a.keys.map { |k|
+        [k.to_sym, a[k]]
+      }
+    ]
+  end
+end

data/lib/swagger_roar/version.rb

@@ -0,0 +1,3 @@
+module SwaggerRoar
+  VERSION = "0.0.1"
+end

data/spec/sample_entities/single_propery_mapping.rb

@@ -0,0 +1,12 @@
+module SinglePropertyMapping
+  class GrapeEntity < Grape::Entity
+    expose :title, documentation: {type: "String", desc: "Status update text"}
+  end
+
+  class RoarRepresenter
+    include Roar::Representer::JSON
+    extend SwaggerRoar
+
+    property :title, documentation: {type: "String", desc: "Status update text"}
+  end
+end

data/spec/sample_mappings.rb

@@ -0,0 +1 @@
+require "sample_mappings/single_propery_mapping"

data/spec/sample_mappings/single_propery_mapping.rb

@@ -0,0 +1,12 @@
+module SinglePropertyMapping
+  class GrapeEntity < Grape::Entity
+    expose :title, documentation: {type: "String", desc: "Status update text"}
+  end
+
+  class RoarRepresenter
+    include Roar::Representer::JSON
+    extend SwaggerRoar
+
+    property :title, documentation: {type: "String", desc: "Status update text"}
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,21 @@
+require "pry"
+require "swagger_roar"
+
+RSpec::Matchers.define :generate_swagger_documentation do
+  match do |m|
+
+    grape_doc(m) == roar_doc(m)
+  end
+
+  def grape_doc(m)
+    "#{m}::GrapeEntity".constantize.documentation
+  end
+
+  def roar_doc(m)
+    "#{m}::RoarRepresenter".constantize.documentation
+  end
+
+  failure_message do |m|
+    "expected that Roar doc would be #{roar_doc(m)}, but was #{grape_doc(m)}"
+  end
+end

data/spec/swagger_roar_spec.rb

@@ -0,0 +1,12 @@
+require "spec_helper"
+require "grape-entity"
+require "roar/representer/json"
+require "sample_mappings"
+
+describe SwaggerRoar do
+  describe 'should generate documentation' do
+    it 'for single property mapping' do
+      expect(SinglePropertyMapping).to generate_swagger_documentation
+    end
+  end
+end

data/spec/version_spec.rb

@@ -0,0 +1,7 @@
+require "spec_helper"
+
+describe SwaggerRoar do
+  it 'is defined' do
+    expect(SwaggerRoar::VERSION).to eq('0.0.1')
+  end
+end

data/swagger_roar.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'swagger_roar/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "swagger_roar"
+  gem.version       = SwaggerRoar::VERSION
+  gem.version       = "#{gem.version}-alpha-#{ENV['TRAVIS_BUILD_NUMBER']}" if ENV['TRAVIS']
+  gem.authors       = ["Yura Taras"]
+  gem.email         = ["yura.taras@gmail.com"]
+  gem.description   = %q{DRY in swagger and roar scenario, generate documentation from roar modelss}
+  gem.summary       = %q{Generate swagger model from roar specification}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'guard'
+  gem.add_development_dependency 'guard-rspec'
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'grape-entity'
+  gem.add_development_dependency 'roar'
+end

metadata

@@ -0,0 +1,150 @@
+--- !ruby/object:Gem::Specification
+name: swagger_roar
+version: !ruby/object:Gem::Version
+  version: 0.0.1.pre.alpha.pre.8
+platform: ruby
+authors:
+- Yura Taras
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: guard
+  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: guard-rspec
+  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: rake
+  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: grape-entity
+  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: roar
+  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: DRY in swagger and roar scenario, generate documentation from roar modelss
+email:
+- yura.taras@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/swagger_roar.rb
+- lib/swagger_roar/version.rb
+- spec/sample_entities/single_propery_mapping.rb
+- spec/sample_mappings.rb
+- spec/sample_mappings/single_propery_mapping.rb
+- spec/spec_helper.rb
+- spec/swagger_roar_spec.rb
+- spec/version_spec.rb
+- swagger_roar.gemspec
+homepage: ''
+licenses: []
+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: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Generate swagger model from roar specification
+test_files:
+- spec/sample_entities/single_propery_mapping.rb
+- spec/sample_mappings.rb
+- spec/sample_mappings/single_propery_mapping.rb
+- spec/spec_helper.rb
+- spec/swagger_roar_spec.rb
+- spec/version_spec.rb