api_me 0.7.1 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a97089cfc6b7bf6d795b611f125e707765cd0556
-  data.tar.gz: 15fb80cbe68170c4f56453bddd63726f5fbe3e93
+  metadata.gz: 8aefa13bb6c4cb741b5b745f763b478ec279004d
+  data.tar.gz: 36d2113a88594b323d188d7f6f2812b2ae591109
 SHA512:
-  metadata.gz: d560b2e6b10738a5f85d3634d2516860b796046e80cf0ff60001f0a056a7cd70e1a3770eac520fbf662ed31e3c183252a113308cddf70337ab42c36cd9c41e9f
-  data.tar.gz: a405ad926c4611f2b325a750ab3aecd04851b9b70565158cbed3b70ad7f5c87bdfd19a511b0b9f221df3d836a4bef5f2ada8bceded6e63d242e7a52b5554e990
+  metadata.gz: 7e9a8cff6b5ca7301ef12b2e9b5cc6c41f7b39e3c0bb63249c26392d1f3a031c132462e1f035d2b4bcc18e364be52b90b60dbf61b318d3a7995d3b1f781e4d2a
+  data.tar.gz: 4db327ab00687bb5c1378dc8839de1d2917156919fb80a82a2008cab093f68bdcaec6697c7535cca523edf0e150a616e0e9f4f65963be00d3633389320d36824

data/Gemfile

@@ -10,5 +10,5 @@ group :test do
   gem 'combustion', '~> 0.5.2'
   gem 'rack-test'
   gem 'pundit'
-  gem 'active_model_serializers', '~> 0.8.0'
+  gem 'active_model_serializers', '~> 0.10.0'
 end

data/README.md

@@ -12,6 +12,27 @@ Api controllers use the fantastic [Pundit](https://github.com/elabs/pundit) gem
 
 The primary goal of this gem was to keep things simple so that customization is fairly straight forward by separating concerns and providing overrides. Reusing existing libraries was a primary goal during the design, hence the overall simplicity of this gem. We currently use this gem internally at [Inigo](inigo.io) and are committed to its ongoing maintenance.
 
+### Upgrade from 0.7.X to 0.8.X
+- Upgrade to the latest version of 0.7.X. Run the app/tests and check/fix all deprecations
+- Upgrade to the latest version of 0.8.X, update active_model_serializers to 0.10.X.
+- Add the following initializer:
+  `config/initializers/active_model_serializer.rb`
+  ```rb
+  ActiveModelSerializers.config.adapter = :json
+  ```
+- Remove all `embed ...` methods from the serializers
+- Update all belongs-to relationships to have FKs, serialize the FK id in all active model serializers instead of embeding the relationship (I.E. `has_one :foo` becomes `attributes :foo_id`)
+- Update all has-many relationships to serialize the ids instead of embeding the relationship. (I.E. `has_many :foos` becomes `attributes :foo_ids`)
+- Remove all has-one relationships and manually build a method to serialize the id. Ex:
+  ```rb
+  attributes :foo_id
+
+  def foo_id
+    object.foo ? object.foo.id : nil
+  end
+  ```
+- Embeded has-one and belongs-to relationships look the same on the serializer, so look at the model to identify the differences.
+
 ### Installation
 Add the gem to your Gemfile: `gem api_me`.
 
@@ -85,7 +106,7 @@ The ApiMe::BaseFilter is called if no filter exists for the resource, by default
 
 ### Sorting
 
-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.
+To enable sorting just pass `sort` in your request with `sortCiteria` and `sortReverse`.
 
 Ember Example
 ````js

data/api_me.gemspec

@@ -21,7 +21,7 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency 'activerecord',             '>= 3.2.0'
   s.add_runtime_dependency 'activesupport',            '>= 3.2.0'
   s.add_runtime_dependency 'pundit',                   '~> 1.0'
-  s.add_runtime_dependency 'active_model_serializers', '~> 0.8.0'
+  s.add_runtime_dependency 'active_model_serializers', '~> 0.10.0'
   s.add_runtime_dependency 'search_object',            '~> 1.0'
   s.add_runtime_dependency 'kaminari',                 '~> 0.16.3'
 

data/lib/api_me/model.rb

@@ -1,4 +1,6 @@
+require 'active_model_serializers/model'
+
 module ApiMe
-  class Model < ActiveModel::Serializer
+  class Model < ActiveModelSerializers::Model
   end
 end

data/lib/api_me/pagination.rb

@@ -29,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
 

data/lib/api_me/sorting.rb

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

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

@@ -142,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&sort%5BassoCriteria%5D='
+    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
@@ -152,7 +152,7 @@ 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&sort%5BassoCriteria%5D='
+    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)

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

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

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

@@ -1,4 +1,3 @@
 class UserSerializer < ActiveModel::Serializer
-  embed :ids
   attributes :id, :username
 end

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

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: api_me
 version: !ruby/object:Gem::Version
-  version: 0.7.1
+  version: 0.8.0
 platform: ruby
 authors:
 - Sam Clopton
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-21 00:00:00.000000000 Z
+date: 2016-09-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -59,14 +59,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.0
+        version: 0.10.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.0
+        version: 0.10.0
 - !ruby/object:Gem::Dependency
   name: search_object
   requirement: !ruby/object:Gem::Requirement