code42_api_rails 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c45add59110e012980ff808a973e08ecf78daf8c
+  data.tar.gz: eea16008c0938e30ad6adca5a9b702aa6c967395
+SHA512:
+  metadata.gz: 9fd9f7e1f9d3112455a18d43b5378c0757c70421096ba5ec75fbc717f7557421a8c5d242ac3c197db3e23d33b71849b2d31f6babfad564955ed91051dd4b320e
+  data.tar.gz: 75f318e48b5176ff308ee0bd3bf0e1ea7d7a803c02f320d550d840f62dfd7029af56e3e0ef3998d0929924e370806ccd8d7434d289d23478fe2cfa557ac3220a

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2014 YOURNAME
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,33 @@
+# Code42ApiRails
+
+A gem to enable API spec compliance to rails projects
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'code42_api_rails'
+```
+
+And then execute:
+
+```bash
+$ bundle install
+```
+
+## Usage
+
+Subclass your controllers from RailsApi::BaseController.
+
+```ruby
+class ApplicationController < RailsApi::BaseController
+end
+```
+
+Subclass your models from RailsApi::Model.
+
+```ruby
+class MyModel < RailsApi::Model
+end
+```

data/Rakefile

@@ -0,0 +1,35 @@
+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    = 'Code42Api'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+require 'cucumber/rake/task'
+
+task :test => [:minitest, :features]
+
+Cucumber::Rake::Task.new(:features) do |t|
+end
+
+Rake::TestTask.new(:minitest) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/features/api_response.feature

@@ -0,0 +1,22 @@
+Feature: API Response
+
+  Scenario: PUT returns an object
+    Given I send and accept JSON
+    And the following Author exists:
+      | id | first_name | last_name |
+      | 3  | Stephen    | King      |
+    When I send a PUT request to "/authors/3" with the following:
+    """
+    { "author": { "last_name": "Colbert" } }
+    """
+    Then the response status should be "200"
+    And the JSON response should be:
+    """
+    {
+      "id": 3,
+      "first_name": "Stephen",
+      "last_name": "Colbert",
+      "created_at": "2014-01-01T06:00:00.000Z",
+      "updated_at": "2014-01-01T06:00:00.000Z"
+    }
+    """

data/features/errors.feature

@@ -0,0 +1,24 @@
+Feature: API Errors
+
+  Scenario: Validation errors are formatted according to spec
+    Given I send and accept JSON
+    And the following Author exists:
+      | id | first_name | last_name |
+      | 3  | Stephen    | King      |
+    When I send a PUT request to "/authors/3" with the following:
+    """
+    { "author": { "last_name": null } }
+    """
+    Then the response status should be "422"
+    And the JSON response should be:
+    """
+    {
+      "errors": [
+        {
+          "name": "last_name",
+          "type": "PresenceError",
+          "description": "can't be blank"
+        }
+      ]
+    }
+    """

data/features/step_definitions/model_steps.rb

@@ -0,0 +1,3 @@
+Given(/^the following Author(s?) exist(s?):$/) do |_,_,authors|
+  Author.create!(authors.hashes)
+end

data/features/support/env.rb

@@ -0,0 +1,72 @@
+# IMPORTANT: This file is generated by cucumber-rails - edit at your own peril.
+# It is recommended to regenerate this file in the future when you upgrade to a
+# newer version of cucumber-rails. Consider adding your own code to a new file
+# instead of editing this one. Cucumber will automatically load all features/**/*.rb
+# files.
+
+ENV['RAILS_ROOT'] = File.expand_path('./test/dummy')
+
+require 'cucumber/rails'
+require 'cucumber/api_steps'
+require 'rspec'
+require 'cucumber/rspec/doubles'
+
+# Capybara defaults to CSS3 selectors rather than XPath.
+# If you'd prefer to use XPath, just uncomment this line and adjust any
+# selectors in your step definitions to use the XPath syntax.
+# Capybara.default_selector = :xpath
+
+# By default, any exception happening in your Rails application will bubble up
+# to Cucumber so that your scenario will fail. This is a different from how
+# your application behaves in the production environment, where an error page will
+# be rendered instead.
+#
+# Sometimes we want to override this default behaviour and allow Rails to rescue
+# exceptions and display an error page (just like when the app is running in production).
+# Typical scenarios where you want to do this is when you test your error pages.
+# There are two ways to allow Rails to rescue exceptions:
+#
+# 1) Tag your scenario (or feature) with @allow-rescue
+#
+# 2) Set the value below to true. Beware that doing this globally is not
+# recommended as it will mask a lot of errors for you!
+#
+ActionController::Base.allow_rescue = false
+
+# Remove/comment out the lines below if your app doesn't have a database.
+# For some databases (like MongoDB and CouchDB) you may need to use :truncation instead.
+begin
+  DatabaseCleaner.strategy = :transaction
+rescue NameError
+  raise "You need to add database_cleaner to your Gemfile (in the :test group) if you wish to use it."
+end
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |c|
+    c.syntax = %i(should expect)
+  end
+end
+
+# You may also want to configure DatabaseCleaner to use different strategies for certain features and scenarios.
+# See the DatabaseCleaner documentation for details. Example:
+#
+#   Before('@no-txn,@selenium,@culerity,@celerity,@javascript') do
+#     # { :except => [:widgets] } may not do what you expect here
+#     # as Cucumber::Rails::Database.javascript_strategy overrides
+#     # this setting.
+#     DatabaseCleaner.strategy = :truncation
+#   end
+#
+#   Before('~@no-txn', '~@selenium', '~@culerity', '~@celerity', '~@javascript') do
+#     DatabaseCleaner.strategy = :transaction
+#   end
+#
+
+# Possible values are :truncation and :transaction
+# The :transaction strategy is faster, but might give you threading problems.
+# See https://github.com/cucumber/cucumber-rails/blob/master/features/choose_javascript_database_strategy.feature
+Cucumber::Rails::Database.javascript_strategy = :truncation
+
+Before do
+  Time.stub(:now).and_return Time.new(2014,1,1)
+end

data/lib/code42_api/base_controller.rb

@@ -0,0 +1,5 @@
+module Code42Api
+  class BaseController < ActionController::Base
+    self.responder = BaseResponder
+  end
+end

data/lib/code42_api/base_responder.rb

@@ -0,0 +1,19 @@
+require 'action_controller'
+module Code42Api
+  class BaseResponder < ActionController::Responder
+    def api_behavior(error)
+      raise error unless resourceful?
+      raise MissingRenderer.new(format) unless has_renderer?
+
+      if get?
+        display resource
+      elsif post?
+        display resource, status: :created, location: api_location
+      elsif put? || patch?
+        display resource, status: :ok
+      else
+        head :no_content
+      end
+    end
+  end
+end

data/lib/code42_api/errors.rb

@@ -0,0 +1,90 @@
+require 'active_model'
+
+module Code42Api
+  TypeMapping = Struct.new(:type, :description)
+  class Errors < ActiveModel::Errors
+    STANDARD_ERROR = "StandardError"
+    ERROR_MAPPINGS = {
+      'PresenceError' => [
+        :blank,
+        :empty,
+        :present
+      ],
+      'LengthError' => [
+        :too_long,
+        :too_short,
+        :wrong_length
+      ],
+      'BoundError' => [
+        :greater_than,
+        :greater_than_or_equal_to,
+        :equal_to,
+        :less_than,
+        :less_than_or_equal_to,
+        :other_than,
+        :odd,
+        :even
+      ],
+      'TypeError' => [
+        :not_a_number,
+        :not_an_integer
+      ],
+      'AcceptanceError' => [:accepted],
+      'FormatError' => [:invalid],
+      'InclusionError' => [
+        :inclusion,
+        :exclusion
+      ]
+    }
+
+
+    def add(attribute, message = :invalid, options = {})
+      type = get_type(message, options)
+
+      message = normalize_message(attribute, message, options)
+      if exception = options[:strict]
+        exception = ActiveModel::StrictValidationFailed if exception == true
+        raise exception, full_message(attribute, message)
+      end
+
+      self[attribute] << ErrorMessage.new(message, type)
+    end
+
+    def get_type(message, options)
+      if options[:error_type]
+        options[:error_type]
+      elsif message.is_a?(Symbol)
+        type_from_symbol(message)
+      else
+        STANDARD_ERROR
+      end
+    end
+
+    def type_from_symbol(symbol)
+      ERROR_MAPPINGS.keys.detect { |k| ERROR_MAPPINGS[k].include?(symbol) } || STANDARD_ERROR
+    end
+
+    def as_json(options = nil)
+      errors = []
+      to_hash.each do |(attribute_name,values)|
+        values.each do |value|
+          errors << {
+            name: attribute_name,
+            type: value.type,
+            description: value,
+          }
+        end
+      end
+      errors.as_json(options)
+    end
+  end
+
+  class ErrorMessage < SimpleDelegator
+    attr_reader :type
+
+    def initialize(message, type = STANDARD_ERROR)
+      @type = type
+      super(message)
+    end
+  end
+end

data/lib/code42_api/model.rb

@@ -0,0 +1,11 @@
+require 'active_record'
+
+module Code42Api
+  class Model < ActiveRecord::Base
+    self.abstract_class = true
+
+    def errors
+      @errors ||= Code42Api::Errors.new(self)
+    end
+  end
+end

data/lib/code42_api/railtie.rb

@@ -0,0 +1,7 @@
+module Code42Api
+  class Railtie < Rails::Railtie
+    config.before_initialize do
+      config.active_support.use_standard_json_time_format = true
+    end
+  end
+end

data/lib/code42_api/version.rb

@@ -0,0 +1,3 @@
+module Code42Api
+  VERSION = "0.0.2"
+end

data/lib/code42_api_rails.rb

@@ -0,0 +1,8 @@
+require 'code42_api/base_responder'
+require 'code42_api/base_controller'
+require 'code42_api/errors'
+require 'code42_api/model'
+require 'code42_api/railtie'
+
+module Code42Api
+end

data/lib/tasks/code42_rails_tasks.rake

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

data/test/code42_api_test.rb

@@ -0,0 +1,8 @@
+require 'test_helper'
+
+class Code42ApiTest < ActiveSupport::TestCase
+  test "time as json returns a iso8601 string" do
+    time = Time.utc(2014,1,1,12,0,0).in_time_zone
+    assert_equal "2014-01-01T12:00:00.000Z", time.as_json
+  end
+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__)
+
+Rails.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 .