prmd 0.4.0 → 0.5.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    YTBiMDJmODY4NDAwMTE1ZTMzZTJiY2I2MzA1M2VkMzM2OWZkYmI5NA==
+    YTg0MzdjNDU3M2MxOTk2ODE2MTYyMGU1YWM2OGNjMGQ5OWM5NWM4Mg==
   data.tar.gz: !binary |-
-    MTc2MjY0MjgzMDEwYzhhYWVmYzZkY2VhNjI0YmM3ZmI4MThhYzFlZA==
+    ZDViYzZmYmIxODY3YzFhOTBjZWZhMzM2ODNhZGJkNjk4MjViNDRjMw==
 SHA512:
   metadata.gz: !binary |-
-    ZDJkMzVkZTk4ZTI1YmU5M2Q2MGVmNzZhZjI0YzFmODYwNDE0YThlYjA1MTYw
-    NDI0ZDNhYmFjOTczNTllOTBjZDgyNDYwZGQyMzZhYmVlMzZlMTFjZTIzYWVm
-    MmNjOTA0MTIzMWRlNjNmMDU5YTQ3YjZkZjQyZGQ1MzY1YWNlNGI=
+    NDgwNWU1ODRmNzc1MjJlNzU3NmUxNzg4OTk2NGVlZmY3NDRkODg2ZTYyN2E3
+    NmU2ZjJkNjI0MWI1YmQ5MTFlYTZjZTdmNjJmZGE4MmExNzk5YjBlMDA5YjEy
+    ZDhhOGJjMzRjMjQ1MzY2ZWY4ZTYzOWExMTA5OTFiODNjZDBjZjA=
   data.tar.gz: !binary |-
-    NmI3N2ViOGIyZDE1NTljODExNDhkY2E2MDlmZThhZTFiZWE2YmFhNmQyNTg0
-    MTBjYzczMjg4NDI1OGVjODlkOTI5NzU5YjllYmMyZGJjYzQ2N2I1YWZlMGM2
-    MzY3YzIwM2RjYTlkNzk5MzExNjU0NjAxZDUzYTIzODlkZDQ2YjY=
+    NWRmM2Y5NjQyYmUwYjVlNzI4ZDYxY2VjMmYwNjA4MTJiMTE4NGVhNTQ1MzZl
+    MzM1MjMwMjkzZGMwYWMzM2EwMDJiOTRjN2VlMjVhMzA5ZjczN2IzZjUyYmMx
+    MDNmYjc4YTgyOTE1ZWNiMWJhYzhjMGZiOWI2MjkwZTMyZGVkODY=

data/CONTRIBUTORS.md

@@ -1,12 +1,19 @@
+* Adel Qalieh <aqalieh95@gmail.com>
 * Brandur <brandur@heroku.com>
 * Brandur <brandur@mutelight.org>
 * Chris Continanza <christopher.continanza@gmail.com>
+* Dan Peterson <dpiddy@gmail.com>
 * Dane Harrigan <dane.harrigan@gmail.com>
+* Eric J. Holmes <eric@ejholmes.net>
 * Ernesto Jiménez <me@ernesto-jimenez.com>
+* Justin Halsall <justin@juice10.com>
 * Kousuke Ebihara <Kosuke_Ebihara@voyagegroup.com>
 * Kousuke Ebihara <kousuke@co3k.org>
 * Mark McGranaghan <mmcgrana@gmail.com>
+* Martin Seeler <developer@chasmo.de>
+* Matthew Conway <himself@mattonrails.com>
 * Olivier Lance <olance@users.noreply.github.com>
+* Scott Clasen <scott@heroku.com>
 * Timothée Peignier <timothee.peignier@tryphon.org>
 * Wesley Beary <geemus+github@gmail.com>
 * geemus <geemus@gmail.com>

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    prmd (0.4.0)
+    prmd (0.5.0)
       erubis (~> 2.7)
       json_schema (~> 0.1)
 

data/README.md

@@ -79,7 +79,10 @@ $ prmd doc schema.json > schema.md
 ```
 
 # Render from schema
+
+```console
 $ prmd render --template schemata.erb schema.json > schema.md
+```
 
 Typically you'll want to prepend header and overview information to
 your API documentation. You can do this with the `--prepend` flag:

data/bin/prmd

@@ -16,6 +16,9 @@ commands = {
     opts.on("-p", "--prepend header,overview", Array, "Prepend files to output") do |p|
       options[:prepend] = p
     end
+    opts.on("-u", "--url-style json", String, "URL style to output (default/json)") do |s|
+      options[:style] = s
+    end
     opts.on("-c", "--content-type application/json", String, "Content-Type header") do |c|
       options[:content_type] = c
     end

data/lib/prmd.rb

@@ -12,6 +12,7 @@ require File.join(dir, 'prmd', 'commands', 'verify')
 require File.join(dir, 'prmd', 'schema')
 require File.join(dir, 'prmd', 'version')
 require File.join(dir, 'prmd', 'template')
+require File.join(dir, 'prmd', 'url_generator')
 
 module Prmd
 end

data/lib/prmd/commands/render.rb

@@ -3,6 +3,7 @@ module Prmd
     doc = ''
 
     options[:content_type] ||= 'application/json'
+    options[:style] ||= 'default'
 
     if options[:prepend]
       doc << options[:prepend].map {|path| File.read(path)}.join("\n") << "\n"
@@ -12,7 +13,6 @@ module Prmd
     if not File.directory?(template_dir)  # to keep backward compatibility
       template_dir = File.dirname(options[:template])
     end
-    options[:template] = template_dir
 
     doc << Prmd::Template::render('schema.erb', template_dir, {
       options:         options,

data/lib/prmd/schema.rb

@@ -57,7 +57,9 @@ module Prmd
     end
 
     def schema_value_example(value)
-      if value.has_key?('properties') # nested properties
+      if value.has_key?('example')
+        return value['example']
+      elsif value.has_key?('properties') # nested properties
         return schema_example(value)
       elsif value.has_key?('items') # array of objects
         _, items = dereference(value['items'])
@@ -66,8 +68,6 @@ module Prmd
         else
           return [schema_example(items)]
         end
-      else
-        return value['example']
       end
     end
 

data/lib/prmd/templates/schemata/helper.erb

@@ -40,15 +40,30 @@
           attribute[0] = "#{key}:#{attribute[0]}"
         end
         attributes.concat(nested)
+      # found an array with nested objects
+      elsif value['type'] == ['array'] && value['items'] && value['items']['properties']
+        nested = extract_attributes(schema, value['items']['properties'])
+        nested.each do |attribute|
+          attribute[0] = "#{key}/#{attribute[0]}"
+        end
+        attributes.concat(nested)
       # just a regular attribute
       else
         description = value['description']
+        if value['default']
+          description += "<br/><b>default:</b> <code>#{value['default'].to_json}</code>"
+        end
+
         if value['enum']
           description += '<br/><b>one of:</b>' + [*value['enum']].map { |e| "<code>#{e.to_json}</code>" }.join(" or ")
         end
 
         if value.has_key?('example')
-          example = [*value['example']].map { |e| "<code>#{e.to_json}</code>" }.join(" or ")
+          example = if value['example'].is_a?(Hash) && value['example'].has_key?('oneOf')
+            value['example']['oneOf'].map { |e| "<code>#{e.to_json}</code>" }.join(" or ")
+          else
+            "<code>#{value['example'].to_json}</code>"
+          end
         elsif value['type'] == ['array'] && value.has_key?('items')
           example = "<code>#{schema.schema_value_example(value)}</code>"
         end

data/lib/prmd/templates/schemata/link.erb

@@ -48,7 +48,8 @@ HTTP/1.1 <%= case link['rel']
   end %>
 ```
 ```json
-  <%- if link.has_key?('targetSchema') %>
+  <%- if link['rel'] == 'empty' %>
+  <%- elsif link.has_key?('targetSchema') && link['targetSchema'].has_key?('properties') %>
 <%= JSON.pretty_generate(schema.schema_example(link['targetSchema'])) %>
   <%- elsif link['rel'] == 'instances' %>
 <%= JSON.pretty_generate([schema.schemata_example(resource)]) %>

data/lib/prmd/templates/schemata/link_curl_example.erb

@@ -1,25 +1,23 @@
-```term
+```bash
   <%-
     data = {}
     path = path.gsub(/{([^}]*)}/) {|match| '$' + match.gsub(/[{}]/, '').upcase}
+    get_params = []
 
     if link.has_key?('schema')
       data.merge!(schema.schema_example(link['schema']))
 
       if link['method'].upcase == 'GET' && !data.empty?
-        path << '?'
-        data.sort_by {|k,_| k.to_s }.each do |key, values|
-          [values].flatten.each do |value|
-            path << [key.to_s, CGI.escape(value.to_s)].join('=') << '&'
-          end
-        end
-        path.chop! # remove trailing '&'
+        get_params << Prmd::UrlGenerator.new({schema: schema, link: link, options: options}).url_params
       end
     end
   %>
-$ curl -n -X <%= link['method'] %> <%= schema.href %><%= path %>
-  <%- unless data.empty? || link['method'].upcase == 'GET' %>
--H "Content-Type: <%= options[:content_type] %>" \
--d '<%= data.to_json %>'
-  <%- end %>
+$ curl -n -X <%= link['method'] %> <%= schema.href %><%= path -%>
+<%- unless data.empty? || link['method'].upcase == 'GET' %> \
+  -H "Content-Type: <%= options[:content_type] %>" \
+  -d '<%= data.to_json %>'
+<%- end %>
+<%- unless get_params.empty? || link['method'].upcase != 'GET' %> -G \
+  -d <%= get_params.join(" \\\n  -d ") %>
+<%- end %>
 ```

data/lib/prmd/url_generator.rb

@@ -0,0 +1,85 @@
+module Prmd
+  class UrlGenerator
+
+    def initialize(params)
+      @schema = params[:schema]
+      @link = params[:link]
+      @options = params[:options]
+    end
+
+    def url_params
+      if @options[:style].downcase == 'json'
+        klass = Generators::JSON
+      else
+        klass = Generators::Default
+      end
+
+      klass.generate({schema: @schema, link: @link})
+    end
+
+    private
+
+    module Generators
+      class Default
+        class << self
+          def generate(params)
+            data = {}
+            data.merge!(params[:schema].schema_example(params[:link]['schema']))
+            generate_params(data)
+          end
+
+          private
+
+          def param_name(key, prefix, array = false)
+            result = if prefix
+              "#{prefix}[#{key}]"
+            else
+              key
+            end
+
+            result += "[]" if array
+            result
+          end
+
+          def generate_params(obj, prefix = nil)
+            result = []
+            obj.each do |key,value|
+              if value.is_a?(Hash)
+                newprefix = if prefix
+                  "#{prefix}[#{key}]"
+                else
+                  key
+                end
+                result << generate_params(value, newprefix)
+              elsif value.is_a?(Array)
+                value.each do |val|
+                  result << [param_name(key, prefix, true), CGI.escape(val.to_s)].join('=')
+                end
+              else
+                next unless value # ignores parameters with empty examples
+                result << [param_name(key, prefix), CGI.escape(value.to_s)].join('=')
+              end
+            end
+            result.flatten
+          end
+        end
+      end
+
+      class JSON
+        def self.generate(params)
+          data = {}
+          data.merge!(params[:schema].schema_example(params[:link]['schema']))
+
+          result = []
+          data.sort_by {|k,_| k.to_s }.each do |key, values|
+            [values].flatten.each do |value|
+              result << [key.to_s, CGI.escape(value.to_s)].join('=')
+            end
+          end
+
+          result
+        end
+      end
+    end
+  end
+end

data/lib/prmd/version.rb

@@ -1,3 +1,3 @@
 module Prmd
-  VERSION = "0.4.0"
+  VERSION = "0.5.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: prmd
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - geemus
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-03 00:00:00.000000000 Z
+date: 2014-07-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: erubis
@@ -113,6 +113,7 @@ files:
 - lib/prmd/templates/schemata/helper.erb
 - lib/prmd/templates/schemata/link.erb
 - lib/prmd/templates/schemata/link_curl_example.erb
+- lib/prmd/url_generator.rb
 - lib/prmd/version.rb
 - prmd.gemspec
 - schemas/hyper-schema.json
@@ -143,7 +144,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.3.0
 signing_key: 
 specification_version: 4
 summary: JSON Schema tooling