Api

Gemfile

@@ -44,7 +44,7 @@ gem 'will_paginate',            '~> 3.0.5'
 gem 'delayed_paperclip',        '~> 2.6.1'                        # asyncronous image processing
 gem 'devise',                   '~> 3.2.2'
 gem 'hashie',                   '~> 2.0.5'
-gem 'paperclip',                '~> 3.5.0'                        # easy object attachment with s3 storage
+gem 'paperclip',                '~> 4.1.1'
 gem 'ruby-progressbar',         '~> 1.4.2'
 
 # operations
@@ -62,6 +62,9 @@ gem 'pg',                       '~> 0.17'
 # gem 'sidekiq-failures',         '~> 0.3'
 # gem 'sinatra',                  '~> 1.4.4'
 
+# API
+gem "apipie-rails",             "~> 0.0.24"
+
 group :development do
   gem 'awesome_print'
   gem 'better_errors'

Gemfile.lock

@@ -44,6 +44,8 @@ GEM
       thread_safe (~> 0.1)
       tzinfo (~> 1.1)
     addressable (2.3.6)
+    apipie-rails (0.0.24)
+      rails (>= 3.0.10)
     arel (5.0.1.20140414130214)
     asset_sync (1.0.0)
       activemodel
@@ -251,7 +253,7 @@ GEM
     nokogiri (1.6.2.1)
       mini_portile (= 0.6.0)
     orm_adapter (0.5.0)
-    paperclip (3.5.4)
+    paperclip (4.1.1)
       activemodel (>= 3.0.0)
       activesupport (>= 3.0.0)
       cocaine (~> 0.5.3)
@@ -376,7 +378,7 @@ GEM
       eventmachine (>= 1.0.0)
       rack (>= 1.0.0)
     thor (0.19.1)
-    thread_safe (0.3.3)
+    thread_safe (0.3.4)
     tilt (1.4.1)
     timers (1.1.0)
     tins (1.3.0)
@@ -396,7 +398,7 @@ GEM
       polyglot (>= 0.3.1)
     typhoeus (0.6.8)
       ethon (>= 0.7.0)
-    tzinfo (1.1.0)
+    tzinfo (1.2.0)
       thread_safe (~> 0.1)
     uglifier (2.1.2)
       execjs (>= 0.3.0)
@@ -419,6 +421,7 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
+  apipie-rails (~> 0.0.24)
   asset_sync (~> 1.0.0)
   awesome_print
   aws-sdk (~> 1.30.0)
@@ -452,7 +455,7 @@ DEPENDENCIES
   mailcatcher
   modernizr-rails (~> 2.6.2.3)
   newrelic_rpm (~> 3.7)
-  paperclip (~> 3.5.0)
+  paperclip (~> 4.1.1)
   pg (~> 0.17)
   pry-nav
   pry-rails

app/controllers/api/base_controller.rb

@@ -0,0 +1,46 @@
+class Api::BaseController < ApplicationController
+  protect_from_forgery with: :null_session
+  layout false
+  respond_to :json
+
+  rescue_from Exception, with: :internal_error
+  rescue_from Timeout::Error, with: :timeout
+  rescue_from Rack::Timeout::Error, with: :timeout
+  rescue_from ActiveRecord::RecordNotFound, with: :not_found
+
+  protected
+    def bad_request
+      return render "api/errors/bad_request", status: 400
+    end
+    def conflict
+      return render "api/errors/conflict", status: 409
+    end
+    def forbidden
+      return render "api/errors/forbidden", status: 403
+    end
+    def internal_error(exception)
+      return render "api/errors/internal_error", status: 500
+    end
+    def invalid_resource
+      return render "api/errors/invalid_resource", status: 400
+    end
+    def invalid_version
+      return render "api/errors/invalid_version", status: 400
+    end
+    def not_found(exception)
+      return render "api/errors/not_found", status: 404
+    end
+    def throttled
+      return render "api/errors/throttled", status: 429
+    end
+    def timeout(exception)
+      # If the timeout occured during the middle of a persistence layer query, we need to cancel the
+      # query so that a "closed connection" exception isn't raised in the middle
+      # of the next request that executes a query
+      ActiveRecord::Base.connection.reset!
+      return render "api/errors/timeout", status: 503
+    end
+    def unauthenticated
+      return render "api/errors/unauthenticated", status: 401
+    end
+end

app/controllers/api/v1/lapses_controller.rb

@@ -0,0 +1,46 @@
+class Api::V1::LapsesController < Api::BaseController
+  before_action :set_lapse, only: [:show, :update, :destroy]
+
+  def index
+    @lapses = Lapse.all
+  end
+
+  def show
+    render 'api/v1/lapses/show', status: 200
+  end
+
+  def create
+    @lapse = Lapse.new(lapse_params)
+    if @lapse.save
+      render 'api/v1/lapses/show', status: 201
+    else
+      @resourceful_errors = @lapse.errors.full_messages
+      render 'api/errors/resourceful_error', status: 422
+    end
+  end
+
+  def update
+    if @lapse.update(lapse_params)
+      render 'api/v1/lapses/show', status: 200
+    else
+      @resourceful_errors = @lapse.errors.full_messages
+      render 'api/errors/resourceful_error', status: 422
+    end
+  end
+
+  def destroy
+    @lapse.destroy
+    render json: { message: success_message }, status: 200
+  end
+
+  private
+    def set_lapse
+      @lapse = Lapse.find(params[:id])
+    end
+
+    def lapse_params
+      {
+        name: params[:name]
+      }
+    end
+end

app/controllers/api/v1/moments_controller.rb

@@ -0,0 +1,41 @@
+class Api::V1::MomentsController <  Api::BaseController
+  before_action :set_moment, only: [:show, :destroy]
+  before_action :current_lapse, only: [:create]
+
+  def index
+    @moments = Moment.all
+  end
+
+  def show
+    render 'api/v1/moments/show', status: 200
+  end
+
+  def create
+    @moment = Moment.new(moment_params)
+    @moment.lapse = @lapse
+    if @moment.save
+      render 'api/v1/moments/show', status: 201
+    else
+      @resourceful_errors = @moment.errors.full_messages
+      render 'api/errors/resourceful_error', status: 422
+    end
+  end
+
+  def destroy
+    @moment.destroy
+    render json: { message: success_message }, status: 200
+  end
+
+  private
+    def set_moment
+      @moment = Moment.find(params[:id])
+    end
+
+    def current_lapse
+      @lapse = Lapse.find(params[:lapse_id])
+    end
+
+    def moment_params
+      { active: params[:active] }
+    end
+end

app/controllers/application_controller.rb

@@ -1,6 +1,6 @@
 class ApplicationController < ActionController::Base
   include ResourcefulMessages
-  protect_from_forgery
+  protect_from_forgery with: :exception
 
   if Rails.application.config.consider_all_requests_local == false
     # note: these are rescued from bottom (most specific) to top (least)

app/models/lapse.rb

@@ -0,0 +1,7 @@
+class Lapse < ActiveRecord::Base
+
+  has_many :moments, dependent: :destroy
+
+  validates :name, presence: true
+
+end

app/models/moment.rb

@@ -0,0 +1,11 @@
+class Moment < ActiveRecord::Base
+
+  belongs_to :lapse
+  has_attached_file :image, styles: { medium: "300x300>", thumb: "100x100>" }
+
+  validates_attachment_content_type :image, content_type: /\Aimage\/.*\Z/
+  # validates :image, presence: true
+  validates :lapse, presence: true
+  validates :active, presence: true
+
+end

app/views/api/errors/bad_request.rabl

@@ -0,0 +1,2 @@
+object false
+node(:error) { I18n.t(:bad_request, scope: "api.errors") }

app/views/api/errors/conflict.rabl

@@ -0,0 +1,2 @@
+object false
+node(:error) { I18n.t(:conflict, scope: "api.errors") }

app/views/api/errors/forbidden.rabl

@@ -0,0 +1,2 @@
+object false
+node(:error) { I18n.t(:forbidden, scope: "api.errors") }

app/views/api/errors/internal_error.rabl

@@ -0,0 +1,2 @@
+object false
+node(:error) { I18n.t(:internal_error, scope: "api.errors") }

app/views/api/errors/invalid_resource.rabl

@@ -0,0 +1,2 @@
+object false
+node(:error) { I18n.t(:invalid_resource, scope: "api.errors") }

app/views/api/errors/invalid_version.rabl

@@ -0,0 +1,2 @@
+object false
+node(:error) { I18n.t(:invalid_version, scope: "api.errors") }

app/views/api/errors/not_found.rabl

@@ -0,0 +1,2 @@
+object false
+node(:error) { I18n.t(:not_found, scope: "api.errors") }

app/views/api/errors/resourceful_error.rabl

@@ -0,0 +1,2 @@
+object false
+node(:error) { @resourceful_errors }

app/views/api/errors/throttled.rabl

@@ -0,0 +1,2 @@
+object false
+node(:error) { I18n.t(:throttled, scope: "api.errors") }

app/views/api/errors/unauthenticated.rabl

@@ -0,0 +1,2 @@
+object false
+node(:error) { I18n.t(:unauthenticated, scope: "api.errors") }

app/views/api/v1/lapses/index.rabl

@@ -0,0 +1,2 @@
+collection @lapses
+attributes :id, :name

app/views/api/v1/lapses/show.rabl

@@ -0,0 +1,2 @@
+object @lapse
+attributes :id, :name

app/views/api/v1/moments/index.rabl

@@ -0,0 +1,2 @@
+collection @moments
+attributes :id, :active

app/views/api/v1/moments/show.rabl

@@ -0,0 +1,2 @@
+object @moment
+attributes :id, :active

config/initializers/apipie.rb

@@ -0,0 +1,14 @@
+Apipie.configure do |config|
+  config.app_name = "RailsBaseApp"
+  config.app_info = "This is an example api."
+  config.copyright = ""
+  config.api_base_url = "1"
+  config.api_controllers_matcher = "#{Rails.root}/app/controllers/api/**/*.rb"
+  config.ignored_by_recorder = %w[]
+  config.doc_base_url = "/"
+  config.use_cache = Rails.env.production?
+  config.validate = false
+  config.force_dsl = true
+  config.reload_controllers = Rails.env.development?
+  config.default_version = "v1"
+end

config/initializers/rabl_init.rb

@@ -0,0 +1,28 @@
+# config/initializers/rabl_init.rb
+require 'rabl'
+Rabl.configure do |config|
+  # Commented as these are defaults
+  # config.cache_all_output = false
+  # config.cache_sources = Rails.env != 'development' # Defaults to false
+  # config.cache_engine = Rabl::CacheEngine.new # Defaults to Rails cache
+  # config.perform_caching = false
+  # config.escape_all_output = false
+  # config.json_engine = nil # Class with #dump class method (defaults JSON)
+  # config.msgpack_engine = nil # Defaults to ::MessagePack
+  # config.bson_engine = nil # Defaults to ::BSON
+  # config.plist_engine = nil # Defaults to ::Plist::Emit
+  # config.include_json_root = true
+  # config.include_msgpack_root = true
+  # config.include_bson_root = true
+  # config.include_plist_root = true
+  # config.include_xml_root  = false
+  # config.include_child_root = true
+  # config.enable_json_callbacks = false
+  # config.xml_options = { :dasherize  => true, :skip_types => false }
+  # config.view_paths = []
+  # config.raise_on_missing_attribute = true # Defaults to false
+  # config.replace_nil_values_with_empty_strings = true # Defaults to false
+  # config.replace_empty_string_values_with_nil_values = true # Defaults to false
+  # config.exclude_nil_values = true # Defaults to false
+  # config.exclude_empty_values_in_collections = true # Defaults to false
+end

config/locales/en.yml

@@ -2,7 +2,18 @@
 # See https://github.com/svenfuchs/rails-i18n/tree/master/rails%2Flocale for starting points.
 
 en:
-  hello: "Hello world"
+  api:
+    errors:
+      bad_request:      "The data given to this server does not meet our criteria."
+      conflict:         "The request conflicts with an existing resource."
+      forbidden:        "The action you requested was forbidden."
+      internal_error:   "Something has gone wrong."
+      invalid_resource: "The current resource was deemed invalid."
+      invalid_version:  "This action is not available in the given version of the api."
+      not_found:        "The requested resource could not be found."
+      throttled:        "You have gone over your allotted amount of requests and have been throttled."
+      timeout:          "A timeout has occurred."
+      unauthenticated:  "This action requires authentication to continue."
 
   actioncontroller:
     # override these default messages by defining

config/routes.rb

@@ -1,12 +1,22 @@
 require 'constraints/production_path_constraint'
+require 'constraints/api_constraints'
 
 RailsBaseApp::Application.routes.draw do
 
+  # api*
+  constraints subdomain: /\Aapi/ do
+    # apipie
+    scope module: "api/v1", constraints: ApiConstraints.new(version: 1, default: true) do
+      resources :lapses, only: [:index, :show, :create, :update, :destroy], shallow: true do
+        resources :moments, only: [:index, :show, :create, :destroy]
+      end
+    end
+  end
+
   root              to: 'pages#home'
   get   'timeout',  to: 'pages#timeout'
 
   # catch rest of production paths with 404 page
   match '*path',    to: 'pages#not_found', via: [:get, :post],
                                         constraints: ProductionPathConstraint.new
-
 end

db/migrate/20140529205817_create_lapses.rb

@@ -0,0 +1,8 @@
+class CreateLapses < ActiveRecord::Migration
+  def change
+    create_table :lapses do |t|
+      t.string :name
+      t.timestamps
+    end
+  end
+end

db/migrate/20140529205934_create_moments.rb

@@ -0,0 +1,8 @@
+class CreateMoments < ActiveRecord::Migration
+  def change
+    create_table :moments do |t|
+      t.integer :lapse_id
+      t.timestamps
+    end
+  end
+end