jsonapi-resources 0.0.13 → 0.0.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2d31c91126186e543683030f0b2c2a0fb513d64e
-  data.tar.gz: 8bd319a9b582d306093f9cfaf82733f5edeb7aa1
+  metadata.gz: 6700d2a30e18dc6391ba4aa8bc0ecdd517e2fdfb
+  data.tar.gz: ad330dfe0d8fdc5da07d7ee40db08e892293296d
 SHA512:
-  metadata.gz: d4b2634d12eba8207a651bdb60a42e82bb85136d7098feaaf70821ea58c8200636b8b4e480a423b8ab8e1af1f2f8837cb33fe307adf55843c6da770e4c02e7f9
-  data.tar.gz: ebd5e529dd9662930ee305309cba83324325e090abdda8fcb7cf6a8cc204b437fde534d6de58d5815c5c1278efa9c527b4ea6ce3113940fcc651b00c5015bd37
+  metadata.gz: 893a1947cd78da813d77e69c92dafbaac07b50c8dab2ab495ebdf49da50c082f8123c99361cf95793e606dd4916d140401566a4465829bf137aa1f86144589db
+  data.tar.gz: d00fb87cc0c3a787d28fb68bc1d8072b6dc30143108dc3672770b19704430126511bf0aa73d2b86434546812ff6a4d194d710eb521a6f9d88840d8faeeef59d6

data/.travis.yml

@@ -1,4 +1,5 @@
 language: ruby
 rvm:
+  - 1.9.3
   - 2.0.0
-  - 2.1.1
+  - 2.1

data/README.md

@@ -260,42 +260,72 @@ end
 
 ##### Finders
 
-Basic finding by filters is supported by resources. However if you have more complex requirements for finding you can override the `find`, `find_by_key` and `find_by_keys` methods on the resource class.
+Basic finding by filters is supported by resources. This is implemented in the `find`, `find_by_key` and `find_by_keys` finder methods. Currently this is implemented for ActiveRecord based resources. The finder methods rely on the `records` method to get an Arel relation. It is therefore possible to override `records` to affect the three find related methods.
 
-Here's an example that defers the `find` operation to a `current_user` set on the `context` option:
+###### Customizing base records for finder methods
 
-```ruby
-class AuthorResource < JSONAPI::Resource
-  attributes :id, :name
-  model_name 'Person'
-  has_many :posts
+If you need to change the base records on which `find`, `find_by_key` and `find_by_keys` operate, you can override the `records` method on the resource class.
 
-  filter :name
+For example to allow a user to only retrieve his own posts you can do the following:
+
+```ruby
+class PostResource < JSONAPI::Resource
+  attribute :id, :title, :body
 
-  def self.find(attrs, options = {})
+  def self.records(options = {})
     context = options[:context]
-    authors = context.current_user.find_authors(attrs)
+    context.current_user.posts
+  end
+end
+```
 
-    return authors.map do |author|
-      self.new(author)
-    end
+###### Applying Filters
+
+The `apply_filter` method is called to apply each filter to the Arel relation. You may override this method to gain control over how the filters are applied to the Arel relation.
+
+For example to change how a
+
+```ruby
+def apply_filter(records, filter, value)
+  case filter
+    when :visibility
+      records.where('users.publicly_visible = ?', value == :public)
+    when :last_name, :first_name, :name
+      if value.is_a?(Array)
+        value.each do |val|
+          records = records.where(_model_class.arel_table[filter].matches(val))
+        end
+        return records
+      else
+        records.where(_model_class.arel_table[filter].matches(value))
+      end
+    else
+      return super(records, filter, value)
   end
 end
 ```
 
-##### Customizing base records for finder methods
+###### Override finder methods
 
-If you need to change the base records on which `find`, `find_by_key` and `find_by_keys` operate, you can override the `records` method on the resource class.
+Finally if you have more complex requirements for finding you can override the `find`, `find_by_key` and `find_by_keys` methods on the resource class.
 
-For example to allow a user to only retrieve his own posts you can do the following:
+Here's an example that defers the `find` operation to a `current_user` set on the `context` option:
 
 ```ruby
-class PostResource < JSONAPI::Resource
-  attribute :id, :title, :body
+class AuthorResource < JSONAPI::Resource
+  attributes :id, :name
+  model_name 'Person'
+  has_many :posts
 
-  def self.records(options = {})
+  filter :name
+
+  def self.find(filters, options = {})
     context = options[:context]
-    context.current_user.posts
+    authors = context.current_user.find_authors(filters)
+
+    return authors.map do |author|
+      self.new(author)
+    end
   end
 end
 ```

data/lib/jsonapi/formatter.rb

@@ -97,12 +97,7 @@ end
 class DefaultValueFormatter < JSONAPI::ValueFormatter
   class << self
     def format(raw_value, context)
-      case raw_value
-        when String, Integer
-          return raw_value
-        else
-          return raw_value.to_s
-      end
+      raw_value
     end
   end
 end

data/lib/jsonapi/request.rb

@@ -20,7 +20,7 @@ module JSONAPI
     end
 
     def setup(params)
-      @resource_klass ||= self.class.resource_for(params[:controller]) if params[:controller]
+      @resource_klass ||= self.class.resource_for(params[:controller].split('/').last) if params[:controller]
 
       unless params.nil?
         case params[:action]
@@ -76,10 +76,14 @@ module JSONAPI
       fields.each do |type, values|
         underscored_type = unformat_key(type)
         fields[type] = []
-        type_resource = self.class.resource_for(underscored_type)
-        if type_resource.nil? || !(@resource_klass._type == underscored_type ||
-                                   @resource_klass._has_association?(underscored_type))
+        begin
+          type_resource = self.class.resource_for(underscored_type)
+        rescue NameError
           @errors.concat(JSONAPI::Exceptions::InvalidResource.new(type).errors)
+        end
+          if type_resource.nil? || !(@resource_klass._type == underscored_type ||
+                                     @resource_klass._has_association?(underscored_type))
+            @errors.concat(JSONAPI::Exceptions::InvalidResource.new(type).errors)
         else
           unless values.nil?
             valid_fields = type_resource.fields.collect {|key| format_key(key)}

data/lib/jsonapi/resource.rb

@@ -217,29 +217,34 @@ module JSONAPI
         _associations.keys | _attributes.keys
       end
 
+      def apply_filter(records, filter, value)
+        records.where(filter => value)
+      end
+
       # Override this method if you have more complex requirements than this basic find method provides
       def find(filters, options = {})
         context = options[:context]
         sort_params = options.fetch(:sort_params) { [] }
         includes = []
-        where_filters = {}
+
+        records = records(options)
 
         filters.each do |filter, value|
           if _associations.include?(filter)
             if _associations[filter].is_a?(JSONAPI::Association::HasMany)
               includes.push(filter)
-              where_filters["#{filter}.#{_associations[filter].primary_key}"] = value
+              records = apply_filter(records, "#{filter}.#{_associations[filter].primary_key}", value)
             else
-              where_filters["#{_associations[filter].foreign_key}"] = value
+              records = apply_filter(records, "#{_associations[filter].foreign_key}", value)
             end
           else
-            where_filters[filter] = value
+            records = apply_filter(records, filter, value)
           end
         end
 
         resources = []
         order_options = construct_order_options(sort_params)
-        records(options).where(where_filters).order(order_options).includes(includes).each do |model|
+        records.order(order_options).includes(includes).each do |model|
           resources.push self.new(model, context)
         end
 
@@ -260,7 +265,7 @@ module JSONAPI
         _models = records(options).where({_primary_key => keys})
 
         unless _models.length == keys.length
-          key = (keys - _models.pluck(:id).map(&:to_s)).first
+          key = (keys - _models.pluck(_primary_key).map(&:to_s)).first
           raise JSONAPI::Exceptions::RecordNotFound.new(key)
         end
 

data/lib/jsonapi/resource_for.rb

@@ -11,15 +11,19 @@ module JSONAPI
           resource_name = JSONAPI::Resource._resource_name_from_type(type)
           Object.const_get resource_name if resource_name
         rescue NameError
-          nil
+          raise NameError, "JSONAPI: Could not find resource '#{type}'. (Class #{resource_name} not found)"
         end
       else
         def resource_for(type)
           resource_name = JSONAPI::Resource._resource_name_from_type(type)
-          resource_name.safe_constantize if resource_name
+          resource = resource_name.safe_constantize if resource_name
+          if resource.nil?
+            raise NameError, "JSONAPI: Could not find resource '#{type}'. (Class #{resource_name} not found)"
+          end
+          resource
         end
       end
       # :nocov:
     end
   end
-end
+end

data/lib/jsonapi/resources/version.rb

@@ -1,5 +1,5 @@
 module JSONAPI
   module Resources
-    VERSION = "0.0.13"
+    VERSION = "0.0.14"
   end
 end

data/test/controllers/controller_test.rb

@@ -1106,7 +1106,7 @@ class ExpenseEntriesControllerTest < ActionController::TestCase
     assert json_response['expense_entries'].is_a?(Hash)
     assert_equal 3, json_response['expense_entries']['links']['employee']
     assert_equal 'USD', json_response['expense_entries']['links']['iso_currency']
-    assert_equal '50.58', json_response['expense_entries']['cost']
+    assert_equal 50.58, json_response['expense_entries']['cost']
 
     delete :destroy, {id: json_response['expense_entries']['id']}
     assert_response :no_content
@@ -1133,7 +1133,7 @@ class ExpenseEntriesControllerTest < ActionController::TestCase
     assert json_response['expenseEntries'].is_a?(Hash)
     assert_equal 3, json_response['expenseEntries']['links']['employee']
     assert_equal 'USD', json_response['expenseEntries']['links']['isoCurrency']
-    assert_equal '50.58', json_response['expenseEntries']['cost']
+    assert_equal 50.58, json_response['expenseEntries']['cost']
 
     delete :destroy, {id: json_response['expenseEntries']['id']}
     assert_response :no_content
@@ -1160,7 +1160,7 @@ class ExpenseEntriesControllerTest < ActionController::TestCase
     assert json_response['expense-entries'].is_a?(Hash)
     assert_equal 3, json_response['expense-entries']['links']['employee']
     assert_equal 'USD', json_response['expense-entries']['links']['iso-currency']
-    assert_equal '50.58', json_response['expense-entries']['cost']
+    assert_equal 50.58, json_response['expense-entries']['cost']
 
     delete :destroy, {id: json_response['expense-entries']['id']}
     assert_response :no_content
@@ -1466,3 +1466,21 @@ class Api::V2::PreferencesControllerTest < ActionController::TestCase
     assert_response :success
   end
 end
+
+class FactsControllerTest < ActionController::TestCase
+  def test_type_formatting
+    get :show, {id: '1'}
+    assert_response :success
+    assert json_response['facts'].is_a?(Hash)
+    assert_equal 'Jane Author', json_response['facts']['spouseName']
+    assert_equal 'First man to run across Antartica.', json_response['facts']['bio']
+    assert_equal 23.89/45.6, json_response['facts']['qualityRating']
+    assert_equal 47000.56, json_response['facts']['salary']
+    assert_equal '2013-08-07T20:25:00.000Z', json_response['facts']['dateTimeJoined']
+    assert_equal '1965-06-30', json_response['facts']['birthday']
+    assert_equal '2000-01-01T20:00:00Z', json_response['facts']['bedtime']
+    assert_equal 'abc', json_response['facts']['photo']
+    assert_equal false, json_response['facts']['cool']
+  end
+end
+

data/test/fixtures/active_record.rb

@@ -92,6 +92,19 @@ ActiveRecord::Schema.define do
     t.integer :person_id
     t.boolean :advanced_mode, default: false
   end
+
+  create_table :facts, force: true do |t|
+    t.integer  :person_id
+    t.string   :spouse_name
+    t.text     :bio
+    t.float    :quality_rating
+    t.decimal  :salary, :precision => 12, :scale => 2
+    t.datetime :date_time_joined
+    t.date     :birthday
+    t.time     :bedtime
+    t.binary   :photo, limit: 1.kilobyte
+    t.boolean  :cool
+  end
 end
 
 ### MODELS
@@ -160,6 +173,9 @@ class Preferences < ActiveRecord::Base
   has_many :friends, class_name: 'Person'
 end
 
+class Fact < ActiveRecord::Base
+end
+
 class Breed
 
   def initialize(id = nil, name = nil)
@@ -236,6 +252,9 @@ end
 class BreedsController < JSONAPI::ResourceController
 end
 
+class FactsController < JSONAPI::ResourceController
+end
+
 ### CONTROLLERS
 module Api
   module V1
@@ -455,7 +474,7 @@ class BreedResource < JSONAPI::Resource
   # This is unneeded, just here for testing
   routing_options :param => :id
 
-  def self.find(attrs, options = {})
+  def self.find(filters, options = {})
     breeds = []
     $breed_data.breeds.values.each do |breed|
       breeds.push(BreedResource.new(breed, options[:context]))
@@ -509,11 +528,24 @@ class PreferencesResource < JSONAPI::Resource
   has_one :author, foreign_key: :person_id
   has_many :friends
 
-  def self.find_by_key(key, context: nil)
+  def self.find_by_key(key, options = {})
     new(Preferences.first)
   end
 end
 
+class FactResource < JSONAPI::Resource
+  attribute :id
+  attribute :spouse_name
+  attribute :bio
+  attribute :quality_rating
+  attribute :salary
+  attribute :date_time_joined
+  attribute :birthday
+  attribute :bedtime
+  attribute :photo
+  attribute :cool
+end
+
 warn 'start testing Name Collisions'
 # The name collisions only emmit warnings. Exceptions would change the flow of the tests
 
@@ -685,3 +717,14 @@ betaz = Planet.create(name: 'Beta X', description: 'Newly discovered Planet Z',
 betaw = Planet.create(name: 'Beta W', description: 'Newly discovered Planet W')
 
 preference = Preferences.create
+
+fact = Fact.create(spouse_name: 'Jane Author',
+                   bio: 'First man to run across Antartica.',
+                   quality_rating: 23.89/45.6,
+                   salary: BigDecimal('47000.56'),
+                   date_time_joined: DateTime.parse('2013-08-07 20:25:00 UTC +00:00'),
+                   birthday: Date.parse('1965-06-30'),
+                   bedtime: Time.parse('2000-01-01 20:00:00 UTC +00:00'),
+                   photo: "abc",
+                   cool: false
+)

data/test/test_helper.rb

@@ -31,6 +31,8 @@ class TestApp < Rails::Application
   config.session_store :cookie_store, key: 'session'
   config.secret_key_base = 'secret'
 
+  ActiveSupport::JSON::Encoding.encode_big_decimal_as_string = false
+
   #Raise errors on unsupported parameters
   config.action_controller.action_on_unpermitted_parameters = :raise
 end
@@ -53,6 +55,7 @@ TestApp.routes.draw do
   jsonapi_resources :planet_types
   jsonapi_resources :moons
   jsonapi_resources :preferences
+  jsonapi_resources :facts
 
   namespace :api do
     namespace :v1 do

data/test/unit/serializer/serializer_test.rb

@@ -505,7 +505,7 @@ class SerializerTest < MiniTest::Unit::TestCase
         expenseEntries: {
           id: 1,
           transactionDate: '04/15/2014',
-          cost: '12.05',
+          cost: 12.05,
           links: {
             isoCurrency: 'USD',
             employee: 3
@@ -602,4 +602,46 @@ class SerializerTest < MiniTest::Unit::TestCase
     assert_match /\"planetType\":null/, json
     assert_match /\"moons\":\[\]/, json
   end
+
+  def test_serializer_booleans
+    JSONAPI.configuration.json_key_format = :underscored_key
+
+    preferences = PreferencesResource.new(Preferences.find(1))
+
+    assert_hash_equals(
+      {
+        preferences: {
+                  id: 1,
+                  advanced_mode: false,
+                  links: {
+                    author: nil,
+                    friends: []
+                  }
+                }
+      },
+      JSONAPI::ResourceSerializer.new(PreferencesResource).serialize_to_hash(preferences))
+  end
+
+  def test_serializer_data_types
+    JSONAPI.configuration.json_key_format = :underscored_key
+
+    facts = FactResource.new(Fact.find(1))
+
+    assert_hash_equals(
+      {
+        facts: {
+          id: 1,
+          spouse_name: 'Jane Author',
+          bio: 'First man to run across Antartica.',
+          quality_rating: 23.89/45.6,
+          salary: BigDecimal('47000.56', 30),
+          date_time_joined: DateTime.parse('2013-08-07 20:25:00 UTC +00:00'),
+          birthday: Date.parse('1965-06-30'),
+          bedtime: Time.parse('2000-01-01 20:00:00 UTC +00:00'), #DB seems to set the date to 2001-01-01 for time types
+          photo: "abc",
+          cool: false
+        }
+      },
+      JSONAPI::ResourceSerializer.new(FactResource).serialize_to_hash(facts))
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jsonapi-resources
 version: !ruby/object:Gem::Version
-  version: 0.0.13
+  version: 0.0.14
 platform: ruby
 authors:
 - Dan Gebhardt
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-06 00:00:00.000000000 Z
+date: 2015-01-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler