jsonapi-resources 0.0.1

data/test/fixtures/active_record.rb

@@ -0,0 +1,585 @@
+require 'active_record'
+require 'jsonapi/resource_controller'
+require 'jsonapi/resource'
+require 'jsonapi/exceptions'
+require 'rails'
+require 'rails/all'
+
+### DATABASE
+ActiveRecord::Schema.define do
+  create_table :people, force: true do |t|
+    t.string     :name
+    t.string     :email
+    t.datetime   :date_joined
+    t.timestamps
+  end
+
+  create_table :posts, force: true do |t|
+    t.string     :title
+    t.text       :body
+    t.integer    :author_id
+    t.belongs_to :section, index: true
+    t.timestamps
+  end
+
+  create_table :comments, force: true do |t|
+    t.text       :body
+    t.belongs_to :post, index: true
+    t.integer    :author_id
+    t.timestamps
+  end
+
+  create_table :tags, force: true do |t|
+    t.string :name
+  end
+
+  create_table :sections, force: true do |t|
+    t.string :name
+  end
+
+  create_table :posts_tags, force: true do |t|
+    t.references :post, :tag, index: true
+  end
+
+  create_table :comments_tags, force: true do |t|
+    t.references :comment, :tag, index: true
+  end
+
+  create_table :currencies, id: false, force: true do |t|
+    t.string :code, limit: 3, null: false
+    t.string :name
+    t.timestamps
+  end
+  add_index :currencies, :code, unique: true
+
+  create_table :expense_entries, force: true do |t|
+    t.string :currency_code, limit: 3, null: false
+    t.integer :employee_id, null: false
+    t.decimal :cost, precision: 12, scale: 4, null: false
+    t.date :transaction_date
+  end
+
+  create_table :planets, force: true do |t|
+    t.string :name
+    t.string :description
+    t.integer :planet_type_id
+  end
+
+  create_table :planet_types, force: true do |t|
+    t.string :name
+  end
+
+  create_table :moons, force: true do |t|
+    t.string  :name
+    t.string  :description
+    t.integer :planet_id
+  end
+
+  create_table :preferences, force: true do |t|
+    t.integer :person_id
+    t.boolean :advanced_mode, default: false
+  end
+end
+
+### MODELS
+class Person < ActiveRecord::Base
+  has_many :posts, foreign_key: 'author_id'
+  has_many :comments, foreign_key: 'author_id'
+  has_many :expense_entries, foreign_key: 'employee_id', dependent: :restrict_with_exception
+
+  ### Validations
+  validates :name, presence: true
+  validates :date_joined, presence: true
+end
+
+class Post < ActiveRecord::Base
+  belongs_to :author, class_name: 'Person', foreign_key: 'author_id'
+  has_many :comments
+  has_and_belongs_to_many :tags, join_table: :posts_tags
+  belongs_to :section
+
+  validates :author, presence: true
+end
+
+class Comment < ActiveRecord::Base
+  belongs_to :author, class_name: 'Person', foreign_key: 'author_id'
+  belongs_to :post
+  has_and_belongs_to_many :tags, join_table: :comments_tags
+end
+
+class Tag < ActiveRecord::Base
+  has_and_belongs_to_many :posts, join_table: :posts_tags
+end
+
+class Section < ActiveRecord::Base
+end
+
+class Currency < ActiveRecord::Base
+  self.primary_key = :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'
+end
+
+class Planet < ActiveRecord::Base
+  has_many :moons
+  has_one :planet_type
+end
+
+class PlanetType < ActiveRecord::Base
+  has_many :planets
+end
+
+class Moon < ActiveRecord::Base
+  belongs_to :planet
+end
+
+class Breed
+
+  def initialize(id = nil, name = nil)
+    if id.nil?
+      @id = $breed_data.new_id
+      $breed_data.add(self)
+    else
+      @id = id
+    end
+    @name = name
+  end
+
+  attr_accessor :id, :name
+
+  def destroy
+    $breed_data.remove(@id)
+  end
+
+  def save!
+  end
+end
+
+class BreedData
+  def initialize
+    @breeds = {}
+  end
+
+  def breeds
+    @breeds
+  end
+
+  def new_id
+    @breeds.keys.max + 1
+  end
+
+  def add(breed)
+    @breeds[breed.id] = breed
+  end
+
+  def remove(id)
+    @breeds.delete(id)
+  end
+
+end
+
+### PORO Data - don't do this in a production app
+$breed_data = BreedData.new
+$breed_data.add(Breed.new(0, 'persian'))
+$breed_data.add(Breed.new(1, 'siamese'))
+$breed_data.add(Breed.new(2, 'sphinx'))
+$breed_data.add(Breed.new(3, 'to_delete'))
+
+### CONTROLLERS
+class AuthorsController < JSONAPI::ResourceController
+
+end
+
+class PeopleController < JSONAPI::ResourceController
+
+end
+
+class PostsController < JSONAPI::ResourceController
+end
+
+class TagsController < JSONAPI::ResourceController
+end
+
+class CurrenciesController < JSONAPI::ResourceController
+end
+
+class ExpenseEntriesController < JSONAPI::ResourceController
+end
+
+class BreedsController < JSONAPI::ResourceController
+end
+
+### CONTROLLERS
+module Api
+  module V1
+    class AuthorsController < JSONAPI::ResourceController
+    end
+
+    class PeopleController < JSONAPI::ResourceController
+    end
+
+    class PostsController < JSONAPI::ResourceController
+    end
+
+    class TagsController < JSONAPI::ResourceController
+    end
+
+    class CurrenciesController < JSONAPI::ResourceController
+    end
+
+    class ExpenseEntriesController < JSONAPI::ResourceController
+    end
+
+    class BreedsController < JSONAPI::ResourceController
+    end
+  end
+
+  module V2
+    class AuthorsController < JSONAPI::ResourceController
+    end
+
+    class PeopleController < JSONAPI::ResourceController
+    end
+
+    class PostsController < JSONAPI::ResourceController
+    end
+
+    class PreferencesController < JSONAPI::ResourceController
+    end
+  end
+
+  module V3
+    class PostsController < JSONAPI::ResourceController
+    end
+  end
+end
+
+### RESOURCES
+class PersonResource < JSONAPI::Resource
+  attributes :id, :name, :email, :date_joined
+  has_many :comments
+  has_many :posts
+
+  filter :name
+
+  def self.verify_custom_filter(filter, values, context = nil)
+    case filter
+      when :name
+        values.each do |value|
+          if value.length < 3
+            raise JSONAPI::Exceptions::InvalidFilterValue.new(filter, value)
+          end
+        end
+    end
+    return filter, values
+  end
+end
+
+class AuthorResource < JSONAPI::Resource
+  attributes :id, :name, :email
+  model_name 'Person'
+  has_many :posts
+
+  filter :name
+
+  def self.find(filters, context = nil)
+    resources = []
+
+    filters.each do |attr, filter|
+      _model_class.where("\"#{attr}\" LIKE \"%#{filter[0]}%\"").each do |object|
+        resources.push self.new(object)
+      end
+    end
+    return resources
+  end
+
+  def fetchable(keys, context = nil)
+    if (@object.id % 2) == 1
+      super(keys - [:email])
+    else
+      super(keys)
+    end
+  end
+end
+
+class CommentResource < JSONAPI::Resource
+  attributes :id, :body
+  has_one :post
+  has_one :author, class_name: 'Person'
+  has_many :tags
+end
+
+class TagResource < JSONAPI::Resource
+  attributes :id, :name
+
+  has_many :posts
+end
+
+class SectionResource < JSONAPI::Resource
+  attributes 'name'
+end
+
+class PostResource < JSONAPI::Resource
+  attribute :id
+  attribute :title
+  attribute :body
+  attribute :subject
+
+  has_one :author, class_name: 'Person'
+  has_one :section
+  has_many :tags, treat_as_set: true
+  has_many :comments, treat_as_set: false
+  def subject
+    @object.title
+  end
+
+  filters :title, :author, :tags, :comments
+  filter :id
+
+  def self.updateable(keys, context = nil)
+    super(keys - [:author, :subject])
+  end
+
+  def self.createable(keys, context = nil)
+    super(keys - [:subject])
+  end
+
+  def self.verify_custom_filter(filter, values, context = nil)
+    case filter
+      when :id
+        values.each do |key|
+          verify_key(key, context)
+        end
+    end
+    return filter, values
+  end
+
+  def self.is_num?(str)
+    begin
+      !!Integer(str)
+    rescue ArgumentError, TypeError
+      false
+    end
+  end
+
+  def self.verify_key(key, context = nil)
+    raise JSONAPI::Exceptions::InvalidFieldValue.new(:id, key) unless is_num?(key)
+    raise JSONAPI::Exceptions::RecordNotFound.new(key) unless find_by_key(key)
+    return key
+  end
+end
+
+class CurrencyResource < JSONAPI::Resource
+  key :code
+  attributes :code, :name
+
+  routing_options :param => :code
+
+  has_many :expense_entries
+end
+
+class ExpenseEntryResource < JSONAPI::Resource
+  attributes :id, :cost, :transaction_date
+
+  has_one :currency, class_name: 'Currency', key: 'currency_code'
+  has_one :employee
+end
+
+class BreedResource < JSONAPI::Resource
+  attributes :id, :name
+
+  def self.find(attrs, context = nil)
+    breeds = []
+    $breed_data.breeds.values.each do |breed|
+      breeds.push(BreedResource.new(breed))
+    end
+    breeds
+  end
+
+  def self.find_by_key(id, context = nil)
+    BreedResource.new($breed_data.breeds[id.to_i])
+  end
+end
+
+class PlanetResource < JSONAPI::Resource
+  attribute :id
+  attribute :name
+  attribute :description
+
+  has_many :moons
+  has_one :planet_type
+end
+
+class PlanetTypeResource < JSONAPI::Resource
+  attribute :name
+  has_many :planets
+end
+
+class MoonResource < JSONAPI::Resource
+  attribute :id
+  attribute :name
+  attribute :description
+
+  has_one :planet
+end
+
+class PreferencesResource < JSONAPI::Resource
+  attribute :id
+  attribute :advanced_mode
+
+  has_one :author, class_name: 'Person'
+  has_many :friends, class_name: 'Person'
+end
+
+### DATA
+javascript = Section.create(name: 'javascript')
+ruby = Section.create(name: 'ruby')
+
+a = Person.create(name: 'Joe Author',
+                 email: 'joe@xyz.fake',
+                 date_joined: DateTime.parse('2013-08-07 20:25:00 UTC +00:00'))
+
+b = Person.create(name: 'Fred Reader',
+                 email: 'fred@xyz.fake',
+                 date_joined: DateTime.parse('2013-10-31 20:25:00 UTC +00:00'))
+
+c = Person.create(name: 'Lazy Author',
+                  email: 'lazy@xyz.fake',
+                  date_joined: DateTime.parse('2013-10-31 21:25:00 UTC +00:00'))
+
+d = Person.create(name: 'Tag Crazy Author',
+                  email: 'taggy@xyz.fake',
+                  date_joined: DateTime.parse('2013-11-30 4:20:00 UTC +00:00'))
+
+short_tag = Tag.create(name: 'short')
+whiny_tag = Tag.create(name: 'whiny')
+grumpy_tag = Tag.create(name: 'grumpy')
+happy_tag = Tag.create(name: 'happy')
+jr_tag = Tag.create(name: 'JR')
+
+silly_tag = Tag.create(name: 'silly')
+sleepy_tag = Tag.create(name: 'sleepy')
+goofy_tag = Tag.create(name: 'goofy')
+wacky_tag = Tag.create(name: 'wacky')
+
+# id:1
+Post.create(title: 'New post',
+              body:  'A body!!!',
+              author_id: a.id).tap do |post|
+
+  post.tags.concat short_tag, whiny_tag, grumpy_tag
+
+  post.comments.create(body: 'what a dumb post', author_id: a.id, post_id: post.id).tap do |comment|
+    comment.tags.concat whiny_tag, short_tag
+  end
+
+  post.comments.create(body: 'i liked it', author_id: b.id, post_id: post.id).tap do |comment|
+    comment.tags.concat happy_tag, short_tag
+  end
+end
+
+# id:2
+Post.create(title: 'JR Solves your serialization woes!',
+              body:  'Use JR',
+              author_id: a.id,
+              section: Section.create(name: 'ruby')).tap do |post|
+
+  post.tags.concat jr_tag
+
+  post.comments.create(body: 'Thanks man. Great post. But what is JR?', author_id: b.id, post_id: post.id).tap do |comment|
+    comment.tags.concat jr_tag
+  end
+end
+
+# id:3
+Post.create(title: 'Update This Later',
+            body:  'AAAA',
+            author_id: c.id)
+
+# id:4
+Post.create(title: 'Delete This Later - Single',
+            body:  'AAAA',
+            author_id: c.id)
+
+# id:5
+Post.create(title: 'Delete This Later - Multiple1',
+            body:  'AAAA',
+            author_id: c.id)
+
+# id:6
+Post.create(title: 'Delete This Later - Multiple2',
+            body:  'AAAA',
+            author_id: c.id)
+
+# id:7
+Post.create(title: 'Delete This Later - Single2',
+            body:  'AAAA',
+            author_id: c.id)
+
+# id:8
+Post.create(title: 'Delete This Later - Multiple2-1',
+            body:  'AAAA',
+            author_id: c.id)
+
+# id:9
+Post.create(title: 'Delete This Later - Multiple2-2',
+            body:  'AAAA',
+            author_id: c.id)
+
+# id:9
+Post.create(title: 'Update This Later - Multiple',
+            body:  'AAAA',
+            author_id: c.id)
+
+# id:10
+Post.create(title: 'JR How To',
+            body:  'Use JR to write API apps',
+            author_id: a.id).tap do |post|
+  post.tags.concat jr_tag
+end
+
+Currency.create(code: 'USD', name: 'United States Dollar')
+Currency.create(code: 'EUR', name: 'Euro Member Countries')
+
+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'))
+
+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'))
+
+Post.create(title: 'Tagged up post 1',
+            body:  'AAAA',
+            author_id: d.id,
+            tag_ids: [6,7,8,9]
+            )
+
+Post.create(title: 'Tagged up post 2',
+            body:  'BBBB',
+            author_id: d.id,
+            tag_ids: [6,7,8,9]
+)
+
+gas_giant = PlanetType.create(name: 'Gas Giant')
+planetoid = PlanetType.create(name: 'Planetoid')
+terrestrial = PlanetType.create(name: 'Terrestrial')
+sulfuric = PlanetType.create(name: 'Sulfuric')
+unknown = PlanetType.create(name: 'unknown')
+
+saturn = Planet.create(name: 'Satern',
+                       description: 'Saturn is the sixth planet from the Sun and the second largest planet in the Solar System, after Jupiter.',
+                       planet_type_id: planetoid.id)
+titan = Moon.create(name:'Titan', description: 'Best known of the Saturn moons.', planet_id: saturn.id)
+pluto = Planet.create(name: 'Pluto', description: 'Pluto is the smallest planet.', planet_type_id: planetoid.id)
+uranus = Planet.create(name: 'Uranus', description: 'Insert adolescent jokes here.', planet_type_id: gas_giant.id)
+jupiter = Planet.create(name: 'Jupiter', description: 'A gas giant.', planet_type_id: gas_giant.id)
+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)