grape-slate 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5e04cae5066e79fe582f3ef02421bc44e7ca4b61
-  data.tar.gz: f6fb5ae6d7e0f3ed73be17d5c2bd081f6b0dc6ff
+  metadata.gz: b6828a105a9549ab7e3c4b07a768f456f314894e
+  data.tar.gz: 1e25809ed91fb457afa2fa078cd44f6774ac846d
 SHA512:
-  metadata.gz: c2de2d46cec6b5902a692709149d369e8191ac8f8f4d1e8a3ca937ff3b33d458ea33b138bf01f3c13f79b45f5b8a89fd6f485b2dd97d52646371f4c036877c52
-  data.tar.gz: 952f11d48656bd422e20632db98e3f4fbb7f04807c2803f60d4c92c0300970cbe057d297d49bf1f11de2c06bf81f5a4ae23b24e952b4cb778633f320db7165d8
+  metadata.gz: 9a9df3362458e42cef445e5d8ad1809e44a3434ee00257d28334c9befc69bd601945f857c653b3f33ec6f61583e420a734c0bb56ffe3396afca0735da0f9073e
+  data.tar.gz: 71a6228059b4275b57844c1b10ead0ee06a28ed6bb397c8010397531edc9b85b191f3d98fdf5a8cd7d6fbbc7b13881930d7b49dfc90ad448cf5a0e59761f1f88

data/Gemfile

@@ -4,3 +4,5 @@ source 'https://rubygems.org'
 gemspec
 
 gem 'grape', github: 'intridea/grape'
+
+gem 'grape-markdown', path: '/var/gems/grape-markdown'

data/grape-slate.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
-  spec.add_runtime_dependency 'grape-markdown', '~> 0.0.3'
+  spec.add_runtime_dependency 'grape-markdown', '~> 0.0.5'
 
   spec.add_development_dependency 'coveralls', '~> 0.7'
   spec.add_development_dependency 'rspec', '~> 2.14'

data/lib/grape-slate/document.rb

@@ -18,9 +18,8 @@ module GrapeSlate
 
     def template_for(name)
       directory = File.dirname(File.expand_path(__FILE__))
-      path = File.join(directory, "./templates/#{name}.md.erb")
 
-      File.read(path)
+      File.read(File.join(directory, "./templates/#{name}.md.erb"))
     end
   end
 end

data/lib/grape-slate/example_generator/shell.rb

@@ -23,20 +23,18 @@ class GrapeSlate::ExampleGenerator::Shell
     route.route_method
   end
 
+  def route_path
+    route.route_path_without_format
+  end
+
   def command
-    "curl #{host}/#{route_name}/#{id}"
+    "curl #{host}/#{route_path}".split('/').reject!(&:empty?).join('/')
   end
 
   def request_by_id?
     method == 'GET' && !route.list? || %w(PUT DELETE).include?(method)
   end
 
-  def id
-    return unless request_by_id?
-
-    GrapeMarkdown::Configuration.generate_id
-  end
-
   def request
     return unless %w(POST PUT DELETE).include?(method)
 

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

@@ -17,7 +17,7 @@ toc_footers:
   <% resource.namespaced.each do |grouped_resource| %>
     <% grouped_resource.paths.each do |resource_by_path| %>
       <% resource_by_path.routes.each do |route| %>
-## <%= route.route_description %>
+## <%= route.route_short_description %>
 
 <%= shell_example(route, resource) %>
 
@@ -28,12 +28,10 @@ toc_footers:
 ```
 <%= route.route_description %>
 
-### HTTP Request
+### HTTP Method
 
 `<%= route.route_method %>`
 
-### URL Parameters
-
 <%= properties_table(resource) %>
 
       <% end %>

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

@@ -1,4 +1,4 @@
-Properties
+### URL Parameters
 
 | Name | Type | Description |
 |:-----|:-----|:------------|

data/lib/grape-slate/version.rb

@@ -1,3 +1,3 @@
 module GrapeSlate
-  VERSION = '0.0.3'
+  VERSION = '0.0.4'
 end

data/spec/grape-slate/document_spec.rb

@@ -51,7 +51,11 @@ describe GrapeSlate::Document do
     end
 
     it 'includes properties for the resources' do
-      expect(subject).to include('Properties')
+      expect(subject).to include('URL Parameters')
+    end
+
+    it 'does not include excluded resources' do
+      expect(subject).to_not match(/admin/i)
     end
   end
 end

data/spec/support/sample_api.rb

@@ -31,6 +31,28 @@ class SampleApi < Grape::API
     end
   end
 
+  resource '/widgets/:widget_id/sprockets' do
+    desc 'create a sprocket for a specific widget'
+    params do
+      requires :name,
+               type: 'string',
+               desc: 'the widgets name',
+               documentation: { example: 'super widget' }
+    end
+    post '/' do
+    end
+
+    desc 'updates a sprocket for a specific widget'
+    params do
+      requires :name,
+               type: 'string',
+               desc: 'the widgets name',
+               documentation: { example: 'super widget' }
+    end
+    put ':id' do
+    end
+  end
+
   resource 'admin' do
     get '/' do
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grape-slate
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - John Allen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-26 00:00:00.000000000 Z
+date: 2014-02-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grape-markdown
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.3
+        version: 0.0.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.3
+        version: 0.0.5
 - !ruby/object:Gem::Dependency
   name: coveralls
   requirement: !ruby/object:Gem::Requirement