grime 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a23e9fc8192a6840620dcfc52c3ef68973b56554
-  data.tar.gz: 6d3a1b67ddc0a71252e1b6916c77850904e7bc7b
+  metadata.gz: 5bc1ed21ac97e18ee1ab8bbb6c4a3f5e2d8ab9c0
+  data.tar.gz: 79663fad6d656626775d1e7326da59259efab684
 SHA512:
-  metadata.gz: 9d5fb77aa8ea3592026cfadc83a05b13b97d13e27e426489fcb66d446fb3b4004d778224c2bb7986f75bc39f129bf93e9b01b8eab22f1945f36f67730691623e
-  data.tar.gz: db806cfb5752d27732f0a4ad3f34fe5512d288d828f76f161f726793977dfa2b993f17aa56f4ccc71da1a39fb5e0495ad578c0b5915d3600aeb548b4b8fc340c
+  metadata.gz: 6cb5140721d7d084680168cde3a096409b18631b78dcc0ec688d226f1705c3b231210cb2cd51b2d0cab53201b6e580e0a0ca0471549aab27929d352b495c7116
+  data.tar.gz: 52de4663813d58df6d029e75d56e198ee8e4a130d905da35e546396d9229660c7cf406fc8c13baa676ddfcacd515ad1ed80072143d178adc7216a87491c05b59

data/.gitignore

@@ -15,3 +15,11 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+.bundle/
+log/*.log
+pkg/
+test/dummy/db/*.sqlite3
+test/dummy/db/*.sqlite3-journal
+test/dummy/log/*.log
+test/dummy/tmp/
+test/dummy/.sass-cache

data/README.md

@@ -1,6 +1,6 @@
 # Grime
 
-TODO: Write a gem description
+Provides a basic JSON CRUD API controller base class.
 
 ## Installation
 
@@ -18,7 +18,61 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+### Basic API controller
+
+Subclass `Grime::ApiController` for each model you'd like an API for:
+
+    class PeopleController < Grime::ApiController
+
+      def object_params
+        params.require(:person).permit(:name, :age)
+      end
+
+      def filter_params
+        params[:filter].permit(:name, :age)
+      end
+
+    end
+
+NOTE: overriding `object_params` is not strictly required, but without it
+the controller will allow mass-assignment of ALL attributes of the underlying
+model. A warning will be printed to the log to remind you that this is bad.
+
+Similarly, overriding `filter_params` is not required - but by default
+ANYTHING passed in `params[:filter]` will be passed to `where`, including
+arrays and nested hashes. A warning will be printed in this case as well.
+
+### Customization
+
+The operation of `Grime::ApiController` can be customized further by overriding
+methods.
+
+* `object_class`: by default, the model class is determined from the controller name.
+  Override this method to specify a different class.
+
+* `scope`: by default, this is simply `object_class`. Override it to supply a `Relation`
+  to use when creating / finding objects.
+
+* `object_params_for_create` / `object_params_for_update`: by default, `object_params`
+  are used for both creation and updates. If different parameters are allowed for different
+  actions, override these methods to specify them.
+
+### Error Conditions
+
+There are several possible error conditions:
+
+* record not found: results in an HTTP 404 status code and a payload of
+  `{ "error": "not_found" }`
+
+* missing required parameters: results in an HTTP 400 status code and a payload of
+  `{ "error": "missing_parameters", "message": "param not found: person" }`
+
+* parameters that are not allowed: results in an HTTP 400 status code and a payload of
+  `{ "error": "unpermitted_parameters", "message": "found unpermitted parameters: updated_at" }`
+
+* record fails validation: results in an HTTP 422 status code and a payload of:
+  `{ "errors": { "name" => ["cannot be blank"] } }` where each value under `errors` is an attribute
+  and its corresponding error messages.
 
 ## Contributing
 

data/Rakefile

@@ -1 +1,32 @@
-require "bundler/gem_tasks"
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Grime'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/app/controllers/grime/api_controller.rb

@@ -5,8 +5,29 @@ module Grime
       @object = scope.find(params[:id])
     end
 
+    rescue_from 'ActiveRecord::RecordInvalid' do |e|
+      render json: { errors: e.record.errors }, status: :unprocessable_entity
+    end
+
+    rescue_from 'ActionController::UnpermittedParameters' do |e|
+      render json: { error: 'unpermitted_parameters', message: e.message }, status: :bad_request
+    end
+
+    rescue_from 'ActionController::ParameterMissing' do |e|
+      render json: { error: 'missing_parameters', message: e.message }, status: :bad_request
+    end
+
+    rescue_from 'ActiveRecord::RecordNotFound' do |e|
+      render json: { error: 'not_found' }, status: :not_found
+    end
+
     def index
-      render json: scope.all
+      if filter_params_present? && scope.respond_to?(:where)
+        objects = scope.where(filter_params)
+      else
+        objects = scope.all
+      end
+      render json: objects
     end
 
     def show
@@ -14,15 +35,12 @@ module Grime
     end
 
     def create
-      ActiveRecord::Base.transaction do
-        @object = scope.create
-        @object.update_attributes!(params[params_key])
-      end
+      @object = scope.create!(object_params_for_create)
       render json: @object
     end
 
     def update
-      @object.update!(params[params_key])
+      @object.update!(object_params_for_update)
       render json: @object
     end
 
@@ -44,5 +62,30 @@ module Grime
       controller_name.chomp('Controller').singularize.classify.constantize
     end
 
+    def filter_params_present?
+      params[:filter] && params[:filter].is_a?(Hash)
+    end
+
+    def filter_params
+      logger.warn("WARNING: allowing all filter parameters in #{controller_name}. This is probably not what you want.\nOverride filter_params to fix this.")
+      params[:filter].permit!
+    end
+
+    def object_params
+      logger.warn("WARNING: allowing all parameters in #{controller_name}. This is probably not what you want.\nOverride object_params to fix this.")
+      params.require(params_key).permit!
+    end
+
+    # NOTE: override these methods if you want to have different
+    #       parameters for create vs. update
+    #
+    def object_params_for_create
+      object_params
+    end
+
+    def object_params_for_update
+      object_params
+    end
+
   end
-end
+end

data/grime.gemspec

@@ -1,10 +1,12 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+$:.push File.expand_path("../lib", __FILE__)
 
+# Maintain your gem's version:
+require "grime/version"
+
+# Describe your gem and declare its dependencies:
 Gem::Specification.new do |spec|
   spec.name          = "grime"
-  spec.version       = "0.0.2"
+  spec.version       = Grime::VERSION
   spec.authors       = ["John Colvin"]
   spec.email         = ["john.colvin@neo.com"]
   spec.description   = 'Crud controller for your JSON API!'
@@ -17,6 +19,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.3"
-  spec.add_development_dependency "rake"
+  spec.add_dependency "rails", "~> 4.0.0"
+
+  spec.add_development_dependency "sqlite3"
 end

data/lib/grime.rb

@@ -1,6 +1,4 @@
+require 'grime/railtie' if defined?(Rails)
+
 module Grime
-  module Rails
-    class Engine < ::Rails::Engine
-    end
-  end
 end

data/lib/grime/railtie.rb

@@ -0,0 +1,7 @@
+module Grime
+  module Rails
+    class Engine < ::Rails::Engine
+    end
+  end
+end
+

data/lib/grime/version.rb

@@ -0,0 +1,3 @@
+module Grime
+  VERSION = "0.0.3"
+end

data/lib/tasks/grime_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :grime do
+#   # Task goes here
+# end

data/test/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== 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
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

data/test/dummy/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 File.expand_path('../config/application', __FILE__)
+
+Dummy::Application.load_tasks

data/test/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/sstephenson/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/test/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,13 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+ */

data/test/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,5 @@
+class ApplicationController < ActionController::Base
+  # Prevent CSRF attacks by raising an exception.
+  # For APIs, you may want to use :null_session instead.
+  protect_from_forgery with: :exception
+end

data/test/dummy/app/controllers/people_controller.rb

@@ -0,0 +1,11 @@
+class PeopleController < Grime::ApiController
+
+  def object_params
+    params.require(:person).permit(:name, :age)
+  end
+
+  def filter_params
+    params[:filter].permit(:name, :age)
+  end
+
+end

data/test/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/test/dummy/app/models/person.rb

@@ -0,0 +1,5 @@
+class Person < ActiveRecord::Base
+
+  validates_presence_of :name
+
+end

data/test/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag    "application", media: "all", "data-turbolinks-track" => true %>
+  <%= javascript_include_tag "application", "data-turbolinks-track" => true %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/test/dummy/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+load Gem.bin_path('bundler', 'bundle')

data/test/dummy/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../../config/application',  __FILE__)
+require_relative '../config/boot'
+require 'rails/commands'

data/test/dummy/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run

data/test/dummy/config.ru

@@ -0,0 +1,4 @@
+# This file is used by Rack-based servers to start the application.
+
+require ::File.expand_path('../config/environment',  __FILE__)
+run Rails.application

data/test/dummy/config/application.rb

@@ -0,0 +1,23 @@
+require File.expand_path('../boot', __FILE__)
+
+require 'rails/all'
+
+Bundler.require(*Rails.groups)
+require "grime"
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+  end
+end
+

data/test/dummy/config/boot.rb

@@ -0,0 +1,5 @@
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../../Gemfile', __FILE__)
+
+require 'bundler/setup' if File.exists?(ENV['BUNDLE_GEMFILE'])
+$LOAD_PATH.unshift File.expand_path('../../../../lib', __FILE__)

data/test/dummy/config/database.yml

@@ -0,0 +1,25 @@
+# SQLite version 3.x
+#   gem install sqlite3
+#
+#   Ensure the SQLite 3 gem is defined in your Gemfile
+#   gem 'sqlite3'
+development:
+  adapter: sqlite3
+  database: db/development.sqlite3
+  pool: 5
+  timeout: 5000
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
+  adapter: sqlite3
+  database: db/test.sqlite3
+  pool: 5
+  timeout: 5000
+
+production:
+  adapter: sqlite3
+  database: db/production.sqlite3
+  pool: 5
+  timeout: 5000

data/test/dummy/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the Rails application.
+require File.expand_path('../application', __FILE__)
+
+# Initialize the Rails application.
+Dummy::Application.initialize!

data/test/dummy/config/environments/development.rb

@@ -0,0 +1,29 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # In the development environment your application's code is reloaded on
+  # every request. This slows down response time but is perfect for development
+  # since you don't have to restart the web server when you make code changes.
+  config.cache_classes = false
+
+  # Do not eager load code on boot.
+  config.eager_load = false
+
+  # Show full error reports and disable caching.
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Don't care if the mailer can't send.
+  config.action_mailer.raise_delivery_errors = false
+
+  # Print deprecation notices to the Rails logger.
+  config.active_support.deprecation = :log
+
+  # Raise an error on page load if there are pending migrations
+  config.active_record.migration_error = :page_load
+
+  # Debug mode disables concatenation and preprocessing of assets.
+  # This option may cause significant delays in view rendering with a large
+  # number of complex assets.
+  config.assets.debug = true
+end

data/test/dummy/config/environments/production.rb

@@ -0,0 +1,80 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # Code is not reloaded between requests.
+  config.cache_classes = true
+
+  # Eager load code on boot. This eager loads most of Rails and
+  # your application in memory, allowing both thread web servers
+  # and those relying on copy on write to perform better.
+  # Rake tasks automatically ignore this option for performance.
+  config.eager_load = true
+
+  # Full error reports are disabled and caching is turned on.
+  config.consider_all_requests_local       = false
+  config.action_controller.perform_caching = true
+
+  # Enable Rack::Cache to put a simple HTTP cache in front of your application
+  # Add `rack-cache` to your Gemfile before enabling this.
+  # For large-scale production use, consider using a caching reverse proxy like nginx, varnish or squid.
+  # config.action_dispatch.rack_cache = true
+
+  # Disable Rails's static asset server (Apache or nginx will already do this).
+  config.serve_static_assets = false
+
+  # Compress JavaScripts and CSS.
+  config.assets.js_compressor = :uglifier
+  # config.assets.css_compressor = :sass
+
+  # Do not fallback to assets pipeline if a precompiled asset is missed.
+  config.assets.compile = false
+
+  # Generate digests for assets URLs.
+  config.assets.digest = true
+
+  # Version of your assets, change this if you want to expire all your assets.
+  config.assets.version = '1.0'
+
+  # Specifies the header that your server uses for sending files.
+  # config.action_dispatch.x_sendfile_header = "X-Sendfile" # for apache
+  # config.action_dispatch.x_sendfile_header = 'X-Accel-Redirect' # for nginx
+
+  # Force all access to the app over SSL, use Strict-Transport-Security, and use secure cookies.
+  # config.force_ssl = true
+
+  # Set to :debug to see everything in the log.
+  config.log_level = :info
+
+  # Prepend all log lines with the following tags.
+  # config.log_tags = [ :subdomain, :uuid ]
+
+  # Use a different logger for distributed setups.
+  # config.logger = ActiveSupport::TaggedLogging.new(SyslogLogger.new)
+
+  # Use a different cache store in production.
+  # config.cache_store = :mem_cache_store
+
+  # Enable serving of images, stylesheets, and JavaScripts from an asset server.
+  # config.action_controller.asset_host = "http://assets.example.com"
+
+  # Precompile additional assets.
+  # application.js, application.css, and all non-JS/CSS in app/assets folder are already added.
+  # config.assets.precompile += %w( search.js )
+
+  # Ignore bad email addresses and do not raise email delivery errors.
+  # Set this to true and configure the email server for immediate delivery to raise delivery errors.
+  # config.action_mailer.raise_delivery_errors = false
+
+  # Enable locale fallbacks for I18n (makes lookups for any locale fall back to
+  # the I18n.default_locale when a translation can not be found).
+  config.i18n.fallbacks = true
+
+  # Send deprecation notices to registered listeners.
+  config.active_support.deprecation = :notify
+
+  # Disable automatic flushing of the log to improve performance.
+  # config.autoflush_log = false
+
+  # Use default logging formatter so that PID and timestamp are not suppressed.
+  config.log_formatter = ::Logger::Formatter.new
+end

data/test/dummy/config/environments/test.rb

@@ -0,0 +1,38 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  config.action_controller.action_on_unpermitted_parameters = :raise
+
+  # The test environment is used exclusively to run your application's
+  # test suite. You never need to work with it otherwise. Remember that
+  # your test database is "scratch space" for the test suite and is wiped
+  # and recreated between test runs. Don't rely on the data there!
+  config.cache_classes = true
+
+  # Do not eager load code on boot. This avoids loading your whole application
+  # just for the purpose of running a single test. If you are using a tool that
+  # preloads Rails for running tests, you may have to set it to true.
+  config.eager_load = false
+
+  # Configure static asset server for tests with Cache-Control for performance.
+  config.serve_static_assets  = true
+  config.static_cache_control = "public, max-age=3600"
+
+  # Show full error reports and disable caching.
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Raise exceptions instead of rendering exception templates.
+  config.action_dispatch.show_exceptions = false
+
+  # Disable request forgery protection in test environment.
+  config.action_controller.allow_forgery_protection = false
+
+  # Tell Action Mailer not to deliver emails to the real world.
+  # The :test delivery method accumulates sent emails in the
+  # ActionMailer::Base.deliveries array.
+  config.action_mailer.delivery_method = :test
+
+  # Print deprecation notices to the stderr.
+  config.active_support.deprecation = :stderr
+end

data/test/dummy/config/initializers/backtrace_silencers.rb

@@ -0,0 +1,7 @@
+# Be sure to restart your server when you modify this file.
+
+# You can add backtrace silencers for libraries that you're using but don't wish to see in your backtraces.
+# Rails.backtrace_cleaner.add_silencer { |line| line =~ /my_noisy_library/ }
+
+# You can also remove all the silencers if you're trying to debug a problem that might stem from framework code.
+# Rails.backtrace_cleaner.remove_silencers!

data/test/dummy/config/initializers/filter_parameter_logging.rb

@@ -0,0 +1,4 @@
+# Be sure to restart your server when you modify this file.
+
+# Configure sensitive parameters which will be filtered from the log file.
+Rails.application.config.filter_parameters += [:password]

data/test/dummy/config/initializers/inflections.rb

@@ -0,0 +1,16 @@
+# Be sure to restart your server when you modify this file.
+
+# Add new inflection rules using the following format. Inflections
+# are locale specific, and you may define rules for as many different
+# locales as you wish. All of these examples are active by default:
+# ActiveSupport::Inflector.inflections(:en) do |inflect|
+#   inflect.plural /^(ox)$/i, '\1en'
+#   inflect.singular /^(ox)en/i, '\1'
+#   inflect.irregular 'person', 'people'
+#   inflect.uncountable %w( fish sheep )
+# end
+
+# These inflection rules are supported but not enabled by default:
+# ActiveSupport::Inflector.inflections(:en) do |inflect|
+#   inflect.acronym 'RESTful'
+# end

data/test/dummy/config/initializers/mime_types.rb

@@ -0,0 +1,5 @@
+# Be sure to restart your server when you modify this file.
+
+# Add new mime types for use in respond_to blocks:
+# Mime::Type.register "text/richtext", :rtf
+# Mime::Type.register_alias "text/html", :iphone

data/test/dummy/config/initializers/secret_token.rb

@@ -0,0 +1,12 @@
+# Be sure to restart your server when you modify this file.
+
+# Your secret key is used for verifying the integrity of signed cookies.
+# If you change this key, all old signed cookies will become invalid!
+
+# Make sure the secret is at least 30 characters and all random,
+# no regular words or you'll be exposed to dictionary attacks.
+# You can use `rake secret` to generate a secure secret key.
+
+# Make sure your secret_key_base is kept private
+# if you're sharing your code publicly.
+Dummy::Application.config.secret_key_base = '83e01bbf709580c787f266ed0cf77e297c43a83d1d1dde67e9aa908a0d5e8b67f3c9ce745f5826830aae841474aa20e63d14c3bed16ab60ca4cdbe1a79ab070a'

data/test/dummy/config/initializers/session_store.rb

@@ -0,0 +1,3 @@
+# Be sure to restart your server when you modify this file.
+
+Dummy::Application.config.session_store :cookie_store, key: '_dummy_session'

data/test/dummy/config/initializers/wrap_parameters.rb

@@ -0,0 +1,14 @@
+# Be sure to restart your server when you modify this file.
+
+# This file contains settings for ActionController::ParamsWrapper which
+# is enabled by default.
+
+# Enable parameter wrapping for JSON. You can disable this by setting :format to an empty array.
+ActiveSupport.on_load(:action_controller) do
+  wrap_parameters format: [:json] if respond_to?(:wrap_parameters)
+end
+
+# To enable root element in JSON for ActiveRecord objects.
+# ActiveSupport.on_load(:active_record) do
+#  self.include_root_in_json = true
+# end

data/test/dummy/config/locales/en.yml

@@ -0,0 +1,23 @@
+# Files in the config/locales directory are used for internationalization
+# and are automatically loaded by Rails. If you want to use locales other
+# than English, add the necessary files in this directory.
+#
+# To use the locales, use `I18n.t`:
+#
+#     I18n.t 'hello'
+#
+# In views, this is aliased to just `t`:
+#
+#     <%= t('hello') %>
+#
+# To use a different locale, set it with `I18n.locale`:
+#
+#     I18n.locale = :es
+#
+# This would use the information in config/locales/es.yml.
+#
+# To learn more, please read the Rails Internationalization guide
+# available at http://guides.rubyonrails.org/i18n.html.
+
+en:
+  hello: "Hello world"

data/test/dummy/config/routes.rb

@@ -0,0 +1,3 @@
+Dummy::Application.routes.draw do
+  resources :people
+end

data/test/dummy/db/migrate/20131015194728_create_people.rb

@@ -0,0 +1,9 @@
+class CreatePeople < ActiveRecord::Migration
+  def change
+    create_table :people do |t|
+      t.string :name
+      t.integer :age
+      t.timestamps
+    end
+  end
+end

data/test/dummy/db/schema.rb

@@ -0,0 +1,23 @@
+# encoding: UTF-8
+# This file is auto-generated from the current state of the database. Instead
+# of editing this file, please use the migrations feature of Active Record to
+# incrementally modify your database, and then regenerate this schema definition.
+#
+# Note that this schema.rb definition is the authoritative source for your
+# database schema. If you need to create the application database on another
+# system, you should be using db:schema:load, not running all the migrations
+# from scratch. The latter is a flawed and unsustainable approach (the more migrations
+# you'll amass, the slower it'll run and the greater likelihood for issues).
+#
+# It's strongly recommended that you check this file into your version control system.
+
+ActiveRecord::Schema.define(version: 20131015194728) do
+
+  create_table "people", force: true do |t|
+    t.string   "name"
+    t.integer  "age"
+    t.datetime "created_at"
+    t.datetime "updated_at"
+  end
+
+end

data/test/dummy/public/404.html

@@ -0,0 +1,58 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>The page you were looking for doesn't exist (404)</title>
+  <style>
+  body {
+    background-color: #EFEFEF;
+    color: #2E2F30;
+    text-align: center;
+    font-family: arial, sans-serif;
+  }
+
+  div.dialog {
+    width: 25em;
+    margin: 4em auto 0 auto;
+    border: 1px solid #CCC;
+    border-right-color: #999;
+    border-left-color: #999;
+    border-bottom-color: #BBB;
+    border-top: #B00100 solid 4px;
+    border-top-left-radius: 9px;
+    border-top-right-radius: 9px;
+    background-color: white;
+    padding: 7px 4em 0 4em;
+  }
+
+  h1 {
+    font-size: 100%;
+    color: #730E15;
+    line-height: 1.5em;
+  }
+
+  body > p {
+    width: 33em;
+    margin: 0 auto 1em;
+    padding: 1em 0;
+    background-color: #F7F7F7;
+    border: 1px solid #CCC;
+    border-right-color: #999;
+    border-bottom-color: #999;
+    border-bottom-left-radius: 4px;
+    border-bottom-right-radius: 4px;
+    border-top-color: #DADADA;
+    color: #666;
+    box-shadow:0 3px 8px rgba(50, 50, 50, 0.17);
+  }
+  </style>
+</head>
+
+<body>
+  <!-- This file lives in public/404.html -->
+  <div class="dialog">
+    <h1>The page you were looking for doesn't exist.</h1>
+    <p>You may have mistyped the address or the page may have moved.</p>
+  </div>
+  <p>If you are the application owner check the logs for more information.</p>
+</body>
+</html>

data/test/dummy/public/422.html

@@ -0,0 +1,58 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>The change you wanted was rejected (422)</title>
+  <style>
+  body {
+    background-color: #EFEFEF;
+    color: #2E2F30;
+    text-align: center;
+    font-family: arial, sans-serif;
+  }
+
+  div.dialog {
+    width: 25em;
+    margin: 4em auto 0 auto;
+    border: 1px solid #CCC;
+    border-right-color: #999;
+    border-left-color: #999;
+    border-bottom-color: #BBB;
+    border-top: #B00100 solid 4px;
+    border-top-left-radius: 9px;
+    border-top-right-radius: 9px;
+    background-color: white;
+    padding: 7px 4em 0 4em;
+  }
+
+  h1 {
+    font-size: 100%;
+    color: #730E15;
+    line-height: 1.5em;
+  }
+
+  body > p {
+    width: 33em;
+    margin: 0 auto 1em;
+    padding: 1em 0;
+    background-color: #F7F7F7;
+    border: 1px solid #CCC;
+    border-right-color: #999;
+    border-bottom-color: #999;
+    border-bottom-left-radius: 4px;
+    border-bottom-right-radius: 4px;
+    border-top-color: #DADADA;
+    color: #666;
+    box-shadow:0 3px 8px rgba(50, 50, 50, 0.17);
+  }
+  </style>
+</head>
+
+<body>
+  <!-- This file lives in public/422.html -->
+  <div class="dialog">
+    <h1>The change you wanted was rejected.</h1>
+    <p>Maybe you tried to change something you didn't have access to.</p>
+  </div>
+  <p>If you are the application owner check the logs for more information.</p>
+</body>
+</html>

data/test/dummy/public/500.html

@@ -0,0 +1,57 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>We're sorry, but something went wrong (500)</title>
+  <style>
+  body {
+    background-color: #EFEFEF;
+    color: #2E2F30;
+    text-align: center;
+    font-family: arial, sans-serif;
+  }
+
+  div.dialog {
+    width: 25em;
+    margin: 4em auto 0 auto;
+    border: 1px solid #CCC;
+    border-right-color: #999;
+    border-left-color: #999;
+    border-bottom-color: #BBB;
+    border-top: #B00100 solid 4px;
+    border-top-left-radius: 9px;
+    border-top-right-radius: 9px;
+    background-color: white;
+    padding: 7px 4em 0 4em;
+  }
+
+  h1 {
+    font-size: 100%;
+    color: #730E15;
+    line-height: 1.5em;
+  }
+
+  body > p {
+    width: 33em;
+    margin: 0 auto 1em;
+    padding: 1em 0;
+    background-color: #F7F7F7;
+    border: 1px solid #CCC;
+    border-right-color: #999;
+    border-bottom-color: #999;
+    border-bottom-left-radius: 4px;
+    border-bottom-right-radius: 4px;
+    border-top-color: #DADADA;
+    color: #666;
+    box-shadow:0 3px 8px rgba(50, 50, 50, 0.17);
+  }
+  </style>
+</head>
+
+<body>
+  <!-- This file lives in public/500.html -->
+  <div class="dialog">
+    <h1>We're sorry, but something went wrong.</h1>
+  </div>
+  <p>If you are the application owner check the logs for more information.</p>
+</body>
+</html>

data/test/grime_test.rb

@@ -0,0 +1,7 @@
+require 'test_helper'
+
+class GrimeTest < ActiveSupport::TestCase
+  test "truth" do
+    assert_kind_of Module, Grime
+  end
+end

data/test/people_errors_test.rb

@@ -0,0 +1,50 @@
+class PeopleErrorsTest < ActionController::TestCase
+
+  tests PeopleController
+
+  test "it returns validation errors" do
+    post :create, person: { age: 23 }
+
+    assert_response :unprocessable_entity
+    parsed_body = JSON.parse(response.body)
+    assert_equal ["errors"], parsed_body.keys
+    assert_equal ["name"], parsed_body["errors"].keys
+  end
+
+  test "it rejects unpermitted parameters" do
+    post :create, person: { updated_at: 27, age: 23 }
+
+    assert_response :bad_request
+    parsed_body = JSON.parse(response.body)
+    assert_equal ["error", "message"], parsed_body.keys
+    assert_equal "unpermitted_parameters", parsed_body["error"]
+  end
+
+  test "it requires required parameters" do
+    post :create, {}
+
+    assert_response :bad_request
+    parsed_body = JSON.parse(response.body)
+    assert_equal ["error", "message"], parsed_body.keys
+    assert_equal "missing_parameters", parsed_body["error"]
+  end
+
+  test "it returns 404 when no record exists" do
+    get :show, id: '1234567890'
+
+    assert_response :not_found
+    parsed_body = JSON.parse(response.body)
+    assert_equal ["error"], parsed_body.keys
+    assert_equal "not_found", parsed_body["error"]
+  end
+
+  test "it refuses sneaky parameters in filter" do
+    person = Person.create(name: 'Nobody', age: 23)
+    other_person = Person.create(name: 'Somebody', age: 27)
+
+    get :index, filter: { something: { evil: "in here" } }
+
+    assert_response :bad_request
+  end
+end
+

data/test/people_test.rb

@@ -0,0 +1,61 @@
+class PeopleTest < ActionController::TestCase
+
+  tests PeopleController
+
+  test "it can create a record" do
+    post :create, person: { name: 'Nobody', age: 23 }
+
+    assert_response :success
+    assert Person.find_by(name: 'Nobody').present?
+  end
+
+  test "it can read a record" do
+    person = Person.create(name: 'Nobody', age: 23)
+
+    get :show, id: person.id.to_s
+
+    assert_response :success
+    parsed_body = JSON.parse(response.body)
+    assert_equal person.id, parsed_body["id"]
+    assert_equal person.name, parsed_body["name"]
+  end
+
+  test "it can list all records" do
+    person = Person.create(name: 'Nobody', age: 23)
+    other_person = Person.create(name: 'Somebody', age: 27)
+
+    get :index
+
+    assert_response :success
+    parsed_body = JSON.parse(response.body)
+    assert parsed_body.is_a?(Array)
+  end
+
+  test "it can list all records matching a filter" do
+    person = Person.create(name: 'Nobody', age: 23)
+    other_person = Person.create(name: 'Somebody', age: 27)
+
+    get :index, filter: { name: 'Somebody' }
+
+    assert_response :success
+    parsed_body = JSON.parse(response.body)
+    assert_equal 1, parsed_body.length
+  end
+
+  test "it can update a record" do
+    person = Person.create(name: 'Nobody', age: 23)
+
+    put :update, id: person.id.to_s, person: { name: 'Nobody 2' }
+
+    assert_response :success
+    assert Person.find_by(name: 'Nobody 2').present?
+  end
+
+  test "it can destroy a record" do
+    person = Person.create(name: 'Nobody', age: 23)
+
+    delete :destroy, id: person.id.to_s
+
+    assert_response :success
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,15 @@
+# Configure Rails Environment
+ENV["RAILS_ENV"] = "test"
+
+require File.expand_path("../dummy/config/environment.rb",  __FILE__)
+require "rails/test_help"
+
+Rails.backtrace_cleaner.remove_silencers!
+
+# Load support files
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
+
+# Load fixtures from the engine
+if ActiveSupport::TestCase.method_defined?(:fixture_path=)
+  ActiveSupport::TestCase.fixture_path = File.expand_path("../fixtures", __FILE__)
+end

metadata

@@ -1,31 +1,31 @@
 --- !ruby/object:Gem::Specification
 name: grime
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - John Colvin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-22 00:00:00.000000000 Z
+date: 2013-11-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1.3'
-  type: :development
+        version: 4.0.0
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: 4.0.0
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
@@ -53,6 +53,55 @@ files:
 - app/controllers/grime/api_controller.rb
 - grime.gemspec
 - lib/grime.rb
+- lib/grime/railtie.rb
+- lib/grime/version.rb
+- lib/tasks/grime_tasks.rake
+- test/dummy/README.rdoc
+- test/dummy/Rakefile
+- test/dummy/app/assets/images/.keep
+- test/dummy/app/assets/javascripts/application.js
+- test/dummy/app/assets/stylesheets/application.css
+- test/dummy/app/controllers/application_controller.rb
+- test/dummy/app/controllers/concerns/.keep
+- test/dummy/app/controllers/people_controller.rb
+- test/dummy/app/helpers/application_helper.rb
+- test/dummy/app/mailers/.keep
+- test/dummy/app/models/.keep
+- test/dummy/app/models/concerns/.keep
+- test/dummy/app/models/person.rb
+- test/dummy/app/views/layouts/application.html.erb
+- test/dummy/bin/bundle
+- test/dummy/bin/rails
+- test/dummy/bin/rake
+- test/dummy/config.ru
+- test/dummy/config/application.rb
+- test/dummy/config/boot.rb
+- test/dummy/config/database.yml
+- test/dummy/config/environment.rb
+- test/dummy/config/environments/development.rb
+- test/dummy/config/environments/production.rb
+- test/dummy/config/environments/test.rb
+- test/dummy/config/initializers/backtrace_silencers.rb
+- test/dummy/config/initializers/filter_parameter_logging.rb
+- test/dummy/config/initializers/inflections.rb
+- test/dummy/config/initializers/mime_types.rb
+- test/dummy/config/initializers/secret_token.rb
+- test/dummy/config/initializers/session_store.rb
+- test/dummy/config/initializers/wrap_parameters.rb
+- test/dummy/config/locales/en.yml
+- test/dummy/config/routes.rb
+- test/dummy/db/migrate/20131015194728_create_people.rb
+- test/dummy/db/schema.rb
+- test/dummy/lib/assets/.keep
+- test/dummy/log/.keep
+- test/dummy/public/404.html
+- test/dummy/public/422.html
+- test/dummy/public/500.html
+- test/dummy/public/favicon.ico
+- test/grime_test.rb
+- test/people_errors_test.rb
+- test/people_test.rb
+- test/test_helper.rb
 homepage: ''
 licenses:
 - MIT
@@ -77,5 +126,50 @@ rubygems_version: 2.0.2
 signing_key: 
 specification_version: 4
 summary: If you've got CRUD, try Grime!
-test_files: []
-has_rdoc: 
+test_files:
+- test/dummy/README.rdoc
+- test/dummy/Rakefile
+- test/dummy/app/assets/images/.keep
+- test/dummy/app/assets/javascripts/application.js
+- test/dummy/app/assets/stylesheets/application.css
+- test/dummy/app/controllers/application_controller.rb
+- test/dummy/app/controllers/concerns/.keep
+- test/dummy/app/controllers/people_controller.rb
+- test/dummy/app/helpers/application_helper.rb
+- test/dummy/app/mailers/.keep
+- test/dummy/app/models/.keep
+- test/dummy/app/models/concerns/.keep
+- test/dummy/app/models/person.rb
+- test/dummy/app/views/layouts/application.html.erb
+- test/dummy/bin/bundle
+- test/dummy/bin/rails
+- test/dummy/bin/rake
+- test/dummy/config.ru
+- test/dummy/config/application.rb
+- test/dummy/config/boot.rb
+- test/dummy/config/database.yml
+- test/dummy/config/environment.rb
+- test/dummy/config/environments/development.rb
+- test/dummy/config/environments/production.rb
+- test/dummy/config/environments/test.rb
+- test/dummy/config/initializers/backtrace_silencers.rb
+- test/dummy/config/initializers/filter_parameter_logging.rb
+- test/dummy/config/initializers/inflections.rb
+- test/dummy/config/initializers/mime_types.rb
+- test/dummy/config/initializers/secret_token.rb
+- test/dummy/config/initializers/session_store.rb
+- test/dummy/config/initializers/wrap_parameters.rb
+- test/dummy/config/locales/en.yml
+- test/dummy/config/routes.rb
+- test/dummy/db/migrate/20131015194728_create_people.rb
+- test/dummy/db/schema.rb
+- test/dummy/lib/assets/.keep
+- test/dummy/log/.keep
+- test/dummy/public/404.html
+- test/dummy/public/422.html
+- test/dummy/public/500.html
+- test/dummy/public/favicon.ico
+- test/grime_test.rb
+- test/people_errors_test.rb
+- test/people_test.rb
+- test/test_helper.rb