jsonapi_swagger_helpers 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9a9dd06a7c8afca90ba9b3b340598a61ee7473d4
-  data.tar.gz: a4e56e637f81f4da21a6e784c9a4d2dae0b85953
+  metadata.gz: 6e5e96630c96f25da98ee7a9ff41551e282da46d
+  data.tar.gz: 144a9a7a03e9f768864958a9d0ae29a9410a533b
 SHA512:
-  metadata.gz: 002f847d7f43fa3433932b72fab3e1efba37aafa120d2ba7332b9df78c9792a7e9075d5e30a6f56592d69c49a8ab5a213a03ad55463cce5db5040720d2896fd1
-  data.tar.gz: edc488adacd76b2281ad138410e37e3150fb380b889550ec171f8e0e90207e5dd917c81fb94f40335189d790f7a50f648f9865d517a68969e0f29841699e54de
+  metadata.gz: 53242cf8560b129aa133be07917aa1cc38ecd15d7151a69d29e4d1d80118f63e90834c8d00310fd236754beb04088c17674c5c3b336982159d4f625c6bd9b350
+  data.tar.gz: 9b07e484928616360f8a1415c9ce7b650edf803628a208ac295d2a847a131241f8bf051217e84f66dfa3bb5e522d3b240c4dcb20059f34342cab9f54ba1a0f05

data/lib/jsonapi_swagger_helpers.rb

@@ -1,5 +1,6 @@
 require 'swagger/blocks'
 require "jsonapi_spec_helpers"
+require "jsonapi_swagger_helpers/errors"
 require "jsonapi_swagger_helpers/configuration"
 require "jsonapi_swagger_helpers/payload_definition"
 require "jsonapi_swagger_helpers/util"

data/lib/jsonapi_swagger_helpers/configuration.rb

@@ -1,10 +1,12 @@
-class JsonapiSwaggerHelpers::Configuration
-  def type_mapping
-    @type_mapping ||= {
-      string: [String],
-      integer: [Integer, Bignum],
-      float: [Float],
-      boolean: [TrueClass, FalseClass]
-    }
+module JsonapiSwaggerHelpers
+  class Configuration
+    def type_mapping
+      @type_mapping ||= {
+        string: [String],
+        integer: [Integer, Bignum],
+        float: [Float],
+        boolean: [TrueClass, FalseClass]
+      }
+    end
   end
 end

data/lib/jsonapi_swagger_helpers/create_action.rb

@@ -1,25 +1,27 @@
-class JsonapiSwaggerHelpers::CreateAction
-  include JsonapiSwaggerHelpers::Writeable
+module JsonapiSwaggerHelpers
+  class CreateAction
+    include JsonapiSwaggerHelpers::Writeable
 
-  def action_name
-    :create
-  end
+    def action_name
+      :create
+    end
 
-  def generate
-    _self = self
+    def generate
+      _self = self
 
-    define_schema
-    @node.operation :post do
-      key :description, _self.description
-      key :operationId, _self.operation_id
-      key :tags, _self.all_tags
+      define_schema
+      @node.operation :post do
+        key :description, _self.description
+        key :operationId, _self.operation_id
+        key :tags, _self.all_tags
 
-      parameter do
-        key :name, :payload
-        key :in, :body
+        parameter do
+          key :name, :payload
+          key :in, :body
 
-        schema do
-          key :'$ref', :"#{_self.strong_resource.name}_create"
+          schema do
+            key :'$ref', :"#{_self.strong_resource.name}_create"
+          end
         end
       end
     end

data/lib/jsonapi_swagger_helpers/destroy_action.rb

@@ -1,19 +1,21 @@
-class JsonapiSwaggerHelpers::DestroyAction
-  include JsonapiSwaggerHelpers::Writeable
+module JsonapiSwaggerHelpers
+  class DestroyAction
+    include JsonapiSwaggerHelpers::Writeable
 
-  def action_name
-    :destroy
-  end
+    def action_name
+      :destroy
+    end
 
-  def generate
-    _self = self
+    def generate
+      _self = self
 
-    @node.operation :delete do
-      key :description, _self.description
-      key :operationId, _self.operation_id
-      key :tags, _self.tags
+      @node.operation :delete do
+        key :description, _self.description
+        key :operationId, _self.operation_id
+        key :tags, _self.tags
 
-      _self.util.id_in_url(self)
+        _self.util.id_in_url(self)
+      end
     end
   end
 end

data/lib/jsonapi_swagger_helpers/errors.rb

@@ -0,0 +1,22 @@
+module JsonapiSwaggerHelpers
+  module Errors
+    class TypeNotFound < StandardError
+      def initialize(payload_name, attribute)
+        @payload_name = payload_name
+        @attribute = attribute
+      end
+
+      def message
+        <<-STR
+Could not find type mapping for payload "#{@payload_name}", key "#{@attribute}".
+
+To add a custom mapping:
+
+JsonapiSwaggerHelpers.config do |c|
+  c.type_mapping[:string] << MyCustomType
+end
+        STR
+      end
+    end
+  end
+end

data/lib/jsonapi_swagger_helpers/index_action.rb

@@ -1,42 +1,44 @@
-class JsonapiSwaggerHelpers::IndexAction
-  include JsonapiSwaggerHelpers::Readable
+module JsonapiSwaggerHelpers
+  class IndexAction
+    include JsonapiSwaggerHelpers::Readable
 
-  def action_name
-    :index
-  end
+    def action_name
+      :index
+    end
 
-  def generate
-    _self = self
+    def generate
+      _self = self
 
-    @node.operation :get do
-      key :description, _self.full_description
-      key :operationId, _self.operation_id
-      key :tags, _self.all_tags
+      @node.operation :get do
+        key :description, _self.full_description
+        key :operationId, _self.operation_id
+        key :tags, _self.all_tags
 
-      _self.util.jsonapi_sorting(self)
-      _self.util.jsonapi_pagination(self)
+        _self.util.jsonapi_sorting(self)
+        _self.util.jsonapi_pagination(self)
 
-      _self.util.each_filter(_self.resource) do |filter_label|
-        _self.util.jsonapi_filter(self, filter_label)
-      end
+        _self.util.each_filter(_self.resource) do |filter_label|
+          _self.util.jsonapi_filter(self, filter_label)
+        end
 
-      _self.each_stat do |stat_name, calculations|
-        _self.util.jsonapi_stat(self, stat_name, calculations)
-      end
+        _self.each_stat do |stat_name, calculations|
+          _self.util.jsonapi_stat(self, stat_name, calculations)
+        end
 
-      _self.util.jsonapi_fields(self, _self.jsonapi_type)
+        _self.util.jsonapi_fields(self, _self.jsonapi_type)
 
-      if _self.has_extra_fields?
-        _self.util.jsonapi_extra_fields(self, _self.resource)
-      end
+        if _self.has_extra_fields?
+          _self.util.jsonapi_extra_fields(self, _self.resource)
+        end
 
-      if _self.has_sideloads?
-        _self.util.jsonapi_includes(self)
+        if _self.has_sideloads?
+          _self.util.jsonapi_includes(self)
 
-        _self.each_association do |association_name, association_resource|
-          _self.util.each_filter(association_resource, association_name) do |filter_label|
-            _self.util.jsonapi_filter(self, filter_label)
-            _self.util.jsonapi_fields(self, association_resource.config[:type])
+          _self.each_association do |association_name, association_resource|
+            _self.util.each_filter(association_resource, association_name) do |filter_label|
+              _self.util.jsonapi_filter(self, filter_label)
+              _self.util.jsonapi_fields(self, association_resource.config[:type])
+            end
           end
         end
       end

data/lib/jsonapi_swagger_helpers/payload_definition.rb

@@ -1,55 +1,57 @@
-class JsonapiSwaggerHelpers::PayloadDefinition
-  attr_reader :payload
-
-  # Given a spec payload like:
-  #
-  # key(:name, String)
-  #
-  # Return the corresponding swagger type, ie :string
-  # If a key has multiple types, we'll pick the first swagger type that matches:
-  #
-  # key(:total, [String, Integer]) => :string
-  def self.swagger_type_for(payload_name, attribute, type)
-    types = Array(type)
-    return :string if types.empty?
-
-    type_mapping.each_pair do |swagger_type, klasses|
-      if types.any? { |t| klasses.include?(t) }
-        return swagger_type
+module JsonapiSwaggerHelpers
+  class PayloadDefinition
+    attr_reader :payload
+
+    # Given a spec payload like:
+    #
+    # key(:name, String)
+    #
+    # Return the corresponding swagger type, ie :string
+    # If a key has multiple types, we'll pick the first swagger type that matches:
+    #
+    # key(:total, [String, Integer]) => :string
+    def self.swagger_type_for(payload_name, attribute, type)
+      types = Array(type)
+      return :string if types.empty?
+
+      type_mapping.each_pair do |swagger_type, klasses|
+        if types.any? { |t| klasses.include?(t) }
+          return swagger_type
+        end
       end
-    end
 
-    raise JsonapiSwaggerHelpers::Errors::TypeNotFound
-      .new(payload_name, attribute)
-  end
+      raise JsonapiSwaggerHelpers::Errors::TypeNotFound
+        .new(payload_name, attribute)
+    end
 
-  def self.type_mapping
-    JsonapiSwaggerHelpers.config.type_mapping
-  end
+    def self.type_mapping
+      JsonapiSwaggerHelpers.config.type_mapping
+    end
 
-  def initialize(payload)
-    @payload = payload
-  end
+    def initialize(payload)
+      @payload = payload
+    end
 
-  def context
-    JsonapiSwaggerHelpers.docs_controller
-  end
+    def context
+      JsonapiSwaggerHelpers.docs_controller
+    end
 
-  def jsonapi_type
-    payload.type
-  end
+    def jsonapi_type
+      payload.type
+    end
 
-  def generate
-    _self = self
+    def generate
+      _self = self
 
-    context.send(:swagger_schema, payload.name) do
-      payload = _self.payload
+      context.send(:swagger_schema, payload.name) do
+        payload = _self.payload
 
-      payload.keys.each_pair do |attribute, config|
-        property attribute do
-          type = _self.class.swagger_type_for(payload.name, attribute, config[:type])
-          key :type, type
-          key :description, config[:description]
+        payload.keys.each_pair do |attribute, config|
+          property attribute do
+            type = _self.class.swagger_type_for(payload.name, attribute, config[:type])
+            key :type, type
+            key :description, config[:description]
+          end
         end
       end
     end

data/lib/jsonapi_swagger_helpers/readable.rb

@@ -1,83 +1,85 @@
-module JsonapiSwaggerHelpers::Readable
-  def self.included(klass)
-    klass.class_eval do
-      attr_reader :node,
-        :controller,
-        :resource,
-        :description,
-        :tags
+module JsonapiSwaggerHelpers
+  module Readable
+    def self.included(klass)
+      klass.class_eval do
+        attr_reader :node,
+          :controller,
+          :resource,
+          :description,
+          :tags
+      end
     end
-  end
 
-  def initialize(node, controller, description: nil, tags: [])
-    @node = node
-    @controller = controller
-    @resource = controller._jsonapi_compliable
-    @description = description || default_description
-    @tags = tags
-  end
+    def initialize(node, controller, description: nil, tags: [])
+      @node = node
+      @controller = controller
+      @resource = controller._jsonapi_compliable
+      @description = description || default_description
+      @tags = tags
+    end
 
-  def default_description
-    "#{action_name.capitalize} Action"
-  end
+    def default_description
+      "#{action_name.capitalize} Action"
+    end
 
-  def operation_id
-    "#{controller.name.gsub('::', '-')}-#{action_name}"
-  end
+    def operation_id
+      "#{controller.name.gsub('::', '-')}-#{action_name}"
+    end
 
-  def util
-    JsonapiSwaggerHelpers::Util
-  end
+    def util
+      JsonapiSwaggerHelpers::Util
+    end
 
-  def include_directive
-    util.include_directive_for(controller, action_name)
-  end
+    def include_directive
+      util.include_directive_for(controller, action_name)
+    end
 
-  def has_sideloads?
-    include_directive.keys.length > 0
-  end
+    def has_sideloads?
+      include_directive.keys.length > 0
+    end
 
-  def has_extra_fields?
-    resource.config[:extra_fields].keys.length > 1
-  end
+    def has_extra_fields?
+      resource.config[:extra_fields].keys.length > 1
+    end
 
-  def full_description
-    "#{description}<br /><br />#{util.sideload_label(include_directive)}"
-  end
+    def full_description
+      "#{description}<br /><br />#{util.sideload_label(include_directive)}"
+    end
 
-  def all_tags
-    tags + payload_tags
-  end
+    def all_tags
+      tags + payload_tags
+    end
 
-  def payload_tags
-    util.payload_tags_for(resource, include_directive.to_hash)
-  end
+    def payload_tags
+      util.payload_tags_for(resource, include_directive.to_hash)
+    end
 
-  def operation_id
-    "#{controller.name.gsub('::', '-')}-#{action_name}"
-  end
+    def operation_id
+      "#{controller.name.gsub('::', '-')}-#{action_name}"
+    end
 
-  def each_stat
-    resource.config[:stats].each_pair do |stat_name, opts|
-      calculations = opts.calculations.keys - [:keys]
-      calculations = calculations.join(', ')
+    def each_stat
+      resource.config[:stats].each_pair do |stat_name, opts|
+        calculations = opts.calculations.keys - [:keys]
+        calculations = calculations.join(', ')
 
-      yield stat_name, calculations
+        yield stat_name, calculations
+      end
     end
-  end
 
-  def each_association
-    resource_map = util.all_resources(resource, include_directive)
-    resource_map.each_pair do |association_name, association_resource|
-      yield association_name, association_resource
+    def each_association
+      resource_map = util.all_resources(resource, include_directive)
+      resource_map.each_pair do |association_name, association_resource|
+        yield association_name, association_resource
+      end
     end
-  end
 
-  def jsonapi_type
-    resource.config[:type]
-  end
+    def jsonapi_type
+      resource.config[:type]
+    end
 
-  def generate
-    raise 'override me'
+    def generate
+      raise 'override me'
+    end
   end
 end

data/lib/jsonapi_swagger_helpers/show_action.rb

@@ -1,39 +1,41 @@
-class JsonapiSwaggerHelpers::ShowAction
-  include JsonapiSwaggerHelpers::Readable
+module JsonapiSwaggerHelpers
+  class ShowAction
+    include JsonapiSwaggerHelpers::Readable
 
-  def action_name
-    :show
-  end
+    def action_name
+      :show
+    end
 
-  def generate
-    _self = self
+    def generate
+      _self = self
 
-    @node.operation :get do
-      key :description, _self.full_description
-      key :operationId, _self.operation_id
-      key :tags, _self.all_tags
+      @node.operation :get do
+        key :description, _self.full_description
+        key :operationId, _self.operation_id
+        key :tags, _self.all_tags
 
-      _self.util.id_in_url(self)
-      _self.util.jsonapi_fields(self, _self.jsonapi_type)
+        _self.util.id_in_url(self)
+        _self.util.jsonapi_fields(self, _self.jsonapi_type)
 
-      if _self.has_extra_fields?
-        _self.util.jsonapi_extra_fields(self, _self.resource)
-      end
+        if _self.has_extra_fields?
+          _self.util.jsonapi_extra_fields(self, _self.resource)
+        end
 
-      _self.each_stat do |stat_name, calculations|
-        _self.util.jsonapi_stat(self, stat_name, calculations)
-      end
+        _self.each_stat do |stat_name, calculations|
+          _self.util.jsonapi_stat(self, stat_name, calculations)
+        end
 
-      if _self.has_sideloads?
-        _self.util.jsonapi_includes(self)
+        if _self.has_sideloads?
+          _self.util.jsonapi_includes(self)
 
-        _self.each_association do |association_name, association_resource|
-          _self.util.each_filter(association_resource, association_name) do |filter_label|
-            _self.util.jsonapi_filter(self, filter_label)
-            _self.util.jsonapi_fields(self, association_resource.config[:type])
+          _self.each_association do |association_name, association_resource|
+            _self.util.each_filter(association_resource, association_name) do |filter_label|
+              _self.util.jsonapi_filter(self, filter_label)
+              _self.util.jsonapi_fields(self, association_resource.config[:type])
 
-            if association_resource.config[:extra_fields].keys.length > 0
-              _self.util.jsonapi_extra_fields(self, association_resource)
+              if association_resource.config[:extra_fields].keys.length > 0
+                _self.util.jsonapi_extra_fields(self, association_resource)
+              end
             end
           end
         end

data/lib/jsonapi_swagger_helpers/update_action.rb

@@ -1,27 +1,29 @@
-class JsonapiSwaggerHelpers::UpdateAction
-  include JsonapiSwaggerHelpers::Writeable
+module JsonapiSwaggerHelpers
+  class UpdateAction
+    include JsonapiSwaggerHelpers::Writeable
 
-  def action_name
-    :update
-  end
+    def action_name
+      :update
+    end
 
-  def generate
-    _self = self
+    def generate
+      _self = self
 
-    define_schema
-    @node.operation :put do
-      key :description, _self.description
-      key :operationId, _self.operation_id
-      key :tags, _self.all_tags
+      define_schema
+      @node.operation :put do
+        key :description, _self.description
+        key :operationId, _self.operation_id
+        key :tags, _self.all_tags
 
-      _self.util.id_in_url(self)
+        _self.util.id_in_url(self)
 
-      parameter do
-        key :name, :payload
-        key :in, :body
+        parameter do
+          key :name, :payload
+          key :in, :body
 
-        schema do
-          key :'$ref', :"#{_self.strong_resource.name}_update"
+          schema do
+            key :'$ref', :"#{_self.strong_resource.name}_update"
+          end
         end
       end
     end

data/lib/jsonapi_swagger_helpers/util.rb

@@ -1,165 +1,167 @@
-module JsonapiSwaggerHelpers::Util
-  def self.controller_for(path)
-    path = path.sub('{id}', '1')
-    route = Rails.application.routes.recognize_path(path)
-    "#{route[:controller]}_controller".classify.constantize
-  end
+module JsonapiSwaggerHelpers
+  class Util
+    def self.controller_for(path)
+      path = path.sub('{id}', '1')
+      route = Rails.application.routes.recognize_path(path)
+      "#{route[:controller]}_controller".classify.constantize
+    end
 
-  def self.sideload_label(include_directive)
-    sideloads = include_directive.to_string.split(",").sort.join(",<br/>")
+    def self.sideload_label(include_directive)
+      sideloads = include_directive.to_string.split(",").sort.join(",<br/>")
 
-    <<-HTML
-<label>
-  Possible sideloads:
-  <span class="possible-sideloads">#{sideloads}</span>
-</label>
-    HTML
-  end
+      <<-HTML
+  <label>
+    Possible sideloads:
+    <span class="possible-sideloads">#{sideloads}</span>
+  </label>
+      HTML
+    end
 
-  def self.each_filter(resource, association_name = nil)
-    resource.config[:filters].each_pair do |filter_name, opts|
-      if association_name
-        yield "filter[#{association_name}][#{filter_name}]"
-      else
-        yield "filter[#{filter_name}]"
+    def self.each_filter(resource, association_name = nil)
+      resource.config[:filters].each_pair do |filter_name, opts|
+        if association_name
+          yield "filter[#{association_name}][#{filter_name}]"
+        else
+          yield "filter[#{filter_name}]"
+        end
       end
     end
-  end
 
-  def self.all_resources(resource, include_directive, memo = {})
-    resource.sideloading.sideloads.each_pair do |name, sideload|
-      next if memo[name] || !include_directive.key?(name)
+    def self.all_resources(resource, include_directive, memo = {})
+      resource.sideloading.sideloads.each_pair do |name, sideload|
+        next if memo[name] || !include_directive.key?(name)
 
-      memo[name] = sideload.resource.class
-      all_resources(sideload.resource.class, include_directive[name], memo)
+        memo[name] = sideload.resource.class
+        all_resources(sideload.resource.class, include_directive[name], memo)
+      end
+      memo
     end
-    memo
-  end
 
-  def self.include_directive_for(controller, action)
-    resource_class = controller._jsonapi_compliable
-    includes       = resource_class.sideloading.to_hash[:base]
-    whitelist      = resource_class.config[:sideload_whitelist]
+    def self.include_directive_for(controller, action)
+      resource_class = controller._jsonapi_compliable
+      includes       = resource_class.sideloading.to_hash[:base]
+      whitelist      = resource_class.config[:sideload_whitelist]
 
-    if whitelist && whitelist[action]
-      includes = JsonapiCompliable::Util::IncludeParams
-        .scrub(includes, whitelist[action])
-    end
+      if whitelist && whitelist[action]
+        includes = JsonapiCompliable::Util::IncludeParams
+          .scrub(includes, whitelist[action])
+      end
 
-    JSONAPI::IncludeDirective.new(includes)
-  end
+      JSONAPI::IncludeDirective.new(includes)
+    end
 
-  def self.payloads_for(resource, include_hash)
-    [].tap do |payloads|
-      payloads << JsonapiSpecHelpers::Payload.by_type(resource.config[:type])
+    def self.payloads_for(resource, include_hash)
+      [].tap do |payloads|
+        payloads << JsonapiSpecHelpers::Payload.by_type(resource.config[:type])
 
-      include_hash.each_pair do |name, nested|
-        sideload = resource.sideloading.sideloads[name]
+        include_hash.each_pair do |name, nested|
+          sideload = resource.sideloading.sideloads[name]
 
-        if sideload.polymorphic?
-          sideload.polymorphic_groups.each_pair do |type, sl|
-            payloads << payloads_for(sl.resource_class, nested)
+          if sideload.polymorphic?
+            sideload.polymorphic_groups.each_pair do |type, sl|
+              payloads << payloads_for(sl.resource_class, nested)
+            end
+          else
+            sideload_resource = sideload.resource_class
+            payloads << payloads_for(sideload_resource, nested)
           end
-        else
-          sideload_resource = sideload.resource_class
-          payloads << payloads_for(sideload_resource, nested)
         end
-      end
-    end.flatten.uniq(&:name)
-  end
-
-  def self.payload_tags_for(resource, include_hash)
-    payloads_for(resource, include_hash).map { |p| "payload-#{p.name}" }
-  end
+      end.flatten.uniq(&:name)
+    end
 
-  def self.jsonapi_filter(node, label)
-    node.parameter do
-      key :description, '<a href="http://jsonapi.org/format/#fetching-filtering">JSONAPI Filter</a>'
-      key :name, label
-      key :in, :query
-      key :type, :string
-      key :required, false
+    def self.payload_tags_for(resource, include_hash)
+      payloads_for(resource, include_hash).map { |p| "payload-#{p.name}" }
     end
-  end
 
-  def self.jsonapi_sorting(node)
-    node.parameter do
-      key :description, '<a href="http://jsonapi.org/format/#fetching-sorting">JSONAPI Sorting</a>'
-      key :name, :sort
-      key :in, :query
-      key :type, :string
-      key :required, false
+    def self.jsonapi_filter(node, label)
+      node.parameter do
+        key :description, '<a href="http://jsonapi.org/format/#fetching-filtering">JSONAPI Filter</a>'
+        key :name, label
+        key :in, :query
+        key :type, :string
+        key :required, false
+      end
     end
-  end
 
-  def self.jsonapi_pagination(node)
-    node.parameter do
-      key :description, '<a href="http://jsonapi.org/format/#fetching-pagination">JSONAPI Page Size</a>'
-      key :name, "page[size]"
-      key :in, :query
-      key :type, :string
-      key :required, false
+    def self.jsonapi_sorting(node)
+      node.parameter do
+        key :description, '<a href="http://jsonapi.org/format/#fetching-sorting">JSONAPI Sorting</a>'
+        key :name, :sort
+        key :in, :query
+        key :type, :string
+        key :required, false
+      end
     end
 
-    node.parameter do
-      key :description, '<a href="http://jsonapi.org/format/#fetching-pagination">JSONAPI Page Number</a>'
-      key :name, "page[number]"
-      key :in, :query
-      key :type, :string
-      key :required, false
+    def self.jsonapi_pagination(node)
+      node.parameter do
+        key :description, '<a href="http://jsonapi.org/format/#fetching-pagination">JSONAPI Page Size</a>'
+        key :name, "page[size]"
+        key :in, :query
+        key :type, :string
+        key :required, false
+      end
+
+      node.parameter do
+        key :description, '<a href="http://jsonapi.org/format/#fetching-pagination">JSONAPI Page Number</a>'
+        key :name, "page[number]"
+        key :in, :query
+        key :type, :string
+        key :required, false
+      end
     end
-  end
 
-  def self.jsonapi_stat(node, name, calculations)
-    node.parameter do
-      key :name, "stats[#{name}]"
-      key :description, "<a href=\"https://jsonapi-suite.github.io/jsonapi_suite/how-to-return-statistics\">JSONAPI Stats</a><br /><b>Possible Calculations:</b> #{calculations}"
-      key :in, :query
-      key :type, :string
-      key :required, false
+    def self.jsonapi_stat(node, name, calculations)
+      node.parameter do
+        key :name, "stats[#{name}]"
+        key :description, "<a href=\"https://jsonapi-suite.github.io/jsonapi_suite/how-to-return-statistics\">JSONAPI Stats</a><br /><b>Possible Calculations:</b> #{calculations}"
+        key :in, :query
+        key :type, :string
+        key :required, false
+      end
     end
-  end
 
-  def self.jsonapi_includes(node)
-    node.parameter do
-      key :description, '<a href="http://jsonapi.org/format/#fetching-includes">JSONAPI Includes</a>'
-      key :name, :include
-      key :in, :query
-      key :type, :string
-      key :required, false
+    def self.jsonapi_includes(node)
+      node.parameter do
+        key :description, '<a href="http://jsonapi.org/format/#fetching-includes">JSONAPI Includes</a>'
+        key :name, :include
+        key :in, :query
+        key :type, :string
+        key :required, false
+      end
     end
-  end
 
-  def self.jsonapi_fields(node, jsonapi_type)
-    node.parameter do
-      key :description, '<a href="http://jsonapi.org/format/#fetching-sparse-fieldsets">JSONAPI Sparse Fieldset</a>'
-      key :name, "fields[#{jsonapi_type}]"
-      key :in, :query
-      key :type, :string
-      key :required, false
+    def self.jsonapi_fields(node, jsonapi_type)
+      node.parameter do
+        key :description, '<a href="http://jsonapi.org/format/#fetching-sparse-fieldsets">JSONAPI Sparse Fieldset</a>'
+        key :name, "fields[#{jsonapi_type}]"
+        key :in, :query
+        key :type, :string
+        key :required, false
+      end
     end
-  end
 
-  def self.jsonapi_extra_fields(node, resource)
-    jsonapi_type = resource.config[:type]
+    def self.jsonapi_extra_fields(node, resource)
+      jsonapi_type = resource.config[:type]
 
-    extra_field_names = resource.config[:extra_fields].keys.join(',')
-    node.parameter do
-      key :description, "<a href=\"https://jsonapi-suite.github.io/jsonapi_suite/how-to-conditionally-render-fields\">JSONAPI Extra Fields</a><br /><b>Possible Fields:</b> #{extra_field_names}"
-      key :name, "extra_fields[#{jsonapi_type}]"
-      key :in, :query
-      key :type, :string
-      key :required, false
+      extra_field_names = resource.config[:extra_fields].keys.join(',')
+      node.parameter do
+        key :description, "<a href=\"https://jsonapi-suite.github.io/jsonapi_suite/how-to-conditionally-render-fields\">JSONAPI Extra Fields</a><br /><b>Possible Fields:</b> #{extra_field_names}"
+        key :name, "extra_fields[#{jsonapi_type}]"
+        key :in, :query
+        key :type, :string
+        key :required, false
+      end
     end
-  end
 
-  def self.id_in_url(node)
-    node.parameter do
-      key :name, :id
-      key :in, :path
-      key :type, :string
-      key :required, true
-      key :description, 'record id'
+    def self.id_in_url(node)
+      node.parameter do
+        key :name, :id
+        key :in, :path
+        key :type, :string
+        key :required, true
+        key :description, 'record id'
+      end
     end
   end
 end

data/lib/jsonapi_swagger_helpers/version.rb

@@ -1,3 +1,3 @@
 module JsonapiSwaggerHelpers
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

data/lib/jsonapi_swagger_helpers/writeable.rb

@@ -1,89 +1,91 @@
-module JsonapiSwaggerHelpers::Writeable
-  def self.included(klass)
-    klass.class_eval do
-      attr_reader :node,
-        :controller,
-        :resource,
-        :description,
-        :tags
+module JsonapiSwaggerHelpers
+  module Writeable
+    def self.included(klass)
+      klass.class_eval do
+        attr_reader :node,
+          :controller,
+          :resource,
+          :description,
+          :tags
+      end
     end
-  end
-
-  def initialize(node, controller, description: nil, tags: [])
-    @node = node
-    @controller = controller
-    @resource = controller._jsonapi_compliable
-    @description = description || default_description
-    @tags = tags
-  end
 
-  def util
-    JsonapiSwaggerHelpers::Util
-  end
-
-  def action_name
-    raise 'override me'
-  end
+    def initialize(node, controller, description: nil, tags: [])
+      @node = node
+      @controller = controller
+      @resource = controller._jsonapi_compliable
+      @description = description || default_description
+      @tags = tags
+    end
 
-  def default_description
-    "#{action_name.to_s.capitalize} Action"
-  end
+    def util
+      JsonapiSwaggerHelpers::Util
+    end
 
-  def operation_id
-    "#{controller.name.gsub('::', '-')}-#{action_name}"
-  end
+    def action_name
+      raise 'override me'
+    end
 
-  def all_tags
-    tags + payload_tags
-  end
+    def default_description
+      "#{action_name.to_s.capitalize} Action"
+    end
 
-  def payload_tags
-    tags = [:"payload-#{strong_resource.name}_#{action_name}"]
+    def operation_id
+      "#{controller.name.gsub('::', '-')}-#{action_name}"
+    end
 
-    strong_resource.relations.each_pair do |relation_name, relation_config|
-      tags << :"payload-#{strong_resource.name}_#{relation_name}_#{action_name}"
+    def all_tags
+      tags + payload_tags
     end
 
-    tags
-  end
+    def payload_tags
+      tags = [:"payload-#{strong_resource.name}_#{action_name}"]
 
-  def context
-    JsonapiSwaggerHelpers.docs_controller
-  end
+      strong_resource.relations.each_pair do |relation_name, relation_config|
+        tags << :"payload-#{strong_resource.name}_#{relation_name}_#{action_name}"
+      end
 
-  def strong_resource
-    controller._strong_resources[action_name]
-  end
+      tags
+    end
 
-  def define_schema
-    _self = self
-    context.send(:swagger_schema, :"#{strong_resource.name}_#{action_name}") do
-      _self.strong_resource.attributes.each_pair do |attribute, config|
-        property attribute do
-          key :type, config[:type] # TODO - swagger type?
-        end
-      end
+    def context
+      JsonapiSwaggerHelpers.docs_controller
     end
 
-    _self.strong_resource.relations.each_pair do |relation_name, relation_config|
-      context.send(:swagger_schema, :"#{strong_resource.name}_#{relation_name}_#{action_name}") do
-        relation_config[:resource].attributes.each_pair do |attribute, config|
+    def strong_resource
+      controller._strong_resources[action_name]
+    end
+
+    def define_schema
+      _self = self
+      context.send(:swagger_schema, :"#{strong_resource.name}_#{action_name}") do
+        _self.strong_resource.attributes.each_pair do |attribute, config|
           property attribute do
             key :type, config[:type] # TODO - swagger type?
           end
         end
       end
+
+      _self.strong_resource.relations.each_pair do |relation_name, relation_config|
+        context.send(:swagger_schema, :"#{strong_resource.name}_#{relation_name}_#{action_name}") do
+          relation_config[:resource].attributes.each_pair do |attribute, config|
+            property attribute do
+              key :type, config[:type] # TODO - swagger type?
+            end
+          end
+        end
+      end
     end
-  end
 
-  def generate
-    _self = self
+    def generate
+      _self = self
 
-    define_schema
-    @node.operation :post do
-      key :description, _self.description
-      key :operationId, _self.operation_id
-      key :tags, _self.all_tags
+      define_schema
+      @node.operation :post do
+        key :description, _self.description
+        key :operationId, _self.operation_id
+        key :tags, _self.all_tags
+      end
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jsonapi_swagger_helpers
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Lee Richmond
@@ -102,6 +102,7 @@ files:
 - lib/jsonapi_swagger_helpers/create_action.rb
 - lib/jsonapi_swagger_helpers/destroy_action.rb
 - lib/jsonapi_swagger_helpers/docs_controller_mixin.rb
+- lib/jsonapi_swagger_helpers/errors.rb
 - lib/jsonapi_swagger_helpers/index_action.rb
 - lib/jsonapi_swagger_helpers/payload_definition.rb
 - lib/jsonapi_swagger_helpers/readable.rb