jsonapi-resources 0.0.8 → 0.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3e063aecb3183d3a1862dc4fd88f0f06ddc921dd
-  data.tar.gz: 40b0476410fe269a08f16791f8b927d2aee02156
+  metadata.gz: 6eb51f8c096de8ece9f78168a967750a958fe620
+  data.tar.gz: 1e7e845621c801642776c99bd559185af85a645c
 SHA512:
-  metadata.gz: f4135619c0ad660679b93ea9dcde314991134824e0d01540705b4a3055e0acccfab76d74b0e49cf94d969d949063a51c50328165265b90b2057065ec34b13eb3
-  data.tar.gz: 335f3f2b30251c07b2286dbdcd176d3f199fd844d99f6c9619a0b54e598b66e0fe07b1386cddb1c18106b3e1d968e6a6a1f5eaabb11e3cc72d75d08bf54581ae
+  metadata.gz: 57b8f79c39ddfe67ab9fc939292b8f9c9ed014cf0b673eab9c7e9957a927dd743b51c719c40c55973c81856898c349715c1ae3560a8e72c5efc37fe7c71e7407
+  data.tar.gz: d3ac8f45d9d357fc9adc44a88cb46596c5dcb81bac8b6f1bb3bbb20079eb797490689f4014e118a52a3885f418d9955ebc52e21f8de0f1fe66ccfb4fe18852f6

data/README.md

@@ -92,7 +92,7 @@ class AuthorResource < JSONAPI::Resource
   model_name 'Person'
   has_many :posts
 
-  def fetchable_fields(context)
+  def fetchable_fields
     if (context.current_user.guest)
       super(context) - [:email]
     else
@@ -132,6 +132,24 @@ end
 
 The `context` is not by default used by the `ResourceController`, but may be used if you override the controller methods. By using the context you have the option to determine the createable and updateable fields based on the user.
 
+##### Sortable Attributes
+
+JR supports [sorting primary resources by multiple sort criteria](http://jsonapi.org/format/#fetching-sorting).
+
+By default all attributes are assumed to be sortable. To prevent some attributes from being sortable, override the `self.sortable_fields` method on a resource.
+
+Here's an example that prevents sorting by post's `body`:
+
+```ruby
+class PostResource < JSONAPI::Resource
+  attribute :id, :title, :body
+
+  def self.sortable_fields(context)
+    super(context) - [:body]
+  end
+end
+```
+
 ##### Attribute Formatting
 
 Attributes can have a Format. By default all attributes use the default formatter. If an attribute has the `format` option set the system will attempt to find a formatter based on this name. In the following example the `last_login_time` will be returned formatted to a certain time zone:
@@ -244,7 +262,7 @@ end
 
 Basic finding by filters is supported by resources. However if you have more complex requirements for finding you can override the `find` and `find_by_key` methods on the resource.
 
-Here's an example that defers the `find` operation to a `current_user` set on the `context`:
+Here's an example that defers the `find` operation to a `current_user` set on the `context` option:
 
 ```ruby
 class AuthorResource < JSONAPI::Resource
@@ -254,7 +272,8 @@ class AuthorResource < JSONAPI::Resource
 
   filter :name
 
-  def self.find(attrs, context = nil)
+  def self.find(attrs, options = {})
+    context = options[:context]
     authors = context.current_user.find_authors(attrs)
 
     return authors.map do |author|
@@ -313,6 +332,9 @@ module JSONAPI
   COUNT_MISMATCH = 108
   KEY_ORDER_MISMATCH = 109
   KEY_NOT_INCLUDED_IN_URL = 110
+  INVALID_INCLUDE = 112
+  RELATION_EXISTS = 113
+  INVALID_SORT_PARAM = 114
 
   RECORD_NOT_FOUND = 404
   LOCKED = 423

data/lib/jsonapi/error_codes.rb

@@ -12,7 +12,8 @@ module JSONAPI
   KEY_NOT_INCLUDED_IN_URL = 110
   INVALID_INCLUDE = 112
   RELATION_EXISTS = 113
+  INVALID_SORT_PARAM = 114
 
   RECORD_NOT_FOUND = 404
   LOCKED = 423
-end
+end

data/lib/jsonapi/exceptions.rb

@@ -130,6 +130,21 @@ module JSONAPI
       end
     end
 
+    class InvalidSortParam < Error
+      attr_accessor :sort_param, :resource
+      def initialize(resource, sort_param)
+        @resource = resource
+        @sort_param = sort_param
+      end
+
+      def errors
+        [JSONAPI::Error.new(code: JSONAPI::INVALID_SORT_PARAM,
+                            status: :bad_request,
+                            title: 'Invalid sort param',
+                            detail: "#{sort_param} is not a valid sort param for #{resource}")]
+      end
+    end
+
     class ParametersNotAllowed < Error
       attr_accessor :params
       def initialize(params)

data/lib/jsonapi/operation.rb

@@ -39,7 +39,7 @@ module JSONAPI
     end
 
     def apply(context)
-      resource = @resource_klass.find_by_key(@resource_id, context)
+      resource = @resource_klass.find_by_key(@resource_id, context: context)
       resource.remove
 
       return JSONAPI::OperationResult.new(:no_content)
@@ -62,7 +62,7 @@ module JSONAPI
     end
 
     def apply(context)
-      resource = @resource_klass.find_by_key(@resource_id, context)
+      resource = @resource_klass.find_by_key(@resource_id, context: context)
       resource.replace_fields(values)
       resource.save
 
@@ -81,7 +81,7 @@ module JSONAPI
     end
 
     def apply(context)
-      resource = @resource_klass.find_by_key(@resource_id, context)
+      resource = @resource_klass.find_by_key(@resource_id, context: context)
       resource.create_has_one_link(@association_type, @key_value)
       resource.save
 
@@ -100,7 +100,7 @@ module JSONAPI
     end
 
     def apply(context)
-      resource = @resource_klass.find_by_key(@resource_id, context)
+      resource = @resource_klass.find_by_key(@resource_id, context: context)
       resource.replace_has_one_link(@association_type, @key_value)
       resource.save
 
@@ -119,7 +119,7 @@ module JSONAPI
     end
 
     def apply(context)
-      resource = @resource_klass.find_by_key(@resource_id, context)
+      resource = @resource_klass.find_by_key(@resource_id, context: context)
       @key_values.each do |value|
         resource.create_has_many_link(@association_type, value)
       end
@@ -139,7 +139,7 @@ module JSONAPI
     end
 
     def apply(context)
-      resource = @resource_klass.find_by_key(@resource_id, context)
+      resource = @resource_klass.find_by_key(@resource_id, context: context)
       resource.replace_has_many_links(@association_type, @key_values)
       resource.save
 
@@ -158,7 +158,7 @@ module JSONAPI
     end
 
     def apply(context)
-      resource = @resource_klass.find_by_key(@resource_id, context)
+      resource = @resource_klass.find_by_key(@resource_id, context: context)
       resource.remove_has_many_link(@association_type, @associated_key)
 
       return JSONAPI::OperationResult.new(:no_content)
@@ -178,7 +178,7 @@ module JSONAPI
     end
 
     def apply(context)
-      resource = @resource_klass.find_by_key(@resource_id, context)
+      resource = @resource_klass.find_by_key(@resource_id, context: context)
       resource.remove_has_one_link(@association_type)
       resource.save
 

data/lib/jsonapi/request.rb

@@ -5,7 +5,7 @@ module JSONAPI
   class Request
     include ResourceFor
 
-    attr_accessor :fields, :include, :filters, :errors, :operations, :resource_klass, :context
+    attr_accessor :fields, :include, :filters, :sort_params, :errors, :operations, :resource_klass, :context
 
     def initialize(params = nil, options = {})
       @context = options.fetch(:context, nil)
@@ -28,6 +28,7 @@ module JSONAPI
             parse_fields(params)
             parse_include(params)
             parse_filters(params)
+            parse_sort_params(params)
           when 'show_associations'
           when 'show'
             parse_fields(params)
@@ -144,6 +145,26 @@ module JSONAPI
       @filters = filters
     end
 
+    def parse_sort_params(params)
+      @sort_params = if params[:sort].present?
+        CSV.parse_line(params[:sort]).each do |sort_param|
+          check_sort_param(@resource_klass, sort_param)
+        end
+      else
+        []
+      end
+    end
+
+    def check_sort_param(resource_klass, sort_param)
+      sort_param = sort_param.sub(/\A-/, '')
+      sortable_fields = resource_klass.sortable_fields(context)
+
+      unless sortable_fields.include? sort_param.to_sym
+        @errors.concat(JSONAPI::Exceptions::InvalidSortParam
+          .new(format_key(resource_klass._type), sort_param).errors)
+      end
+    end
+
     def parse_add_operation(params)
       object_params_raw = params.require(format_key(@resource_klass._type))
 

data/lib/jsonapi/resource.rb

@@ -26,7 +26,7 @@ module JSONAPI
 
     def create_has_many_link(association_type, association_key_value)
       association = self.class._associations[association_type]
-      related_resource = self.class.resource_for(association.type).find_by_key(association_key_value, @context)
+      related_resource = self.class.resource_for(association.type).find_by_key(association_key_value, context: @context)
 
       # ToDo: Add option to skip relations that already exist instead of returning an error?
       relation = @model.send(association.type).where(association.primary_key => association_key_value).first
@@ -214,12 +214,19 @@ module JSONAPI
         _updateable_associations | _attributes.keys
       end
 
+      # Override in your resource to filter the sortable keys
+      def sortable_fields(context = nil)
+        _attributes.keys
+      end
+
       def fields
         _associations.keys | _attributes.keys
       end
 
       # Override this method if you have more complex requirements than this basic find method provides
-      def find(filters, context = nil)
+      def find(filters, options = {})
+        context = options[:context]
+        sort_params = options.fetch(:sort_params) { [] }
         includes = []
         where_filters = {}
 
@@ -237,14 +244,16 @@ module JSONAPI
         end
 
         resources = []
-        _model_class.where(where_filters).includes(includes).each do |model|
+        order_options = construct_order_options(sort_params)
+        _model_class.where(where_filters).order(order_options).includes(includes).each do |model|
           resources.push self.new(model, context)
         end
 
         return resources
       end
 
-      def find_by_key(key, context = nil)
+      def find_by_key(key, options = {})
+        context = options[:context]
         model = _model_class.where({_primary_key => key}).first
         if model.nil?
           raise JSONAPI::Exceptions::RecordNotFound.new(key)
@@ -408,6 +417,16 @@ module JSONAPI
           end
         end
       end
+
+      def construct_order_options(sort_params)
+        sort_params.each_with_object({}) { |sort_key, order_hash|
+          if sort_key.starts_with?('-')
+            order_hash[sort_key.slice(1..-1)] = :desc
+          else
+            order_hash[sort_key] = :asc
+          end
+        }
+      end
     end
   end
 end

data/lib/jsonapi/resource_controller.rb

@@ -17,7 +17,8 @@ module JSONAPI
 
     def index
       render json: JSONAPI::ResourceSerializer.new.serialize_to_hash(
-          resource_klass.find(resource_klass.verify_filters(@request.filters, context), context),
+          resource_klass.find(resource_klass.verify_filters(@request.filters, context),
+            context: context, sort_params: @request.sort_params),
           include: @request.include,
           fields: @request.fields,
           attribute_formatters: attribute_formatters,
@@ -32,10 +33,10 @@ module JSONAPI
       if keys.length > 1
         resources = []
         keys.each do |key|
-          resources.push(resource_klass.find_by_key(key, context))
+          resources.push(resource_klass.find_by_key(key, context: context))
         end
       else
-        resources = resource_klass.find_by_key(keys[0], context)
+        resources = resource_klass.find_by_key(keys[0], context: context)
       end
 
       render json: JSONAPI::ResourceSerializer.new.serialize_to_hash(
@@ -53,7 +54,7 @@ module JSONAPI
 
       parent_key = params[resource_klass._as_parent_key]
 
-      parent_resource = resource_klass.find_by_key(parent_key, context)
+      parent_resource = resource_klass.find_by_key(parent_key, context: context)
 
       association = resource_klass._association(association_type)
       render json: { association_type => parent_resource.send(association.foreign_key)}

data/lib/jsonapi/resources/version.rb

@@ -1,5 +1,5 @@
 module JSONAPI
   module Resources
-    VERSION = "0.0.8"
+    VERSION = "0.0.9"
   end
 end

data/test/controllers/controller_test.rb

@@ -157,6 +157,41 @@ class PostsControllerTest < ActionController::TestCase
     assert_equal 3, json_response['posts'].size
   end
 
+  def test_sorting_asc
+    get :index, {sort: 'title'}
+
+    assert_response :success
+    assert_equal "Delete This Later - Multiple2-1", json_response['posts'][0]['title']
+  end
+
+  def test_sorting_desc
+    get :index, {sort: '-title'}
+
+    assert_response :success
+    assert_equal "Update This Later - Multiple", json_response['posts'][0]['title']
+  end
+
+  def test_sorting_by_multiple_fields
+    get :index, {sort: 'title,body'}
+
+    assert_response :success
+    assert_equal 8, json_response['posts'][0]['id']
+  end
+
+  def test_invalid_sort_param
+    get :index, {sort: 'asdfg'}
+
+    assert_response :bad_request
+    assert_match /asdfg is not a valid sort param for post/, response.body
+  end
+
+  def test_excluded_sort_param
+    get :index, {sort: 'id'}
+
+    assert_response :bad_request
+    assert_match /id is not a valid sort param for post/, response.body
+  end
+
   # ToDo: test validating the parameter values
   # def test_index_invalid_filter_value
   #   get :index, {ids: [1,'asdfg1']}

data/test/fixtures/active_record.rb

@@ -308,12 +308,12 @@ class AuthorResource < JSONAPI::Resource
 
   filter :name
 
-  def self.find(filters, context)
+  def self.find(filters, options = {})
     resources = []
 
     filters.each do |attr, filter|
       _model_class.where("\"#{attr}\" LIKE \"%#{filter[0]}%\"").each do |model|
-        resources.push self.new(model, context)
+        resources.push self.new(model, options[:context])
       end
     end
     return resources
@@ -372,6 +372,10 @@ class PostResource < JSONAPI::Resource
     super(context) - [:subject]
   end
 
+  def self.sortable_fields(context)
+    super(context) - [:id]
+  end
+
   def self.verify_custom_filter(filter, values, context = nil)
     case filter
       when :id
@@ -392,7 +396,7 @@ class PostResource < JSONAPI::Resource
 
   def self.verify_key(key, context = nil)
     raise JSONAPI::Exceptions::InvalidFieldValue.new(:id, key) unless is_num?(key)
-    raise JSONAPI::Exceptions::RecordNotFound.new(key) unless find_by_key(key, context)
+    raise JSONAPI::Exceptions::RecordNotFound.new(key) unless find_by_key(key, context: context)
     return key
   end
 end
@@ -417,16 +421,16 @@ class BreedResource < JSONAPI::Resource
   # This is unneeded, just here for testing
   routing_options :param => :id
 
-  def self.find(attrs, context = nil)
+  def self.find(attrs, options = {})
     breeds = []
     $breed_data.breeds.values.each do |breed|
-      breeds.push(BreedResource.new(breed, context))
+      breeds.push(BreedResource.new(breed, options[:context]))
     end
     breeds
   end
 
-  def self.find_by_key(id, context = nil)
-    BreedResource.new($breed_data.breeds[id.to_i], context)
+  def self.find_by_key(id, options = {})
+    BreedResource.new($breed_data.breeds[id.to_i], options[:context])
   end
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jsonapi-resources
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.0.9
 platform: ruby
 authors:
 - Dan Gebhardt
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-21 00:00:00.000000000 Z
+date: 2014-10-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler