grape-apiary 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 52206e764a472e2d8f633d64fd3bbc539cc88925
-  data.tar.gz: d8d6e2db710aa896c9803109eac91a3642800d88
+  metadata.gz: 4b15d2669d75c2f5461216dc111cb0680cf4ef03
+  data.tar.gz: 7fae72c31f7d7b15050f170af438bae065fd62e2
 SHA512:
-  metadata.gz: d9980ad74abc11410812d277ef93358bc28d977b378b63f82f0f9164a9c81a50e4581b4aef331329519f87ef52ffae3ddf4e5df50338555b0af42b3dfbf4a987
-  data.tar.gz: 4327574f995b557a30c69d9b2f5f193c0820cfc975c3ce72f697e42fde054ae3ce0a9e629b1b0b5cef71affa5611b2489766edbd6a5d803a1fc7721ee65d7b5a
+  metadata.gz: b746ab57f5703d7f0791a8c35bf257c9d2e87c8d9a8f2b5db4d347793a065e59b277a0bc1f16325dded4c03f80d8488afbab340bfbc0859150029b15b9643c07
+  data.tar.gz: 33f12c650f2518b7c5fb0570278bb70f4e684d5f524091862e73a3554884823d4b9763ad733d92b36d3f9e6ba85c415137aeae605cd38e0b344c387842940a8c

data/.rspec

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

data/.travis.yml

@@ -4,7 +4,7 @@ rvm:
   - 2.1.0
   - 2.0.0
   - 1.9.3
-  - jruby-19mode
+  - jruby
 addons:
   code_climate:
     repo_token: acf391ea515caa468e74c55532dddebed1e1d32b235bee0845e04700e8c634aa

data/Gemfile

@@ -2,3 +2,17 @@ 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

@@ -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/README.md

@@ -6,12 +6,17 @@
 [![Dependency Status](https://gemnasium.com/connexio-labs/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 API.
+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.
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
+    gem 'grape', github: 'intridea/grape' # see note above
     gem 'grape-apiary'
 
 And then execute:
@@ -24,9 +29,11 @@ Or install it yourself as:
 
 ## Usage
 
+Add some metadata about your API and then execute the `generate` method on the `GrapeApiary::Blueprint` class.
+
 ### Configuration
 
-Configure details about your api in an initializers or similar
+Configure details about your api in an initializers or similar:
 
 ```ruby
 GrapeApiary.config do |config|
@@ -36,21 +43,22 @@ GrapeApiary.config do |config|
   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]
 end
 
-# headers you want documented
+# request headers you want documented
 GrapeApiary.config.request_headers = [
   { 'Accept-Charset' => 'utf-8' },
-  { 'Connection'     => 'keep-alive' },
-  { 'Content-Type'   => 'application/json' }
+  { 'Connection'     => 'keep-alive' }
 ]
 
+# response headers you want documented
 GrapeApiary.config.response_headers = [
   { 'Content-Length' => '21685' },
-  { 'Connection'     => 'keep-alive' },
-  { 'Content-Type'   => 'application/json' }
+  { 'Connection'     => 'keep-alive' }
 ]
 ```
 
@@ -63,6 +71,12 @@ 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
+* 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)
 
 ## Contributing
 

data/Rakefile

@@ -1,4 +1,8 @@
-require 'bundler/gem_tasks'
+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|

data/grape-apiary.gemspec

@@ -26,4 +26,7 @@ Gem::Specification.new do |spec|
   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-apiary.rb

@@ -5,7 +5,6 @@ require 'grape-apiary/parameter'
 require 'grape-apiary/sample_generator'
 require 'grape-apiary/route'
 require 'grape-apiary/resource'
-require 'grape-apiary/routes'
 require 'grape-apiary/blueprint'
 
 module GrapeApiary
@@ -15,3 +14,15 @@ module GrapeApiary
     block_given? ? yield(Config) : Config
   end
 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

data/lib/grape-apiary/blueprint.rb

@@ -1,11 +1,11 @@
 module GrapeApiary
   class Blueprint
-    attr_reader :api_class, :template, :binding
+    attr_reader :api_class, :template
+
+    delegate(*GrapeApiary::Config::SETTINGS, to: 'GrapeApiary::Config')
 
     def initialize(api_class)
       @api_class = api_class
-      @template  = File.read('./lib/grape-apiary/templates/blueprint.md.erb')
-      @binding   = Routes.new(api_class).routes_binding
     end
 
     def generate
@@ -13,6 +13,62 @@ module GrapeApiary
     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)
+      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 { |name, routes| Resource.new(name, routes) }
+      end
+    end
+
+    def formatted_request_headers
+      formatted_headers(GrapeApiary::Config.request_headers)
+    end
+
+    def formatted_response_headers
+      formatted_headers(GrapeApiary::Config.response_headers)
+    end
+
+    def show_request_sample?(route)
+      %w(PUT POST).include?(route.route_method)
+    end
+
+    def routes_binding
+      binding
+    end
+
+    private
+
+    def formatted_headers(headers)
+      spacer  = "\n" + (' ' * 12)
+
+      strings = headers.map do |header|
+        key, value = *header.first
+
+        "#{key}: #{value}"
+      end
+
+      strings.join(spacer)
     end
   end
 end

data/lib/grape-apiary/config.rb

@@ -6,6 +6,7 @@ module GrapeApiary
       :description,
       :request_headers,
       :response_headers,
+      :example_id_type,
       :resource_exclusion
     ]
 
@@ -23,6 +24,35 @@ module GrapeApiary
       def resource_exclusion
         @resource_exclusion ||= []
       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-apiary/parameter.rb

@@ -2,8 +2,9 @@ module GrapeApiary
   class Parameter
     attr_reader :route, :name, :settings
 
-    delegate :route_model, :route_namespace,       to: :route
-    delegate :requirement, :type, :example, :desc, to: :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
@@ -30,11 +31,13 @@ module GrapeApiary
       model = name.include?('_id') ? name.gsub('_id', '') : route.route_model
 
       {
-        required:     true,
-        requirement:  'required',
-        type:         'uuid',
-        desc:         "the `id` of the `#{model}`",
-        example:      SecureRandom.uuid
+        required:       true,
+        requirement:    'required',
+        type:           'uuid',
+        desc:           "the `id` of the `#{model}`",
+        documentation:  {
+          example:      GrapeApiary::Config.generate_id
+        }
       }
     end
   end

data/lib/grape-apiary/resource.rb

@@ -1,11 +1,12 @@
 module GrapeApiary
   class Resource
-    attr_reader :key, :name, :routes
+    attr_reader :key, :name, :routes, :sample_generator
 
     def initialize(key, routes)
-      @key    = key
-      @name   = key.humanize
-      @routes = routes
+      @key              = key
+      @name             = key.humanize
+      @routes           = routes
+      @sample_generator = SampleGenerator.new(self)
     end
 
     def title
@@ -32,15 +33,25 @@ module GrapeApiary
     end
 
     def sample_request
-      SampleGenerator.new(self).request
+      sample_generator.request
     end
 
     def sample_response
-      SampleGenerator.new(self).response
+      sample_generator.response
     end
 
     def unique_params
-      # params = routes.map(&:route_params)
+      # TODO: this is a hack, assuming that the resource has a POST or PUT
+      # route that defines all of the parameters that would define the resource
+      potential = routes.select do |route|
+        %w(POST PUT).include?(route.route_method)
+      end
+
+      if potential.present?
+        potential.first.route_params
+      else
+        []
+      end
     end
   end
 end

data/lib/grape-apiary/sample_generator.rb

@@ -2,19 +2,45 @@ module GrapeApiary
   class SampleGenerator
     attr_reader :resource
 
+    delegate :unique_params, to: :resource
+
     def initialize(resource)
       @resource = resource
     end
 
     def sample
+      @sample ||= begin
+        array = resource.unique_params.map do |resource|
+          [resource.name, resource.example]
+        end
+
+        Hash[array]
+      end
     end
 
     def request
-      {}.to_json
+      return unless sample.present?
+
+      # format json spaces for blueprint markdown
+      JSON.pretty_generate(sample)
+        .gsub('{', (' ' * 14) + '{')
+        .gsub('}', (' ' * 14) + '}')
+        .gsub(/\ {2}\"/, (' ' * 16) + '"')
     end
 
     def response
-      {}.to_json
+      return unless sample.present?
+
+      hash = sample.reverse_merge(id: GrapeApiary::Config.generate_id)
+      # sample = [sample] if list?(route)
+
+      # format json spaces for blueprint markdown
+      JSON.pretty_generate(hash)
+        .gsub('[', (' ' * 12) + '[')
+        .gsub(']', (' ' * 12) + ']')
+        .gsub('{', (' ' * 14) + '{')
+        .gsub('}', (' ' * 14) + '}')
+        .gsub(/\ {2}\"/, (' ' * 16) + '"')
     end
   end
 end

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

@@ -27,11 +27,14 @@ Actions on the <%= resource.name %> resource
 
 <%= resource.sample_request %>
 <% end %>
+<%= route.request_description %>
     + Headers
 
             <%= formatted_response_headers %>
 
     + Body
+
+<%= resource.sample_response %>
       <% end %>
     <% end %>
   <% end %>

data/lib/grape-apiary/version.rb

@@ -1,3 +1,3 @@
 module GrapeApiary
-  VERSION = '0.0.2'
+  VERSION = '0.0.3'
 end

data/spec/grape-apiary/blueprint_spec.rb

@@ -3,26 +3,28 @@ require 'spec_helper'
 describe GrapeApiary::Blueprint do
   include_context 'configuration'
 
-  context '#generate' do
-    before do
-      GrapeApiary.config do |config|
-        config.host               = host
-        config.name               = name
-        config.description        = description
-        config.resource_exclusion = [:admin]
-      end
+  before do
+    GrapeApiary.config do |config|
+      config.host               = host
+      config.name               = name
+      config.description        = description
+      config.resource_exclusion = [:admin]
+    end
 
-      GrapeApiary.config.request_headers = [
-        { 'Accept-Charset' => 'utf-8' },
-        { 'Connection'     => 'keep-alive' }
-      ]
+    GrapeApiary.config.request_headers = [
+      { 'Accept-Charset' => 'utf-8' },
+      { 'Connection'     => 'keep-alive' }
+    ]
 
-      GrapeApiary.config.response_headers = [
-        { 'Content-Length' => '21685' },
-        { 'Connection'     => 'keep-alive' }
-      ]
-    end
+    GrapeApiary.config.response_headers = [
+      { 'Content-Length' => '21685' },
+      { 'Connection'     => 'keep-alive' }
+    ]
+  end
+
+  subject { GrapeApiary::Blueprint.new(SampleApi) }
 
+  context '#generate' do
     let(:klass) { SampleApi }
 
     subject { GrapeApiary::Blueprint.new(klass).generate }
@@ -47,4 +49,32 @@ describe GrapeApiary::Blueprint do
       expect(subject).to include('# Group Widgets')
     end
   end
+
+  it 'exposes configuration settings' do
+    GrapeApiary::Config::SETTINGS.each do |setting|
+      expect(subject.send(setting)).to eq(GrapeApiary.config.send(setting))
+    end
+  end
+
+  it 'exposes the raw routes of the given api' do
+    expect(subject.routes).to eq(SampleApi.routes)
+  end
+
+  context '#resources' do
+    let(:unique_routes) { subject.routes.map(&:route_name).uniq }
+
+    let(:included_routes) do
+      unique_routes.reject do |name|
+        GrapeApiary.config.resource_exclusion.include?(name.to_sym)
+      end
+    end
+
+    it 'aggregates routes into resources' do
+      expect(subject.resources.first).to be_a(GrapeApiary::Resource)
+    end
+
+    it 'excluded resources based on configuration' do
+      expect(subject.resources.map(&:key)).to eq(included_routes)
+    end
+  end
 end

data/spec/grape-apiary/config_spec.rb

@@ -48,4 +48,38 @@ describe GrapeApiary::Config do
       end
     end
   end
+
+  context 'sample id generation' do
+    it 'allows for setting the type for id generation' do
+      subject.example_id_type = :uuid
+
+      expect(subject.example_id_type).to eq(:uuid)
+    end
+
+    it 'guards against unsupported types' do
+      expect do
+        subject.example_id_type = :foo
+      end.to raise_error(UnsupportedIDType)
+    end
+
+    it 'checks for the bson library if requested' do
+      expect { subject.example_id_type = :bson }.to raise_error(BSONNotDefinied)
+    end
+
+    it 'generates a valid uuid' do
+      test = /[0-9A-F]{8}-[0-9A-F]{4}-[0-9A-F]{4}-[0-9A-F]{4}-[0-9A-F]{12}/i
+
+      subject.example_id_type = :uuid
+
+      expect(subject.generate_id).to match(test)
+    end
+
+    it 'generates a valid integer' do
+      test = /^[0-9]{1,10}$/
+
+      subject.example_id_type = :integer
+
+      expect(subject.generate_id.to_s).to match(test)
+    end
+  end
 end

data/spec/grape-apiary/resource_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+describe GrapeApiary::Resource do
+  include_context 'configuration'
+
+  subject { GrapeApiary::Resource.new('foo', []) }
+
+  context 'sample' do
+    it 'request generation is delegated to a generator' do
+      expect(subject.sample_generator).to receive(:request)
+
+      subject.sample_request
+    end
+
+    it 'response generation is delegated to a generator' do
+      expect(subject.sample_generator).to receive(:response)
+
+      subject.sample_response
+    end
+  end
+end

data/spec/grape-apiary/route_spec.rb

@@ -3,7 +3,7 @@ require 'spec_helper'
 describe GrapeApiary::Route do
   include_context 'configuration'
 
-  let(:routes) { GrapeApiary::Routes.new(SampleApi).routes }
+  let(:routes) { GrapeApiary::Blueprint.new(SampleApi).routes }
 
   subject { routes.first }
 

data/spec/grape-apiary/sample_generator_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+
+describe GrapeApiary::SampleGenerator do
+  include_context 'configuration'
+
+  before do
+    GrapeApiary.config do |config|
+      config.host               = host
+      config.name               = name
+      config.description        = description
+    end
+  end
+
+  let(:blueprint) { GrapeApiary::Blueprint.new(SampleApi) }
+  let(:resource)  { blueprint.resources.first }
+
+  subject { GrapeApiary::SampleGenerator.new(resource) }
+
+  it 'creates a sample hash from a resource' do
+    expect(subject.sample).to be_a(Hash)
+  end
+
+  context '#request' do
+    it 'creates a sample request in JSON form' do
+      expect { JSON.parse(subject.request) }.to_not raise_error
+    end
+  end
+
+  context '#response' do
+    it 'creates a sample response in JSON form' do
+      expect { JSON.parse(subject.response) }.to_not raise_error
+    end
+
+    it 'includes a sample id' do
+      expect(JSON.parse(subject.response)['id']).to_not be(nil)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,13 +1,16 @@
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 $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/apiary'
+
+require 'rubygems'
 require 'bundler'
 Bundler.setup :default, :test
 
 require 'coveralls'
 Coveralls.wear!
 
-require 'grape/apiary'
 require 'rspec'
 require 'pry'
 

data/spec/support/config_context.rb

@@ -5,24 +5,10 @@ shared_context 'configuration' do
   let(:resource_exclusion) { [:admin, :swagger_docs] }
 
   let(:request_headers) do
-    [
-      { 'Accept-Charset' => 'utf-8' },
-      { 'Connection'     => 'keep-alive' },
-      { 'Content-Type'   => 'application/json' }
-    ]
+    [{ 'Accept-Charset' => 'utf-8' }]
   end
 
   let(:response_headers) do
-    [
-      { 'Content-Length' => '21685' },
-      { 'Connection'     => 'keep-alive' },
-      { 'Content-Type'   => 'application/json' }
-    ]
-  end
-
-  let(:app) do
-    def app
-      SampleApi
-    end
+    [{ 'Connection'     => 'keep-alive' }]
   end
 end

data/spec/support/sample_api.rb

@@ -10,8 +10,14 @@ class SampleApi < Grape::API
 
     desc 'create a widget'
     params do
-      requires :name, type: 'string', desc: 'the widgets name'
-      optional :description, type: 'string', desc: 'the widgets name'
+      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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grape-apiary
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - John Allen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-06 00:00:00.000000000 Z
+date: 2014-02-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grape
@@ -108,6 +108,48 @@ dependencies:
     - - "~>"
       - !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 an Apiary (http://apiary.io) Blueprint from the docuementation
   that is created by your Grape API
 email:
@@ -117,9 +159,11 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rspec"
 - ".rubocop.yml"
 - ".travis.yml"
 - Gemfile
+- Guardfile
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -130,15 +174,15 @@ files:
 - lib/grape-apiary/parameter.rb
 - lib/grape-apiary/resource.rb
 - lib/grape-apiary/route.rb
-- lib/grape-apiary/routes.rb
 - lib/grape-apiary/sample_generator.rb
 - lib/grape-apiary/templates/blueprint.md.erb
 - lib/grape-apiary/version.rb
 - lib/grape/apiary.rb
 - spec/grape-apiary/blueprint_spec.rb
 - spec/grape-apiary/config_spec.rb
+- spec/grape-apiary/resource_spec.rb
 - spec/grape-apiary/route_spec.rb
-- spec/grape-apiary/routes_spec.rb
+- spec/grape-apiary/sample_generator_spec.rb
 - spec/spec_helper.rb
 - spec/support/config_context.rb
 - spec/support/sample_api.rb
@@ -169,8 +213,9 @@ summary: Allows for generating an Apiary Blueprint for you Grape API
 test_files:
 - spec/grape-apiary/blueprint_spec.rb
 - spec/grape-apiary/config_spec.rb
+- spec/grape-apiary/resource_spec.rb
 - spec/grape-apiary/route_spec.rb
-- spec/grape-apiary/routes_spec.rb
+- spec/grape-apiary/sample_generator_spec.rb
 - spec/spec_helper.rb
 - spec/support/config_context.rb
 - spec/support/sample_api.rb

data/lib/grape-apiary/routes.rb

@@ -1,57 +0,0 @@
-module GrapeApiary
-  class Routes
-    attr_reader :api_class
-
-    delegate(*GrapeApiary::Config::SETTINGS, to: 'GrapeApiary::Config')
-
-    def initialize(api_class)
-      @api_class = api_class
-    end
-
-    def routes
-      @routes ||= api_class.routes.map do |route|
-        GrapeApiary::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 { |name, routes| Resource.new(name, routes) }
-      end
-    end
-
-    def formatted_request_headers
-      formatted_headers(GrapeApiary::Config.request_headers)
-    end
-
-    def formatted_response_headers
-      formatted_headers(GrapeApiary::Config.response_headers)
-    end
-
-    def show_request_sample?(route)
-      %w(PUT POST).include?(route.route_method)
-    end
-
-    def routes_binding
-      binding
-    end
-
-    private
-
-    def formatted_headers(headers)
-      spacer  = "\n" + (' ' * 12)
-
-      strings = headers.map do |header|
-        key, value = *header.first
-
-        "#{key}: #{value}"
-      end
-
-      strings.join(spacer)
-    end
-  end
-end

data/spec/grape-apiary/routes_spec.rb

@@ -1,54 +0,0 @@
-require 'spec_helper'
-
-describe GrapeApiary::Routes do
-  include_context 'configuration'
-
-  before do
-    GrapeApiary.config do |config|
-      config.host               = host
-      config.name               = name
-      config.description        = description
-      config.resource_exclusion = [:admin]
-    end
-
-    GrapeApiary.config.request_headers = [
-      { 'Accept-Charset' => 'utf-8' },
-      { 'Connection'     => 'keep-alive' }
-    ]
-
-    GrapeApiary.config.response_headers = [
-      { 'Content-Length' => '21685' },
-      { 'Connection'     => 'keep-alive' }
-    ]
-  end
-
-  subject { GrapeApiary::Routes.new(SampleApi) }
-
-  it 'exposes configuration settings' do
-    GrapeApiary::Config::SETTINGS.each do |setting|
-      expect(subject.send(setting)).to eq(GrapeApiary.config.send(setting))
-    end
-  end
-
-  it 'exposes the raw routes of the given api' do
-    expect(subject.routes).to eq(SampleApi.routes)
-  end
-
-  context '#resources' do
-    let(:unique_routes) { subject.routes.map(&:route_name).uniq }
-
-    let(:included_routes) do
-      unique_routes.reject do |name|
-        GrapeApiary.config.resource_exclusion.include?(name.to_sym)
-      end
-    end
-
-    it 'aggregates routes into resources' do
-      expect(subject.resources.first).to be_a(GrapeApiary::Resource)
-    end
-
-    it 'excluded resources based on configuration' do
-      expect(subject.resources.map(&:key)).to eq(included_routes)
-    end
-  end
-end