grape-slate 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5e5f0ec63333f2ed9755fbd1a9e739f255c37857
-  data.tar.gz: 1ea43b80a15189cc8f4206ccc9106be2768dffbc
+  metadata.gz: 5046a1a84a749c671e8b84fbd68de5ec134223cd
+  data.tar.gz: c594e654de27ff590cea59d4866a1034bd4155c5
 SHA512:
-  metadata.gz: e91a4c1503f278fb21f166c9776d46da546dadfb0f7bc2a5c03b0a06cd26630eea431fb1483c614bba7304cc6f4b823e868231c4d9029e2678107d50752ab36f
-  data.tar.gz: 54d8ced9b41b87f6d82d9160b3b4849b757bb56671054a48d5321abfe29afe43a1ededab84469e0c7abc794c86faacbefbbf230b1f1d824227046a1a3209a168
+  metadata.gz: a3ceb49766fa67ebc883815837914a7504c66765b33ae0566a9ac8bb7458fee848c846a6dac86b356341439cab0fa6a8dec1cd57497edc0aa951c58651b09d98
+  data.tar.gz: 744ef5f8a0c94a2c6c3a7ab169b3e19b1ac6a83dcfc87751d46543d10018942183a3d23aa20b9d004ec53e1edf5d478b5f14d790baed90fdf92fde5af8c561b8

data/Gemfile

@@ -4,5 +4,3 @@ 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'
+  spec.add_runtime_dependency 'grape-markdown', '~> 0.0.3'
 
   spec.add_development_dependency 'coveralls', '~> 0.7'
   spec.add_development_dependency 'rspec', '~> 2.14'

data/lib/grape-slate.rb

@@ -1,24 +1,18 @@
 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'
+  autoload :Version,          'grape-slate/version'
+  autoload :SampleGenerator,  'grape-slate/sample_generator'
+  autoload :Document,         'grape-slate/document'
+  autoload :ExampleGenerator, 'grape-slate/example_generator'
 
   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'
+    if block_given?
+      yield(GrapeMarkdown::Configuration)
+    else
+      GrapeMarkdown::Configuration
     end
   end
 end
+
+GrapeMarkdown::Configuration.extend :host

data/lib/grape-slate/document.rb

@@ -1,55 +1,17 @@
 module GrapeSlate
   class Document < GrapeMarkdown::Document
-    attr_reader :api_class, :document_template, :properties_template
-
-    delegate(*GrapeMarkdown::Config::SETTINGS, to: 'GrapeSlate::Config')
+    attr_reader :shell_template
 
     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
+      super
 
-    def properties_table(resource)
-      ERB.new(properties_template, nil, '-').result(resource.resource_binding)
+      @shell_template = template_for(:shell)
     end
 
-    def formatted_request_headers
-      formatted_headers(GrapeSlate::Config.request_headers)
-    end
+    def shell_example(route, resource)
+      example = ExampleGenerator::Shell.new(route, resource)
 
-    def formatted_response_headers
-      formatted_headers(GrapeSlate::Config.response_headers)
-    end
-
-    def show_request_sample?(route)
-      %w(PUT POST).include?(route.route_method)
+      render(shell_template, example.example_binding)
     end
 
     private
@@ -60,19 +22,5 @@ module GrapeSlate
 
       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/example_generator.rb

@@ -0,0 +1,5 @@
+module GrapeSlate
+  module ExampleGenerator
+    autoload :Shell, 'grape-slate/example_generator/shell'
+  end
+end

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

@@ -0,0 +1,57 @@
+class GrapeSlate::ExampleGenerator::Shell
+  attr_reader :route, :resource
+
+  delegate :route_name, to: :route
+  delegate :host, :request_headers, to: 'GrapeMarkdown::Configuration'
+
+  def initialize(route, resource)
+    @route    = route
+    @resource = resource
+  end
+
+  def lines
+    @lines ||= [command, request, data, headers, verbose].flatten.compact
+  end
+
+  def example_binding
+    binding
+  end
+
+  private
+
+  def method
+    route.route_method
+  end
+
+  def command
+    "curl #{host}/#{route_name}/#{id}"
+  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)
+
+    "--request #{method}"
+  end
+
+  def data
+    "--data '#{resource.sample_request(false)}'"
+  end
+
+  def headers
+    request_headers.map { |header| "--header '#{header.first.join(': ')}'" }
+  end
+
+  def verbose
+    '--verbose'
+  end
+end

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

@@ -19,9 +19,7 @@ toc_footers:
       <% resource_by_path.routes.each do |route| %>
 ## <%= route.route_description %>
 
-```shell
-curl http://example.com
-```
+<%= shell_example(route, resource) %>
 
 > The above command returns JSON structured like this:
 

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

@@ -0,0 +1,12 @@
+```shell
+<%
+  first = lines.shift
+  last  = lines.pop
+-%>
+<%= first -%>
+<%= ' \\' if lines.any? %>
+<% lines.each do |line| -%>
+  <%= line -%> \
+<% end -%>
+  <%= last %>
+```

data/lib/grape-slate/version.rb

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

data/spec/grape-slate/document_spec.rb

@@ -5,9 +5,11 @@ describe GrapeSlate::Document do
 
   before do
     GrapeSlate.config do |config|
+      config.host               = host
       config.name               = name
       config.description        = description
       config.resource_exclusion = [:admin]
+      config.include_root       = true
     end
 
     GrapeSlate.config.request_headers = [
@@ -29,7 +31,6 @@ describe GrapeSlate::Document do
     subject { GrapeSlate::Document.new(klass).generate }
 
     it 'sets the title based on name' do
-      puts subject
       expect(subject).to include("title: #{name} Reference")
     end
 
@@ -45,12 +46,12 @@ describe GrapeSlate::Document do
       expect(subject).to include(description)
     end
 
-    # it 'includes groups for each resource' do
-    #   expect(subject).to include('# Group Widgets')
-    # end
+    it 'includes a headline for each resource' do
+      expect(subject).to include('# Widgets')
+    end
 
-    # it 'includes properties for the resources' do
-    #   expect(subject).to include('Properties')
-    # end
+    it 'includes properties for the resources' do
+      expect(subject).to include('Properties')
+    end
   end
 end

data/spec/support/config_context.rb

@@ -1,4 +1,5 @@
 shared_context 'configuration' do
+  let(:host)               { 'http://api.example.com' }
   let(:name)               { 'some api v1' }
   let(:description)        { 'some blueprint description' }
   let(:resource_exclusion) { [:admin, :swagger_docs] }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grape-slate
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - John Allen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-25 00:00:00.000000000 Z
+date: 2014-02-26 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'
+        version: 0.0.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.0'
+        version: 0.0.3
 - !ruby/object:Gem::Dependency
   name: coveralls
   requirement: !ruby/object:Gem::Requirement
@@ -169,12 +169,14 @@ files:
 - Rakefile
 - grape-slate.gemspec
 - lib/grape-slate.rb
-- lib/grape-slate/config.rb
 - lib/grape-slate/document.rb
+- lib/grape-slate/example_generator.rb
+- lib/grape-slate/example_generator/shell.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/templates/shell.md.erb
 - lib/grape-slate/version.rb
 - lib/grape/slate.rb
 - spec/grape-slate/document_spec.rb

data/lib/grape-slate/config.rb

@@ -1,62 +0,0 @@
-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