prmd 0.5.0 → 0.6.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    YTg0MzdjNDU3M2MxOTk2ODE2MTYyMGU1YWM2OGNjMGQ5OWM5NWM4Mg==
+    YzI3ZTkyMWEwZDAzNzc5ZDQxZDI3ZmUwMWQ2MTVhZGIyNTRmNzI0NQ==
   data.tar.gz: !binary |-
-    ZDViYzZmYmIxODY3YzFhOTBjZWZhMzM2ODNhZGJkNjk4MjViNDRjMw==
+    OTdiNDJlZWQ1YzkxYmU1OWRkODU1NWY4YmVhZThiMzhjZjhmMjA0YQ==
 SHA512:
   metadata.gz: !binary |-
-    NDgwNWU1ODRmNzc1MjJlNzU3NmUxNzg4OTk2NGVlZmY3NDRkODg2ZTYyN2E3
-    NmU2ZjJkNjI0MWI1YmQ5MTFlYTZjZTdmNjJmZGE4MmExNzk5YjBlMDA5YjEy
-    ZDhhOGJjMzRjMjQ1MzY2ZWY4ZTYzOWExMTA5OTFiODNjZDBjZjA=
+    NDkxMjczOWQ0MmMwMDEzN2JkYzVhOGZmNTUyZGQxYzg4ZDY4N2EyZDMzNTIx
+    YTI4ZjJiMTBhMTdlNmU5MTU2MmRmMzY0MjVkNzY4YTBkMjEyYTkzODk2NjI5
+    MmMxN2E3NTg1OTAzNWRmOWE1MjdmMTQyY2Y0YmExNzIwNWJmNGM=
   data.tar.gz: !binary |-
-    NWRmM2Y5NjQyYmUwYjVlNzI4ZDYxY2VjMmYwNjA4MTJiMTE4NGVhNTQ1MzZl
-    MzM1MjMwMjkzZGMwYWMzM2EwMDJiOTRjN2VlMjVhMzA5ZjczN2IzZjUyYmMx
-    MDNmYjc4YTgyOTE1ZWNiMWJhYzhjMGZiOWI2MjkwZTMyZGVkODY=
+    NGZlY2E3NzVhOGRkN2YxODM1ZjJkMTk1ZDAwNzNiNjE4Yzk3MjJmNjhjMDhk
+    NWJkNDJhNDY5M2E5OWViY2VhM2MyZGI0ZTMxMjI0MTFjMzk5YWVjN2JjYWI0
+    OTJiN2YzZmUxMzY5YWRhODA2ZDM4ZDNlNmJlMzQ4N2Y0NmFhN2I=

data/Gemfile.lock

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

data/lib/prmd/schema.rb

@@ -58,15 +58,18 @@ module Prmd
 
     def schema_value_example(value)
       if value.has_key?('example')
-        return value['example']
+        value['example']
+      elsif value.has_key?('anyOf')
+        ref = value['anyOf'].detect {|ref| ref['$ref'].split('/').last == 'id'} || value['anyOf'].first
+        schema_example(ref)
       elsif value.has_key?('properties') # nested properties
-        return schema_example(value)
+        schema_example(value)
       elsif value.has_key?('items') # array of objects
         _, items = dereference(value['items'])
         if value['items'].has_key?('example')
-          return [items['example']]
+          [items['example']]
         else
-          return [schema_example(items)]
+          [schema_example(items)]
         end
       end
     end

data/lib/prmd/templates/schema.erb

@@ -10,9 +10,9 @@
         schema:          schema,
         schemata:        schemata
       })
-    rescue => e 
+    rescue => e
       $stdout.puts("Error in resource: #{resource}")
       raise e
     end
-  end.join("\n") << "\n"
+  end.join("\n")
 %>

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

@@ -6,6 +6,12 @@
     properties.each do |key, value|
       # found a reference to another element:
       _, value = schema.dereference(value)
+
+      # include top level reference to nested things, when top level is nullable
+      if value.has_key?('type') && value['type'].include?('null') && (value.has_key?('items') || value.has_key?('properties'))
+        attributes << build_attribute(schema, key, value)
+      end
+
       if value.has_key?('anyOf')
         descriptions = []
         examples = []
@@ -34,14 +40,14 @@
         attributes << [key, "string", description, example]
 
       # found a nested object
-      elsif value['type'] == ['object'] && value['properties']
+      elsif value['properties']
         nested = extract_attributes(schema, value['properties'])
         nested.each do |attribute|
           attribute[0] = "#{key}:#{attribute[0]}"
         end
         attributes.concat(nested)
       # found an array with nested objects
-      elsif value['type'] == ['array'] && value['items'] && value['items']['properties']
+      elsif value['items'] && value['items']['properties']
         nested = extract_attributes(schema, value['items']['properties'])
         nested.each do |attribute|
           attribute[0] = "#{key}/#{attribute[0]}"
@@ -49,37 +55,44 @@
         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
+        attributes << build_attribute(schema, key, value)
+      end
+    end
+    return attributes
+  end
 
-        if value['enum']
-          description += '<br/><b>one of:</b>' + [*value['enum']].map { |e| "<code>#{e.to_json}</code>" }.join(" or ")
-        end
+  def build_attribute(schema, key, value)
+    description = value['description']
+    if value['default']
+      description += "<br/><b>default:</b> <code>#{value['default'].to_json}</code>"
+    end
 
-        if value.has_key?('example')
-          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
+    if value['enum']
+      description += '<br/><b>one of:</b>' + [*value['enum']].map { |e| "<code>#{e.to_json}</code>" }.join(" or ")
+    end
 
-        type = if value['type'].include?('null')
-          'nullable '
-        else
-          ''
-        end
-        type += (value['format'] || (value['type'] - ['null']).first)
-        attributes << [key, type, description, example]
+    if value.has_key?('example')
+      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>"
+    elsif value['type'].include?('null')
+      example = "<code>null</code>"
     end
-    return attributes
+
+    type = if value['type'].include?('null')
+      'nullable '
+    else
+      ''
+    end
+    type += (value['format'] || (value['type'] - ['null']).first)
+    [key, type, description, example]
   end
 
+
   def build_link_path(schema, link)
     link['href'].gsub(%r|(\{\([^\)]+\)\})|) do |ref|
       ref = ref.gsub('%2F', '/').gsub('%23', '#').gsub(%r|[\{\(\)\}]|, '')

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

@@ -43,6 +43,8 @@
 HTTP/1.1 <%= case link['rel']
   when 'create'
     '201 Created'
+  when 'empty'
+    '202 Accepted'
   else
     '200 OK'
   end %>

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

@@ -13,11 +13,10 @@
     end
   %>
 $ curl -n -X <%= link['method'] %> <%= schema.href %><%= path -%>
-<%- unless data.empty? || link['method'].upcase == 'GET' %> \
+<%- if !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 '<%= JSON.pretty_generate(data) %>'
+<%- elsif !get_params.empty? && link['method'].upcase == 'GET' %> -G \
   -d <%= get_params.join(" \\\n  -d ") %>
 <%- end %>
 ```

data/lib/prmd/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: prmd
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - geemus
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-17 00:00:00.000000000 Z
+date: 2014-07-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: erubis
@@ -154,4 +154,3 @@ test_files:
 - test/schema_test.rb
 - test/schemata/input/meta.json
 - test/schemata/input/user.json
-has_rdoc: