grape_ape_rails 0.5.0

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

@@ -0,0 +1,36 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # 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/spec/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/spec/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/spec/dummy/config/initializers/grape_ape_rails.rb

@@ -0,0 +1,23 @@
+GrapeApeRails.configure do |config|
+  config.organization_name = "monkeyworks"
+  config.app_name = "titan"
+  config.api_secret_key = "123456fakefakefake123456"
+  # config.api_header_security_enabled = true
+  # config.api_security_algorithm = "sha256"
+  # config.api_header_security_uses_request_body = false
+  config.security_envelope_debug = false
+  config.available_locales = %i[ en jp es de ]
+end
+
+# Subscribe to grape request and log with Rails.logger
+ActiveSupport::Notifications.subscribe('grape.request') do |name, starts, ends, notification_id, payload|
+  api_version = payload[:api_version] ? "[#{payload[:api_version]}]" : nil
+  Rails.logger.info "[API]%s %s %s (%.3f ms) -> %s %s" % [
+    api_version,
+    payload[:request_method],
+    payload[:request_path],
+    (ends-starts)*1000,
+    (payload[:response_status] || "error"),
+    payload[:params] ? "| #{payload[:params].inspect}" : ""
+  ]
+end

data/spec/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/spec/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/spec/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 = '96e264b9b382d061acf985f38f8f2b5baf451c347b76af6365c18d4e4424ed7dba8060866410142cca4a82b55ebd3711bcdf4e264a59767822860d05364fadde'

data/spec/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/spec/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/spec/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/spec/dummy/config/routes.rb

@@ -0,0 +1,5 @@
+Dummy::Application.routes.draw do
+
+  mount API::Base => '/'
+
+end

data/spec/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/spec/dummy/db/migrate/20140714154355_create_widgets.rb

@@ -0,0 +1,10 @@
+class CreateWidgets < ActiveRecord::Migration
+  def change
+    create_table :widgets do |t|
+      t.string :name
+      t.string :color
+      t.boolean :radioactive, default: false
+      t.integer :rads, default: 0
+    end
+  end
+end

data/spec/dummy/db/migrate/20140804173544_create_monkeys.rb

@@ -0,0 +1,9 @@
+class CreateMonkeys < ActiveRecord::Migration
+  def change
+    create_table :monkeys do |t|
+      t.string :name
+      t.string :color
+      t.timestamps
+    end
+  end
+end

data/spec/dummy/db/schema.rb

@@ -0,0 +1,30 @@
+# 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: 20140804173544) do
+
+  create_table "monkeys", force: true do |t|
+    t.string   "name"
+    t.string   "color"
+    t.datetime "created_at"
+    t.datetime "updated_at"
+  end
+
+  create_table "widgets", force: true do |t|
+    t.string  "name"
+    t.string  "color"
+    t.boolean "radioactive", default: false
+    t.integer "rads",        default: 0
+  end
+
+end

data/spec/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/spec/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/spec/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/spec/requests/v1/monkeys_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+describe API::V1::Monkeys do
+  describe "GET /monkeys/:id" do
+    let(:monkey) { FactoryGirl.create(:monkey) }
+
+    it "requires a version header" do
+      get "/monkeys/#{monkey.id}", {}, { 'Content-Type' => 'application/json' }
+      json = MultiJson.load(response.body, symbolize_keys: true)
+      expect(json_error[:code]).to eql "UNAUTHORIZED"
+      expect(json_error[:message]).to eql "[UNAUTHORIZED] Cannot determine API version from header info."
+      expect(response.status).to eql 401
+    end
+
+    it "returns a monkey by id, using the ActiveModelSerializers" do
+      req :get, "/monkeys/#{monkey.id}"
+      expect(response.status).to eql 200
+      expect(json_result[:monkeys].size).to eql 1
+      expect(json_result[:monkeys].first[:name]).to eql "Frank the Monkey"
+    end
+  end
+end

data/spec/requests/v1/widgets_spec.rb

@@ -0,0 +1,125 @@
+require 'spec_helper'
+
+describe API::V1::Widgets do
+
+  describe 'GET /health' do
+    it "responds to health" do
+      get "/health"
+      expect(response.status).to eql 200
+    end
+  end
+
+  describe "GET /widgets/:id/:name" do
+    let(:widget) { FactoryGirl.create(:widget) }
+
+    it "validates the name requirement" do
+      req :get, "/widgets/#{widget.id}/named?foo=42"
+      expect(response.status).to eql 422
+    end
+  end
+
+  describe 'POST /widgets' do
+    let(:attrs) { { name: 'New Widget', color: 'orange', radioactive: false, rads: 587 } }
+    before do
+      req :post, "/widgets", { params: MultiJson.dump(attrs) }
+    end
+    it 'succeeds (201)' do
+      expect(response.status).to eql 201
+    end
+    it 'returns the widget' do
+      expect(json_result[:widgets].first).to eql(attrs.merge({ id: 1}))
+    end
+    describe 'PUT /widgets/1' do
+      let(:update_attrs) { { name: 'Updated', color: 'red' } }
+      before do
+        req :post, "/widgets", { params: MultiJson.dump(attrs) }
+        expect(response.status).to eql 201
+        req :put, "/widgets/1", { params: MultiJson.dump(update_attrs) }
+      end
+      it 'succeeds (200)' do
+        expect(response.status).to eql 200
+      end
+      it 'returns the updated widget' do
+        expect(json_result[:widgets].first).to eql(attrs.merge({ id: 1}).merge(update_attrs))
+      end
+    end
+    describe 'PUT /widgets/1 INVALID' do
+      let(:bad_attrs) { { color: 'xxxxxx' } }
+      before do
+        req :put, "/widgets/1", { params: MultiJson.dump(bad_attrs) }
+      end
+      it 'fails (422)' do
+        expect(response.status).to eql 422
+      end
+      it 'responds with a validation error hash' do
+        expect(json_error).to eql({ code: 'UPDATE_WIDGET_FAILED', message: '[UPDATE_WIDGET_FAILED] Resource failed validation. color is not included in the list' })
+      end
+    end
+  end
+
+  describe 'POST /widgets INVALID' do
+    let(:bad_attrs) { { name: 'Bad Widget', color: 'xxxxxx', radioactive: false, rads: 587 } }
+    before do
+      req :post, "/widgets", { params: MultiJson.dump(bad_attrs) }
+    end
+    it 'fails (422)' do
+      expect(response.status).to eql 422
+    end
+    it 'responds with a validation error hash' do
+      expect(json_error).to eql({ code: 'CREATE_WIDGET_FAILED', message: '[CREATE_WIDGET_FAILED] Resource failed validation. color is not included in the list' })
+    end
+  end
+
+  describe "GET /widgets/:id" do
+    let(:widget) { FactoryGirl.create(:widget) }
+
+    it "requires a versioned header request" do
+      get "/widgets/#{widget.id}", {}, { 'Content-Type' => 'application/json' }
+      json = MultiJson.load(response.body, symbolize_keys: true)
+      expect(json_error[:code]).to eql "UNAUTHORIZED"
+      expect(json_error[:message]).to eql "[UNAUTHORIZED] Cannot determine API version from header info."
+      expect(response.status).to eql 401
+    end
+
+    it "returns a widget by id" do
+      req :get, "/widgets/#{widget.id}"
+      expect(response.status).to eql 200
+      expect(json_result[:widgets].size).to eql 1
+      expect(json_result[:widgets].first[:name]).to eql "Magical Widget Alpha"
+    end
+
+    it 'sets the default locale' do
+      req :get, "/widgets/#{widget.id}"
+      expect(I18n.locale).to eql :en
+    end
+
+    describe 'specifying a locale via header' do
+      it "sets the proper locale" do
+        req :get, "/widgets/#{widget.id}", { locale: 'jp' }
+        expect(response.status).to eql 200
+        expect(I18n.locale).to eql :jp
+      end
+    end
+    describe 'specifying a locale via param' do
+      it "sets the proper locale" do
+        req :get, "/widgets/#{widget.id}?locale=es"
+        expect(response.status).to eql 200
+        expect(I18n.locale).to eql :es
+      end
+    end
+  end
+
+  describe 'GET /widgets' do
+    before do
+      3.times { FactoryGirl.create(:widget) }
+    end
+
+    it 'returns a list of widgets' do
+      req :get, "/widgets"
+      expect(response.status).to eql 200
+      expect(json_result[:widgets].size).to eql 3
+      expect(json_result[:widgets].map{|w| w[:id]}.uniq.size).to eql 3
+    end
+  end
+
+end