jsonapionify 0.9.1 → 0.9.2

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    NGNlYzQxYWRmZDlmZWJhODFiNDEwY2E3ZmZkNmRlNzA0YzhjODU1Zg==
+    MGU3ZWE5YTE4YTNiNjE1NTdiYzI2NTM2Y2UyYTA1ZTllNjVhZGQ3Ng==
   data.tar.gz: !binary |-
-    ZGY4YjVhMWZiZGY0NmM5YWNiZGRjOGUxY2ViMmRlZTNkNTA3YjhhNw==
+    OWViOTNhOGFmYmE2YmNhNGZhNDMzM2FhMzUzMmZmYTY2ZjY0NTNjZQ==
 SHA512:
   metadata.gz: !binary |-
-    ODE5ZWI5MjkxNjhhYzRjYzcwNWJlN2U1MTRlZjM4MjFiMDVlN2FhMzA3NDhh
-    YTc4Zjg1MzY0ZjQ3Zjg2YmUyZDdmZjQyM2ZlYzY4YmRjZjA4OTBmZjA5NDZm
-    YTRiZTAwOTgzNGFkYjY0YWYyZGMwNmEwZmE4YjM4OGY3NzgyY2Y=
+    MjhkNTFiZmZjNzc2ZjRmOTc2ZWQ2M2Y5ZGRkOWIyZTQzOTAxNTA5MDk0Yzg0
+    YjgxYjJhYWNmOTg5M2E5MDZhZjc4ZTE4ODI5YTVjZjM0YTg1YzEzMjYyYjBh
+    NmY2ZGRlMzAzY2Q5NTJkZGMwNGM1NjA2NzNhNmYxM2RmNGM1NGE=
   data.tar.gz: !binary |-
-    YjIxZmE5M2Y4YTVkYWIzOTg1MmVlNjhhMmU5ODU5MzY4YTQ1ZmZkMDM3OTVl
-    MGZmZGJhM2ViYTEyYjZkZTg0YjY4OTA5ZmIyZGE2OGUyNTg5ODk3Mjk0OTJm
-    OWU3YmNmMTllMmFkYThmYmRjNDUyNGRjZTNlMDVhMzM0YWJiNjg=
+    OWI4OWNkMWIyNTI3MDgzZGYyYzkxODZmMDNmNDI3MDYyYmZjYjZlZjI3YTFj
+    NjRlNzQ0ODJkNGU4OTU1NGNhZTc4YmVhOTdlZTZjNDY0ZGVlMjZjODI3MDUw
+    YzhkOTExMjViZTBiNjRlMmVkZTVjMjZlNWJmOGVkZTZhMjBhYjE=

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

@@ -0,0 +1,78 @@
+module JSONAPIonify::Api
+  module Action::Documentation
+    def documentation_object(base, resource, name, include_path, label)
+      url  = build_path(base, name.to_s, include_path)
+      path = URI.parse(url).path
+      OpenStruct.new(
+        id:              [request_method, path].join('-').parameterize,
+        label:           label,
+        sample_requests: example_requests(resource, url)
+      )
+    end
+
+    def example_input(resource)
+      request = Server::Request.env_for('http://example.org', request_method)
+      context = resource.new(
+        request: request,
+        context_definitions: sample_context(resource)
+      ).exec { |c| c }
+      case @example_input
+      when :resource
+        {
+          'data' => resource.build_resource(
+            context,
+            resource.example_instance_for_action(name, context),
+            relationships: false,
+            links:         false,
+            fields:        resource.fields_for_action(name, context)
+          ).as_json
+        }.to_json
+      when :resource_identifier
+        {
+          'data' => resource.build_resource_identifier(
+            resource.example_instance_for_action(name, context)
+          ).as_json
+        }.to_json
+      when Proc
+        @example_input.call
+      end
+    end
+
+    def example_requests(resource, url)
+      responses.map do |response|
+        opts                 = {}
+        opts['CONTENT_TYPE'] = content_type if @example_input
+        accept = response.accept || response.example_accept
+        opts['HTTP_ACCEPT']   = accept
+        if content_type == 'application/vnd.api+json' && @example_input
+          opts[:input] = example_input(resource)
+        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)
+      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(readonly: true) { true }
+        defs[:collection]           = Context.new(&collection_context)
+        defs[:paginated_collection] = Context.new { |context| context.collection }
+        defs[:instance]             = Context.new(readonly: true) { |context| context.collection.first }
+        defs[:owner_context]        = Context.new(readonly: true) { ContextDelegate::Mock.new } if defs.has_key? :owner_context
+      end
+    end
+
+    def sample_request(resource, request)
+      call(resource, request, context_definitions: sample_context(resource), callbacks: false)
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+module JSONAPIonify::Api
+  module Action::Dummy
+    def dummy(&block)
+      new(nil, nil, &block)
+    end
+
+    def error(name, &block)
+      dummy do
+        error_now name, &block
+      end
+    end
+  end
+end

data/lib/jsonapionify/api/action.rb

@@ -2,20 +2,15 @@ require 'unstrict_proc'
 
 module JSONAPIonify::Api
   class Action
+    extend JSONAPIonify::Autoload
+    autoload_all
+    extend Dummy
+    include Documentation
+
     attr_reader :name, :block, :content_type, :responses, :prepend,
                 :path, :request_method, :only_associated, :cacheable,
                 :callbacks
 
-    def self.dummy(&block)
-      new(nil, nil, &block)
-    end
-
-    def self.error(name, &block)
-      dummy do
-        error_now name, &block
-      end
-    end
-
     def initialize(name, request_method, path = nil,
                    example_input: nil,
                    content_type: nil,
@@ -38,6 +33,7 @@ module JSONAPIonify::Api
     end
 
     def initialize_copy(new_instance)
+      puts "DUPED!"
       super
       %i{@responses}.each do |ivar|
         value = instance_variable_get(ivar)
@@ -78,61 +74,6 @@ module JSONAPIonify::Api
       request.path_info.match(path_regex(base, name, include_path))
     end
 
-    def documentation_object(base, resource, name, include_path, label)
-      url  = build_path(base, name.to_s, include_path)
-      path = URI.parse(url).path
-      OpenStruct.new(
-        id:              [request_method, path].join('-').parameterize,
-        label:           label,
-        sample_requests: example_requests(resource, url)
-      )
-    end
-
-    def example_input(resource)
-      request = Server::Request.env_for('http://example.org', request_method)
-      context = ContextDelegate::Mock.new(
-        request: request, resource: resource.new, _is_example_: true, includes: []
-      )
-      case @example_input
-      when :resource
-        {
-          'data' => resource.build_resource(
-            context,
-            resource.example_instance_for_action(name, context),
-            relationships: false,
-            links:         false,
-            fields:        resource.fields_for_action(name, context)
-          ).as_json
-        }.to_json
-      when :resource_identifier
-        {
-          'data' => resource.build_resource_identifier(
-            resource.example_instance_for_action(name, context)
-          ).as_json
-        }.to_json
-      when Proc
-        @example_input.call
-      end
-    end
-
-    def example_requests(resource, url)
-      responses.map do |response|
-        opts                 = {}
-        opts['CONTENT_TYPE'] = content_type if @example_input
-        opts['HTTP_ACCEPT']  = response.accept
-        if content_type == 'application/vnd.api+json' && @example_input
-          opts[:input] = example_input(resource)
-        end
-        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 supports_content_type?(request)
       @content_type == request.content_type || !request.has_body?
     end
@@ -154,23 +95,6 @@ module JSONAPIonify::Api
       self
     end
 
-    def sample_context(resource)
-      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(readonly: true) { true }
-        defs[:collection]           = Context.new(&collection_context)
-        defs[:paginated_collection] = Context.new { |context| context.collection }
-        defs[:instance]             = Context.new(readonly: true) { |context| context.collection.first }
-        defs[:owner_context]        = Context.new(readonly: true) { ContextDelegate::Mock.new } if defs.has_key? :owner_context
-      end
-    end
-
-    def sample_request(resource, request)
-      call(resource, request, context_definitions: sample_context(resource), callbacks: false)
-    end
-
     def call(resource, request, callbacks: self.callbacks, **opts)
       resource.new(
         request:   request,

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

@@ -0,0 +1,25 @@
+module JSONAPIonify::Api
+  module Attribute::Documentation
+    def options_json_for_action(action_name, context)
+      {
+        name:        @name,
+        type:        @type.to_s,
+        description: JSONAPIonify::Documentation.onelinify_markdown(description),
+        example:     example(context.resource.class.generate_id)
+      }.tap do |opts|
+        opts[:not_null] = true if @type.not_null?
+        opts[:required] = true if required_for_action?(action_name, context)
+      end
+    end
+
+    def documentation_object
+      OpenStruct.new(
+        name:        name,
+        type:        type.name,
+        required:    required ? Array.wrap(required).join(', ') : false,
+        description: JSONAPIonify::Documentation.render_markdown(description),
+        allow:       allow
+      )
+    end
+  end
+end

data/lib/jsonapionify/api/attribute.rb

@@ -2,6 +2,10 @@ require 'unstrict_proc'
 
 module JSONAPIonify::Api
   class Attribute
+    extend JSONAPIonify::Autoload
+    autoload_all
+
+    include Documentation
     using UnstrictProc
     attr_reader :name, :type, :description, :read, :write, :required, :block
 
@@ -104,18 +108,6 @@ module JSONAPIonify::Api
         (required === true || Array.wrap(required).include?(action_name))
     end
 
-    def options_json_for_action(action_name, context)
-      {
-        name:        @name,
-        type:        @type.to_s,
-        description: JSONAPIonify::Documentation.onelinify_markdown(description),
-        example:     example(context.resource.class.generate_id)
-      }.tap do |opts|
-        opts[:not_null] = true if @type.not_null?
-        opts[:required] = true if required_for_action?(action_name, context)
-      end
-    end
-
     def read?
       !!@read
     end
@@ -135,16 +127,6 @@ module JSONAPIonify::Api
       end
     end
 
-    def documentation_object
-      OpenStruct.new(
-        name:        name,
-        type:        type.name,
-        required:    Array.wrap(required).join(', '),
-        description: JSONAPIonify::Documentation.render_markdown(description),
-        allow:       allow
-      )
-    end
-
     def allow
       Array.new.tap do |ary|
         ary << 'read' if read?

data/lib/jsonapionify/api/base/{doc_helper.rb → documentation.rb}

@@ -1,5 +1,5 @@
 module JSONAPIonify::Api
-  module Base::DocHelper
+  module Base::Documentation
     Link = Struct.new(:title, :href)
 
     def self.extended(klass)

data/lib/jsonapionify/api/base.rb

@@ -6,7 +6,7 @@ module JSONAPIonify::Api
     extend JSONAPIonify::Autoload
     autoload_all
     extend AppBuilder
-    extend DocHelper
+    extend Documentation
     extend ClassMethods
     extend Delegation
     extend ResourceDefinitions

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

@@ -0,0 +1,18 @@
+module JSONAPIonify::Api
+  module Relationship::Documentation
+    def options_json
+      {
+        name:              name,
+        type:              resource.type,
+        relationship_type: self.class.name.split(':').last.downcase
+      }
+    end
+
+    def documentation_object
+      OpenStruct.new(
+        name:     name,
+        resource: resource_class.type
+      )
+    end
+  end
+end

data/lib/jsonapionify/api/relationship.rb

@@ -4,6 +4,7 @@ module JSONAPIonify::Api
     autoload_all
 
     extend Blocks
+    include Documentation
 
     prepend_class do
       remove_action :delete, :update
@@ -73,21 +74,6 @@ module JSONAPIonify::Api
       @resolve    = resolve
     end
 
-    def options_json
-      {
-        name:              name,
-        type:              resource.type,
-        relationship_type: self.class.name.split(':').last.downcase
-      }
-    end
-
-    def documentation_object
-      OpenStruct.new(
-        name:     name,
-        resource: resource_class.type
-      )
-    end
-
     def resource_class
       @resource_class ||= begin
         rel = self

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

@@ -50,27 +50,6 @@ module JSONAPIonify::Api
       end.to_s
     end
 
-    def documented_actions_in_order
-      indexes = %i{list create read update delete add replace remove}
-      documented_actions.reject do |a, *|
-        ['HEAD', 'OPTIONS'].include? a.request_method
-      end.sort_by do |action, *|
-        indexes.index(action.name) || indexes.length
-      end
-    end
-
-    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|
-          action.documentation_object File.join(base_url, base), *args
-        end
-      )
-    end
-
     def cache(store, *args)
       self.cache_store = ActiveSupport::Cache.lookup_store(store, *args)
     end

data/lib/jsonapionify/api/resource/defaults/options.rb

@@ -4,7 +4,7 @@ module JSONAPIonify::Api
     included do
       id :id
       scope { self.type.classify.constantize }
-      collection do |scope|
+      collection do |scope, context|
         if defined?(ActiveRecord) && scope < ActiveRecord::Base && scope.is_a?(Class)
           scope.all
         else

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

@@ -0,0 +1,57 @@
+module JSONAPIonify::Api
+  module Resource::Documentation
+
+    def self.extended(mod)
+      mod.example_id_generator { |val| val }
+    end
+
+    def documented_actions_in_order
+      indexes = %i{list create read update delete add replace remove}
+      documented_actions.reject do |a, *|
+        ['HEAD', 'OPTIONS'].include? a.request_method
+      end.sort_by do |action, *|
+        indexes.index(action.name) || indexes.length
+      end
+    end
+
+    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|
+          action.documentation_object File.join(base_url, base), *args
+        end
+      )
+    end
+
+    def example_id_generator(&block)
+      index = 0
+      define_singleton_method(:generate_id) do
+        instance_exec index += 1, &block
+      end
+      context :example_id do
+        self.class.generate_id
+      end
+    end
+
+    def example_instance_for_action(action, context)
+      id = generate_id
+      OpenStruct.new.tap do |instance|
+        instance.send "#{id_attribute}=", id.to_s
+        actionable_attributes = attributes.select do |attr|
+          attr.supports_read_for_action?(action, context)
+        end
+        actionable_attributes.each do |attribute|
+          instance.send "#{attribute.name}=", attribute.example(id)
+        end
+
+        instance.define_singleton_method :method_missing do |*args|
+          self
+        end
+      end
+    end
+
+  end
+end

data/lib/jsonapionify/api/resource.rb

@@ -9,6 +9,7 @@ module JSONAPIonify::Api
 
     extend Definitions
     extend ClassMethods
+    extend Documentation
 
     include ErrorHandling
     include Includer
@@ -32,31 +33,6 @@ module JSONAPIonify::Api
       )
     end
 
-    def self.example_id_generator(&block)
-      index = 0
-      define_singleton_method(:generate_id) do
-        instance_exec index += 1, &block
-      end
-      context :example_id do
-        self.class.generate_id
-      end
-    end
-
-    def self.example_instance_for_action(action, context)
-      id = generate_id
-      OpenStruct.new.tap do |instance|
-        instance.send "#{id_attribute}=", id.to_s
-        actionable_attributes = attributes.select do |attr|
-          attr.supports_read_for_action?(action, context)
-        end
-        actionable_attributes.each do |attribute|
-          instance.send "#{attribute.name}=", attribute.example(id)
-        end
-      end
-    end
-
-    example_id_generator { |val| val }
-
     attr_reader :errors, :action, :response_headers
 
     def initialize(

data/lib/jsonapionify/api/response.rb

@@ -1,12 +1,15 @@
 module JSONAPIonify::Api
   class Response
     attr_reader :action, :accept, :response_block, :status,
-                :matcher, :content_type
+                :matcher, :content_type, :extension, :example_accept
 
-    def initialize(action, accept: 'application/vnd.api+json', content_type: nil, status: nil, match: nil, cacheable: true, &block)
+    def initialize(action, accept: 'application/vnd.api+json', content_type: nil, status: nil, match: nil, cacheable: true, extension: nil, &block)
+      accept          = MIME::Types.type_for("ex.#{extension}")[0]&.content_type if extension
+      @extension      = extension.to_s if extension
       @action         = action
       @response_block = block || proc {}
       @accept         = accept unless match
+      @example_accept = accept
       @content_type   = content_type || (@accept == '*/*' ? nil : @accept)
       @matcher        = match || proc {}
       @status         = status || 200

data/lib/jsonapionify/documentation/template.erb

@@ -390,10 +390,10 @@
                             <div class="col-xs-4 attribute-name">
                               <strong><%= attribute.name %></strong>
                               <i class="attribute-type"><%= attribute.type %></i>
-                              <% if attribute.required.present? %>
-                                  <p class="optional">required: <%= attribute.required? %></p>
+                              <% if attribute.required %>
+                                <p class="optional">required: <%= attribute.required %></p>
                               <% else %>
-                                  <p class="optional">optional</p>
+                                <p class="optional">optional</p>
                               <% end %>
                             </div>
                             <div class="col-xs-8 attribute-description">

data/lib/jsonapionify/version.rb

@@ -1,3 +1,3 @@
 module JSONAPIonify
-  VERSION = "0.9.1"
+  VERSION = "0.9.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jsonapionify
 version: !ruby/object:Gem::Version
-  version: 0.9.1
+  version: 0.9.2
 platform: ruby
 authors:
 - Jason Waldrip
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-05-19 00:00:00.000000000 Z
+date: 2016-05-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -503,12 +503,15 @@ files:
 - lib/jsonapionify.rb
 - lib/jsonapionify/api.rb
 - lib/jsonapionify/api/action.rb
+- lib/jsonapionify/api/action/documentation.rb
+- lib/jsonapionify/api/action/dummy.rb
 - lib/jsonapionify/api/attribute.rb
+- lib/jsonapionify/api/attribute/documentation.rb
 - lib/jsonapionify/api/base.rb
 - lib/jsonapionify/api/base/app_builder.rb
 - lib/jsonapionify/api/base/class_methods.rb
 - lib/jsonapionify/api/base/delegation.rb
-- lib/jsonapionify/api/base/doc_helper.rb
+- lib/jsonapionify/api/base/documentation.rb
 - lib/jsonapionify/api/base/reloader.rb
 - lib/jsonapionify/api/base/resource_definitions.rb
 - lib/jsonapionify/api/context.rb
@@ -519,6 +522,7 @@ files:
 - lib/jsonapionify/api/param_options.rb
 - lib/jsonapionify/api/relationship.rb
 - lib/jsonapionify/api/relationship/blocks.rb
+- lib/jsonapionify/api/relationship/documentation.rb
 - lib/jsonapionify/api/relationship/many.rb
 - lib/jsonapionify/api/relationship/one.rb
 - lib/jsonapionify/api/resource.rb
@@ -546,6 +550,7 @@ files:
 - lib/jsonapionify/api/resource/definitions/response_headers.rb
 - lib/jsonapionify/api/resource/definitions/scopes.rb
 - lib/jsonapionify/api/resource/definitions/sorting.rb
+- lib/jsonapionify/api/resource/documentation.rb
 - lib/jsonapionify/api/resource/error_handling.rb
 - lib/jsonapionify/api/resource/exec.rb
 - lib/jsonapionify/api/resource/includer.rb