jsonapionify 0.12.9 → 0.12.10

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ZDY5OTI1YzBhMWMzMjE1NmNiYjM3NTM5NWI2Y2FhNWJmMDI3ZDYyMQ==
+    ZDU0ZmY4YTUxZTBiMzRmYWI3ZGYzODE3YmVmYTA0NWIyNzJmNjczNg==
   data.tar.gz: !binary |-
-    MTRiNTI3NTI4ODhjZTk1NzNiNzExYzBmOTU5NjE2ZTliZjRmN2Y4Zg==
+    YjAxNzVhMzI3YjZmODhkZDI2NDM5M2U2ZThhOTYzNmQ3MDBjZjEwZQ==
 SHA512:
   metadata.gz: !binary |-
-    ZGM4NTlkMDAxYWE5YjAwZDIwNjA4YjQ3NTE2MGU2MTM3MTI0ZTJlZTUzOWFk
-    OTFmODZjN2EzODhiYmU0ZjdjNWQ3YmU0YjdiNTIxZDI5NDRmMzRmMTAxYzFk
-    MjUxYjUyNjA3NTNlZjk1ZDIxNjgzNzJhM2RiNDM0MWU2ODkxNGY=
+    NDNhNjZlNzZiZTI3ZDZhM2IzZDMwMmZhZjQ1YmM0ZGU5NDAyNmFjMWJiNDky
+    YjAyOGM5NDk5NjMxMWJkMDg0YjVlZGQ0NjA4MjBmOGEwMzVlYzhiYjAzMmEy
+    ZTMyYjVhZWI3MTEwMjk0YzExOWRhMWQ4NjU0NmE3ZmNmOTY4MjI=
   data.tar.gz: !binary |-
-    MzI4NDUyZTQyZTgyOTdiNWJiZjZkNzE0Y2JiYWRhZTYzMzY0MDVjNjM2ZWMy
-    MTAwOWFkNmJjZmJkNmUwZmMzZmE0MjQ3NTI1MjkyNTQ2M2U3MjJlMzBmMDQ1
-    MmNkNjY2OGVhZDBkMzY3NmU0NWY3NDU5ZjM5ZDQ1ZmFkNzRlNDc=
+    MTdhOTRkYmUwZTU4MTQwMDM1NzE5YTljNmY5NGI4NDE0ZTE2OGViNTRjYTRh
+    M2U5ZmUwODUxMmM0ZWMzMzVhMzQ1YWQ2YTI4ZDk3ZDc4ZjQyOWJmOGIyODZh
+    ZmVhODdmN2JhNWM1YzNiNjY3MjY1YjhmZmIxYWMyMzFlNWI3YWQ=

data/lib/jsonapionify.rb

@@ -37,7 +37,9 @@ module JSONAPIonify
   end
 
   def self.files
-    Dir.glob(File.join __dir__, './**/*.rb').map { |f| File.expand_path f }.sort
+    files = Dir.glob(File.join __dir__, './**/*.rb').map { |f| File.expand_path f }
+    files << File.expand_path('./jsonapionify/documentation/template.erb', __dir__)
+    files.sort
   end
 
   def self.digest

data/lib/jsonapionify/api/action/documentation.rb

@@ -48,36 +48,14 @@ module JSONAPIonify::Api
         accept = response.accept || response.example_accept
         opts['HTTP_ACCEPT']   = accept
         if content_type == 'application/vnd.api+json' && @example_input
-          opts[:input] = example_input(resource)
+          opts[:input] = "{ ...request body... }"
         end
         url = "#{url}.#{response.extension}" if response.extension
         request  = Server::Request.env_for(url, request_method, opts)
-        response = Server::MockResponse.new(*sample_request(resource, request))
-
         OpenStruct.new(
           request:  request.http_string,
-          response: response.http_string
         )
       end
     end
-
-    def sample_context(resource)
-      action = self
-      resource.context_definitions.dup.tap do |defs|
-        collection_context          = proc do |context|
-          3.times.map { resource.example_instance_for_action(action.name, context) }
-        end
-        defs[:_is_example_]         = Context.new(:_is_example_, readonly: true) { true }
-        defs[:collection]           = Context.new(:collection, &collection_context)
-        defs[:paginated_collection] = Context.new(:paginated_collection) { |collection:| collection }
-        defs[:instance]             = Context.new(:instance, readonly: true) { |collection:| collection.first }
-        defs[:owner_context]        = Context.new(:owner_context, readonly: true) { ContextDelegate::Mock.new } if defs.has_key? :owner_context
-        defs[:action]               = Context.new(:action, readonly: true) { action }
-      end
-    end
-
-    def sample_request(resource, request)
-      call(resource, request, context_definitions: sample_context(resource), callbacks: false)
-    end
   end
 end

data/lib/jsonapionify/api/param_options.rb

@@ -66,6 +66,10 @@ module JSONAPIonify::Api
       with_value @default
     end
 
+    def default_value
+      @default
+    end
+
     def extract_value(params)
       keypath.reduce(params) do |p, key|
         p[key.to_s]

data/lib/jsonapionify/api/resource/documentation.rb

@@ -16,11 +16,13 @@ module JSONAPIonify::Api
 
     def documentation_object(base_url)
       OpenStruct.new(
-        name:          type,
-        description:   JSONAPIonify::Documentation.render_markdown(@description || ''),
-        relationships: relationships.map { |r| r.documentation_object },
-        attributes:    attributes.sort_by(&:name).map(&:documentation_object),
-        actions:       documented_actions_in_order.map do |action, base, args|
+        name:             type,
+        description:      JSONAPIonify::Documentation.render_markdown(@description || ''),
+        relationships:    relationships.map { |r| r.documentation_object },
+        request_headers:  request_header_definitions.values.map { |h| OpenStruct.new name: h.name, required: h.required, actions: h.actions },
+        params:           param_definitions.values.map { |p| OpenStruct.new name: p.string, required: p.required, default: p.default_value }.reject { |p| p.name.start_with? 'fields[' },
+        attributes:       attributes.sort_by(&:name).map(&:documentation_object),
+        actions:          documented_actions_in_order.map do |action, base, args|
           action.documentation_object File.join(base_url, base), *args
         end
       )

data/lib/jsonapionify/documentation/template.erb

@@ -381,6 +381,51 @@
             <p><%= resource.description %></p>
 
             <div class="details">
+              <% if resource.request_headers.present? %>
+                  <h4 id="<%= resource.name %>-params">Request Headers</h4>
+                  <ul class="attributes">
+                    <% resource.request_headers.each do |header| %>
+                        <li>
+                          <div class="row-attribute">
+                            <div class="col-xs-4 param-name">
+                              <strong><%= header.name %></strong>
+                              <% if header.required %>
+                                <p class="optional">required: <%= header.required %></p>
+                              <% else %>
+                                <p class="optional">optional</p>
+                              <% end %>
+                            </div>
+                            <div style="clear: both;"></div>
+                          </div>
+                        </li>
+                    <% end %>
+                  </ul>
+              <% end %>
+
+              <% if resource.params.present? %>
+                  <h4 id="<%= resource.name %>-params">Query Params</h4>
+                  <ul class="attributes">
+                    <% resource.params.each do |param| %>
+                        <li>
+                          <div class="row-attribute">
+                            <div class="col-xs-4 param-name">
+                              <strong><%= param.name %></strong>
+                              <% if param.default.present? %>
+                                <i class="attribute-default">&mdash; default: <%= param.default %></i>
+                              <% end %>
+                              <% if param.required %>
+                                <p class="optional">required: <%= param.required %></p>
+                              <% else %>
+                                <p class="optional">optional</p>
+                              <% end %>
+                            </div>
+                            <div style="clear: both;"></div>
+                          </div>
+                        </li>
+                    <% end %>
+                  </ul>
+              <% end %>
+
               <% if resource.attributes.present? %>
                   <h4 id="<%= resource.name %>-attributes">Attributes</h4>
                   <ul class="attributes">
@@ -423,8 +468,6 @@
                   <% action.sample_requests.each do |sample_request| %>
                       <h5>Request</h5>
                       <pre><code class="http"><%= sample_request.request %></code></pre>
-                      <h5>Response</h5>
-                      <pre><code class="http"><%= sample_request.response %></code></pre>
                   <% end %>
               <% end %>
             </div>

data/lib/jsonapionify/version.rb

@@ -1,3 +1,3 @@
 module JSONAPIonify
-  VERSION = "0.12.9"
+  VERSION = "0.12.10"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jsonapionify
 version: !ruby/object:Gem::Version
-  version: 0.12.9
+  version: 0.12.10
 platform: ruby
 authors:
 - Jason Waldrip
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-07-29 00:00:00.000000000 Z
+date: 2016-08-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport