api_me 0.5.3 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e70094d4fd7b9ae7f7cfddc4dbfe9cec2e94d3ef
-  data.tar.gz: 698e8957b40252211d1f6ee22ff5fa05ab19cb79
+  metadata.gz: 4e8bb2cb3b9c132ede191b0d7276d7cbeabf7252
+  data.tar.gz: 130bf19a960566c5dc4c5f6ab05cb78c387596ed
 SHA512:
-  metadata.gz: b75592dd259a25e71a5ed7af2ff43be82aa51afb939c79ced4f249b76da2954c8c0bfd5ae4881cf748984ce50760935e5294a4f8466a9a143752e491057273b2
-  data.tar.gz: e04298b570816de02a33a062241f234b0da3421d89bf6bad9668fd04bd083b5285c53c538c52ea3cadc4f8bb60d218388dfdd6c5ae7bc47f94ade02be659de07
+  metadata.gz: a52cc62640bb368b1e661fcdacb0c43f87fc93f99e5d87acaa421ad6fa90287f95326521255e4a5d442f7b5f111f4b0da4f920123d4d822e23b172fdafd627db
+  data.tar.gz: 77004d9ae0c8728fa094744ad96fb2c37dbb9b2318ba41ab7c37f35d08daddd9111aeb77438296d9050c14aa7d1b6509b10fe1751027def01690821e82661fcd

data/.editorconfig

@@ -0,0 +1,41 @@
+# EditorConfig helps developers define and maintain consistent
+# coding styles between different editors and IDEs
+# editorconfig.org
+
+root = true
+
+
+[*]
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+indent_style = space
+indent_size = 2
+
+[*.rb]
+indent_style = space
+indent_size = 2
+
+[*.yml]
+indent_style = space
+indent_size = 2
+
+[*.js]
+indent_style = space
+indent_size = 2
+
+[*.hbs]
+indent_style = space
+indent_size = 2
+
+[*.css]
+indent_style = space
+indent_size = 2
+
+[*.html]
+indent_style = space
+indent_size = 2
+
+[*.md]
+trim_trailing_whitespace = false

data/lib/api_me.rb

@@ -5,6 +5,7 @@ require 'kaminari'
 
 require 'api_me/version'
 require 'api_me/base_filter'
+require 'api_me/sorting'
 require 'api_me/pagination'
 
 module ApiMe
@@ -67,7 +68,8 @@ module ApiMe
   def index
     @policy_scope = policy_scope(resource_scope)
     @filter_scope = filter_scope(@policy_scope)
-    @pagination_object = ApiMe::Pagination.new(scope: @filter_scope, page_params: params[:page])
+    @sorted_scope = ApiMe::Sorting.new(scope: @filter_scope, sort_params: params[:sort]).results
+    @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 }
   end
@@ -147,7 +149,7 @@ module ApiMe
   def resource_scope
     model_klass.all
   end
-  
+
   def filter_scope(scope)
     filter_klass.new(
         scope: scope,
@@ -158,7 +160,7 @@ module ApiMe
   def params_klass_symbol
     model_klass.name.demodulize.underscore.to_sym
   end
-  
+
   def filters_hash
     ids_filter_hash = params[:ids] ? { ids: params[:ids] } : {}
     (filter_params || {}).merge(ids_filter_hash)

data/lib/api_me/pagination.rb

@@ -17,7 +17,6 @@ module ApiMe
 
     def page_meta
       return Hash.new unless paging?
-
       {
         size: page_size.nil? ? default_page_size : page_size,
         offset: page_offset,
@@ -30,7 +29,7 @@ module ApiMe
     protected
 
     def page
-      self.scope = scope.page(self.page_offset ? page_offset : 1)
+      self.scope = Kaminari.paginate_array(scope).page(self.page_offset ? page_offset : 1)
       self
     end
 
@@ -38,7 +37,6 @@ module ApiMe
       if page_size
         self.scope = scope.per(page_size)
       end
-
       self
     end
 
@@ -51,5 +49,6 @@ module ApiMe
     def paging?
       page_size || page_offset
     end
+
   end
 end

data/lib/api_me/sorting.rb

@@ -0,0 +1,57 @@
+module ApiMe
+  class Sorting
+    attr_accessor :sort_criteria, :sort_reverse, :scope
+
+    def initialize(scope:, sort_params:)
+      self.scope = scope
+
+      if sort_params
+        self.sort_criteria = sort_params[:criteria]
+        self.sort_reverse = sort_params[:reverse]
+      end
+    end
+
+    def results
+      sorting? ? sort.scope : scope
+    end
+
+    def sort_meta
+      return Hash.new unless sorting?
+      {
+        criteria: sort_criteria.is_blank? || sort_criteria === "" ? default_sort_criteria : sort_criteria,
+        reverse: sort_reverse,
+        record_count: scope.size,
+        total_records: scope.total_count,
+      }
+    end
+
+    protected
+
+    def sort
+      unless sort_criteria === ""
+        sort_p = sort_criteria
+        if sort_reverse === "true"
+          self.scope = scope.sort_by {|scope| scope[sort_p]}.reverse!
+        else
+          self.scope = scope.sort_by {|scope| scope[sort_p]}
+        end
+        self.scope
+      else
+        default_sort_criteria
+        sort.scope
+      end
+      self
+    end
+
+    private
+
+    def default_sort_criteria
+      sort_criteria = "id"
+    end
+
+    def sorting?
+      sort_criteria || sort_reverse
+    end
+
+  end
+end

data/lib/api_me/version.rb

@@ -1,3 +1,3 @@
 module ApiMe
-  VERSION = '0.5.3'
+  VERSION = '0.6.0'
 end

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

@@ -137,4 +137,26 @@ describe 'Posts API' do
 
     expect(json['posts'].length).to eq(filtered_posts.count)
   end
+
+  it 'sends posts reverse sorted by id' do
+    20.times do |i|
+      Post.create(name: 'Post' + i.to_s)
+    end
+
+    get '/api/v1/posts?sort%5Bcriteria%5D=id&sort%5Breverse%5D=true'
+    json = JSON.parse(last_response.body)
+    expect(json['posts'].last['name']).to eq('Post0')
+  end
+
+  it 'sends posts reverse sorted by id and paginated with a size of 10 and an offset of 1' do
+    20.times do |i|
+      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'
+    json = JSON.parse(last_response.body)
+    expect(json['posts'].first['name']).to eq('Post19')
+    expect(json['posts'].length).to eq(10)
+  end
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: api_me
 version: !ruby/object:Gem::Version
-  version: 0.5.3
+  version: 0.6.0
 platform: ruby
 authors:
 - Sam Clopton
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-20 00:00:00.000000000 Z
+date: 2016-05-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -173,6 +173,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".editorconfig"
 - ".gitignore"
 - ".rubocop.yml"
 - ".ruby-version"
@@ -187,6 +188,7 @@ files:
 - lib/api_me/base_filter.rb
 - lib/api_me/engine.rb
 - lib/api_me/pagination.rb
+- lib/api_me/sorting.rb
 - lib/api_me/version.rb
 - lib/generators/api_me/controller/USAGE
 - lib/generators/api_me/controller/controller_generator.rb