jsonapi-resources 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 57590c2f9544bd54d43d1a024ae878bae321f87f
-  data.tar.gz: 102b9414a9ebddd19b249daa2684f9460083c670
+  metadata.gz: ccc95678a9008bcac7b1b375cd19e684c626effb
+  data.tar.gz: e7b641e7055f1a88f9673082617812ffe4b8ae25
 SHA512:
-  metadata.gz: 7b139efb93f753f5a20e314e02e4ae3cc33bed69d7c9303ebf4bf838c9013ea5a8ef625f4720f70114b3ff6b219788e4b7303e7f55723829980fb1ac729d8d9a
-  data.tar.gz: d7580a2b8e21f6813b2a6e2c7d59f8b8f6230e2834c1e9a16c10215d40ebe3e479e451f8d4fad3a811d301e0abed030a66b27d2c3ce9b37553278d6c44bc5a77
+  metadata.gz: 77b1fa60f243eb0fe5d62d9a28f6336d613def402e5d933a3e5157be520eb789c8f073630dbe69982c7e2bc8a1f1203a500c74764c46e0c37ce963ef5e86897c
+  data.tar.gz: af564dac990b904cc6bb4ad8b38fe928043c988d6d7d83619a1f538be8522fa1d72b4c7e2aa4ab01e34e96d3742174c8c70495ef054315b51d195fffab369b42

data/README.md

@@ -50,8 +50,6 @@ Resources must be derived from `JSONAPI::Resource`, or a class that is itself de
 For example:
 
 ```ruby
-require 'jsonapi/resource'
-
 class ContactResource < JSONAPI::Resource
 end
 ```
@@ -64,8 +62,6 @@ the `attribute` method, and multiple attributes can be declared with the `attrib
 For example:
 
 ```ruby
-require 'jsonapi/resource'
-
 class ContactResource < JSONAPI::Resource
   attribute :name_first
   attributes :name_last, :email, :twitter
@@ -81,8 +77,6 @@ This allows a resource's methods to access the underlying model.
 For example, a computed attribute for `full_name` could be defined as such:
 
 ```ruby
-require 'jsonapi/resource'
-
 class ContactResource < JSONAPI::Resource
   attributes :name_first, :name_last, :email, :twitter
   attribute :full_name
@@ -127,8 +121,6 @@ the `update` or `create` methods, override the `self.updatable_fields` and `self
 This example prevents `full_name` from being set:
 
 ```ruby
-require 'jsonapi/resource'
-
 class ContactResource < JSONAPI::Resource
   attributes :name_first, :name_last, :full_name
 
@@ -280,8 +272,6 @@ declared using the `filter` method, and multiple filters can be declared with th
 For example:
 
 ```ruby
-require 'jsonapi/resource'
-
 class ContactResource < JSONAPI::Resource
   attributes :name_first, :name_last, :email, :twitter
 
@@ -290,6 +280,25 @@ class ContactResource < JSONAPI::Resource
 end
 ```
 
+##### Default Filters
+
+A default filter may be defined for a resource using the `default` option on the `filter` method. This default is used
+unless the request overrides this value.
+
+For example:
+
+```ruby
+ class CommentResource < JSONAPI::Resource
+  attributes :body, :status
+  has_one :post
+  has_one :author
+  
+  filter :status, default: 'published,pending'
+end
+```
+
+The default value is used as if it came from the request.
+
 ##### Finders
 
 Basic finding by filters is supported by resources. This is implemented in the `find` and `find_by_key` finder methods. 
@@ -534,23 +543,22 @@ Callbacks can also be defined for `JSONAPI::OperationsProcessor` events:
 - `:remove_has_many_association_operation`: A `remove_has_many_association_operation`.
 - `:remove_has_one_association_operation`: A `remove_has_one_association_operation`.
 
-The operation callbacks have access to two meta data hashes, `@operations_meta` and `@operation_meta`, the full list of
-`@operations`, each individual `@operation` and the `@result` variables.
+The operation callbacks have access to two meta data hashes, `@operations_meta` and `@operation_meta`, two links hashes,
+`@operations_links` and `@operation_links`, the full list of `@operations`, each individual `@operation` and the 
+`@result` variables.
 
 ##### Custom `OperationsProcessor` Example to Return total_count in Meta
 
+Note: this can also be accomplished with the `top_level_meta_include_record_count` option, and in most cases that will
+be the better option. 
+
 To return the total record count of a find operation in the meta data of a find operation you can create a custom
 OperationsProcessor. For example:
 
 ```ruby
 class CountingActiveRecordOperationsProcessor < ActiveRecordOperationsProcessor
   after_find_operation do
-    count = @operation.resource_klass.find_count(@operation.resource_klass.verify_filters(@operation.filters, @context),
-                                 context: @context,
-                                 include_directives: @operation.include_directives,
-                                 sort_criteria: @operation.sort_criteria)
-
-    @operation_meta[:total_records] = count
+    @operation_meta[:total_records] = @operation.record_count
   end
 end
 ```
@@ -730,13 +738,14 @@ module JSONAPI
   KEY_NOT_INCLUDED_IN_URL = 110
   INVALID_INCLUDE = 112
   RELATION_EXISTS = 113
-  INVALID_SORT_PARAM = 114
+  INVALID_SORT_CRITERIA = 114
   INVALID_LINKS_OBJECT = 115
   TYPE_MISMATCH = 116
   INVALID_PAGE_OBJECT = 117
   INVALID_PAGE_VALUE = 118
   INVALID_FIELD_FORMAT = 119
   INVALID_FILTERS_SYNTAX = 120
+  SAVE_FAILED = 121
   FORBIDDEN = 403
   RECORD_NOT_FOUND = 404
   UNSUPPORTED_MEDIA_TYPE = 415
@@ -746,7 +755,7 @@ end
 
 These codes can be customized in your app by creating an initializer to override any or all of the codes.
 
-In addition textual error coses can be returned by setting the configuration option `use_text_errors = true`. For
+In addition textual error codes can be returned by setting the configuration option `use_text_errors = true`. For
 example:
 
 ```ruby
@@ -762,7 +771,6 @@ The `ResourceSerializer` can be used to serialize a resource into JSON API compl
  method that takes a resource instance or array of resource instances to serialize. For example:
 
 ```ruby
-require 'jsonapi/resource_serializer'
 post = Post.find(1)
 JSONAPI::ResourceSerializer.new(PostResource).serialize_to_hash(PostResource.new(post))
 ```
@@ -882,8 +890,6 @@ contact_links_phone_numbers GET       /contacts/:contact_id/links/phone-numbers(
       contact_phone_numbers GET       /contacts/:contact_id/phone-numbers(.:format)             phone_numbers#get_related_resources {:association=>"phone_numbers", :source=>"contacts"}
                    contacts GET       /contacts(.:format)                                       contacts#index
                             POST      /contacts(.:format)                                       contacts#create
-                new_contact GET       /contacts/new(.:format)                                   contacts#new
-               edit_contact GET       /contacts/:id/edit(.:format)                              contacts#edit
                     contact GET       /contacts/:id(.:format)                                   contacts#show
                             PATCH     /contacts/:id(.:format)                                   contacts#update
                             PUT       /contacts/:id(.:format)                                   contacts#update
@@ -894,8 +900,6 @@ contact_links_phone_numbers GET       /contacts/:contact_id/links/phone-numbers(
        phone_number_contact GET       /phone-numbers/:phone_number_id/contact(.:format)         contacts#get_related_resource {:association=>"contact", :source=>"phone_numbers"}
               phone_numbers GET       /phone-numbers(.:format)                                  phone_numbers#index
                             POST      /phone-numbers(.:format)                                  phone_numbers#create
-           new_phone_number GET       /phone-numbers/new(.:format)                              phone_numbers#new
-          edit_phone_number GET       /phone-numbers/:id/edit(.:format)                         phone_numbers#edit
                phone_number GET       /phone-numbers/:id(.:format)                              phone_numbers#show
                             PATCH     /phone-numbers/:id(.:format)                              phone_numbers#update
                             PUT       /phone-numbers/:id(.:format)                              phone_numbers#update
@@ -925,8 +929,6 @@ gives routes that are only related to the primary resource, and none for its rel
       Prefix Verb   URI Pattern                  Controller#Action
     contacts GET    /contacts(.:format)          contacts#index
              POST   /contacts(.:format)          contacts#create
- new_contact GET    /contacts/new(.:format)      contacts#new
-edit_contact GET    /contacts/:id/edit(.:format) contacts#edit
      contact GET    /contacts/:id(.:format)      contacts#show
              PATCH  /contacts/:id(.:format)      contacts#update
              PUT    /contacts/:id(.:format)      contacts#update
@@ -965,8 +967,6 @@ contact_links_phone_numbers GET    /contacts/:contact_id/links/phone-numbers(.:f
                             DELETE /contacts/:contact_id/links/phone-numbers/:keys(.:format) contacts#destroy_association {:association=>"phone_numbers"}
                    contacts GET    /contacts(.:format)                                       contacts#index
                             POST   /contacts(.:format)                                       contacts#create
-                new_contact GET    /contacts/new(.:format)                                   contacts#new
-               edit_contact GET    /contacts/:id/edit(.:format)                              contacts#edit
                     contact GET    /contacts/:id(.:format)                                   contacts#show
                             PATCH  /contacts/:id(.:format)                                   contacts#update
                             PUT    /contacts/:id(.:format)                                   contacts#update
@@ -996,8 +996,6 @@ gives the following routes:
 contact_phone_numbers GET    /contacts/:contact_id/phone-numbers(.:format) phone_numbers#get_related_resources {:association=>"phone_numbers", :source=>"contacts"}
              contacts GET    /contacts(.:format)                           contacts#index
                       POST   /contacts(.:format)                           contacts#create
-          new_contact GET    /contacts/new(.:format)                       contacts#new
-         edit_contact GET    /contacts/:id/edit(.:format)                  contacts#edit
               contact GET    /contacts/:id(.:format)                       contacts#show
                       PATCH  /contacts/:id(.:format)                       contacts#update
                       PUT    /contacts/:id(.:format)                       contacts#update
@@ -1026,8 +1024,6 @@ gives the following routes:
 phone_number_contact GET    /phone-numbers/:phone_number_id/contact(.:format) contacts#get_related_resource {:association=>"contact", :source=>"phone_numbers"}
        phone_numbers GET    /phone-numbers(.:format)                          phone_numbers#index
                      POST   /phone-numbers(.:format)                          phone_numbers#create
-    new_phone_number GET    /phone-numbers/new(.:format)                      phone_numbers#new
-   edit_phone_number GET    /phone-numbers/:id/edit(.:format)                 phone_numbers#edit
         phone_number GET    /phone-numbers/:id(.:format)                      phone_numbers#show
                      PATCH  /phone-numbers/:id(.:format)                      phone_numbers#update
                      PUT    /phone-numbers/:id(.:format)                      phone_numbers#update
@@ -1179,6 +1175,42 @@ end
 
 You would specify this in `JSONAPI.configure` as `:upper_camelized`.
 
+## Configuration
+
+JR has a few configuration options. Some have already been mentioned above. To set configuration options create an 
+initializer and add the options you wish to set. All options have defaults, so you only need to set the options that
+are different. The default options are shown below.
+
+```ruby
+JSONAPI.configure do |config|
+  #:underscored_key, :camelized_key, :dasherized_key, or custom
+  config.json_key_format = :dasherized_key
+
+  #:underscored_route, :camelized_route, :dasherized_route, or custom
+  config.route_format = :dasherized_route
+
+  #:basic, :active_record, or custom
+  config.operations_processor = :active_record
+
+  config.allowed_request_params = [:include, :fields, :format, :controller, :action, :sort, :page]
+
+  # :none, :offset, :paged, or a custom paginator name
+  config.default_paginator = :none
+
+  # Output pagination links at top level
+  config.top_level_links_include_pagination = true
+
+  config.default_page_size = 10
+  config.maximum_page_size = 20
+
+  # Output the record count in top level meta data for find operations
+  config.top_level_meta_include_record_count = false
+  config.top_level_meta_record_count_key = :record_count
+
+  config.use_text_errors = false
+end
+```
+
 ## Contributing
 
 1. Fork it ( http://github.com/cerebris/jsonapi-resources/fork )

data/lib/jsonapi/acts_as_resource_controller.rb

@@ -123,6 +123,10 @@ module JSONAPI
       {}
     end
 
+    def base_response_links
+      {}
+    end
+
     def render_errors(errors)
       operation_results = JSONAPI::OperationResults.new()
       result = JSONAPI::ErrorsOperationResult.new(errors[0].status, errors)
@@ -147,7 +151,9 @@ module JSONAPI
           key_formatter: key_formatter,
           route_formatter: route_formatter,
           base_meta: base_response_meta,
-          resource_serializer_klass: resource_serializer_klass
+          base_links: base_response_links,
+          resource_serializer_klass: resource_serializer_klass,
+          request: @request
         }
       )
     end

data/lib/jsonapi/configuration.rb

@@ -13,7 +13,10 @@ module JSONAPI
                 :default_paginator,
                 :default_page_size,
                 :maximum_page_size,
-                :use_text_errors
+                :use_text_errors,
+                :top_level_links_include_pagination,
+                :top_level_meta_include_record_count,
+                :top_level_meta_record_count_key
 
     def initialize
       #:underscored_key, :camelized_key, :dasherized_key, or custom
@@ -30,8 +33,17 @@ module JSONAPI
       # :none, :offset, :paged, or a custom paginator name
       self.default_paginator = :none
 
+      # Output pagination links at top level
+      self.top_level_links_include_pagination = true
+
       self.default_page_size = 10
       self.maximum_page_size = 20
+
+      # Metadata
+      # Output record count in top level meta for find operation
+      self.top_level_meta_include_record_count = false
+      self.top_level_meta_record_count_key = :record_count
+
       self.use_text_errors = false
     end
 
@@ -69,6 +81,18 @@ module JSONAPI
     def use_text_errors=(use_text_errors)
       @use_text_errors = use_text_errors
     end
+
+    def top_level_links_include_pagination=(top_level_links_include_pagination)
+      @top_level_links_include_pagination = top_level_links_include_pagination
+    end
+
+    def top_level_meta_include_record_count=(top_level_meta_include_record_count)
+      @top_level_meta_include_record_count = top_level_meta_include_record_count
+    end
+
+    def top_level_meta_record_count_key=(top_level_meta_record_count_key)
+      @top_level_meta_record_count_key = top_level_meta_record_count_key
+    end
   end
 
   class << self

data/lib/jsonapi/operation.rb

@@ -23,6 +23,22 @@ module JSONAPI
       super(resource_klass, false)
     end
 
+    def record_count
+      @_record_count ||= @resource_klass.find_count(@resource_klass.verify_filters(@filters, @context),
+                                                     context: @context,
+                                                     include_directives: @include_directives)
+    end
+
+    def pagination_params
+      if @paginator && JSONAPI.configuration.top_level_links_include_pagination
+        options = {}
+        options[:record_count] = record_count if @paginator.class.requires_record_count
+        return @paginator.links_page_params(options)
+      else
+        return {}
+      end
+    end
+
     def apply(context)
       resource_records = @resource_klass.find(@resource_klass.verify_filters(@filters, context),
                                              context: context,
@@ -30,7 +46,18 @@ module JSONAPI
                                              sort_criteria: @sort_criteria,
                                              paginator: @paginator)
 
-      return JSONAPI::ResourcesOperationResult.new(:ok, resource_records)
+      options = {}
+      if JSONAPI.configuration.top_level_links_include_pagination
+        options[:pagination_params] = pagination_params
+      end
+
+      if JSONAPI.configuration.top_level_meta_include_record_count
+        options[:record_count] = record_count
+      end
+
+      return JSONAPI::ResourcesOperationResult.new(:ok,
+                                                   resource_records,
+                                                   options)
 
     rescue JSONAPI::Exceptions::Error => e
       return JSONAPI::ErrorsOperationResult.new(e.errors[0].code, e.errors)

data/lib/jsonapi/operation_result.rb

@@ -2,47 +2,53 @@ module JSONAPI
   class OperationResult
     attr_accessor :code
     attr_accessor :meta
+    attr_accessor :links
+    attr_accessor :options
 
-    def initialize(code)
+    def initialize(code, options = {})
       @code = code
-      @meta = {}
+      @options = options
+      @meta = options.fetch(:meta, {})
+      @links = options.fetch(:links, {})
     end
   end
 
   class ErrorsOperationResult < OperationResult
     attr_accessor :errors
 
-    def initialize(code, errors)
+    def initialize(code, errors, options = {})
       @errors = errors
-      super(code)
+      super(code, options)
     end
   end
 
   class ResourceOperationResult < OperationResult
     attr_accessor :resource
 
-    def initialize(code, resource)
+    def initialize(code, resource, options = {})
       @resource = resource
-      super(code)
+      super(code, options)
     end
   end
 
   class ResourcesOperationResult < OperationResult
-    attr_accessor :resources
+    attr_accessor :resources, :pagination_params, :record_count
 
-    def initialize(code, resources)
+    def initialize(code, resources, options = {})
       @resources = resources
-      super(code)
+      @pagination_params = options.fetch(:pagination_params, {})
+      @record_count = options[:record_count]
+      super(code, options)
     end
   end
 
   class LinksObjectOperationResult < OperationResult
     attr_accessor :parent_resource, :association
 
-    def initialize(code, parent_resource, association)
+    def initialize(code, parent_resource, association, options = {})
       @parent_resource = parent_resource
       @association = association
-      super(code)
+      super(code, options)
     end
   end
 end

data/lib/jsonapi/operation_results.rb

@@ -2,11 +2,13 @@ module JSONAPI
   class OperationResults
     attr_accessor :results
     attr_accessor :meta
+    attr_accessor :links
 
     def initialize
       @results = []
       @has_errors = false
       @meta = {}
+      @links = {}
     end
 
     def add_result(result)

data/lib/jsonapi/operations_processor.rb

@@ -41,16 +41,21 @@ module JSONAPI
 
       run_callbacks :operations do
         transaction do
+          # Links and meta data global to the set of operations
           @operations_meta = {}
+          @operations_links = {}
           @operations.each do |operation|
             @operation = operation
+            # Links and meta data for each operation
             @operation_meta = {}
+            @operation_links = {}
             run_callbacks :operation do
               @result = nil
               run_callbacks @operation.class.name.demodulize.underscore.to_sym do
                 @result = process_operation(@operation)
               end
               @result.meta.merge!(@operation_meta)
+              @result.links.merge!(@operation_links)
               @results.add_result(@result)
               if @results.has_errors?
                 rollback
@@ -58,6 +63,7 @@ module JSONAPI
             end
           end
           @results.meta = @operations_meta
+          @results.links = @operations_links
         end
       end
       @results

data/lib/jsonapi/paginator.rb

@@ -7,7 +7,19 @@ module JSONAPI
       # relation
     end
 
+    def links_page_params(options = {})
+      # :nocov:
+      {}
+      # :nocov:
+    end
+
     class << self
+      def requires_record_count
+        # :nocov:
+        false
+        # :nocov:
+      end
+
       def paginator_for(paginator)
         paginator_class_name = "#{paginator.to_s.camelize}Paginator"
         paginator_class_name.safe_constantize if paginator_class_name
@@ -17,15 +29,62 @@ module JSONAPI
 end
 
 class OffsetPaginator < JSONAPI::Paginator
+  attr_reader :limit, :offset
+
   def initialize(params)
     parse_pagination_params(params)
     verify_pagination_params
   end
 
+  def self.requires_record_count
+    true
+  end
+
   def apply(relation, order_options)
     relation.offset(@offset).limit(@limit)
   end
 
+  def links_page_params(options = {})
+    record_count = options[:record_count]
+    links_page_params = {}
+
+    links_page_params['first'] = {
+      'offset' => 0,
+      'limit' => @limit
+    }
+
+    if @offset > 0
+      previous_offset = @offset - @limit
+
+      if previous_offset < 0
+        previous_offset = 0
+      end
+
+      links_page_params['previous'] = {
+        'offset' => previous_offset,
+        'limit' => @limit
+      }
+    end
+
+    next_offset = @offset + @limit
+
+    unless next_offset >= record_count
+      links_page_params['next'] = {
+        'offset' => next_offset,
+        'limit'=> @limit
+      }
+    end
+
+    if record_count
+      links_page_params['last'] = {
+        'offset' => record_count - @limit,
+        'limit' => @limit
+      }
+    end
+
+    links_page_params
+  end
+
   private
   def parse_pagination_params(params)
     if params.nil?
@@ -58,16 +117,57 @@ class OffsetPaginator < JSONAPI::Paginator
 end
 
 class PagedPaginator < JSONAPI::Paginator
+  attr_reader :size, :number
+
   def initialize(params)
     parse_pagination_params(params)
     verify_pagination_params
   end
 
+  def self.requires_record_count
+    true
+  end
+
   def apply(relation, order_options)
     offset = (@number - 1) * @size
     relation.offset(offset).limit(@size)
   end
 
+  def links_page_params(options = {})
+    record_count = options[:record_count]
+    page_count = (record_count / @size.to_f).ceil
+
+    links_page_params = {}
+
+    links_page_params['first'] = {
+      'number' => 1,
+      'size' => @size
+    }
+
+    if @number > 1
+      links_page_params['previous'] = {
+        'number' => @number - 1,
+        'size' => @size
+      }
+    end
+
+    unless @number >= page_count
+      links_page_params['next'] = {
+        'number' => @number + 1,
+        'size'=> @size
+      }
+    end
+
+    if record_count
+      links_page_params['last'] = {
+        'number' => page_count,
+        'size' => @size
+      }
+    end
+
+    links_page_params
+  end
+
   private
   def parse_pagination_params(params)
     if params.nil?

data/lib/jsonapi/request.rb

@@ -5,9 +5,10 @@ module JSONAPI
   class Request
     attr_accessor :fields, :include, :filters, :sort_criteria, :errors, :operations,
                   :resource_klass, :context, :paginator, :source_klass, :source_id,
-                  :include_directives
+                  :include_directives, :params
 
     def initialize(params = nil, options = {})
+      @params = params
       @context = options[:context]
       @key_formatter = options.fetch(:key_formatter, JSONAPI.configuration.key_formatter)
       @errors = []
@@ -21,7 +22,7 @@ module JSONAPI
       @paginator = nil
       @id = nil
 
-      setup_action(params)
+      setup_action(@params)
     end
 
     def setup_action(params)

data/lib/jsonapi/resource_serializer.rb

@@ -67,6 +67,10 @@ module JSONAPI
       }
     end
 
+    def find_link(query_params)
+      "#{@base_url}/#{formatted_module_path_from_klass(@primary_resource_klass)}#{@route_formatter.format(@primary_resource_klass._type.to_s)}?#{query_params.to_query}"
+    end
+
     private
     # Process the primary source object(s). This will then serialize associated object recursively based on the
     # requested includes. Fields are controlled fields option for each resource type, such
@@ -200,7 +204,11 @@ module JSONAPI
     end
 
     def formatted_module_path(source)
-      source.class.name =~ /::[^:]+\Z/ ? (@route_formatter.format($`).freeze.gsub('::', '/') + '/').downcase : ''
+      formatted_module_path_from_klass(source.class)
+    end
+
+    def formatted_module_path_from_klass(klass)
+      klass.name =~ /::[^:]+\Z/ ? (@route_formatter.format($`).freeze.gsub('::', '/') + '/').downcase : ''
     end
 
     def self_href(source)

data/lib/jsonapi/resources/version.rb

@@ -1,5 +1,5 @@
 module JSONAPI
   module Resources
-    VERSION = "0.4.0"
+    VERSION = "0.4.1"
   end
 end

data/lib/jsonapi/response_document.rb

@@ -13,6 +13,9 @@ module JSONAPI
       meta = top_level_meta
       hash.merge!(meta: meta) unless meta.empty?
 
+      links = top_level_links
+      hash.merge!(links: links) unless links.empty?
+
       hash
     end
 
@@ -37,6 +40,8 @@ module JSONAPI
       )
     end
 
+    # Rolls up the top level meta data from the base_meta, the set of operations,
+    # and the result of each operation. The keys are then formatted.
     def top_level_meta
       meta = @options.fetch(:base_meta, {})
 
@@ -44,11 +49,45 @@ module JSONAPI
 
       @operation_results.results.each do |result|
         meta.merge!(result.meta)
+
+        if JSONAPI.configuration.top_level_meta_include_record_count
+          meta[JSONAPI.configuration.top_level_meta_record_count_key] = result.record_count
+        end
       end
 
       meta.deep_transform_keys { |key| @key_formatter.format(key) }
     end
 
+    # Rolls up the top level links from the base_links, the set of operations,
+    # and the result of each operation. The keys are then formatted.
+    def top_level_links
+      links = @options.fetch(:base_links, {})
+
+      links.merge!(@operation_results.links)
+
+      @operation_results.results.each do |result|
+        links.merge!(result.links)
+
+        # Build pagination links
+        if result.is_a?(JSONAPI::ResourcesOperationResult)
+          result.pagination_params.each_pair do |link_name, params|
+            query_params = {}
+            query_params[:page] = params
+
+            request = @options[:request]
+            query_params[:fields] = request.params[:fields] if request.params[:fields]
+            query_params[:include] = request.params[:include] if request.params[:include]
+            query_params[:sort] = request.params[:sort] if request.params[:sort]
+            query_params[:filter] = request.params[:filter] if request.params[:filter]
+
+            links[link_name] = serializer.find_link(query_params)
+          end
+        end
+      end
+
+      links.deep_transform_keys { |key| @key_formatter.format(key) }
+    end
+
     def results_to_hash
       if @operation_results.has_errors?
         {errors: @operation_results.all_errors}

data/lib/jsonapi/routing_ext.rb

@@ -26,6 +26,13 @@ module ActionDispatch
           options.merge!(res.routing_resource_options)
           options[:path] = format_route(@resource_type)
 
+          if options[:except]
+            options[:except] << :new unless options[:except].include?(:new) || options[:except].include?('new')
+            options[:except] << :edit unless options[:except].include?(:edit) || options[:except].include?('edit')
+          else
+            options[:except] = [:new, :edit]
+          end
+
           resource @resource_type, options do
             @scope[:jsonapi_resource] = @resource_type
 
@@ -37,15 +44,15 @@ module ActionDispatch
           end
         end
 
-        def jsonapi_relationships
+        def jsonapi_relationships(options = {})
           res = JSONAPI::Resource.resource_for(resource_type_with_module_prefix(@resource_type))
           res._associations.each do |association_name, association|
             if association.is_a?(JSONAPI::Association::HasMany)
-              jsonapi_links(association_name)
-              jsonapi_related_resources(association_name)
+              jsonapi_links(association_name, options)
+              jsonapi_related_resources(association_name, options)
             else
-              jsonapi_link(association_name)
-              jsonapi_related_resource(association_name)
+              jsonapi_link(association_name, options)
+              jsonapi_related_resource(association_name, options)
             end
           end
         end
@@ -62,6 +69,13 @@ module ActionDispatch
 
           options[:path] = format_route(@resource_type)
 
+          if options[:except]
+            options[:except] << :new unless options[:except].include?(:new) || options[:except].include?('new')
+            options[:except] << :edit unless options[:except].include?(:edit) || options[:except].include?('edit')
+          else
+            options[:except] = [:new, :edit]
+          end
+
           resources @resource_type, options do
             @scope[:jsonapi_resource] = @resource_type
 

data/test/controllers/controller_test.rb

@@ -2148,6 +2148,33 @@ class Api::V2::BooksControllerTest < ActionController::TestCase
     assert_equal 'Book 0', json_response['data'][0]['attributes']['title']
   end
 
+  def test_books_record_count_in_meta
+    Api::V2::BookResource.paginator :offset
+    JSONAPI.configuration.top_level_meta_include_record_count = true
+    get :index, {include: 'book-comments'}
+    JSONAPI.configuration.top_level_meta_include_record_count = false
+
+    assert_response :success
+    assert_equal 1000, json_response['meta']['record-count']
+    assert_equal 10, json_response['data'].size
+    assert_equal 'Book 0', json_response['data'][0]['attributes']['title']
+  end
+
+  def test_books_record_count_in_meta_custom_name
+    Api::V2::BookResource.paginator :offset
+    JSONAPI.configuration.top_level_meta_include_record_count = true
+    JSONAPI.configuration.top_level_meta_record_count_key = 'total_records'
+
+    get :index, {include: 'book-comments'}
+    JSONAPI.configuration.top_level_meta_include_record_count = false
+    JSONAPI.configuration.top_level_meta_record_count_key = :record_count
+
+    assert_response :success
+    assert_equal 1000, json_response['meta']['total-records']
+    assert_equal 10, json_response['data'].size
+    assert_equal 'Book 0', json_response['data'][0]['attributes']['title']
+  end
+
   def test_books_offset_pagination_no_params_includes_query_count_one_level
     Api::V2::BookResource.paginator :offset
 
@@ -2157,7 +2184,7 @@ class Api::V2::BooksControllerTest < ActionController::TestCase
     assert_response :success
     assert_equal 10, json_response['data'].size
     assert_equal 'Book 0', json_response['data'][0]['attributes']['title']
-    assert_equal 2, query_count
+    assert_equal 3, query_count
   end
 
   def test_books_offset_pagination_no_params_includes_query_count_two_levels
@@ -2169,7 +2196,7 @@ class Api::V2::BooksControllerTest < ActionController::TestCase
     assert_response :success
     assert_equal 10, json_response['data'].size
     assert_equal 'Book 0', json_response['data'][0]['attributes']['title']
-    assert_equal 3, query_count
+    assert_equal 4, query_count
   end
 
   def test_books_offset_pagination
@@ -2305,6 +2332,18 @@ class Api::V4::BooksControllerTest < ActionController::TestCase
     assert_equal 1000, json_response['meta']['totalRecords']
     JSONAPI.configuration.operations_processor = :active_record
   end
+
+  def test_books_operation_links
+    JSONAPI.configuration.operations_processor = :counting_active_record
+    Api::V4::BookResource.paginator :offset
+    get :index, {page: {offset: 50, limit: 12}}
+    assert_response :success
+    assert_equal 12, json_response['data'].size
+    assert_equal 'Book 50', json_response['data'][0]['attributes']['title']
+    assert_equal 5, json_response['links'].size
+    assert_equal 'https://test_corp.com', json_response['links']['spec']
+    JSONAPI.configuration.operations_processor = :active_record
+  end
 end
 
 class CategoriesControllerTest < ActionController::TestCase

data/test/fixtures/active_record.rb

@@ -353,13 +353,8 @@ $breed_data.add(Breed.new(3, 'to_delete'))
 ### OperationsProcessor
 class CountingActiveRecordOperationsProcessor < ActiveRecordOperationsProcessor
   after_find_operation do
-
-    count = @operation.resource_klass.find_count(@operation.resource_klass.verify_filters(@operation.filters, @context),
-                                 context: @context,
-                                 include_directives: @operation.include_directives,
-                                 sort_criteria: @operation.sort_criteria)
-
-    @operation_meta[:total_records] = count
+    @operation_meta[:total_records] = @operation.record_count
+    @operation_links['spec'] = 'https://test_corp.com'
   end
 end
 

data/test/test_helper.rb

@@ -113,7 +113,7 @@ TestApp.routes.draw do
         jsonapi_link :author, except: [:destroy]
       end
 
-      jsonapi_resource :preferences
+      jsonapi_resource :preferences, except: [:create, :destroy]
 
       jsonapi_resources :books
       jsonapi_resources :book_comments

data/test/unit/pagination/offset_paginator_test.rb

@@ -0,0 +1,206 @@
+require File.expand_path('../../../test_helper', __FILE__)
+require 'jsonapi-resources'
+
+class OffsetPaginatorTest < ActiveSupport::TestCase
+
+  def test_offset_default_page_params
+    params = ActionController::Parameters.new(
+      {
+      }
+    )
+
+    paginator = OffsetPaginator.new(params)
+
+    assert_equal JSONAPI.configuration.default_page_size, paginator.limit
+    assert_equal 0, paginator.offset
+  end
+
+  def test_offset_parse_page_params_default_offset
+    params = ActionController::Parameters.new(
+      {
+        limit: 20
+      }
+    )
+
+    paginator = OffsetPaginator.new(params)
+
+    assert_equal 20, paginator.limit
+    assert_equal 0, paginator.offset
+  end
+
+  def test_offset_parse_page_params
+    params = ActionController::Parameters.new(
+      {
+        limit: 5,
+        offset: 7
+      }
+    )
+
+    paginator = OffsetPaginator.new(params)
+
+    assert_equal 5, paginator.limit
+    assert_equal 7, paginator.offset
+  end
+
+  def test_offset_parse_page_params_limit_too_large
+    params = ActionController::Parameters.new(
+      {
+        limit: 50,
+        offset: 0
+      }
+    )
+
+    assert_raises JSONAPI::Exceptions::InvalidPageValue do
+      OffsetPaginator.new(params)
+    end
+  end
+
+  def test_offset_parse_page_params_not_allowed
+    params = ActionController::Parameters.new(
+      {
+        limit: 50,
+        start: 0
+      }
+    )
+
+    assert_raises JSONAPI::Exceptions::PageParametersNotAllowed do
+      OffsetPaginator.new(params)
+    end
+  end
+
+  def test_offset_parse_page_params_start
+    params = ActionController::Parameters.new(
+      {
+        limit: 5,
+        offset: 0
+      }
+    )
+
+    paginator = OffsetPaginator.new(params)
+
+    assert_equal 5, paginator.limit
+    assert_equal 0, paginator.offset
+  end
+
+
+  def test_offset_links_page_params_large_data_set_start
+    params = ActionController::Parameters.new(
+      {
+        limit: 5,
+        offset: 0
+      }
+    )
+
+    paginator = OffsetPaginator.new(params)
+    links_params = paginator.links_page_params(record_count: 50)
+
+    assert_equal 3, links_params.size
+
+    assert_equal 5, links_params['first']['limit']
+    assert_equal 0, links_params['first']['offset']
+
+    assert_equal 5, links_params['next']['limit']
+    assert_equal 5, links_params['next']['offset']
+
+    assert_equal 5, links_params['last']['limit']
+    assert_equal 45, links_params['last']['offset']
+  end
+
+  def test_offset_links_page_params_large_data_set_before_start
+    params = ActionController::Parameters.new(
+      {
+        limit: 5,
+        offset: 2
+      }
+    )
+
+    paginator = OffsetPaginator.new(params)
+    links_params = paginator.links_page_params(record_count: 50)
+
+    assert_equal 4, links_params.size
+
+    assert_equal 5, links_params['first']['limit']
+    assert_equal 0, links_params['first']['offset']
+
+    assert_equal 5, links_params['previous']['limit']
+    assert_equal 0, links_params['previous']['offset']
+
+    assert_equal 5, links_params['next']['limit']
+    assert_equal 7, links_params['next']['offset']
+
+    assert_equal 5, links_params['last']['limit']
+    assert_equal 45, links_params['last']['offset']
+  end
+
+  def test_offset_links_page_params_large_data_set_middle
+    params = ActionController::Parameters.new(
+      {
+        limit: 5,
+        offset: 27
+      }
+    )
+
+    paginator = OffsetPaginator.new(params)
+    links_params = paginator.links_page_params(record_count: 50)
+
+    assert_equal 4, links_params.size
+
+    assert_equal 5, links_params['first']['limit']
+    assert_equal 0, links_params['first']['offset']
+
+    assert_equal 5, links_params['previous']['limit']
+    assert_equal 22, links_params['previous']['offset']
+
+    assert_equal 5, links_params['next']['limit']
+    assert_equal 32, links_params['next']['offset']
+
+    assert_equal 5, links_params['last']['limit']
+    assert_equal 45, links_params['last']['offset']
+  end
+
+  def test_offset_links_page_params_large_data_set_end
+    params = ActionController::Parameters.new(
+      {
+        limit: 5,
+        offset: 45
+      }
+    )
+
+    paginator = OffsetPaginator.new(params)
+    links_params = paginator.links_page_params(record_count: 50)
+
+    assert_equal 3, links_params.size
+
+    assert_equal 5, links_params['first']['limit']
+    assert_equal 0, links_params['first']['offset']
+
+    assert_equal 5, links_params['previous']['limit']
+    assert_equal 40, links_params['previous']['offset']
+
+    assert_equal 5, links_params['last']['limit']
+    assert_equal 45, links_params['last']['offset']
+  end
+
+  def test_offset_links_page_params_large_data_set_past_end
+    params = ActionController::Parameters.new(
+      {
+        limit: 5,
+        offset: 48
+      }
+    )
+
+    paginator = OffsetPaginator.new(params)
+    links_params = paginator.links_page_params(record_count: 50)
+
+    assert_equal 3, links_params.size
+
+    assert_equal 5, links_params['first']['limit']
+    assert_equal 0, links_params['first']['offset']
+
+    assert_equal 5, links_params['previous']['limit']
+    assert_equal 43, links_params['previous']['offset']
+
+    assert_equal 5, links_params['last']['limit']
+    assert_equal 45, links_params['last']['offset']
+  end
+end

data/test/unit/pagination/paged_paginator_test.rb

@@ -0,0 +1,203 @@
+require File.expand_path('../../../test_helper', __FILE__)
+require 'jsonapi-resources'
+
+class PagedPaginatorTest < ActiveSupport::TestCase
+
+  def test_paged_default_page_params
+    params = ActionController::Parameters.new(
+      {
+      }
+    )
+
+    paginator = PagedPaginator.new(params)
+
+    assert_equal JSONAPI.configuration.default_page_size, paginator.size
+    assert_equal 1, paginator.number
+  end
+
+  def test_paged_parse_page_params_default_page
+    params = ActionController::Parameters.new(
+      {
+        size: 20
+      }
+    )
+
+    paginator = PagedPaginator.new(params)
+
+    assert_equal 20, paginator.size
+    assert_equal 1, paginator.number
+  end
+
+  def test_paged_parse_page_params
+    params = ActionController::Parameters.new(
+      {
+        size: 5,
+        number: 7
+      }
+    )
+
+    paginator = PagedPaginator.new(params)
+
+    assert_equal 5, paginator.size
+    assert_equal 7, paginator.number
+  end
+
+  def test_paged_parse_page_params_size_too_large
+    params = ActionController::Parameters.new(
+      {
+        size: 50,
+        number: 1
+      }
+    )
+
+    assert_raises JSONAPI::Exceptions::InvalidPageValue do
+      PagedPaginator.new(params)
+    end
+  end
+
+  def test_paged_parse_page_params_not_allowed
+    params = ActionController::Parameters.new(
+      {
+        size: 50,
+        start: 1
+      }
+    )
+
+    assert_raises JSONAPI::Exceptions::PageParametersNotAllowed do
+      PagedPaginator.new(params)
+    end
+  end
+
+  def test_paged_parse_page_params_start
+    params = ActionController::Parameters.new(
+      {
+        size: 5,
+        number: 1
+      }
+    )
+
+    paginator = PagedPaginator.new(params)
+
+    assert_equal 5, paginator.size
+    assert_equal 1, paginator.number
+  end
+
+
+  def test_paged_links_page_params_large_data_set_start_full_pages
+    params = ActionController::Parameters.new(
+      {
+        size: 5,
+        number: 1
+      }
+    )
+
+    paginator = PagedPaginator.new(params)
+    links_params = paginator.links_page_params(record_count: 50)
+
+    assert_equal 3, links_params.size
+
+    assert_equal 5, links_params['first']['size']
+    assert_equal 1, links_params['first']['number']
+
+    assert_equal 5, links_params['next']['size']
+    assert_equal 2, links_params['next']['number']
+
+    assert_equal 5, links_params['last']['size']
+    assert_equal 10, links_params['last']['number']
+  end
+
+  def test_paged_links_page_params_large_data_set_start_partial_last
+    params = ActionController::Parameters.new(
+      {
+        size: 5,
+        number: 1
+      }
+    )
+
+    paginator = PagedPaginator.new(params)
+    links_params = paginator.links_page_params(record_count: 51)
+
+    assert_equal 3, links_params.size
+
+    assert_equal 5, links_params['first']['size']
+    assert_equal 1, links_params['first']['number']
+
+    assert_equal 5, links_params['next']['size']
+    assert_equal 2, links_params['next']['number']
+
+    assert_equal 5, links_params['last']['size']
+    assert_equal 11, links_params['last']['number']
+  end
+
+  def test_paged_links_page_params_large_data_set_middle
+    params = ActionController::Parameters.new(
+      {
+        size: 5,
+        number: 4
+      }
+    )
+
+    paginator = PagedPaginator.new(params)
+    links_params = paginator.links_page_params(record_count: 50)
+
+    assert_equal 4, links_params.size
+
+    assert_equal 5, links_params['first']['size']
+    assert_equal 1, links_params['first']['number']
+
+    assert_equal 5, links_params['previous']['size']
+    assert_equal 3, links_params['previous']['number']
+
+    assert_equal 5, links_params['next']['size']
+    assert_equal 5, links_params['next']['number']
+
+    assert_equal 5, links_params['last']['size']
+    assert_equal 10, links_params['last']['number']
+  end
+
+  def test_paged_links_page_params_large_data_set_end
+    params = ActionController::Parameters.new(
+      {
+        size: 5,
+        number: 10
+      }
+    )
+
+    paginator = PagedPaginator.new(params)
+    links_params = paginator.links_page_params(record_count: 50)
+
+    assert_equal 3, links_params.size
+
+    assert_equal 5, links_params['first']['size']
+    assert_equal 1, links_params['first']['number']
+
+    assert_equal 5, links_params['previous']['size']
+    assert_equal 9, links_params['previous']['number']
+
+    assert_equal 5, links_params['last']['size']
+    assert_equal 10, links_params['last']['number']
+  end
+
+  def test_paged_links_page_params_large_data_set_past_end
+    params = ActionController::Parameters.new(
+      {
+        size: 5,
+        number: 11
+      }
+    )
+
+    paginator = PagedPaginator.new(params)
+    links_params = paginator.links_page_params(record_count: 50)
+
+    assert_equal 3, links_params.size
+
+    assert_equal 5, links_params['first']['size']
+    assert_equal 1, links_params['first']['number']
+
+    assert_equal 5, links_params['previous']['size']
+    assert_equal 10, links_params['previous']['number']
+
+    assert_equal 5, links_params['last']['size']
+    assert_equal 10, links_params['last']['number']
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jsonapi-resources
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Dan Gebhardt
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-10 00:00:00.000000000 Z
+date: 2015-06-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -194,6 +194,8 @@ files:
 - test/test_helper.rb
 - test/unit/jsonapi_request/jsonapi_request_test.rb
 - test/unit/operation/operations_processor_test.rb
+- test/unit/pagination/offset_paginator_test.rb
+- test/unit/pagination/paged_paginator_test.rb
 - test/unit/resource/resource_test.rb
 - test/unit/serializer/include_directives_test.rb
 - test/unit/serializer/response_document_test.rb
@@ -254,6 +256,8 @@ test_files:
 - test/test_helper.rb
 - test/unit/jsonapi_request/jsonapi_request_test.rb
 - test/unit/operation/operations_processor_test.rb
+- test/unit/pagination/offset_paginator_test.rb
+- test/unit/pagination/paged_paginator_test.rb
 - test/unit/resource/resource_test.rb
 - test/unit/serializer/include_directives_test.rb
 - test/unit/serializer/response_document_test.rb