initial commit

Author: Lee Richmond

.gitignore

@@ -0,0 +1,22 @@
+# See https://help.github.com/articles/ignoring-files for more about ignoring files.
+#
+# If you find yourself ignoring temporary files generated by your text editor
+# or operating system, you probably want to add a global ignore instead:
+#   git config --global core.excludesfile '~/.gitignore_global'
+
+# Ignore bundler config.
+/.bundle
+
+# Ignore the default SQLite database.
+/db/*.sqlite3
+/db/*.sqlite3-journal
+spec/examples.txt
+
+# Ignore all logfiles and tempfiles.
+/log/*
+/tmp/*
+!/log/.keep
+!/tmp/.keep
+
+# Ignore Byebug command history file.
+.byebug_history

.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

Gemfile

@@ -0,0 +1,29 @@
+source 'https://rubygems.org'
+
+gem 'rails', '~> 5.0.0', '>= 5.0.0.1'
+gem 'sqlite3'
+gem 'puma', '~> 3.0'
+gem 'jsonapi_suite', '~> 0.1'
+gem 'kaminari', '~> 0.17'
+gem 'active_model_serializers',
+  git: 'https://github.com/richmolj/active_model_serializers.git',
+  branch: 'include_data_if_sideloaded'
+
+group :development, :test do
+  gem 'pry'
+  gem 'pry-byebug', platform: :mri
+  gem 'rspec-rails', '~> 3.5'
+end
+
+group :test do
+  gem 'database_cleaner', '~> 1.5'
+end
+
+group :development do
+  gem 'listen', '~> 3.0.5'
+  gem 'spring'
+  gem 'spring-watcher-listen', '~> 2.0.0'
+end
+
+# Windows does not include zoneinfo files, so bundle the tzinfo-data gem
+gem 'tzinfo-data', platforms: [:mingw, :mswin, :x64_mingw, :jruby]

Gemfile.lock

@@ -0,0 +1,214 @@
+GIT
+  remote: https://github.com/richmolj/active_model_serializers.git
+  revision: 8700ac6124b8685b979b4a03570f71d498a18d36
+  branch: include_data_if_sideloaded
+  specs:
+    active_model_serializers (0.10.2)
+      actionpack (>= 4.1, < 6)
+      activemodel (>= 4.1, < 6)
+      jsonapi (~> 0.1.1.beta2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (5.0.0.1)
+      actionpack (= 5.0.0.1)
+      nio4r (~> 1.2)
+      websocket-driver (~> 0.6.1)
+    actionmailer (5.0.0.1)
+      actionpack (= 5.0.0.1)
+      actionview (= 5.0.0.1)
+      activejob (= 5.0.0.1)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (5.0.0.1)
+      actionview (= 5.0.0.1)
+      activesupport (= 5.0.0.1)
+      rack (~> 2.0)
+      rack-test (~> 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (5.0.0.1)
+      activesupport (= 5.0.0.1)
+      builder (~> 3.1)
+      erubis (~> 2.7.0)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    activejob (5.0.0.1)
+      activesupport (= 5.0.0.1)
+      globalid (>= 0.3.6)
+    activemodel (5.0.0.1)
+      activesupport (= 5.0.0.1)
+    activerecord (5.0.0.1)
+      activemodel (= 5.0.0.1)
+      activesupport (= 5.0.0.1)
+      arel (~> 7.0)
+    activesupport (5.0.0.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (~> 0.7)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    arel (7.1.2)
+    builder (3.2.2)
+    byebug (9.0.5)
+    coderay (1.1.1)
+    concurrent-ruby (1.0.2)
+    database_cleaner (1.5.3)
+    diff-lcs (1.2.5)
+    erubis (2.7.0)
+    ffi (1.9.14)
+    globalid (0.3.7)
+      activesupport (>= 4.1.0)
+    i18n (0.7.0)
+    json (1.8.3)
+    jsonapi (0.1.1.beta2)
+      json (~> 1.8)
+    jsonapi_ams_extensions (0.1.1)
+      active_model_serializers (~> 0.10.x)
+    jsonapi_compliable (0.3.4)
+      active_model_serializers (~> 0.10)
+      jsonapi (~> 0.1.1.beta2)
+      jsonapi_ams_extensions (~> 0.1)
+      rails (>= 4.1, < 6)
+    jsonapi_errorable (0.1.1)
+      active_model_serializers (~> 0.10)
+      rails (>= 4.1, < 6)
+    jsonapi_spec_helpers (0.2.1)
+    jsonapi_suite (0.1.2)
+      active_model_serializers (~> 0.10.x)
+      jsonapi_ams_extensions (~> 0.1)
+      jsonapi_compliable (~> 0.3)
+      jsonapi_errorable (~> 0.1)
+      jsonapi_spec_helpers (~> 0.2)
+      jsonapi_swagger_helpers (~> 0.1)
+      nested_attribute_reassignable (~> 0.6)
+      rails (>= 4.1, < 6)
+      strong_resources (~> 0.1)
+    jsonapi_swagger_helpers (0.1.2)
+      swagger-blocks (~> 1.3)
+    kaminari (0.17.0)
+      actionpack (>= 3.0.0)
+      activesupport (>= 3.0.0)
+    listen (3.0.8)
+      rb-fsevent (~> 0.9, >= 0.9.4)
+      rb-inotify (~> 0.9, >= 0.9.7)
+    loofah (2.0.3)
+      nokogiri (>= 1.5.9)
+    mail (2.6.4)
+      mime-types (>= 1.16, < 4)
+    method_source (0.8.2)
+    mime-types (3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2016.0521)
+    mini_portile2 (2.1.0)
+    minitest (5.9.0)
+    nested_attribute_reassignable (0.6.5)
+      activerecord (>= 4.1, < 6)
+    nio4r (1.2.1)
+    nokogiri (1.6.8)
+      mini_portile2 (~> 2.1.0)
+      pkg-config (~> 1.1.7)
+    pkg-config (1.1.7)
+    pry (0.10.4)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    pry-byebug (3.4.0)
+      byebug (~> 9.0)
+      pry (~> 0.10)
+    puma (3.6.0)
+    rack (2.0.1)
+    rack-test (0.6.3)
+      rack (>= 1.0)
+    rails (5.0.0.1)
+      actioncable (= 5.0.0.1)
+      actionmailer (= 5.0.0.1)
+      actionpack (= 5.0.0.1)
+      actionview (= 5.0.0.1)
+      activejob (= 5.0.0.1)
+      activemodel (= 5.0.0.1)
+      activerecord (= 5.0.0.1)
+      activesupport (= 5.0.0.1)
+      bundler (>= 1.3.0, < 2.0)
+      railties (= 5.0.0.1)
+      sprockets-rails (>= 2.0.0)
+    rails-dom-testing (2.0.1)
+      activesupport (>= 4.2.0, < 6.0)
+      nokogiri (~> 1.6.0)
+    rails-html-sanitizer (1.0.3)
+      loofah (~> 2.0)
+    railties (5.0.0.1)
+      actionpack (= 5.0.0.1)
+      activesupport (= 5.0.0.1)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (11.3.0)
+    rb-fsevent (0.9.7)
+    rb-inotify (0.9.7)
+      ffi (>= 0.5.0)
+    rspec-core (3.5.3)
+      rspec-support (~> 3.5.0)
+    rspec-expectations (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-mocks (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-rails (3.5.1)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      railties (>= 3.0)
+      rspec-core (~> 3.5.0)
+      rspec-expectations (~> 3.5.0)
+      rspec-mocks (~> 3.5.0)
+      rspec-support (~> 3.5.0)
+    rspec-support (3.5.0)
+    slop (3.6.0)
+    spring (1.7.2)
+    spring-watcher-listen (2.0.0)
+      listen (>= 2.7, < 4.0)
+      spring (~> 1.2)
+    sprockets (3.7.0)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.2.0)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    sqlite3 (1.3.11)
+    strong_resources (0.1.1)
+      rails (>= 4.1, < 6.0)
+      stronger_parameters (~> 2.6)
+    stronger_parameters (2.6.0)
+      actionpack (>= 3.2, < 5.1)
+    swagger-blocks (1.3.4)
+    thor (0.19.1)
+    thread_safe (0.3.5)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+    websocket-driver (0.6.4)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  active_model_serializers!
+  database_cleaner (~> 1.5)
+  jsonapi_suite (~> 0.1)
+  kaminari (~> 0.17)
+  listen (~> 3.0.5)
+  pry
+  pry-byebug
+  puma (~> 3.0)
+  rails (~> 5.0.0, >= 5.0.0.1)
+  rspec-rails (~> 3.5)
+  spring
+  spring-watcher-listen (~> 2.0.0)
+  sqlite3
+  tzinfo-data
+
+BUNDLED WITH
+   1.12.5

README.md

@@ -0,0 +1,24 @@
+# README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...

Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require_relative 'config/application'
+
+Rails.application.load_tasks

app/controllers/application_controller.rb

@@ -0,0 +1,7 @@
+class ApplicationController < ActionController::API
+  include JsonapiSuite::ControllerMixin
+
+  rescue_from Exception do |e|
+    handle_exception(e)
+  end
+end

app/controllers/concerns/.keep

@@ -0,0 +1,57 @@
+class EmployeesController < ApplicationController
+  jsonapi do
+    allow_filter :name
+    allow_filter :age
+
+    allow_filter :name_prefix do |scope, value|
+      scope.where(["name LIKE ?", "#{value}%"])
+    end
+
+    includes whitelist: {
+      index: :department,
+      show: { department: :goals }
+    }
+  end
+
+  before_action :deserialize_jsonapi!, only: [:create, :update]
+
+  strong_resource :employee do
+    belongs_to :department
+  end
+
+  def index
+    employees = Employee.all
+    render_ams(employees)
+  end
+
+  def show
+    employee = jsonapi_scope(Employee.all).find(params[:id])
+    render_ams(employee)
+  end
+
+  def create
+    employee = Employee.new(strong_resource)
+
+    if employee.save
+      render_ams(employee)
+    else
+      render_errors_for(employee)
+    end
+  end
+
+  def update
+    employee = Employee.find(params[:id])
+
+    if employee.update_attributes(strong_resource)
+      render_ams(employee, scope: false)
+    else
+      render_errors_for(employee)
+    end
+  end
+
+  def destroy
+    employee = Employee.find(params[:id])
+    employee.destroy
+    render_ams(employee)
+  end
+end

app/controllers/employees_controller.rb

@@ -0,0 +1,3 @@
+class ApplicationRecord < ActiveRecord::Base
+  self.abstract_class = true
+end

app/models/application_record.rb

@@ -0,0 +1,4 @@
+class Department < ApplicationRecord
+  has_many :employees
+  has_many :goals
+end

app/models/concerns/.keep

@@ -0,0 +1,7 @@
+class Employee < ApplicationRecord
+  include NestedAttributeReassignable
+
+  belongs_to :department
+
+  reassignable_nested_attributes_for :department
+end

app/models/department.rb

@@ -0,0 +1,3 @@
+class Goal < ApplicationRecord
+  belongs_to :department
+end

app/models/employee.rb

@@ -0,0 +1,3 @@
+class ApplicationSerializer < ActiveModel::Serializer
+  include JsonapiAmsExtensions
+end