jekyll-ramler 0.0.10 → 0.0.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cfbe8616d3768a3cf43814ef7a4f5f53ab0cfde3
-  data.tar.gz: 50830df613cabba283c4ada094b31ea9c12082e4
+  metadata.gz: 5de4b422758205cd5f099f15a65a1e73f060347f
+  data.tar.gz: 69481e98d6f6c4877d94d536f3c496362b62493c
 SHA512:
-  metadata.gz: 923d4dc2b9889f6b95ff125fd3f3ef39749b891c635ae342831e088df5ff48a5a7f8be199bee0055f1d64a514d13ee014311d35667609fddc3f4fd944cbe55d1
-  data.tar.gz: db64fe426afaaa661c2f64efe43b109811a1220155224f2fd8ca1e2b8b02317ff4f3f88ab60e17ae1a20e388a942df5fe645825102fcb534cfe2eb6b3f4b93b0
+  metadata.gz: 4ba166fd3dd5724ec148bbe053dbdae1d64d8fdf19db8253af9fef9a7fca7d5afcb0b38dac6b773aa0733d24b8022d92ee7c43b1918472938ed9b3cadd9620f7
+  data.tar.gz: d74a6090861d19edda05ab1e5cf7fd78e82b114821f3a01832cb4bbda3c80e01c19b364635410597319204e7cd8c1acb2b9bf39bfeb9720044645e50a99fb8e7

data/Gemfile.lock

@@ -1,75 +1,46 @@
 PATH
   remote: .
   specs:
-    jekyll-ramler (0.0.9)
+    jekyll-ramler (0.0.11)
       jekyll
       ruby_deep_clone
 
 GEM
   remote: https://rubygems.org/
   specs:
-    blankslate (2.1.2.4)
-    celluloid (0.16.0)
-      timers (~> 4.0.0)
-    classifier-reborn (2.0.3)
-      fast-stemmer (~> 1.0)
     coderay (1.1.0)
-    coffee-script (2.3.0)
-      coffee-script-source
-      execjs
-    coffee-script-source (1.9.0)
     colorator (0.1)
     diff-lcs (1.2.5)
-    execjs (2.3.0)
     fakefs (0.6.5)
-    fast-stemmer (1.0.2)
-    ffi (1.9.6)
-    hitimes (1.2.2)
-    jekyll (2.5.3)
-      classifier-reborn (~> 2.0)
+    ffi (1.9.10)
+    jekyll (3.0.1)
       colorator (~> 0.1)
-      jekyll-coffeescript (~> 1.0)
-      jekyll-gist (~> 1.0)
-      jekyll-paginate (~> 1.0)
       jekyll-sass-converter (~> 1.0)
       jekyll-watch (~> 1.1)
       kramdown (~> 1.3)
-      liquid (~> 2.6.1)
+      liquid (~> 3.0)
       mercenary (~> 0.3.3)
-      pygments.rb (~> 0.6.0)
-      redcarpet (~> 3.1)
+      rouge (~> 1.7)
       safe_yaml (~> 1.0)
-      toml (~> 0.1.0)
-    jekyll-coffeescript (1.0.1)
-      coffee-script (~> 2.2)
-    jekyll-gist (1.1.0)
-    jekyll-paginate (1.1.0)
     jekyll-sass-converter (1.3.0)
       sass (~> 3.2)
-    jekyll-watch (1.2.1)
-      listen (~> 2.7)
-    kramdown (1.5.0)
-    liquid (2.6.2)
-    listen (2.8.5)
-      celluloid (>= 0.15.2)
+    jekyll-watch (1.3.0)
+      listen (~> 3.0)
+    kramdown (1.9.0)
+    liquid (3.0.6)
+    listen (3.0.5)
       rb-fsevent (>= 0.9.3)
       rb-inotify (>= 0.9)
     mercenary (0.3.5)
     method_source (0.8.2)
-    parslet (1.5.0)
-      blankslate (~> 2.0)
-    posix-spawn (0.3.9)
     pry (0.10.1)
       coderay (~> 1.1.0)
       method_source (~> 0.8.1)
       slop (~> 3.4)
-    pygments.rb (0.6.2)
-      posix-spawn (~> 0.3.6)
-      yajl-ruby (~> 1.2.0)
-    rb-fsevent (0.9.4)
+    rb-fsevent (0.9.6)
     rb-inotify (0.9.5)
       ffi (>= 0.5.0)
-    redcarpet (3.2.2)
+    rouge (1.10.1)
     rspec (3.2.0)
       rspec-core (~> 3.2.0)
       rspec-expectations (~> 3.2.0)
@@ -85,13 +56,8 @@ GEM
     rspec-support (3.2.1)
     ruby_deep_clone (0.6.0)
     safe_yaml (1.0.4)
-    sass (3.4.11)
+    sass (3.4.19)
     slop (3.6.0)
-    timers (4.0.1)
-      hitimes
-    toml (0.1.2)
-      parslet (~> 1.5.0)
-    yajl-ruby (1.2.1)
 
 PLATFORMS
   ruby
@@ -102,3 +68,6 @@ DEPENDENCIES
   pry
   rspec
   rspec-mocks
+
+BUNDLED WITH
+   1.10.6

data/README.md

@@ -18,6 +18,15 @@ specificed in a RAML file.
 - Supports Raw and Table based displays of JSON Schema included in your RAMLs
 - Automatic insertion of inherited JSON Schema (via `$ref` and `allOf`)
 
+## Example
+
+GovDelivery's developer documentation site, <http://developer.govdelivery.com>, 
+is built on jekyll-ramler, [jekyll-code-example-tag](https://github.com/govdelivery/jekyll-code-example-tag), 
+and [jekyll-nested-menu-generator](https://github.com/govdelivery/jekyll-nested-menu-generator).
+
+For an example of the output generated by jekyll-ramler, please visit 
+GovDelivery's TMS API documentation at <http://developer.govdelivery.com/api/tms/>.
+
 ## Installation
 
 ### Dependencies

data/jekyll-ramler.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
   s.name        = 'jekyll-ramler'
-  s.version     = '0.0.10'
-  s.date        = '2015-02-09'
+  s.version     = '0.0.12'
+  s.date        = '2015-11-23'
   s.authors     = ['GovDelivery']
   s.email       = 'support@govdelivery.com'
   s.homepage    = 'https://github.com/govdelivery/jekyll-ramler'

data/lib/raml-generate.rb

@@ -40,8 +40,8 @@ module Jekyll
       def transform_md(output)
         # Use the existing Jekyll Markdown converters
         md_converters = site.converters.select{|c| c.matches('.md')}
-        md_converters.reduce(output) do |output, converter|
-          converter.convert output 
+        md_converters.reduce(output) do |output_to_convert, converter|
+          converter.convert output_to_convert
         end
       end
 
@@ -52,14 +52,14 @@ module Jekyll
 
         default = {"values" => {}} if default.nil?
 
-        layout = default['values'].fetch('layout', 'default')
+        default['values'].fetch('layout', 'default')
       end
 
   end
 
   class SecuritySchemePage<GeneratedPage
     def initialize(site, base, web_root, dir, securityScheme)
-        super(site, base, web_root, dir, securityScheme, layout=get_layout("#{web_root}resource", site))
+        super(site, base, web_root, dir, securityScheme, get_layout("#{web_root}resource", site))
     end
   end
 
@@ -163,10 +163,10 @@ module Jekyll
               when 'application/json'
                 obj['schema_hash'] = JSON.parse(obj['schema'])
 
-                refactor_object = lambda do |obj|
-                  obj['properties'].each do |name, param|
+                refactor_object = lambda do |lam_obj|
+                  lam_obj['properties'].each do |name, param|
                     param['displayName'] = name
-                    param['required'] = true if obj.fetch('required', []).include?(name)
+                    param['required'] = true if lam_obj.fetch('required', []).include?(name)
 
                     if param.include?('example') and ['object', 'array'].include?(param['type'])
                       param['example'] = JSON.pretty_generate(JSON.parse(param['example']))
@@ -176,9 +176,9 @@ module Jekyll
                       param['items'] = JSON.pretty_generate(param['items'])
                     end
 
-                    obj['properties'][name] = param
+                    lam_obj['properties'][name] = param
                   end
-                  obj
+                  lam_obj
                 end
 
                 if obj['schema_hash'].include?('properties')
@@ -248,7 +248,37 @@ module Jekyll
         @site.pages << DocumentationPage.new(@site, @site.source, @web_root, documentation_dir, documentation)
       end
 
+      generate_downloadable_descriptors(raml_hash, raml_path)
+    end
+
+    private
+    def generate_resource_pages(resources, parent_dir=nil)
+
+      if parent_dir
+        dir = parent_dir
+      else 
+        dir = Jekyll::get_dir('resource', @site.config)
+      end
+
+      resources.each do |resource|
+        resource_name = resource["relativeUri"]
+        resource_dir = File.join(dir, resource_name)
+        @site.pages << ResourcePage.new(@site, @site.source, @web_root, resource_dir, resource, @traits, @securitySchemes)
+        generate_resource_pages(resource['resources'], resource_dir) if resource.has_key?('resources')
+      end
+    end
+
+    def generate_downloadable_descriptors(raml_hash, raml_path)
       # Allow users to download descriptor as RAML and JSON, which may be modified since it was read
+      raml_hash = DeepClone.clone raml_hash 
+
+      # Get rid of 'title' attribute added to security schemes
+      # securitySchemes will be an array of hashes containing one key (Name) value (a hash of properties) pairing
+      raml_hash.fetch('securitySchemes', []).each {|el| el.each_value { |scheme| scheme.delete('title') }}
+
+      # replace "resources" with the associated "relativeUri" of each resource
+      fix_resources(raml_hash)
+
       download_basename = @site.config.fetch('ramler_downloadable_descriptor_basenames', {}).fetch(raml_path, 'api') 
       raml_download_filename = download_basename + '.raml'
       json_download_filename = download_basename + '.json'
@@ -261,24 +291,27 @@ module Jekyll
       @site.static_files << RawFile.new(@site, @site.source, @web_root, json_download_filename, raml_json) 
     end
 
-    private
-      def generate_resource_pages(resources, parent_dir=nil)
-
-        if parent_dir
-          dir = parent_dir
-        else 
-          dir = Jekyll::get_dir('resource', @site.config)
-        end
-
-        resources.each do |resource|
-          resource_name = resource["relativeUri"]
-          resource_dir = File.join(dir, resource_name)
-          @site.pages << ResourcePage.new(@site, @site.source, @web_root, resource_dir, resource, @traits, @securitySchemes)
-          if resource.has_key?('resources')
-            generate_resource_pages(resource['resources'], resource_dir)
-        end
+    def fix_resources(raml_hash) 
+      # DFS FTW
+      raml_hash.fetch('resources', []).each do |resource_hash|
+        raml_hash[resource_hash.delete('relativeUri')] = resource_hash
+        fix_resources(resource_hash)
+      end
 
+      raml_hash.fetch('methods', []).each do |method_hash|
+        raml_hash[method_hash.delete('method')] = method_hash
+        fix_body(method_hash)
       end
+      raml_hash.delete('methods')
+      raml_hash.delete('schema_hash') 
+      raml_hash.delete('relativeUriPathSegments')
+      raml_hash.delete('resources')
+      raml_hash
+    end
+
+    def fix_body(method_hash)
+        method_hash.fetch('body', {}).each {|content_type, definition| definition.delete('schema_hash')} 
+        method_hash.fetch('responses', {}).each {|response_code, response_hash| fix_body(response_hash) if response_hash}
     end
   end
 end

metadata

@@ -1,41 +1,41 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-ramler
 version: !ruby/object:Gem::Version
-  version: 0.0.10
+  version: 0.0.12
 platform: ruby
 authors:
 - GovDelivery
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-09 00:00:00.000000000 Z
+date: 2015-11-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: ruby_deep_clone
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: "Generates Jekyll pages for overview, security, and \n                     resource
@@ -45,7 +45,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .travis.yml
+- ".travis.yml"
 - CHANGELOG
 - Gemfile
 - Gemfile.lock
@@ -75,17 +75,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.14
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Jekyll plugin that generates API documentation pages based on RAML