raddocs 1.0.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ffbd193e9c8f8b0bf7fd8e25fdee03e5b3f421c7
-  data.tar.gz: 02f48976120eeaedd38ad8698f7c0a26fec12d2c
+  metadata.gz: 5043b44d22752b964fc9a570ef8a2788e052b40c
+  data.tar.gz: 311bb2c3b45d3707d2da468e65fe685f68c5b438
 SHA512:
-  metadata.gz: 57e35b21e0e6a3f928c5e0d7325ea81225340e27fc62269fa0c77f698529917f231b6e451580273a7e14256de48c069a34e550866b31b2b87e63c2bcb6b04aab
-  data.tar.gz: ebaf4933fcedc78144fe7aec56b71e581428b7c508f0d6b8c7504c9fd5df8987bfb5dd402126f9822318f1ebb7e64332ea6f6e70ea0da14aeb33a4361284142f
+  metadata.gz: b17b829952b94d6730582268d63c3b1fa72d26fe4f08c40b54cb54a75db48b4cff2439b9f2167c3a1e03c5148c1e4410ba84ba173d22aea80749ec97cbc37bcf
+  data.tar.gz: 3c9f051091ae8ee325b8d985ea236510cbe1f3d675d3bee556aa1cfe3d9f532198a54c898eb8d029c06584a85bb8a1e0a86a83562e500ae05866fa5a0bf53ae0

data/lib/raddocs/models.rb

@@ -8,19 +8,23 @@ module Raddocs
     # @return [Array] array of {Raddocs::Resource Resources}
     def resources
       @attrs.fetch("resources", {}).map do |resource|
-        Resource.new(resource["name"], resource["examples"])
+        Resource.new(resource["name"], resource["explanation"], resource["examples"])
       end
     end
   end
 
   # Group of examples related to a specific resource, eg "Orders"
-  class Resource < Struct.new(:name, :examples)
+  class Resource < Struct.new(:name, :explanation, :examples)
     # @return [Array] array of {Raddocs::IndexExample IndexExamples}
     def examples
       @examples ||= super.map do |example|
         IndexExample.new(example)
       end
     end
+
+    def explanation?
+      !explanation.nil?
+    end
   end
 
   # Example model for the index page
@@ -42,17 +46,18 @@ module Raddocs
 
   # Example page model
   class Example
-    attr_reader :resource, :description, :explanation, :parameters, :response_fields,
+    attr_reader :resource, :resource_explanation, :description, :explanation, :parameters, :response_fields,
       :requests
 
     def initialize(file)
       @attrs = JSON.parse(File.read(file))
-
+      @resource_explanation = @attrs.fetch("resource_explanation", nil)
       @resource = @attrs.fetch("resource")
+      
       @description = @attrs.fetch("description")
       @explanation = @attrs.fetch("explanation", nil)
       @parameters = Parameters.new(@attrs.fetch("parameters"))
-      @response_fields = ResponseFields.new(@attrs.fetch("response_fields"))
+      @response_fields = ResponseFields.new(@attrs.fetch("response_fields", []))
       @requests = @attrs.fetch("requests").map { |request| Request.new(request) }
     end
 
@@ -60,6 +65,10 @@ module Raddocs
     def explanation?
       !explanation.nil?
     end
+
+    def resource_explanation?
+      !resource_explanation.nil?
+    end
   end
 
   # Guide page model

data/lib/views/example.haml

@@ -33,6 +33,9 @@
       = link_to "« Back to Index", "/"
 
     %h1== #{example.resource} API
+    - if example.resource_explanation?
+      %p.explanation
+        = example.resource_explanation
     .article
       %h2= example.description
 

data/lib/views/guide.erb

@@ -6,12 +6,12 @@
       <link rel="stylesheet" href="<%= file %>" />
     <% end %>
 
-    <script src="#{url_location}/js/jquery-1-7-2.js"></script>
-    <script src="#{url_location}/js/codemirror.js"></script>
-    <script src="#{url_location}/js/mode/css/css.js"></script>
-    <script src="#{url_location}/js/mode/htmlmixed/htmlmixed.js"></script>
-    <script src="#{url_location}/js/mode/javascript/javascript.js"></script>
-    <script src="#{url_location}/js/mode/xml/xml.js"></script>
+    <script src="<%= url_location %>/js/jquery-1-7-2.js"></script>
+    <script src="<%= url_location %>/js/codemirror.js"></script>
+    <script src="<%= url_location %>/js/mode/css/css.js"></script>
+    <script src="<%= url_location %>/js/mode/htmlmixed/htmlmixed.js"></script>
+    <script src="<%= url_location %>/js/mode/javascript/javascript.js"></script>
+    <script src="<%= url_location %>/js/mode/xml/xml.js"></script>
 
     <style>
       td.required .name:after {

data/lib/views/index.haml

@@ -9,6 +9,9 @@
 - index.resources.each do |resource|
   .resource
     %h2= resource.name
+    - if resource.explanation?
+      %p.explanation
+        = resource.explanation
     %ul.examples
       - resource.examples.each do |example|
         %li.example

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: raddocs
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 2.0.0
 platform: ruby
 authors:
 - Eric Oestrich
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-03 00:00:00.000000000 Z
+date: 2017-05-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: haml
   requirement: !ruby/object:Gem::Requirement