jsonapi-resources 0.0.4 → 0.0.5

data/test/fixtures/active_record.rb

@@ -40,17 +40,20 @@ ActiveRecord::Schema.define do
   create_table :posts_tags, force: true do |t|
     t.references :post, :tag, index: true
   end
+  add_index :posts_tags, [:post_id, :tag_id], unique: true
 
   create_table :comments_tags, force: true do |t|
     t.references :comment, :tag, index: true
   end
 
-  create_table :currencies, id: false, force: true do |t|
+  create_table :iso_currencies, id: false, force: true do |t|
     t.string :code, limit: 3, null: false
     t.string :name
+    t.string :country_name
+    t.string :minor_unit
     t.timestamps
   end
-  add_index :currencies, :code, unique: true
+  add_index :iso_currencies, :code, unique: true
 
   create_table :expense_entries, force: true do |t|
     t.string :currency_code, limit: 3, null: false
@@ -65,6 +68,11 @@ ActiveRecord::Schema.define do
     t.integer :planet_type_id
   end
 
+  create_table :planets_tags, force: true do |t|
+    t.references :planet, :tag, index: true
+  end
+  add_index :planets_tags, [:planet_id, :tag_id], unique: true
+
   create_table :planet_types, force: true do |t|
     t.string :name
   end
@@ -109,24 +117,27 @@ end
 
 class Tag < ActiveRecord::Base
   has_and_belongs_to_many :posts, join_table: :posts_tags
+  has_and_belongs_to_many :planets, join_table: :planets_tags
 end
 
 class Section < ActiveRecord::Base
 end
 
-class Currency < ActiveRecord::Base
+class IsoCurrency < ActiveRecord::Base
   self.primary_key = :code
-  has_many :expense_entries, foreign_key: 'currency_code'
+  # has_many :expense_entries, foreign_key: 'currency_code'
 end
 
 class ExpenseEntry < ActiveRecord::Base
   belongs_to :employee, class_name: 'Person', foreign_key: 'employee_id'
-  belongs_to :currency, class_name: 'Currency', foreign_key: 'currency_code'
+  belongs_to :iso_currency, foreign_key: 'currency_code'
 end
 
 class Planet < ActiveRecord::Base
   has_many :moons
   has_one :planet_type
+
+  has_and_belongs_to_many :tags, join_table: :planets_tags
 end
 
 class PlanetType < ActiveRecord::Base
@@ -204,7 +215,7 @@ end
 class TagsController < JSONAPI::ResourceController
 end
 
-class CurrenciesController < JSONAPI::ResourceController
+class IsoCurrenciesController < JSONAPI::ResourceController
 end
 
 class ExpenseEntriesController < JSONAPI::ResourceController
@@ -228,7 +239,7 @@ module Api
     class TagsController < JSONAPI::ResourceController
     end
 
-    class CurrenciesController < JSONAPI::ResourceController
+    class IsoCurrenciesController < JSONAPI::ResourceController
     end
 
     class ExpenseEntriesController < JSONAPI::ResourceController
@@ -236,6 +247,15 @@ module Api
 
     class BreedsController < JSONAPI::ResourceController
     end
+
+    class PlanetsController < JSONAPI::ResourceController
+    end
+
+    class PlanetTypesController < JSONAPI::ResourceController
+    end
+
+    class MoonsController < JSONAPI::ResourceController
+    end
   end
 
   module V2
@@ -260,7 +280,9 @@ end
 
 ### RESOURCES
 class PersonResource < JSONAPI::Resource
-  attributes :id, :name, :email, :date_joined
+  attributes :id, :name, :email
+  attribute :date_joined, format: :date_with_timezone
+
   has_many :comments
   has_many :posts
 
@@ -317,6 +339,8 @@ class TagResource < JSONAPI::Resource
   attributes :id, :name
 
   has_many :posts
+  # Not including the planets association so they don't get output
+  #has_many :planets
 end
 
 class SectionResource < JSONAPI::Resource
@@ -340,12 +364,12 @@ class PostResource < JSONAPI::Resource
   filters :title, :author, :tags, :comments
   filter :id
 
-  def self.updateable(keys, context = nil)
-    super(keys - [:author, :subject])
+  def self.updateable_fields(context)
+    super(context) - [:author, :subject]
   end
 
-  def self.createable(keys, context = nil)
-    super(keys - [:subject])
+  def self.createable_fields(context)
+    super(context) - [:subject]
   end
 
   def self.verify_custom_filter(filter, values, context = nil)
@@ -373,24 +397,24 @@ class PostResource < JSONAPI::Resource
   end
 end
 
-class CurrencyResource < JSONAPI::Resource
+class IsoCurrencyResource < JSONAPI::Resource
   key :code
-  attributes :code, :name
+  attributes :code, :name, :country_name, :minor_unit
 
   routing_options :param => :code
-
-  has_many :expense_entries
 end
 
 class ExpenseEntryResource < JSONAPI::Resource
-  attributes :id, :cost, :transaction_date
+  attributes :id, :cost
+  attribute :transaction_date, format: :date
 
-  has_one :currency, class_name: 'Currency', key: 'currency_code'
-  has_one :employee
+  has_one :iso_currency, key: 'currency_code', primary_key: 'code'
+  has_one :employee, class_name: 'Person'
 end
 
 class BreedResource < JSONAPI::Resource
-  attributes :id, :name
+  attribute :id, format_misspelled: :does_not_exist
+  attribute :name, format: :title
 
   def self.find(attrs, context = nil)
     breeds = []
@@ -412,6 +436,14 @@ class PlanetResource < JSONAPI::Resource
 
   has_many :moons
   has_one :planet_type
+
+  has_many :tags, acts_as_set: true
+end
+
+class PropertyResource < JSONAPI::Resource
+  attributes :id, :name
+
+  has_many :planets
 end
 
 class PlanetTypeResource < JSONAPI::Resource
@@ -542,25 +574,27 @@ Post.create(title: 'JR How To',
   post.tags.concat jr_tag
 end
 
-Currency.create(code: 'USD', name: 'United States Dollar')
-Currency.create(code: 'EUR', name: 'Euro Member Countries')
+IsoCurrency.create(code: 'USD', name: 'United States Dollar', country_name: 'United States', minor_unit: 'cent')
+IsoCurrency.create(code: 'EUR', name: 'Euro Member Countries', country_name: 'Euro Member Countries', minor_unit: 'cent')
 
 ExpenseEntry.create(currency_code: 'USD',
                employee_id: c.id,
                cost: '12.05',
-               transaction_date: DateTime.parse('2014-04-15 12:13:14 UTC +00:00'))
+               transaction_date: Date.parse('2014-04-15'))
 
 ExpenseEntry.create(currency_code: 'USD',
                employee_id: c.id,
                cost: '12.06',
-               transaction_date: DateTime.parse('2014-04-15 12:13:15 UTC +00:00'))
+               transaction_date: Date.parse('2014-04-15'))
 
+# id:11
 Post.create(title: 'Tagged up post 1',
             body:  'AAAA',
             author_id: d.id,
             tag_ids: [6,7,8,9]
             )
 
+# id:12
 Post.create(title: 'Tagged up post 2',
             body:  'BBBB',
             author_id: d.id,
@@ -583,3 +617,5 @@ jupiter = Planet.create(name: 'Jupiter', description: 'A gas giant.', planet_typ
 betax = Planet.create(name: 'Beta X', description: 'Newly discovered Planet X', planet_type_id: unknown.id)
 betay = Planet.create(name: 'Beta X', description: 'Newly discovered Planet Y', planet_type_id: unknown.id)
 betaz = Planet.create(name: 'Beta X', description: 'Newly discovered Planet Z', planet_type_id: unknown.id)
+betaw = Planet.create(name: 'Beta W', description: 'Newly discovered Planet W')
+

data/test/integration/requests/request_test.rb

@@ -9,23 +9,19 @@ class RequestTest < ActionDispatch::IntegrationTest
   end
 
   def test_put_single
-    put '/posts/3', {"posts" => {"id" => "3", "title" => "A great new Post", "links" => { "tags" => [3,4] }}}
+    put '/posts/3',
+        {
+          'posts' => {
+            'id' => '3',
+            'title' => 'A great new Post',
+            'links' => {
+              'tags' => [3, 4]
+            }
+          }
+        }
     assert_equal 200, status
   end
 
-  # def test_put_links
-  #   put '/posts/3/links/tags', {"tags" => [1,4] }
-  #   assert_equal 200, status
-  # end
-
-  # def test_patch_create
-  #   patch '/posts',
-  #       {"op" => "add",
-  #       "path" => "/-",
-  #       "value" => {"title" => "Another great new Post", "body" => "saasd", "links" => { "author" => 3 }}}
-  #   assert_equal 200, status
-  # end
-
   def test_destroy_single
     delete '/posts/7'
     assert_equal 204, status
@@ -36,4 +32,3 @@ class RequestTest < ActionDispatch::IntegrationTest
     assert_equal 204, status
   end
 end
-

data/test/integration/routes/routes_test.rb

@@ -3,83 +3,131 @@ require File.expand_path('../../../test_helper', __FILE__)
 class RoutesTest < ActionDispatch::IntegrationTest
 
   def test_routing_post
-    assert_routing({ path: 'posts', method: :post }, { controller: 'posts', action: 'create' })
+    assert_routing({path: 'posts', method: :post},
+                   {controller: 'posts', action: 'create'})
   end
 
   def test_routing_put
-    assert_routing({ path: '/posts/1', method: :put }, { controller: 'posts', action: 'update', id: '1' })
+    assert_routing({path: '/posts/1', method: :put},
+                   {controller: 'posts', action: 'update', id: '1'})
   end
 
   def test_routing_posts_show
-    assert_routing({ path: '/posts/1', method: :get }, {action: 'show', controller: 'posts', id: '1'})
+    assert_routing({path: '/posts/1', method: :get},
+                   {action: 'show', controller: 'posts', id: '1'})
   end
 
   def test_routing_posts_links_author_show
-    assert_routing({ path: '/posts/1/links/author', method: :get }, { controller: 'posts', action: 'show_association', post_id: '1', association: 'author' })
+    assert_routing({path: '/posts/1/links/author', method: :get},
+                   {controller: 'posts', action: 'show_association', post_id: '1', association: 'author'})
   end
 
   def test_routing_posts_links_author_destroy
-    assert_routing({ path: '/posts/1/links/author', method: :delete }, { controller: 'posts', action: 'destroy_association', post_id: '1', association: 'author' })
+    assert_routing({path: '/posts/1/links/author', method: :delete},
+                   {controller: 'posts', action: 'destroy_association', post_id: '1', association: 'author'})
   end
 
   def test_routing_posts_links_author_create
-    assert_routing({ path: '/posts/1/links/author', method: :post }, { controller: 'posts', action: 'create_association', post_id: '1', association: 'author' })
+    assert_routing({path: '/posts/1/links/author', method: :post},
+                   {controller: 'posts', action: 'create_association', post_id: '1', association: 'author'})
+  end
+
+  def test_routing_posts_links_author_update
+    assert_routing({path: '/posts/1/links/author', method: :put},
+                   {controller: 'posts', action: 'update_association', post_id: '1', association: 'author'})
   end
 
   def test_routing_posts_links_tags_show
-    assert_routing({ path: '/posts/1/links/tags', method: :get }, { controller: 'posts', action: 'show_association', post_id: '1', association: 'tags' })
+    assert_routing({path: '/posts/1/links/tags', method: :get},
+                   {controller: 'posts', action: 'show_association', post_id: '1', association: 'tags'})
   end
 
   def test_routing_posts_links_tags_destroy
-    assert_routing({ path: '/posts/1/links/tags/1,2', method: :delete }, { controller: 'posts', action: 'destroy_association', post_id: '1', keys: '1,2', association: 'tags' })
+    assert_routing({path: '/posts/1/links/tags/1,2', method: :delete},
+                   {controller: 'posts', action: 'destroy_association', post_id: '1', keys: '1,2', association: 'tags'})
+  end
+
+  def test_routing_posts_links_tags_create
+    assert_routing({path: '/posts/1/links/tags', method: :post},
+                   {controller: 'posts', action: 'create_association', post_id: '1', association: 'tags'})
+  end
+
+  def test_routing_posts_links_tags_update_acts_as_set
+    assert_routing({path: '/posts/1/links/tags', method: :put},
+                   {controller: 'posts', action: 'update_association', post_id: '1', association: 'tags'})
   end
 
-  def test_routing_posts_links_tags_update
-    assert_routing({ path: '/posts/1/links/tags', method: :post }, { controller: 'posts', action: 'create_association', post_id: '1', association: 'tags' })
+  def test_routing_authors_show
+    assert_routing({path: '/authors/1', method: :get},
+                   {action: 'show', controller: 'authors', id: '1'})
   end
 
+  def test_routing_author_links_posts_create_not_acts_as_set
+    assert_routing({path: '/authors/1/links/posts', method: :post},
+                   {controller: 'authors', action: 'create_association', author_id: '1', association: 'posts'})
+  end
+
+  # ToDo: Test that non acts as set has_many association update route is not created
+  # def test_routing_author_links_posts_update_not_acts_as_set
+  #   refute_routing({ path: '/authors/1/links/posts', method: :put },
+  #                  { controller: 'authors', action: 'update_association', author_id: '1', association: 'posts' })
+  # end
+
   # V1
   def test_routing_v1_posts_show
-    assert_routing({ path: '/api/v1/posts/1', method: :get }, {action: 'show', controller: 'api/v1/posts', id: '1'})
+    assert_routing({path: '/api/v1/posts/1', method: :get},
+                   {action: 'show', controller: 'api/v1/posts', id: '1'})
   end
 
   def test_routing_v1_posts_delete
-    assert_routing({ path: '/api/v1/posts/1', method: :delete }, {action: 'destroy', controller: 'api/v1/posts', id: '1'})
+    assert_routing({path: '/api/v1/posts/1', method: :delete},
+                   {action: 'destroy', controller: 'api/v1/posts', id: '1'})
   end
 
   def test_routing_v1_posts_links_author_show
-    assert_routing({ path: '/api/v1/posts/1/links/author', method: :get }, { controller: 'api/v1/posts', action: 'show_association', post_id: '1', association: 'author' })
+    assert_routing({path: '/api/v1/posts/1/links/author', method: :get},
+                   {controller: 'api/v1/posts', action: 'show_association', post_id: '1', association: 'author'})
   end
 
   # V2
   def test_routing_v2_posts_show
-    assert_routing({ path: '/api/v2/authors/1', method: :get }, {action: 'show', controller: 'api/v2/authors', id: '1'})
+    assert_routing({path: '/api/v2/authors/1', method: :get},
+                   {action: 'show', controller: 'api/v2/authors', id: '1'})
   end
 
   def test_routing_v2_posts_links_author_show
-    assert_routing({ path: '/api/v2/posts/1/links/author', method: :get }, { controller: 'api/v2/posts', action: 'show_association', post_id: '1', association: 'author' })
+    assert_routing({path: '/api/v2/posts/1/links/author', method: :get},
+                   {controller: 'api/v2/posts', action: 'show_association', post_id: '1', association: 'author'})
   end
 
   def test_routing_v2_preferences_show
-    assert_routing({ path: '/api/v2/preferences', method: :get }, {action: 'show', controller: 'api/v2/preferences'})
+    assert_routing({path: '/api/v2/preferences', method: :get},
+                   {action: 'show', controller: 'api/v2/preferences'})
   end
 
   # V3
   def test_routing_v3_posts_show
-    assert_routing({ path: '/api/v3/posts/1', method: :get }, {action: 'show', controller: 'api/v3/posts', id: '1'})
+    assert_routing({path: '/api/v3/posts/1', method: :get},
+                   {action: 'show', controller: 'api/v3/posts', id: '1'})
   end
 
   # ToDo: Refute routing
   # def test_routing_v3_posts_delete
-  #   assert_routing({ path: '/api/v3/posts/1', method: :delete }, {action: 'destroy', controller: 'api/v3/posts', id: '1'})
+  #   assert_routing({ path: '/api/v3/posts/1', method: :delete },
+  #                  {action: 'destroy', controller: 'api/v3/posts', id: '1'})
   # end
 
   # def test_routing_posts_links_author_except_destroy
-  #   assert_routing({ path: '/api/v3/posts/1/links/author', method: :delete }, { controller: 'api/v3/posts', action: 'destroy_association', post_id: '1', association: 'author' })
+  #   assert_routing({ path: '/api/v3/posts/1/links/author', method: :delete },
+  #                  { controller: 'api/v3/posts', action: 'destroy_association', post_id: '1', association: 'author' })
   # end
   #
   # def test_routing_posts_links_tags_only_create_show
-  #   assert_routing({ path: '/api/v3/posts/1/links/tags/1,2', method: :delete }, { controller: 'api/v3/posts', action: 'destroy_association', post_id: '1', keys: '1,2', association: 'tags' })
+  #   assert_routing({ path: '/api/v3/posts/1/links/tags/1,2', method: :delete },
+  #                  { controller: 'api/v3/posts', action: 'destroy_association', post_id: '1', keys: '1,2', association: 'tags' })
   # end
+
+  # Test that non acts as set has_many association update route is not created
+
 end
 

data/test/test_helper.rb

@@ -12,6 +12,8 @@ require 'minitest/spec'
 require 'rails/all'
 
 require 'jsonapi/routing_ext'
+require 'jsonapi/configuration'
+require 'jsonapi/formatter'
 
 require File.expand_path('../helpers/value_matchers', __FILE__)
 require File.expand_path('../helpers/hash_helpers', __FILE__)
@@ -19,6 +21,10 @@ require File.expand_path('../helpers/functional_helpers', __FILE__)
 
 Rails.env = 'test'
 
+JSONAPI.configure do |config|
+  config.json_key_format = :camelized_key
+end
+
 class TestApp < Rails::Application
   config.eager_load = false
   config.root = File.dirname(__FILE__)
@@ -40,7 +46,7 @@ TestApp.routes.draw do
   jsonapi_resources :tags
   jsonapi_resources :posts
   jsonapi_resources :sections
-  jsonapi_resources :currencies
+  jsonapi_resources :iso_currencies
   jsonapi_resources :expense_entries
   jsonapi_resources :breeds
   jsonapi_resources :planets
@@ -57,7 +63,7 @@ TestApp.routes.draw do
       jsonapi_resources :tags
       jsonapi_resources :posts
       jsonapi_resources :sections
-      jsonapi_resources :currencies
+      jsonapi_resources :iso_currencies
       jsonapi_resources :expense_entries
       jsonapi_resources :breeds
       jsonapi_resources :planets
@@ -74,7 +80,7 @@ TestApp.routes.draw do
 
     namespace :v3 do
       jsonapi_resource :preferences do
-      #   Intentionally empty block to skip association urls
+        # Intentionally empty block to skip association urls
       end
 
       jsonapi_resources :posts, except: [:destroy] do
@@ -96,3 +102,39 @@ class ActiveSupport::TestCase
     @routes = TestApp.routes
   end
 end
+
+class UpperCamelizedKeyFormatter < JSONAPI::KeyFormatter
+  class << self
+    def format(key)
+      super.camelize(:upper)
+    end
+  end
+end
+
+class DateWithTimezoneValueFormatter < JSONAPI::ValueFormatter
+  class << self
+    def format(raw_value, source, context)
+      raw_value.in_time_zone('Eastern Time (US & Canada)').to_s
+    end
+  end
+end
+
+class DateValueFormatter < JSONAPI::ValueFormatter
+  class << self
+    def format(raw_value, source, context)
+      raw_value.strftime('%m/%d/%Y')
+    end
+  end
+end
+
+class TitleValueFormatter < JSONAPI::ValueFormatter
+  class << self
+    def format(raw_value, source, context)
+      super(raw_value, source, context).titlecase
+    end
+
+    def unformat(value, resource_klass, context)
+      value.to_s.downcase
+    end
+  end
+end

data/test/unit/operation/operations_processor_test.rb

@@ -7,6 +7,10 @@ require 'jsonapi/operations_processor'
 
 class OperationsProcessorTest < MiniTest::Unit::TestCase
   def setup
+    betax = Planet.find(5)
+    betay = Planet.find(6)
+    betaz = Planet.find(7)
+    unknown = PlanetType.find(5)
   end
 
   def test_create_single_resource
@@ -51,7 +55,7 @@ class OperationsProcessorTest < MiniTest::Unit::TestCase
     assert_equal(Planet.count, count + 3)
   end
 
-  def test_add_has_one_association
+  def test_replace_has_one_association
     op = JSONAPI::OperationsProcessor.new()
 
     saturn = Planet.find(1)
@@ -71,11 +75,13 @@ class OperationsProcessorTest < MiniTest::Unit::TestCase
 
     assert_kind_of(Array, results)
     assert_kind_of(JSONAPI::OperationResult, results[0])
-    assert_equal(:created, results[0].code)
-    assert_equal(results[0].resource.object.attributes['planet_type_id'], gas_giant.id)
+    assert_equal(:no_content, results[0].code)
+
+    saturn.reload
+    assert_equal(saturn.planet_type_id, gas_giant.id)
   end
 
-  def test_add_has_many_association
+  def test_create_has_many_association
     op = JSONAPI::OperationsProcessor.new()
 
     betax = Planet.find(5)
@@ -83,9 +89,12 @@ class OperationsProcessorTest < MiniTest::Unit::TestCase
     betaz = Planet.find(7)
     gas_giant = PlanetType.find(1)
     unknown = PlanetType.find(5)
-    assert_equal(betax.planet_type_id, unknown.id)
-    assert_equal(betay.planet_type_id, unknown.id)
-    assert_equal(betaz.planet_type_id, unknown.id)
+    betax.planet_type_id = unknown.id
+    betay.planet_type_id = unknown.id
+    betaz.planet_type_id = unknown.id
+    betax.save!
+    betay.save!
+    betaz.save!
 
     operations = [
       JSONAPI::CreateHasManyAssociationOperation.new(PlanetTypeResource, gas_giant.id, :planets, [betax.id, betay.id, betaz.id])
@@ -105,6 +114,39 @@ class OperationsProcessorTest < MiniTest::Unit::TestCase
     assert_equal(betaz.planet_type_id, gas_giant.id)
   end
 
+  def test_replace_has_many_association
+    op = JSONAPI::OperationsProcessor.new()
+
+    betax = Planet.find(5)
+    betay = Planet.find(6)
+    betaz = Planet.find(7)
+    gas_giant = PlanetType.find(1)
+    unknown = PlanetType.find(5)
+    betax.planet_type_id = unknown.id
+    betay.planet_type_id = unknown.id
+    betaz.planet_type_id = unknown.id
+    betax.save!
+    betay.save!
+    betaz.save!
+
+    operations = [
+      JSONAPI::ReplaceHasManyAssociationOperation.new(PlanetTypeResource, gas_giant.id, :planets, [betax.id, betay.id, betaz.id])
+    ]
+
+    request = JSONAPI::Request.new
+    request.operations = operations
+
+    results = op.process(request)
+
+    betax.reload
+    betay.reload
+    betaz.reload
+
+    assert_equal(betax.planet_type_id, gas_giant.id)
+    assert_equal(betay.planet_type_id, gas_giant.id)
+    assert_equal(betaz.planet_type_id, gas_giant.id)
+  end
+
   def test_replace_attributes
     op = JSONAPI::OperationsProcessor.new()
 

data/test/unit/resource/resource_test.rb

@@ -33,8 +33,8 @@ class ResourceTest < MiniTest::Unit::TestCase
 
   def test_class_attributes
     attrs = CatResource._attributes
-    assert_kind_of(Set, attrs)
-    assert_equal(attrs.size, 3)
+    assert_kind_of(Hash, attrs)
+    assert_equal(attrs.keys.size, 3)
   end
 
   def test_class_assosications