grape-apiary 0.0.4 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f0254ff34136f5e9ec9dd020fc5de5f223ba4a82
-  data.tar.gz: 1b3955dc1d5fcd60451f702aa82e8f00dee139d2
+  metadata.gz: af6793664c67c149446b22cc641327ae4befe6b3
+  data.tar.gz: 8dc668050c54078a9c011b59a3d0ee41928ae3a5
 SHA512:
-  metadata.gz: 48f420f9bc8cca9a22b3cd71523c1892d76972e34502dd64bd4368506af938dc21f199895dc32f5dff06e0b94a752ed6acccd6fddb9c08ffcdd19a3c6960a272
-  data.tar.gz: 58e25392ce55c0c35b022dbb41abf58dfffdb5363c800eb7fa8c29004d53eb585f99f7a2a013853026ae5eb3540d3f336d36f6c793a24d2c6625bb79edcb9c42
+  metadata.gz: 31e332776b5469706fc694d0310222c842b474b699fe065a56c51673e6e7ab5919480d666218984a595cfd43113a5616e52188a58b6908837035a97aced82f2b
+  data.tar.gz: ff66609f82ed054e6e9e7eb26c7f301cb63296ffe3f41931f4efa050557af2109fbecdc9ff7a0cfe3f44207981ee8f7003ae3156260a0d5199b06c112f9d386e

data/.rubocop.yml

@@ -1,8 +1,8 @@
 AllCops:
   Excludes:
     - Rakefile
-    - vendor/**
-    - bin/**
+    - vendor/**/*
+    - bin/**/
 
 Documentation:
   # don't require classes to be documented
@@ -12,7 +12,37 @@ Encoding:
   # no need to always specify encoding
   Enabled: false
 
-LineLength:
-  # just one more character please
-  Max: 80
+AlignParameters:
+  # allow for multi-line methods to have normal indentation.
+  # for example:
+  #
+  # Person.where(
+  #   first_name: 'tom',
+  #   last_name: 'foolery'
+  # )
+  EnforcedStyle: with_fixed_indentation
 
+Style/AlignParameters:
+  # allow for end of if to be aligned with a variable.
+  # for example:
+  #
+  # foo = if a == b
+  #   'bar'
+  # else
+  #   'baz'
+  # end
+  EnforcedStyle: with_fixed_indentation
+
+Style/ElseAlignment:
+  Enabled: false
+
+Lint/EndAlignment:
+  AlignWith: variable
+
+ClassAndModuleChildren:
+  # ok to use compact style when modules are predefined.
+  # for example the following is fine so long as we're sure that 
+  # module MDB has already been required/defined.
+  #
+  # class Foo::Bar; end
+  Enabled: false

data/.travis.yml

@@ -1,9 +1,9 @@
 language: ruby
 cache: bundler
 rvm:
-  - 2.1.0
-  - 2.0.0
-  - 1.9.3
+  - 2.3.0
+  - 2.2.4
+  - 2.1.8
   - jruby
 addons:
   code_climate:

data/CHANGELOG.md

@@ -0,0 +1,11 @@
+# Change Log
+All notable changes to this project will be documented in this file.
+This project adheres to [Semantic Versioning](http://semver.org/).
+
+## 0.1.0 (2016-01-25)
+#### Features
+- [PR #5](https://github.com/technekes/grape-apiary/pull/5) - Rake task persists docs to disk from [@bigfleet](https://github.com/bigfleet).
+
+## 0.0.1 - 0.0.4 (2014-02-10)
+#### Features
+- Initial implementation from [@jallen3d](https://github.com/johnallen3d).

data/Gemfile

@@ -2,17 +2,3 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in grape-apiary.gemspec
 gemspec
-
-gem 'grape', github: 'intridea/grape'
-
-group :development, :test do
-  gem 'coveralls', '~> 0.7'
-  gem 'rspec', '~> 2.14'
-  gem 'bundler', '~> 1.5'
-  gem 'rake', '~> 10.0'
-  gem 'rubocop', '~> 0.18'
-  gem 'pry', '~> 0.9'
-  gem 'guard', '~> 2.4'
-  gem 'guard-rspec', '~> 4.2'
-  gem 'guard-bundler', '~> 2.0'
-end

data/Guardfile

@@ -1,9 +1,9 @@
 # More info at https://github.com/guard/guard#readme
 
-guard 'rspec', :version => 2 do
+guard 'rspec', version: 2 do
   watch(%r{^spec/.+_spec\.rb$})
   watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
-  watch('spec/spec_helper.rb')  { "spec/" }
+  watch('spec/spec_helper.rb')  { 'spec/' }
 end
 
 guard 'bundler' do

data/README.md

@@ -1,22 +1,18 @@
 # GrapeApiary
 
-[![Code Climate](https://codeclimate.com/github/connexio-labs/grape-apiary.png)](https://codeclimate.com/github/connexio-labs/grape-apiary)
-[![Build Status](https://travis-ci.org/connexio-labs/grape-apiary.png?branch=master)](https://travis-ci.org/connexio-labs/grape-apiary)
-[![Coverage Status](https://coveralls.io/repos/connexio-labs/grape-apiary/badge.png)](https://coveralls.io/r/connexio-labs/grape-apiary)
-[![Dependency Status](https://gemnasium.com/connexio-labs/grape-apiary.png)](https://gemnasium.com/connexio-labs/grape-apiary)
+[![Code Climate](https://codeclimate.com/github/technekes/grape-apiary.png)](https://codeclimate.com/github/connexio-labs/grape-apiary)
+[![Build Status](https://travis-ci.org/technekes/grape-apiary.png?branch=master)](https://travis-ci.org/connexio-labs/grape-apiary)
+[![Coverage Status](https://coveralls.io/repos/technekes/grape-apiary/badge.png)](https://coveralls.io/r/connexio-labs/grape-apiary)
+[![Dependency Status](https://gemnasium.com/technekes/grape-apiary.png)](https://gemnasium.com/connexio-labs/grape-apiary)
 [![Gem Version](https://badge.fury.io/rb/grape-apiary.png)](http://badge.fury.io/rb/grape-apiary)
 
-Auto generates an [Apiary Blueprint](http://apiary.io) from the docuementation that is created by your [Grape](https://github.com/intridea/grape) API.
-
-### NOTE
-
-This is an early implementation that makes some assumptions about your API (follows a standard REST pattern) that works with our implementation of Grape API's. There is a new an [unreleased feature in Grape](https://github.com/intridea/grape#parameter-documentation) that allows for appending additional documentation. This project is dependent on this feature in order to create example JSON requests and responses.
+Auto generates an [Apiary Blueprint](http://apiary.io) from the docuementation that is created by your [Grape](https://github.com/ruby-grape/grape) API.
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
-    gem 'grape', github: 'intridea/grape' # see note above
+    gem 'grape'
     gem 'grape-apiary'
 
 And then execute:
@@ -27,10 +23,25 @@ Or install it yourself as:
 
     $ gem install grape-apiary
 
+In order to use the Rake task that can write your generated documents to the filesystem, add this
+stanza to your `Rakefile`:
+
+```
+spec = Gem::Specification.find_by_name 'grape-apiary'
+load "#{spec.gem_dir}/lib/grape-apiary/tasks/grape-apiary.rake"
+```
+
 ## Usage
 
 Add some metadata about your API and then execute the `generate` method on the `GrapeApiary::Blueprint` class.
 
+If you have installed the Rake task, per above, you can write your
+documentation to `docs/grape-apiary.md` with this command:
+
+```
+API=AwesomeAPI bundle exec rake ga:docs
+```
+
 ### Configuration
 
 Configure details about your api in an initializers or similar:
@@ -47,6 +58,8 @@ GrapeApiary.config do |config|
   config.example_id_type    = :uuid
   # resources you do not want documented
   config.resource_exclusion = [:admin, :swagger_doc]
+  # whether or not examples should include a root element (default: false)
+  config.include_root       = true
 end
 
 # request headers you want documented
@@ -71,16 +84,16 @@ GrapeApiary::Blueprint.new(AwesomeAPI).generate
 
 ## TODO
 
-* Add a rake task to simplify generation
-* Add support for listing all of a resources attributes at the resource level as a markdown table
+* ~~Add support for listing all of a resources attributes at the resource level as a markdown table~~
 * Handle ever changing sample id's (don't want git diff's after every generation)
 * Add option to change or remove the sample id field (eg. `_id` vs `id`)
 * What if someone does not use JSON?!?
-* Creat sample response for list endpoints (array)
+* ~~Create sample response for list endpoints (array)~~
+* Add an option to include root in json
 
 ## Contributing
 
-1. Fork it ( http://github.com/<my-github-username>/grape-apiary/fork )
+1. Fork it ( http://github.com/technekes/grape-apiary/fork )
 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`)

data/Rakefile

@@ -11,7 +11,7 @@ end
 
 require 'rainbow/ext/string' unless String.respond_to?(:color)
 require 'rubocop/rake_task'
-Rubocop::RakeTask.new(:rubocop)
+RuboCop::RakeTask.new(:rubocop)
 
 task default: [:rubocop, :spec]
 

data/bin/grape-apiary

@@ -0,0 +1,23 @@
+#!/usr/bin/env ruby
+require 'rake'
+require 'bundler'
+
+raise "Bundler is required.  Please install bundler with 'gem install bundler'" unless defined?(Bundler)
+
+#
+# Example:
+#
+#   grape-apiary grape:docs
+
+# init dependencies
+Bundler.setup
+
+# init rake
+Rake.application.init
+
+# load the rake tasks
+gem_dir = File.expand_path('..',File.dirname(__FILE__))
+load "#{gem_dir}/lib/grape-apiary/tasks/grape-apiary.rake"
+
+# invoke the given task
+Rake.application.invoke_task(ARGV[0])

data/grape-apiary.gemspec

@@ -8,9 +8,7 @@ Gem::Specification.new do |spec|
   spec.version       = GrapeApiary::VERSION
   spec.authors       = ['John Allen']
   spec.email         = ['john@threedogconsulting.com']
-  spec.summary       = %q{Allows for generating an Apiary Blueprint for you Grape API}
-  spec.description   = %q{Auto generates an Apiary (http://apiary.io) Blueprint from the docuementation that is created by your Grape API}
-  spec.homepage      = 'https://github.com/connexio-labs/grape-apiary'
+  spec.homepage      = 'https://github.com/technekes/grape-apiary'
   spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0")
@@ -18,13 +16,23 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
-  spec.add_runtime_dependency 'grape', '~> 0.6'
+  spec.summary = <<-SUMMARY
+    Allows for generating an Apiary Blueprint for you Grape API
+  SUMMARY
+
+  spec.description = <<-DESCRIPTION
+    Auto generates an Apiary (http://apiary.io) Blueprint from the
+    docuementation that is created by your Grape API
+  DESCRIPTION
+
+  spec.add_runtime_dependency 'grape', '~> 0.14'
+  spec.add_runtime_dependency 'activesupport'
 
   spec.add_development_dependency 'coveralls', '~> 0.7'
   spec.add_development_dependency 'rspec', '~> 2.14'
   spec.add_development_dependency 'bundler', '~> 1.5'
   spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'rubocop', '~> 0.18'
+  spec.add_development_dependency 'rubocop', '~> 0.36'
   spec.add_development_dependency 'pry', '~> 0.9'
   spec.add_development_dependency 'guard', '~> 2.4'
   spec.add_development_dependency 'guard-rspec', '~> 4.2'

data/lib/grape-apiary.rb

@@ -1,16 +1,16 @@
+require 'active_support/all' # rubocop:disable Style/FileName
 require 'grape'
-require 'grape-apiary/version'
-require 'grape-apiary/config'
-require 'grape-apiary/parameter'
-require 'grape-apiary/sample_generator'
-require 'grape-apiary/route'
-require 'grape-apiary/resource'
-require 'grape-apiary/blueprint'
 
 module GrapeApiary
-  module_function
+  autoload :Version,         'grape-apiary/version'
+  autoload :Config,          'grape-apiary/config'
+  autoload :Parameter,       'grape-apiary/parameter'
+  autoload :SampleGenerator, 'grape-apiary/sample_generator'
+  autoload :Route,           'grape-apiary/route'
+  autoload :Resource,        'grape-apiary/resource'
+  autoload :Blueprint,       'grape-apiary/blueprint'
 
-  def config
+  def self.config
     block_given? ? yield(Config) : Config
   end
 end

data/lib/grape-apiary/blueprint.rb

@@ -1,30 +1,23 @@
 module GrapeApiary
   class Blueprint
-    attr_reader :api_class, :template
+    attr_reader :api_class, :blueprint_template, :properties_template
 
     delegate(*GrapeApiary::Config::SETTINGS, to: 'GrapeApiary::Config')
 
     def initialize(api_class)
-      @api_class = api_class
+      @api_class           = api_class
+      @blueprint_template  = template_for(:blueprint)
+      @properties_template = template_for(:properties)
     end
 
     def generate
-      ERB.new(template).result(binding)
+      ERB.new(blueprint_template, nil, '-').result(binding)
     end
 
     def write
       fail 'Not yet supported'
     end
 
-    def template
-      @template ||= begin
-        directory = File.dirname(File.expand_path(__FILE__))
-        path = File.join(directory, './templates/blueprint.md.erb')
-
-        File.read(path)
-      end
-    end
-
     def routes
       @routes ||= api_class.routes.map do |route|
         GrapeApiary::Route.new(route)
@@ -33,7 +26,7 @@ module GrapeApiary
 
     def resources
       @resources ||= begin
-        grouped_routes = routes.group_by(&:route_name).reject do |name, routes|
+        grouped_routes = routes.group_by(&:route_name).reject do |name, _|
           resource_exclusion.include?(name.to_sym)
         end
 
@@ -41,6 +34,10 @@ module GrapeApiary
       end
     end
 
+    def properties_table(resource)
+      ERB.new(properties_template, nil, '-').result(resource.resource_binding)
+    end
+
     def formatted_request_headers
       formatted_headers(GrapeApiary::Config.request_headers)
     end
@@ -53,12 +50,15 @@ module GrapeApiary
       %w(PUT POST).include?(route.route_method)
     end
 
-    def routes_binding
-      binding
-    end
-
     private
 
+    def template_for(name)
+      directory = File.dirname(File.expand_path(__FILE__))
+      path = File.join(directory, "./templates/#{name}.md.erb")
+
+      File.read(path)
+    end
+
     def formatted_headers(headers)
       return '' unless headers.present?
 

data/lib/grape-apiary/config.rb

@@ -7,8 +7,9 @@ module GrapeApiary
       :request_headers,
       :response_headers,
       :example_id_type,
-      :resource_exclusion
-    ]
+      :resource_exclusion,
+      :include_root
+    ].freeze
 
     class << self
       attr_accessor(*SETTINGS)
@@ -25,6 +26,10 @@ module GrapeApiary
         @resource_exclusion ||= []
       end
 
+      def include_root
+        @include_root ||= false
+      end
+
       def supported_id_types
         [:integer, :uuid, :bson]
       end

data/lib/grape-apiary/parameter.rb

@@ -1,16 +1,17 @@
 module GrapeApiary
   class Parameter
-    attr_reader :route, :name, :settings
+    attr_reader :route, :full_name, :name, :settings
 
     delegate :route_model, :route_namespace, to: :route
     delegate :requirement, :type, :documentation, :desc, to: :settings
     delegate :example, to: :documentation, allow_nil: true
 
     def initialize(route, name, options)
-      @route    = route
-      @name     = name
-      @name     = name.scan(/\[(.*)\]/).flatten.first if name.include?('[')
-      @settings = parse_options(options)
+      @full_name = name
+      @name      = name
+      @name      = name.scan(/\[(.*)\]/).flatten.first if name.include?('[')
+      @route     = route
+      @settings  = parse_options(options)
     end
 
     def description
@@ -20,14 +21,14 @@ module GrapeApiary
     private
 
     def parse_options(options)
-      options = default_options(options) if options.blank?
+      options = default_options if options.blank?
 
       options[:requirement] = options[:required] ? 'required' : 'optional'
 
       Hashie::Mash.new(options)
     end
 
-    def default_options(options)
+    def default_options
       model = name.include?('_id') ? name.gsub('_id', '') : route.route_model
 
       {

data/lib/grape-apiary/resource.rb

@@ -20,7 +20,7 @@ module GrapeApiary
     end
 
     def paths
-      @paths ||= routes.group_by(&:route_path_without_format).map do |n, routes|
+      @paths ||= routes.group_by(&:route_path_without_format).map do |_, routes|
         Resource.new(name, routes)
       end
     end
@@ -36,8 +36,8 @@ module GrapeApiary
       sample_generator.request
     end
 
-    def sample_response
-      sample_generator.response
+    def sample_response(route)
+      sample_generator.response(route.list?)
     end
 
     def unique_params
@@ -55,5 +55,9 @@ module GrapeApiary
         []
       end
     end
+
+    def resource_binding
+      binding
+    end
   end
 end

data/lib/grape-apiary/route.rb

@@ -5,7 +5,7 @@ module GrapeApiary
     delegate :route_namespace, :route_path, :route_method, to: '__getobj__'
 
     def route_params
-      @route_params ||= __getobj__.route_params.map do |param|
+      @route_params ||= __getobj__.route_params.sort.map do |param|
         Parameter.new(self, *param)
       end
     end
@@ -41,12 +41,12 @@ module GrapeApiary
       "+ Response #{code} (application/json)"
     end
 
-    private
-
     def list?
-      route_method == 'GET' && !route_path.include?(':id')
+      %w(GET POST).include?(route_method) && !route_path.include?(':id')
     end
 
+    private
+
     def request_body?
       !%w(GET DELETE).include?(route_method)
     end

data/lib/grape-apiary/sample_generator.rb

@@ -1,46 +1,60 @@
 module GrapeApiary
   class SampleGenerator
-    attr_reader :resource
+    attr_reader :resource, :root
 
     delegate :unique_params, to: :resource
 
     def initialize(resource)
       @resource = resource
+      @root     = resource.key.singularize
     end
 
-    def sample
-      @sample ||= begin
-        array = resource.unique_params.map do |resource|
-          [resource.name, resource.example]
-        end
+    def sample(id = false)
+      array = resource.unique_params.map do |param|
+        next if param.name == root
 
-        Hash[array]
+        [param.name, param.example]
       end
+
+      hash = Hash[array.compact]
+
+      hash = hash.reverse_merge(id: Config.generate_id) if id
+      hash = { root => hash } if Config.include_root
+
+      hash
     end
 
     def request
-      return unless sample.present?
+      hash = sample
+
+      return unless hash.present?
 
       # format json spaces for blueprint markdown
-      JSON.pretty_generate(sample)
+      JSON
+        .pretty_generate(hash)
         .gsub('{', (' ' * 14) + '{')
         .gsub('}', (' ' * 14) + '}')
         .gsub(/\ {2}\"/, (' ' * 16) + '"')
     end
 
-    def response
-      return unless sample.present?
+    def response(list = false)
+      return unless (hash = sample(true)).present?
 
-      hash = sample.reverse_merge(id: GrapeApiary::Config.generate_id)
-      # sample = [sample] if list?(route)
+      pretty_response_for(list ? [hash] : hash)
+    end
 
-      # format json spaces for blueprint markdown
-      JSON.pretty_generate(hash)
+    private
+
+    # rubocop:disable Metrics/AbcSize
+    def pretty_response_for(hash)
+      JSON
+        .pretty_generate(hash)
         .gsub('[', (' ' * 12) + '[')
         .gsub(']', (' ' * 12) + ']')
         .gsub('{', (' ' * 14) + '{')
         .gsub('}', (' ' * 14) + '}')
         .gsub(/\ {2}\"/, (' ' * 16) + '"')
     end
+    # rubocop:enable Metrics/AbcSize
   end
 end

data/lib/grape-apiary/tasks/grape-apiary.rake

@@ -0,0 +1,15 @@
+namespace :ga do
+  desc 'Produce documentation'
+  task docs: :environment do
+    api = ENV['API'] || ARGV[1]
+    fail 'You must provide the name of an API to document' if api.nil?
+    begin
+      api_class = Object.const_get(api)
+      api_docs = GrapeApiary::Blueprint.new(api_class).generate
+      output_file = 'docs/grape-apiary.md'
+      File.open(output_file, 'w') { |file| file.write(api_docs) }
+    rescue NameError
+      raise "#{api} has not been defined as a Grape API"
+    end
+  end
+end

data/lib/grape-apiary/templates/blueprint.md.erb

@@ -6,9 +6,10 @@ HOST: <%= host %>
 
 <% resources.each do |resource| %>
 # Group <%= resource.title %>
+<%= properties_table(resource) %>
   <% resource.namespaced.each do |grouped_resource| %>
     <% grouped_resource.paths.each do |resource_by_path| %>
-## <%= resource.header %>
+## <%= resource_by_path.header %>
 Actions on the <%= resource.name %> resource
       <% if resource_by_path.routes.first.route_params.present? %>
 + Parameters
@@ -30,7 +31,7 @@ Actions on the <%= resource.name %> resource
 
     + Body
 
-<%= resource.sample_response %>
+<%= resource.sample_response(route) %>
       <% end %>
     <% end %>
   <% end %>

data/lib/grape-apiary/templates/properties.md.erb

@@ -0,0 +1,7 @@
+Properties
+
+| Name | Type | Description |
+|:-----|:-----|:------------|
+<% unique_params.each do |param| -%>
+| <%= param.full_name %> |  <%= param.type %> | <%= param.desc %> |
+<% end -%>

data/lib/grape-apiary/version.rb

@@ -1,3 +1,5 @@
+# Needed until support for v2.3+ https://goo.gl/DyKn74
+# frozen_string_literal: true
 module GrapeApiary
-  VERSION = '0.0.4'
+  VERSION = '0.1.0'.freeze
 end

data/spec/grape-apiary/blueprint_spec.rb

@@ -48,6 +48,10 @@ describe GrapeApiary::Blueprint do
     it 'includes groups for each resource' do
       expect(subject).to include('# Group Widgets')
     end
+
+    it 'includes properties for the resources' do
+      expect(subject).to include('Properties')
+    end
   end
 
   it 'exposes configuration settings' do

data/spec/grape-apiary/config_spec.rb

@@ -23,6 +23,18 @@ describe GrapeApiary::Config do
     expect(subject.description).to eq(description)
   end
 
+  context '.include_root' do
+    it 'defaults to false' do
+      expect(subject.include_root).to be(false)
+    end
+
+    it 'allows for inclusion of the root to be set' do
+      subject.include_root = true
+
+      expect(subject.include_root).to eq(true)
+    end
+  end
+
   context 'headers' do
     [:request_headers, :response_headers].each do |type|
       context type do

data/spec/grape-apiary/resource_spec.rb

@@ -15,7 +15,7 @@ describe GrapeApiary::Resource do
     it 'response generation is delegated to a generator' do
       expect(subject.sample_generator).to receive(:response)
 
-      subject.sample_response
+      subject.sample_response(GrapeApiary::Route.new(Grape::Route.new))
     end
   end
 end

data/spec/grape-apiary/sample_generator_spec.rb

@@ -8,6 +8,7 @@ describe GrapeApiary::SampleGenerator do
       config.host               = host
       config.name               = name
       config.description        = description
+      config.include_root       = false
     end
   end
 

data/spec/support/sample_api.rb

@@ -1,7 +1,7 @@
 class SampleApi < Grape::API
   resource 'widgets' do
     desc 'widgets list'
-    get  '/' do
+    get '/' do
     end
 
     desc 'individual widget'
@@ -11,13 +11,13 @@ class SampleApi < Grape::API
     desc 'create a widget'
     params do
       requires :name,
-               type: 'string',
-               desc: 'the widgets name',
-               documentation: { example: 'super widget' }
+        type: 'string',
+        desc: 'the widgets name',
+        documentation: { example: 'super widget' }
       optional :description,
-               type: 'string',
-               desc: 'the widgets name',
-               documentation: { example: 'the best widget ever made' }
+        type: 'string',
+        desc: 'the widgets name',
+        documentation: { example: 'the best widget ever made' }
     end
     post '/' do
     end
@@ -27,7 +27,7 @@ class SampleApi < Grape::API
       optional :name, type: 'string', desc: 'the widgets name'
       optional :description, type: 'string', desc: 'the widgets name'
     end
-    put  ':id' do
+    put ':id' do
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grape-apiary
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.1.0
 platform: ruby
 authors:
 - John Allen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-10 00:00:00.000000000 Z
+date: 2016-01-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grape
@@ -16,14 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '0.14'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '0.14'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  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: coveralls
   requirement: !ruby/object:Gem::Requirement
@@ -86,14 +100,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.18'
+        version: '0.36'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.18'
+        version: '0.36'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -150,11 +164,13 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
-description: Auto generates an Apiary (http://apiary.io) Blueprint from the docuementation
-  that is created by your Grape API
+description: |2
+      Auto generates an Apiary (http://apiary.io) Blueprint from the
+      docuementation that is created by your Grape API
 email:
 - john@threedogconsulting.com
-executables: []
+executables:
+- grape-apiary
 extensions: []
 extra_rdoc_files: []
 files:
@@ -162,11 +178,13 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - Guardfile
 - LICENSE.txt
 - README.md
 - Rakefile
+- bin/grape-apiary
 - grape-apiary.gemspec
 - lib/grape-apiary.rb
 - lib/grape-apiary/blueprint.rb
@@ -175,7 +193,9 @@ files:
 - lib/grape-apiary/resource.rb
 - lib/grape-apiary/route.rb
 - lib/grape-apiary/sample_generator.rb
+- lib/grape-apiary/tasks/grape-apiary.rake
 - lib/grape-apiary/templates/blueprint.md.erb
+- lib/grape-apiary/templates/properties.md.erb
 - lib/grape-apiary/version.rb
 - lib/grape/apiary.rb
 - spec/grape-apiary/blueprint_spec.rb
@@ -186,7 +206,7 @@ files:
 - spec/spec_helper.rb
 - spec/support/config_context.rb
 - spec/support/sample_api.rb
-homepage: https://github.com/connexio-labs/grape-apiary
+homepage: https://github.com/technekes/grape-apiary
 licenses:
 - MIT
 metadata: {}
@@ -206,7 +226,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Allows for generating an Apiary Blueprint for you Grape API
@@ -219,4 +239,3 @@ test_files:
 - spec/spec_helper.rb
 - spec/support/config_context.rb
 - spec/support/sample_api.rb
-has_rdoc: