grape-slate 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5e5f0ec63333f2ed9755fbd1a9e739f255c37857
+  data.tar.gz: 1ea43b80a15189cc8f4206ccc9106be2768dffbc
+SHA512:
+  metadata.gz: e91a4c1503f278fb21f166c9776d46da546dadfb0f7bc2a5c03b0a06cd26630eea431fb1483c614bba7304cc6f4b823e868231c4d9029e2678107d50752ab36f
+  data.tar.gz: 54d8ced9b41b87f6d82d9160b3b4849b757bb56671054a48d5321abfe29afe43a1ededab84469e0c7abc794c86faacbefbbf230b1f1d824227046a1a3209a168

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format=progress

data/.rubocop.yml

@@ -0,0 +1,18 @@
+AllCops:
+  Excludes:
+    - Rakefile
+    - vendor/**
+    - bin/**
+
+Documentation:
+  # don't require classes to be documented
+  Enabled: false
+
+Encoding:
+  # no need to always specify encoding
+  Enabled: false
+
+LineLength:
+  # just one more character please
+  Max: 80
+

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+cache: bundler
+rvm:
+  - 2.1.0
+  - 2.0.0
+  - 1.9.3
+  - jruby
+addons:
+  code_climate:
+    repo_token: acf391ea515caa468e74c55532dddebed1e1d32b235bee0845e04700e8c634aa

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in grape-slate.gemspec
+gemspec
+
+gem 'grape', github: 'intridea/grape'
+
+gem 'grape-markdown', path: '/var/gems/grape-markdown'

data/Guardfile

@@ -0,0 +1,12 @@
+# More info at https://github.com/guard/guard#readme
+
+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/" }
+end
+
+guard 'bundler' do
+  watch('Gemfile')
+  watch(/^.+\.gemspec/)
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 John Allen
+
+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,89 @@
+# GrapeSlate
+
+[![Code Climate](https://codeclimate.com/github/connexio-labs/grape-slate.png)](https://codeclimate.com/github/connexio-labs/grape-slate)
+[![Build Status](https://travis-ci.org/connexio-labs/grape-slate.png?branch=master)](https://travis-ci.org/connexio-labs/grape-slate)
+[![Coverage Status](https://coveralls.io/repos/connexio-labs/grape-slate/badge.png)](https://coveralls.io/r/connexio-labs/grape-slate)
+[![Dependency Status](https://gemnasium.com/connexio-labs/grape-slate.png)](https://gemnasium.com/connexio-labs/grape-slate)
+[![Gem Version](https://badge.fury.io/rb/grape-slate.png)](http://badge.fury.io/rb/grape-slate)
+
+Auto generates an [Slate Document](https://github.com/tripit/slate) 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.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'grape', github: 'intridea/grape' # see note above
+    gem 'grape-slate'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install grape-slate
+
+## Usage
+
+Add some metadata about your API and then execute the `generate` method on the `GrapeSlate::Blueprint` class.
+
+### Configuration
+
+Configure details about your api in an initializers or similar:
+
+```ruby
+GrapeSlate.config do |config|
+  # the name of your api
+  config.name               = 'Awesome API'
+  # a description for your api
+  config.description        = 'The awesome description'
+  # the type to use for generated sample id's (`integer` or `uuid`)
+  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
+GrapeSlate.config.request_headers = [
+  { 'Accept-Charset' => 'utf-8' },
+  { 'Connection'     => 'keep-alive' }
+]
+
+# response headers you want documented
+GrapeSlate.config.response_headers = [
+  { 'Content-Length' => '21685' },
+  { 'Connection'     => 'keep-alive' }
+]
+```
+
+### Generation
+
+```ruby
+# supply the class you'd like to document and generate your blueprint
+GrapeSlate::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~~
+* 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?!?
+* ~~Create sample response for list endpoints (array)~~
+* Add support for writing the blueprint to disk
+* Add an option to include root in json
+
+## Contributing
+
+1. Fork it ( http://github.com/connexio-labs/grape-slate/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`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,23 @@
+require 'rubygems'
+require 'bundler'
+Bundler.setup :default, :test, :development
+
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+end
+
+require 'rainbow/ext/string' unless String.respond_to?(:color)
+require 'rubocop/rake_task'
+Rubocop::RakeTask.new(:rubocop)
+
+task default: [:rubocop, :spec]
+
+task :console do
+  require 'pry'
+  require 'grape-slate'
+  ARGV.clear
+  Pry.start
+end

data/grape-slate.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'grape-slate/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'grape-slate'
+  spec.version       = GrapeSlate::VERSION
+  spec.authors       = ['John Allen']
+  spec.email         = ['john@threedogconsulting.com']
+  spec.summary       = %q{Allows for generating a Slate document for your Grape API}
+  spec.description   = %q{Auto generates a Slate (https://github.com/tripit/slate) document from the docuementation that is created by your Grape API}
+  spec.homepage      = 'https://github.com/connexio-labs/grape-slate'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'grape-markdown', '~> 0.0'
+
+  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 'pry', '~> 0.9'
+  spec.add_development_dependency 'guard', '~> 2.4'
+  spec.add_development_dependency 'guard-rspec', '~> 4.2'
+  spec.add_development_dependency 'guard-bundler', '~> 2.0'
+end

data/lib/grape-slate.rb

@@ -0,0 +1,24 @@
+require 'grape-markdown'
+
+module GrapeSlate
+  autoload :Version,         'grape-slate/version'
+  autoload :Config,          'grape-slate/config'
+  autoload :SampleGenerator, 'grape-slate/sample_generator'
+  autoload :Document,        'grape-slate/document'
+
+  def self.config
+    block_given? ? yield(Config) : Config
+  end
+
+  class UnsupportedIDType < StandardError
+    def message
+      'Unsupported id type, supported types are [integer, uuid, bson]'
+    end
+  end
+
+  class BSONNotDefinied < StandardError
+    def message
+      'BSON type id requested but bson library is not present'
+    end
+  end
+end

data/lib/grape-slate/config.rb

@@ -0,0 +1,62 @@
+module GrapeSlate
+  class Config
+    SETTINGS = [
+      :name,
+      :description,
+      :request_headers,
+      :response_headers,
+      :example_id_type,
+      :resource_exclusion,
+      :include_root
+    ]
+
+    class << self
+      attr_accessor(*SETTINGS)
+
+      def request_headers
+        @request_headers ||= []
+      end
+
+      def response_headers
+        @response_headers ||= []
+      end
+
+      def resource_exclusion
+        @resource_exclusion ||= []
+      end
+
+      def include_root
+        @include_root ||= false
+      end
+
+      def supported_id_types
+        [:integer, :uuid, :bson]
+      end
+
+      def example_id_type=(value)
+        fail UnsupportedIDType unless supported_id_types.include?(value)
+
+        if value.to_sym == :bson && !Object.const_defined?('BSON')
+          fail BSONNotDefinied
+        end
+
+        @example_id_type = value
+      end
+
+      def example_id_type
+        @example_id_type ||= :integer
+      end
+
+      def generate_id
+        case example_id_type
+        when :integer
+          SecureRandom.random_number(1000)
+        when :uuid
+          SecureRandom.uuid
+        when :bson
+          BSON::ObjectId.new.to_s
+        end
+      end
+    end
+  end
+end

data/lib/grape-slate/document.rb

@@ -0,0 +1,78 @@
+module GrapeSlate
+  class Document < GrapeMarkdown::Document
+    attr_reader :api_class, :document_template, :properties_template
+
+    delegate(*GrapeMarkdown::Config::SETTINGS, to: 'GrapeSlate::Config')
+
+    def initialize(api_class)
+      @api_class           = api_class
+      @document_template   = template_for(:document)
+      @properties_template = template_for(:properties)
+    end
+
+    def generate
+      ERB.new(document_template, nil, '-').result(binding)
+    end
+
+    def write
+      fail 'Not yet supported'
+    end
+
+    def routes
+      @routes ||= api_class.routes.map do |route|
+        GrapeMarkdown::Route.new(route)
+      end
+    end
+
+    def resources
+      @resources ||= begin
+        grouped_routes = routes.group_by(&:route_name).reject do |name, routes|
+          resource_exclusion.include?(name.to_sym)
+        end
+
+        grouped_routes.map do |name, routes|
+          GrapeMarkdown::Resource.new(name, routes)
+        end
+      end
+    end
+
+    def properties_table(resource)
+      ERB.new(properties_template, nil, '-').result(resource.resource_binding)
+    end
+
+    def formatted_request_headers
+      formatted_headers(GrapeSlate::Config.request_headers)
+    end
+
+    def formatted_response_headers
+      formatted_headers(GrapeSlate::Config.response_headers)
+    end
+
+    def show_request_sample?(route)
+      %w(PUT POST).include?(route.route_method)
+    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?
+
+      spacer  = "\n" + (' ' * 12)
+
+      strings = headers.map do |header|
+        key, value = *header.first
+
+        "#{key}: #{value}"
+      end
+
+      "    + Headers\n" + spacer + strings.join(spacer)
+    end
+  end
+end

data/lib/grape-slate/sample_generator.rb

@@ -0,0 +1,45 @@
+module GrapeSlate
+  class SampleGenerator
+    attr_reader :resource, :root
+
+    delegate :unique_params, to: :resource
+
+    def initialize(resource)
+      @resource = resource
+      @root     = resource.key.singularize
+    end
+
+    def sample(id = false)
+      array = resource.unique_params.map do |param|
+        next if param.name == root
+
+        [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
+      hash = sample
+
+      return unless hash.present?
+
+      JSON.pretty_generate(hash)
+    end
+
+    def response(list = false)
+      hash = sample(true)
+
+      return unless hash.present?
+
+      hash = [hash] if list
+
+      JSON.pretty_generate(hash)
+    end
+  end
+end

data/lib/grape-slate/templates/document.md.erb

@@ -0,0 +1,44 @@
+---
+title: <%= name %> Reference
+
+language_tabs:
+  - shell
+
+toc_footers:
+  - <a href='#'>Sign Up for a Developer Key</a>
+---
+
+# <%= name %>
+
+<%= description %>
+
+<% resources.each do |resource| %>
+# <%= resource.title %>
+  <% resource.namespaced.each do |grouped_resource| %>
+    <% grouped_resource.paths.each do |resource_by_path| %>
+      <% resource_by_path.routes.each do |route| %>
+## <%= route.route_description %>
+
+```shell
+curl http://example.com
+```
+
+> The above command returns JSON structured like this:
+
+```json
+<%= resource.sample_response(route) %>
+```
+<%= route.route_description %>
+
+### HTTP Request
+
+`<%= route.route_method %>`
+
+### URL Parameters
+
+<%= properties_table(resource) %>
+
+      <% end %>
+    <% end %>
+  <% end %>
+<% end %>

data/lib/grape-slate/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-slate/templates/sample.md

@@ -0,0 +1,214 @@
+---
+title: API Reference
+
+language_tabs:
+  - shell
+  - ruby
+  - python
+
+toc_footers:
+ - <a href='#'>Sign Up for a Developer Key</a>
+ - <a href='http://github.com/tripit/slate'>Documentation Powered by Slate</a>
+---
+
+# Introduction
+
+Welcome to the Kittn API! You can use our API to access Kittn API endpoints, which can get information on various cats, kittens, and breeds in our database.
+
+We have language bindings in Shell, Ruby, and Python! You can view code examples in the dark area to the right, and you can switch the programming language of the examples with the tabs in the top right.
+
+This example API documentation page was created with [Slate](http://github.com/tripit/slate). Feel free to edit it and use it as a base for your own API's documentation.
+
+# Authentication
+
+> To authorize, use this code:
+
+```ruby
+require 'kittn'
+
+api = Kittn::APIClient.authorize!('meowmeowmeow')
+```
+
+```python
+import 'kittn'
+
+api = Kittn.authorize('meowmeowmeow')
+```
+
+```shell
+# With shell, you can just pass the correct header with each request
+curl "api_endpoint_here"
+  -H "Authorization: meowmeowmeow"
+```
+
+> Make sure to replace `meowmeowmeow` with your API key.
+
+Kittn uses API keys to allow access to the API. You can register a new Kittn API key at our [developer portal](http://example.com/developers).
+
+Kittn expects for the API key to be included in all API requests to the server in a header that looks like the following:
+
+`Authorization: meowmeowmeow`
+
+<aside class="notice">
+You must replace `meowmeowmeow` with your personal API key.
+</aside>
+
+# Kittens
+
+## Get All Kittens
+
+```ruby
+require 'kittn'
+
+api = Kittn::APIClient.authorize!('meowmeowmeow')
+api.kittens.get
+```
+
+```python
+import 'kittn'
+
+api = Kittn.authorize('meowmeowmeow')
+api.kittens.get()
+```
+
+```shell
+curl "http://example.com/api/kittens"
+  -H "Authorization: meowmeowmeow"
+```
+
+> The above command returns JSON structured like this:
+
+```json
+[
+  {
+    "id": 1,
+    "name": "Fluffums",
+    "breed": "calico",
+    "fluffiness": 6,
+    "cuteness": 7
+  },
+  {
+    "id": 2,
+    "name": "Isis",
+    "breed": "unknown",
+    "fluffiness": 5,
+    "cuteness": 10
+  }
+]
+```
+
+This endpoint retrieves all kittens.
+
+### HTTP Request
+
+`GET http://example.com/kittens`
+
+### Query Parameters
+
+Parameter | Default | Description
+--------- | ------- | -----------
+include_cats | false | If set to true, the result will also include cats.
+available | true | If set to false, the result will include kittens that have already been adopted.
+
+<aside class="success">
+Remember — a happy kitten is an authenticated kitten!
+</aside>
+
+## Get a Specific Kitten
+
+```ruby
+require 'kittn'
+
+api = Kittn::APIClient.authorize!('meowmeowmeow')
+api.kittens.get(2)
+```
+
+```python
+import 'kittn'
+
+api = Kittn.authorize('meowmeowmeow')
+api.kittens.get(2)
+```
+
+```shell
+curl "http://example.com/api/kittens/3"
+  -H "Authorization: meowmeowmeow"
+```
+
+> The above command returns JSON structured like this:
+
+```json
+{
+  "id": 2,
+  "name": "Isis",
+  "breed": "unknown",
+  "fluffiness": 5,
+  "cuteness": 10
+}
+```
+
+This endpoint retrieves a specific kitten.
+
+<aside class="warning">If you're not using an administrator API key, note that some kittens will return 403 Forbidden if they are hidden for admins only.</aside>
+
+### HTTP Request
+
+`GET http://example.com/kittens/<ID>`
+
+### URL Parameters
+
+Parameter | Description
+--------- | -----------
+ID | The ID of the cat to retrieve
+
+# Errors
+
+The Kittn API uses the following error codes:
+
+
+Error Code | Meaning
+---------- | -------
+400 | Bad Request -- Your request sucks
+401 | Unauthorized -- Your API key is wrong
+403 | Forbidden -- The kitten requested is hidden for administrators only
+404 | Not Found -- The specified kitten could not be found
+405 | Method Not Allowed -- You tried to access a kitten with an invalid method
+406 | Not Acceptable -- You requested a format that isn't json
+410 | Gone -- The kitten requested has been removed from our servers
+418 | I'm a teapot
+429 | Too Many Requests -- You're requesting too many kittens! Slown down!
+500 | Internal Server Error -- We had a problem with our server. Try again later.
+503 | Service Unavailable -- We're temporarially offline for maintanance. Please try again later.
+
+
+
+
+<%= properties_table(resource) %>
+  <% resource.namespaced.each do |grouped_resource| %>
+    <% grouped_resource.paths.each do |resource_by_path| %>
+## <%= resource_by_path.header %>
+Actions on the <%= resource.name %> resource
+      <% if resource_by_path.routes.first.route_params.present? %>
++ Parameters
+        <% resource_by_path.routes.first.route_params.each do |param| %>
+    + <%= param.description %>
+        <% end %>
+      <% end %>
+      <% resource_by_path.routes.each do |route| %>
+### <%= route.route_description %>
+<% if show_request_sample?(route) %>
+<%= route.request_description %>
+<%= formatted_request_headers %>
+    + Body
+
+<%= resource.sample_request %>
+<% end %>
+<%= route.response_description %>
+<%= formatted_response_headers %>
+
+    + Body
+
+<%= resource.sample_response(route) %>
+      <% end %>
+    <% end %>
+  <% end %>

data/lib/grape-slate/version.rb

@@ -0,0 +1,3 @@
+module GrapeSlate
+  VERSION = '0.0.1'
+end

data/lib/grape/slate.rb

@@ -0,0 +1 @@
+require 'grape-slate'

data/spec/grape-slate/document_spec.rb

@@ -0,0 +1,56 @@
+require 'spec_helper'
+
+describe GrapeSlate::Document do
+  include_context 'configuration'
+
+  before do
+    GrapeSlate.config do |config|
+      config.name               = name
+      config.description        = description
+      config.resource_exclusion = [:admin]
+    end
+
+    GrapeSlate.config.request_headers = [
+      { 'Accept-Charset' => 'utf-8' },
+      { 'Connection'     => 'keep-alive' }
+    ]
+
+    GrapeSlate.config.response_headers = [
+      { 'Content-Length' => '21685' },
+      { 'Connection'     => 'keep-alive' }
+    ]
+  end
+
+  subject { GrapeSlate::Document.new(SampleApi) }
+
+  context '#generate' do
+    let(:klass) { SampleApi }
+
+    subject { GrapeSlate::Document.new(klass).generate }
+
+    it 'sets the title based on name' do
+      puts subject
+      expect(subject).to include("title: #{name} Reference")
+    end
+
+    it 'lists shell as the language type' do
+      expect(subject).to include('  - shell')
+    end
+
+    it 'creates a header from configuration' do
+      expect(subject).to include("# #{name}")
+    end
+
+    it 'adds the description' do
+      expect(subject).to include(description)
+    end
+
+    # 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
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), 'support'))
+
+require 'grape/slate'
+
+require 'rubygems'
+require 'bundler'
+Bundler.setup :default, :test
+
+require 'coveralls'
+Coveralls.wear!
+
+require 'rspec'
+require 'pry'
+
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }

data/spec/support/config_context.rb

@@ -0,0 +1,13 @@
+shared_context 'configuration' do
+  let(:name)               { 'some api v1' }
+  let(:description)        { 'some blueprint description' }
+  let(:resource_exclusion) { [:admin, :swagger_docs] }
+
+  let(:request_headers) do
+    [{ 'Accept-Charset' => 'utf-8' }]
+  end
+
+  let(:response_headers) do
+    [{ 'Connection'     => 'keep-alive' }]
+  end
+end

data/spec/support/sample_api.rb

@@ -0,0 +1,38 @@
+class SampleApi < Grape::API
+  resource 'widgets' do
+    desc 'widgets list'
+    get  '/' do
+    end
+
+    desc 'individual widget'
+    get ':id' do
+    end
+
+    desc 'create a widget'
+    params do
+      requires :name,
+               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' }
+    end
+    post '/' do
+    end
+
+    desc 'update a widget'
+    params do
+      optional :name, type: 'string', desc: 'the widgets name'
+      optional :description, type: 'string', desc: 'the widgets name'
+    end
+    put  ':id' do
+    end
+  end
+
+  resource 'admin' do
+    get '/' do
+    end
+  end
+end

metadata

@@ -0,0 +1,213 @@
+--- !ruby/object:Gem::Specification
+name: grape-slate
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- John Allen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: grape-markdown
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !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: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.18'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.18'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: guard-bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: Auto generates a Slate (https://github.com/tripit/slate) document from
+  the docuementation that is created by your Grape API
+email:
+- john@threedogconsulting.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- grape-slate.gemspec
+- lib/grape-slate.rb
+- lib/grape-slate/config.rb
+- lib/grape-slate/document.rb
+- lib/grape-slate/sample_generator.rb
+- lib/grape-slate/templates/document.md.erb
+- lib/grape-slate/templates/properties.md.erb
+- lib/grape-slate/templates/sample.md
+- lib/grape-slate/version.rb
+- lib/grape/slate.rb
+- spec/grape-slate/document_spec.rb
+- spec/spec_helper.rb
+- spec/support/config_context.rb
+- spec/support/sample_api.rb
+homepage: https://github.com/connexio-labs/grape-slate
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Allows for generating a Slate document for your Grape API
+test_files:
+- spec/grape-slate/document_spec.rb
+- spec/spec_helper.rb
+- spec/support/config_context.rb
+- spec/support/sample_api.rb
+has_rdoc: