api_me 0.7.0 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7eaa0bc3aa1012e62785ab01d14d6cfd43c213aa
-  data.tar.gz: 8a5b6712ee27defbf5d2c45763bf19b5c57e381f
+  metadata.gz: a97089cfc6b7bf6d795b611f125e707765cd0556
+  data.tar.gz: 15fb80cbe68170c4f56453bddd63726f5fbe3e93
 SHA512:
-  metadata.gz: e1a4bbc4b1dd7278b18c96f8e307f74395e4a2d678f27e0108c7d8f4bb886d26983e70b3539cfe620c370962b1be149040065c8505f364f7880d22705070890a
-  data.tar.gz: dd6b5886ed746e190ec31b3c3ada9dac8761d6dedf5e92cd464f6ab336e769e521791a1778060f7b4a65e165771b369bccfad67d5749b252c9e987c6ffd93923
+  metadata.gz: d560b2e6b10738a5f85d3634d2516860b796046e80cf0ff60001f0a056a7cd70e1a3770eac520fbf662ed31e3c183252a113308cddf70337ab42c36cd9c41e9f
+  data.tar.gz: a405ad926c4611f2b325a750ab3aecd04851b9b70565158cbed3b70ad7f5c87bdfd19a511b0b9f221df3d836a4bef5f2ada8bceded6e63d242e7a52b5554e990

data/.travis.yml

@@ -1,4 +1,4 @@
 language: ruby
 script: bundle exec rspec spec
 rvm:
-  - 2.1.0
+  - 2.2.2

data/README.md

@@ -85,7 +85,7 @@ The ApiMe::BaseFilter is called if no filter exists for the resource, by default
 
 ### Sorting
 
-To enable sorting just pass `sort` in your request with `sortCiteria` and `sortReverse`.
+To enable sorting simply pass `sort` in your API request with `sortCiteria` and `sortReverse` as hash parameters. Associated models will need a third parameter passed in `associationCriteria`, meaning the attribute of the associated model to sort by.
 
 Ember Example
 ````js

data/lib/api_me.rb

@@ -71,14 +71,14 @@ module ApiMe
     @sorted_scope = sort_scope(@filter_scope, params[:sort])
     @pagination_object = ApiMe::Pagination.new(scope: @sorted_scope, page_params: params[:page])
 
-    render json: @pagination_object.results, each_serializer: serializer_klass, meta: { page: @pagination_object.page_meta }
+    render json: @pagination_object.results, root: collection_root_key, each_serializer: serializer_klass, meta: { page: @pagination_object.page_meta }
   end
 
   def show
     @object = find_resource
     authorize @object
 
-    render json: @object, serializer: serializer_klass
+    render json: @object, root: singular_root_key, serializer: serializer_klass
   end
 
   def create
@@ -86,7 +86,7 @@ module ApiMe
     authorize @object
     @object.save!(object_params)
 
-    render status: 201, json: @object, serializer: serializer_klass
+    render status: 201, json: @object, root: singular_root_key, serializer: serializer_klass
   rescue ActiveRecord::RecordInvalid => e
     handle_errors(e)
   end
@@ -112,6 +112,14 @@ module ApiMe
 
   protected
 
+  def singular_root_key
+    model_klass.name.singularize.underscore
+  end
+
+  def collection_root_key
+    model_klass.name.pluralize.underscore
+  end
+
   def object_params
     params.require(params_klass_symbol).permit(*policy(@object || model_klass).permitted_attributes)
   end

data/lib/api_me/model.rb

@@ -0,0 +1,4 @@
+module ApiMe
+  class Model < ActiveModel::Serializer
+  end
+end

data/lib/api_me/pagination.rb

@@ -29,7 +29,7 @@ module ApiMe
     protected
 
     def page
-      self.scope = Kaminari.paginate_array(scope).page(self.page_offset ? page_offset : 1)
+      self.scope = scope.page(self.page_offset ? page_offset : 1)
       self
     end
 

data/lib/api_me/sorting.rb

@@ -1,17 +1,18 @@
 module ApiMe
   class Sorting
-    attr_accessor :sort_criteria, :sort_reverse, :scope
+    attr_accessor :sort_criteria, :sort_reverse, :sort_association, :scope
 
     def initialize(scope:, sort_params:)
       self.scope = scope
       if sort_params
-        self.sort_criteria = sort_params[:criteria]
+        self.sort_association = sort_params[:assoCriteria]
+        self.sort_criteria = sort_params[:criteria] || default_sort_criteria
         self.sort_reverse = sort_params[:reverse]
       end
     end
 
     def results
-      sorting? ? sort.scope : scope
+      sorting? ? sort(sort_criteria) : scope
     end
 
     def sort_meta
@@ -26,20 +27,22 @@ module ApiMe
 
     protected
 
-    def sort
-      unless sort_criteria === ""
-        sort_p = sort_criteria
+    def sort(criteria = default_sort_criteria)
+      unless sort_association == ""
+        criteria_class = criteria.camelize.constantize
+
         if sort_reverse === "true"
-          self.scope = scope.sort_by {|scope| scope[sort_p]}.reverse!
+          self.scope = scope.joins(criteria.to_sym).merge(criteria_class.order(sort_association => :desc))
         else
-          self.scope = scope.sort_by {|scope| scope[sort_p]}
+          self.scope = scope.joins(criteria.to_sym).merge(criteria_class.order(sort_association => :asc))
         end
-        self.scope
       else
-        default_sort_criteria
-        sort.scope
+        if sort_reverse === "true"
+          self.scope = scope.order(criteria => :desc)
+        else
+          self.scope = scope.order(criteria => :asc)
+        end
       end
-      self
     end
 
     private
@@ -51,6 +54,5 @@ module ApiMe
     def sorting?
       sort_criteria || sort_reverse
     end
-
   end
 end

data/lib/api_me/version.rb

@@ -1,3 +1,3 @@
 module ApiMe
-  VERSION = '0.7.0'
+  VERSION = '0.7.1'
 end

data/spec/acceptance/api/v1/posts_spec.rb

@@ -58,7 +58,6 @@ describe 'Posts API' do
     get '/api/v1/posts?page%5Boffset%5D=3'
     json = JSON.parse(last_response.body)
     expect(json['posts'].length).to eq(0)
-
   end
 
   it 'is page size of 10 working for default offset of 1' do
@@ -143,7 +142,7 @@ describe 'Posts API' do
       Post.create(name: 'Post' + i.to_s)
     end
 
-    get '/api/v1/posts?sort%5Bcriteria%5D=id&sort%5Breverse%5D=true'
+    get '/api/v1/posts?sort%5Bcriteria%5D=id&sort%5Breverse%5D=true&sort%5BassoCriteria%5D='
     json = JSON.parse(last_response.body)
     expect(json['posts'].last['name']).to eq('Post0')
   end
@@ -153,10 +152,9 @@ describe 'Posts API' do
       Post.create(name: 'Post' + i.to_s)
     end
 
-    get '/api/v1/posts?page%5Boffset%5D=1&page%5Bsize%5D=10&sort%5Bcriteria%5D=id&sort%5Breverse%5D=true'
+    get '/api/v1/posts?page%5Boffset%5D=1&page%5Bsize%5D=10&sort%5Bcriteria%5D=id&sort%5Breverse%5D=true&sort%5BassoCriteria%5D='
     json = JSON.parse(last_response.body)
     expect(json['posts'].first['name']).to eq('Post19')
     expect(json['posts'].length).to eq(10)
   end
-
 end

data/spec/internal/app/models/post.rb

@@ -1,2 +1,3 @@
 class Post < ActiveRecord::Base
+  belongs_to :user
 end

data/spec/internal/app/models/test_model.rb

@@ -1,4 +1,6 @@
-class TestModel
+require 'api_me/model'
+
+class TestModel < ApiMe::Model
   def self.create
     @created = true
   end

data/spec/internal/app/models/user.rb

@@ -1,2 +1,3 @@
 class User < ActiveRecord::Base
+  has_many :posts
 end

data/spec/internal/app/serializers/post_serializer.rb

@@ -1,3 +1,5 @@
 class PostSerializer < ActiveModel::Serializer
   attributes :name
+
+  has_one :user
 end

data/spec/internal/config/initializers/active_model_serializers.rb

@@ -0,0 +1 @@
+#ActiveModelSerializers.config.adapter = :json

data/spec/internal/db/schema.rb

@@ -6,6 +6,7 @@ ActiveRecord::Schema.define do
 
   create_table :posts, force: true do |t|
     t.string :name
+    t.belongs_to :user, foreign_key: true
     t.timestamps
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: api_me
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.7.1
 platform: ruby
 authors:
 - Sam Clopton
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-23 00:00:00.000000000 Z
+date: 2016-12-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -187,6 +187,7 @@ files:
 - lib/api_me.rb
 - lib/api_me/base_filter.rb
 - lib/api_me/engine.rb
+- lib/api_me/model.rb
 - lib/api_me/pagination.rb
 - lib/api_me/sorting.rb
 - lib/api_me/version.rb
@@ -223,6 +224,7 @@ files:
 - spec/internal/app/serializers/test_model_serializer.rb
 - spec/internal/app/serializers/user_serializer.rb
 - spec/internal/config/database.yml
+- spec/internal/config/initializers/active_model_serializers.rb
 - spec/internal/config/routes.rb
 - spec/internal/db/schema.rb
 - spec/internal/log/.gitignore