├── .gitignore
├── .rspec
├── Gemfile
├── Gemfile.lock
├── README.md
├── Rakefile
├── app
├── assets
│ ├── images
│ │ └── .keep
│ ├── javascripts
│ │ └── application.js
│ └── stylesheets
│ │ └── application.css
├── constraints
│ └── api_constraint.rb
├── controllers
│ ├── application_controller.rb
│ ├── articles_controller.rb
│ ├── concerns
│ │ └── .keep
│ ├── v1
│ │ └── articles_controller.rb
│ └── v2
│ │ └── articles_controller.rb
├── helpers
│ └── application_helper.rb
├── mailers
│ └── .keep
├── models
│ ├── .keep
│ └── concerns
│ │ └── .keep
└── views
│ └── layouts
│ └── application.html.erb
├── bin
├── bundle
├── rails
├── rake
├── rspec
└── spring
├── config.ru
├── config
├── application.rb
├── boot.rb
├── database.yml
├── environment.rb
├── environments
│ ├── development.rb
│ ├── production.rb
│ └── test.rb
├── initializers
│ ├── backtrace_silencers.rb
│ ├── cookies_serializer.rb
│ ├── filter_parameter_logging.rb
│ ├── inflections.rb
│ ├── mime_types.rb
│ ├── session_store.rb
│ └── wrap_parameters.rb
├── locales
│ └── en.yml
├── routes.rb
└── secrets.yml
├── db
└── seeds.rb
├── lib
├── assets
│ └── .keep
└── tasks
│ └── .keep
├── log
└── .keep
├── public
├── 404.html
├── 422.html
├── 500.html
├── favicon.ico
└── robots.txt
├── spec
├── constraints
│ └── api_constraint_spec.rb
├── request_spec_helper.rb
├── requests
│ └── articles_spec.rb
└── spec_helper.rb
└── vendor
└── assets
├── javascripts
└── .keep
└── stylesheets
└── .keep
/.gitignore:
--------------------------------------------------------------------------------
1 | # See https://help.github.com/articles/ignoring-files for more about ignoring files.
2 | #
3 | # If you find yourself ignoring temporary files generated by your text editor
4 | # or operating system, you probably want to add a global ignore instead:
5 | # git config --global core.excludesfile '~/.gitignore_global'
6 |
7 | # Ignore bundler config.
8 | /.bundle
9 |
10 | # Ignore the default SQLite database.
11 | /db/*.sqlite3
12 | /db/*.sqlite3-journal
13 |
14 | # Ignore all logfiles and tempfiles.
15 | /log/*.log
16 | /tmp
17 |
--------------------------------------------------------------------------------
/.rspec:
--------------------------------------------------------------------------------
1 | --color
2 | -I app
3 |
--------------------------------------------------------------------------------
/Gemfile:
--------------------------------------------------------------------------------
1 | source 'https://rubygems.org'
2 |
3 |
4 | # Bundle edge Rails instead: gem 'rails', github: 'rails/rails'
5 | gem 'rails', '4.1.0'
6 | # Use sqlite3 as the database for Active Record
7 | gem 'sqlite3'
8 | # Use SCSS for stylesheets
9 | gem 'sass-rails', '~> 4.0.3'
10 | # Use Uglifier as compressor for JavaScript assets
11 | gem 'uglifier', '>= 1.3.0'
12 | # Use CoffeeScript for .js.coffee assets and views
13 | gem 'coffee-rails', '~> 4.0.0'
14 | # See https://github.com/sstephenson/execjs#readme for more supported runtimes
15 | # gem 'therubyracer', platforms: :ruby
16 |
17 | # Use jquery as the JavaScript library
18 | gem 'jquery-rails'
19 | # Turbolinks makes following links in your web application faster. Read more: https://github.com/rails/turbolinks
20 | gem 'turbolinks'
21 | # Build JSON APIs with ease. Read more: https://github.com/rails/jbuilder
22 | gem 'jbuilder', '~> 2.0'
23 | # bundle exec rake doc:rails generates the API under doc/api.
24 | gem 'sdoc', '~> 0.4.0', group: :doc
25 |
26 | # Spring speeds up development by keeping your application running in the background. Read more: https://github.com/rails/spring
27 | gem 'spring', group: :development
28 |
29 | # Use ActiveModel has_secure_password
30 | # gem 'bcrypt', '~> 3.1.7'
31 |
32 | # Use unicorn as the app server
33 | # gem 'unicorn'
34 |
35 | # Use Capistrano for deployment
36 | # gem 'capistrano-rails', group: :development
37 |
38 | # Use debugger
39 | # gem 'debugger', group: [:development, :test]
40 |
41 | gem 'rspec-rails', group: :test
42 |
--------------------------------------------------------------------------------
/Gemfile.lock:
--------------------------------------------------------------------------------
1 | GEM
2 | remote: https://rubygems.org/
3 | specs:
4 | actionmailer (4.1.0)
5 | actionpack (= 4.1.0)
6 | actionview (= 4.1.0)
7 | mail (~> 2.5.4)
8 | actionpack (4.1.0)
9 | actionview (= 4.1.0)
10 | activesupport (= 4.1.0)
11 | rack (~> 1.5.2)
12 | rack-test (~> 0.6.2)
13 | actionview (4.1.0)
14 | activesupport (= 4.1.0)
15 | builder (~> 3.1)
16 | erubis (~> 2.7.0)
17 | activemodel (4.1.0)
18 | activesupport (= 4.1.0)
19 | builder (~> 3.1)
20 | activerecord (4.1.0)
21 | activemodel (= 4.1.0)
22 | activesupport (= 4.1.0)
23 | arel (~> 5.0.0)
24 | activesupport (4.1.0)
25 | i18n (~> 0.6, >= 0.6.9)
26 | json (~> 1.7, >= 1.7.7)
27 | minitest (~> 5.1)
28 | thread_safe (~> 0.1)
29 | tzinfo (~> 1.1)
30 | arel (5.0.0)
31 | builder (3.2.2)
32 | coffee-rails (4.0.1)
33 | coffee-script (>= 2.2.0)
34 | railties (>= 4.0.0, < 5.0)
35 | coffee-script (2.2.0)
36 | coffee-script-source
37 | execjs
38 | coffee-script-source (1.7.0)
39 | diff-lcs (1.2.5)
40 | erubis (2.7.0)
41 | execjs (2.0.2)
42 | hike (1.2.3)
43 | i18n (0.6.9)
44 | jbuilder (2.0.6)
45 | activesupport (>= 3.0.0, < 5)
46 | multi_json (~> 1.2)
47 | jquery-rails (3.1.0)
48 | railties (>= 3.0, < 5.0)
49 | thor (>= 0.14, < 2.0)
50 | json (1.8.1)
51 | mail (2.5.4)
52 | mime-types (~> 1.16)
53 | treetop (~> 1.4.8)
54 | mime-types (1.25.1)
55 | minitest (5.3.2)
56 | multi_json (1.9.2)
57 | polyglot (0.3.4)
58 | rack (1.5.2)
59 | rack-test (0.6.2)
60 | rack (>= 1.0)
61 | rails (4.1.0)
62 | actionmailer (= 4.1.0)
63 | actionpack (= 4.1.0)
64 | actionview (= 4.1.0)
65 | activemodel (= 4.1.0)
66 | activerecord (= 4.1.0)
67 | activesupport (= 4.1.0)
68 | bundler (>= 1.3.0, < 2.0)
69 | railties (= 4.1.0)
70 | sprockets-rails (~> 2.0)
71 | railties (4.1.0)
72 | actionpack (= 4.1.0)
73 | activesupport (= 4.1.0)
74 | rake (>= 0.8.7)
75 | thor (>= 0.18.1, < 2.0)
76 | rake (10.2.2)
77 | rdoc (4.1.1)
78 | json (~> 1.4)
79 | rspec-core (2.14.7)
80 | rspec-expectations (2.14.5)
81 | diff-lcs (>= 1.1.3, < 2.0)
82 | rspec-mocks (2.14.6)
83 | rspec-rails (2.14.1)
84 | actionpack (>= 3.0)
85 | activemodel (>= 3.0)
86 | activesupport (>= 3.0)
87 | railties (>= 3.0)
88 | rspec-core (~> 2.14.0)
89 | rspec-expectations (~> 2.14.0)
90 | rspec-mocks (~> 2.14.0)
91 | sass (3.2.19)
92 | sass-rails (4.0.3)
93 | railties (>= 4.0.0, < 5.0)
94 | sass (~> 3.2.0)
95 | sprockets (~> 2.8, <= 2.11.0)
96 | sprockets-rails (~> 2.0)
97 | sdoc (0.4.0)
98 | json (~> 1.8)
99 | rdoc (~> 4.0, < 5.0)
100 | spring (1.1.2)
101 | sprockets (2.11.0)
102 | hike (~> 1.2)
103 | multi_json (~> 1.0)
104 | rack (~> 1.0)
105 | tilt (~> 1.1, != 1.3.0)
106 | sprockets-rails (2.1.1)
107 | actionpack (>= 3.0)
108 | activesupport (>= 3.0)
109 | sprockets (~> 2.8)
110 | sqlite3 (1.3.9)
111 | thor (0.19.1)
112 | thread_safe (0.3.3)
113 | tilt (1.4.1)
114 | treetop (1.4.15)
115 | polyglot
116 | polyglot (>= 0.3.1)
117 | turbolinks (2.2.2)
118 | coffee-rails
119 | tzinfo (1.1.0)
120 | thread_safe (~> 0.1)
121 | uglifier (2.5.0)
122 | execjs (>= 0.3.0)
123 | json (>= 1.8.0)
124 |
125 | PLATFORMS
126 | ruby
127 |
128 | DEPENDENCIES
129 | coffee-rails (~> 4.0.0)
130 | jbuilder (~> 2.0)
131 | jquery-rails
132 | rails (= 4.1.0)
133 | rspec-rails
134 | sass-rails (~> 4.0.3)
135 | sdoc (~> 0.4.0)
136 | spring
137 | sqlite3
138 | turbolinks
139 | uglifier (>= 1.3.0)
140 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | Rails Versioned API Example
2 | ===========================
3 |
4 | This is an example of establishing API versioning on top of an existing,
5 | unversioned Rails API.
6 |
7 | ## Getting Started
8 |
9 | 1. Clone the repo
10 |
11 | ```
12 | $ git clone git@github.com:iamvery/rails-api-example.git
13 | $ cd rails-api-example
14 | ```
15 |
16 | 2. Install dependencies
17 |
18 | ```
19 | $ bundle install
20 | ```
21 |
22 | 3. Watch the specs pass
23 |
24 | ```
25 | $ bin/rspec
26 | ... 0 failures
27 | ```
28 |
29 | ## Initial implementation
30 |
31 | The initial, unversioned implementation is at https://github.com/iamvery/rails-api-example/tree/initial-api-implementation.
32 | From there the commits incrementally add versioning to the API using HTTP
33 | accept headers with a [vendor internet media type](http://en.wikipedia.org/wiki/Internet_media_type#Vendor_tree).
34 |
35 | ## What's interesting?
36 |
37 | There are few suite spots in this repo (see what I did there?)
38 |
39 | * [Articles v1 controller](app/controllers/v1/articles_controller.rb)
40 | * [Articles v2 controller](app/controllers/v2/articles_controller.rb)
41 | * [Endpoints specs](spec/requests/articles_spec.rb)
42 | * [Routes](config/routes.rb)
43 | * [API Route Constraint](app/constraints/api_constraint.rb)
44 |
--------------------------------------------------------------------------------
/Rakefile:
--------------------------------------------------------------------------------
1 | # Add your own tasks in files placed in lib/tasks ending in .rake,
2 | # for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
3 |
4 | require File.expand_path('../config/application', __FILE__)
5 |
6 | Rails.application.load_tasks
7 |
--------------------------------------------------------------------------------
/app/assets/images/.keep:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/iamvery/rails-api-example/bca42a9912d028e2cf028286657954bd19bf1c1a/app/assets/images/.keep
--------------------------------------------------------------------------------
/app/assets/javascripts/application.js:
--------------------------------------------------------------------------------
1 | // This is a manifest file that'll be compiled into application.js, which will include all the files
2 | // listed below.
3 | //
4 | // Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
5 | // or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
6 | //
7 | // It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
8 | // compiled file.
9 | //
10 | // Read Sprockets README (https://github.com/sstephenson/sprockets#sprockets-directives) for details
11 | // about supported directives.
12 | //
13 | //= require jquery
14 | //= require jquery_ujs
15 | //= require turbolinks
16 | //= require_tree .
17 |
--------------------------------------------------------------------------------
/app/assets/stylesheets/application.css:
--------------------------------------------------------------------------------
1 | /*
2 | * This is a manifest file that'll be compiled into application.css, which will include all the files
3 | * listed below.
4 | *
5 | * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
6 | * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
7 | *
8 | * You're free to add application-wide styles to this file and they'll appear at the bottom of the
9 | * compiled file so the styles you add here take precedence over styles defined in any styles
10 | * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
11 | * file per style scope.
12 | *
13 | *= require_tree .
14 | *= require_self
15 | */
16 |
--------------------------------------------------------------------------------
/app/constraints/api_constraint.rb:
--------------------------------------------------------------------------------
1 | class ApiConstraint
2 | attr_reader :version
3 |
4 | def initialize(options)
5 | @version = options.fetch(:version)
6 | end
7 |
8 | def matches?(request)
9 | request
10 | .headers
11 | .fetch(:accept)
12 | .include?("version=#{version}")
13 | end
14 | end
15 |
--------------------------------------------------------------------------------
/app/controllers/application_controller.rb:
--------------------------------------------------------------------------------
1 | class ApplicationController < ActionController::Base
2 | # Prevent CSRF attacks by raising an exception.
3 | # For APIs, you may want to use :null_session instead.
4 | protect_from_forgery with: :exception
5 | end
6 |
--------------------------------------------------------------------------------
/app/controllers/articles_controller.rb:
--------------------------------------------------------------------------------
1 | class ArticlesController < ApplicationController
2 | def index
3 | articles = [
4 | { id: 123, name: 'The Things' },
5 | ]
6 |
7 | respond_to do |format|
8 | format.json do
9 | render json: articles
10 | end
11 | end
12 | end
13 | end
14 |
--------------------------------------------------------------------------------
/app/controllers/concerns/.keep:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/iamvery/rails-api-example/bca42a9912d028e2cf028286657954bd19bf1c1a/app/controllers/concerns/.keep
--------------------------------------------------------------------------------
/app/controllers/v1/articles_controller.rb:
--------------------------------------------------------------------------------
1 | module V1
2 | class ArticlesController < ApplicationController
3 | def index
4 | articles = [
5 | { id: 123, name: 'The Things' },
6 | ]
7 |
8 | respond_to do |format|
9 | format.any(:articles_json, :json) do
10 | render json: articles
11 | end
12 | end
13 | end
14 | end
15 | end
16 |
--------------------------------------------------------------------------------
/app/controllers/v2/articles_controller.rb:
--------------------------------------------------------------------------------
1 | module V2
2 | class ArticlesController < ApplicationController
3 | def index
4 | articles = [
5 | { id: 123, name: 'The Things' },
6 | ]
7 |
8 | respond_to do |format|
9 | format.any(:articles_json, :json) do
10 | render json: { articles: articles }
11 | end
12 | end
13 | end
14 | end
15 | end
16 |
--------------------------------------------------------------------------------
/app/helpers/application_helper.rb:
--------------------------------------------------------------------------------
1 | module ApplicationHelper
2 | end
3 |
--------------------------------------------------------------------------------
/app/mailers/.keep:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/iamvery/rails-api-example/bca42a9912d028e2cf028286657954bd19bf1c1a/app/mailers/.keep
--------------------------------------------------------------------------------
/app/models/.keep:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/iamvery/rails-api-example/bca42a9912d028e2cf028286657954bd19bf1c1a/app/models/.keep
--------------------------------------------------------------------------------
/app/models/concerns/.keep:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/iamvery/rails-api-example/bca42a9912d028e2cf028286657954bd19bf1c1a/app/models/concerns/.keep
--------------------------------------------------------------------------------
/app/views/layouts/application.html.erb:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | RailsApiExample
5 | <%= stylesheet_link_tag 'application', media: 'all', 'data-turbolinks-track' => true %>
6 | <%= javascript_include_tag 'application', 'data-turbolinks-track' => true %>
7 | <%= csrf_meta_tags %>
8 |
9 |
10 |
11 | <%= yield %>
12 |
13 |
14 |
15 |
--------------------------------------------------------------------------------
/bin/bundle:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env ruby
2 | ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
3 | load Gem.bin_path('bundler', 'bundle')
4 |
--------------------------------------------------------------------------------
/bin/rails:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env ruby
2 | begin
3 | load File.expand_path("../spring", __FILE__)
4 | rescue LoadError
5 | end
6 | APP_PATH = File.expand_path('../../config/application', __FILE__)
7 | require_relative '../config/boot'
8 | require 'rails/commands'
9 |
--------------------------------------------------------------------------------
/bin/rake:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env ruby
2 | begin
3 | load File.expand_path("../spring", __FILE__)
4 | rescue LoadError
5 | end
6 | require_relative '../config/boot'
7 | require 'rake'
8 | Rake.application.run
9 |
--------------------------------------------------------------------------------
/bin/rspec:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env ruby
2 | #
3 | # This file was generated by Bundler.
4 | #
5 | # The application 'rspec' is installed as part of a gem, and
6 | # this file is here to facilitate running it.
7 | #
8 |
9 | require 'pathname'
10 | ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
11 | Pathname.new(__FILE__).realpath)
12 |
13 | require 'rubygems'
14 | require 'bundler/setup'
15 |
16 | load Gem.bin_path('rspec-core', 'rspec')
17 |
--------------------------------------------------------------------------------
/bin/spring:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env ruby
2 |
3 | # This file loads spring without using Bundler, in order to be fast
4 | # It gets overwritten when you run the `spring binstub` command
5 |
6 | unless defined?(Spring)
7 | require "rubygems"
8 | require "bundler"
9 |
10 | if match = Bundler.default_lockfile.read.match(/^GEM$.*?^ spring \((.*?)\)$.*?^$/m)
11 | ENV["GEM_PATH"] = ([Bundler.bundle_path.to_s] + Gem.path).join(File::PATH_SEPARATOR)
12 | ENV["GEM_HOME"] = ""
13 | Gem.paths = ENV
14 |
15 | gem "spring", match[1]
16 | require "spring/binstub"
17 | end
18 | end
19 |
--------------------------------------------------------------------------------
/config.ru:
--------------------------------------------------------------------------------
1 | # This file is used by Rack-based servers to start the application.
2 |
3 | require ::File.expand_path('../config/environment', __FILE__)
4 | run Rails.application
5 |
--------------------------------------------------------------------------------
/config/application.rb:
--------------------------------------------------------------------------------
1 | require File.expand_path('../boot', __FILE__)
2 |
3 | # Pick the frameworks you want:
4 | require "active_model/railtie"
5 | require "active_record/railtie"
6 | require "action_controller/railtie"
7 | require "action_mailer/railtie"
8 | require "action_view/railtie"
9 | require "sprockets/railtie"
10 | # require "rails/test_unit/railtie"
11 |
12 | # Require the gems listed in Gemfile, including any gems
13 | # you've limited to :test, :development, or :production.
14 | Bundler.require(*Rails.groups)
15 |
16 | module RailsApiExample
17 | class Application < Rails::Application
18 | # Settings in config/environments/* take precedence over those specified here.
19 | # Application configuration should go into files in config/initializers
20 | # -- all .rb files in that directory are automatically loaded.
21 |
22 | # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
23 | # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
24 | # config.time_zone = 'Central Time (US & Canada)'
25 |
26 | # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
27 | # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
28 | # config.i18n.default_locale = :de
29 | end
30 | end
31 |
--------------------------------------------------------------------------------
/config/boot.rb:
--------------------------------------------------------------------------------
1 | # Set up gems listed in the Gemfile.
2 | ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
3 |
4 | require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
5 |
--------------------------------------------------------------------------------
/config/database.yml:
--------------------------------------------------------------------------------
1 | # SQLite version 3.x
2 | # gem install sqlite3
3 | #
4 | # Ensure the SQLite 3 gem is defined in your Gemfile
5 | # gem 'sqlite3'
6 | #
7 | default: &default
8 | adapter: sqlite3
9 | pool: 5
10 | timeout: 5000
11 |
12 | development:
13 | <<: *default
14 | database: db/development.sqlite3
15 |
16 | # Warning: The database defined as "test" will be erased and
17 | # re-generated from your development database when you run "rake".
18 | # Do not set this db to the same as development or production.
19 | test:
20 | <<: *default
21 | database: db/test.sqlite3
22 |
23 | production:
24 | <<: *default
25 | database: db/production.sqlite3
26 |
--------------------------------------------------------------------------------
/config/environment.rb:
--------------------------------------------------------------------------------
1 | # Load the Rails application.
2 | require File.expand_path('../application', __FILE__)
3 |
4 | # Initialize the Rails application.
5 | Rails.application.initialize!
6 |
--------------------------------------------------------------------------------
/config/environments/development.rb:
--------------------------------------------------------------------------------
1 | Rails.application.configure do
2 | # Settings specified here will take precedence over those in config/application.rb.
3 |
4 | # In the development environment your application's code is reloaded on
5 | # every request. This slows down response time but is perfect for development
6 | # since you don't have to restart the web server when you make code changes.
7 | config.cache_classes = false
8 |
9 | # Do not eager load code on boot.
10 | config.eager_load = false
11 |
12 | # Show full error reports and disable caching.
13 | config.consider_all_requests_local = true
14 | config.action_controller.perform_caching = false
15 |
16 | # Don't care if the mailer can't send.
17 | config.action_mailer.raise_delivery_errors = false
18 |
19 | # Print deprecation notices to the Rails logger.
20 | config.active_support.deprecation = :log
21 |
22 | # Raise an error on page load if there are pending migrations.
23 | config.active_record.migration_error = :page_load
24 |
25 | # Debug mode disables concatenation and preprocessing of assets.
26 | # This option may cause significant delays in view rendering with a large
27 | # number of complex assets.
28 | config.assets.debug = true
29 |
30 | # Adds additional error checking when serving assets at runtime.
31 | # Checks for improperly declared sprockets dependencies.
32 | # Raises helpful error messages.
33 | config.assets.raise_runtime_errors = true
34 |
35 | # Raises error for missing translations
36 | # config.action_view.raise_on_missing_translations = true
37 | end
38 |
--------------------------------------------------------------------------------
/config/environments/production.rb:
--------------------------------------------------------------------------------
1 | Rails.application.configure do
2 | # Settings specified here will take precedence over those in config/application.rb.
3 |
4 | # Code is not reloaded between requests.
5 | config.cache_classes = true
6 |
7 | # Eager load code on boot. This eager loads most of Rails and
8 | # your application in memory, allowing both threaded web servers
9 | # and those relying on copy on write to perform better.
10 | # Rake tasks automatically ignore this option for performance.
11 | config.eager_load = true
12 |
13 | # Full error reports are disabled and caching is turned on.
14 | config.consider_all_requests_local = false
15 | config.action_controller.perform_caching = true
16 |
17 | # Enable Rack::Cache to put a simple HTTP cache in front of your application
18 | # Add `rack-cache` to your Gemfile before enabling this.
19 | # For large-scale production use, consider using a caching reverse proxy like nginx, varnish or squid.
20 | # config.action_dispatch.rack_cache = true
21 |
22 | # Disable Rails's static asset server (Apache or nginx will already do this).
23 | config.serve_static_assets = false
24 |
25 | # Compress JavaScripts and CSS.
26 | config.assets.js_compressor = :uglifier
27 | # config.assets.css_compressor = :sass
28 |
29 | # Do not fallback to assets pipeline if a precompiled asset is missed.
30 | config.assets.compile = false
31 |
32 | # Generate digests for assets URLs.
33 | config.assets.digest = true
34 |
35 | # Version of your assets, change this if you want to expire all your assets.
36 | config.assets.version = '1.0'
37 |
38 | # Specifies the header that your server uses for sending files.
39 | # config.action_dispatch.x_sendfile_header = "X-Sendfile" # for apache
40 | # config.action_dispatch.x_sendfile_header = 'X-Accel-Redirect' # for nginx
41 |
42 | # Force all access to the app over SSL, use Strict-Transport-Security, and use secure cookies.
43 | # config.force_ssl = true
44 |
45 | # Set to :debug to see everything in the log.
46 | config.log_level = :info
47 |
48 | # Prepend all log lines with the following tags.
49 | # config.log_tags = [ :subdomain, :uuid ]
50 |
51 | # Use a different logger for distributed setups.
52 | # config.logger = ActiveSupport::TaggedLogging.new(SyslogLogger.new)
53 |
54 | # Use a different cache store in production.
55 | # config.cache_store = :mem_cache_store
56 |
57 | # Enable serving of images, stylesheets, and JavaScripts from an asset server.
58 | # config.action_controller.asset_host = "http://assets.example.com"
59 |
60 | # Precompile additional assets.
61 | # application.js, application.css, and all non-JS/CSS in app/assets folder are already added.
62 | # config.assets.precompile += %w( search.js )
63 |
64 | # Ignore bad email addresses and do not raise email delivery errors.
65 | # Set this to true and configure the email server for immediate delivery to raise delivery errors.
66 | # config.action_mailer.raise_delivery_errors = false
67 |
68 | # Enable locale fallbacks for I18n (makes lookups for any locale fall back to
69 | # the I18n.default_locale when a translation cannot be found).
70 | config.i18n.fallbacks = true
71 |
72 | # Send deprecation notices to registered listeners.
73 | config.active_support.deprecation = :notify
74 |
75 | # Disable automatic flushing of the log to improve performance.
76 | # config.autoflush_log = false
77 |
78 | # Use default logging formatter so that PID and timestamp are not suppressed.
79 | config.log_formatter = ::Logger::Formatter.new
80 |
81 | # Do not dump schema after migrations.
82 | config.active_record.dump_schema_after_migration = false
83 | end
84 |
--------------------------------------------------------------------------------
/config/environments/test.rb:
--------------------------------------------------------------------------------
1 | Rails.application.configure do
2 | # Settings specified here will take precedence over those in config/application.rb.
3 |
4 | # The test environment is used exclusively to run your application's
5 | # test suite. You never need to work with it otherwise. Remember that
6 | # your test database is "scratch space" for the test suite and is wiped
7 | # and recreated between test runs. Don't rely on the data there!
8 | config.cache_classes = true
9 |
10 | # Do not eager load code on boot. This avoids loading your whole application
11 | # just for the purpose of running a single test. If you are using a tool that
12 | # preloads Rails for running tests, you may have to set it to true.
13 | config.eager_load = false
14 |
15 | # Configure static asset server for tests with Cache-Control for performance.
16 | config.serve_static_assets = true
17 | config.static_cache_control = 'public, max-age=3600'
18 |
19 | # Show full error reports and disable caching.
20 | config.consider_all_requests_local = true
21 | config.action_controller.perform_caching = false
22 |
23 | # Raise exceptions instead of rendering exception templates.
24 | config.action_dispatch.show_exceptions = false
25 |
26 | # Disable request forgery protection in test environment.
27 | config.action_controller.allow_forgery_protection = false
28 |
29 | # Tell Action Mailer not to deliver emails to the real world.
30 | # The :test delivery method accumulates sent emails in the
31 | # ActionMailer::Base.deliveries array.
32 | config.action_mailer.delivery_method = :test
33 |
34 | # Print deprecation notices to the stderr.
35 | config.active_support.deprecation = :stderr
36 |
37 | # Raises error for missing translations
38 | # config.action_view.raise_on_missing_translations = true
39 | end
40 |
--------------------------------------------------------------------------------
/config/initializers/backtrace_silencers.rb:
--------------------------------------------------------------------------------
1 | # Be sure to restart your server when you modify this file.
2 |
3 | # You can add backtrace silencers for libraries that you're using but don't wish to see in your backtraces.
4 | # Rails.backtrace_cleaner.add_silencer { |line| line =~ /my_noisy_library/ }
5 |
6 | # You can also remove all the silencers if you're trying to debug a problem that might stem from framework code.
7 | # Rails.backtrace_cleaner.remove_silencers!
8 |
--------------------------------------------------------------------------------
/config/initializers/cookies_serializer.rb:
--------------------------------------------------------------------------------
1 | # Be sure to restart your server when you modify this file.
2 |
3 | Rails.application.config.action_dispatch.cookies_serializer = :json
--------------------------------------------------------------------------------
/config/initializers/filter_parameter_logging.rb:
--------------------------------------------------------------------------------
1 | # Be sure to restart your server when you modify this file.
2 |
3 | # Configure sensitive parameters which will be filtered from the log file.
4 | Rails.application.config.filter_parameters += [:password]
5 |
--------------------------------------------------------------------------------
/config/initializers/inflections.rb:
--------------------------------------------------------------------------------
1 | # Be sure to restart your server when you modify this file.
2 |
3 | # Add new inflection rules using the following format. Inflections
4 | # are locale specific, and you may define rules for as many different
5 | # locales as you wish. All of these examples are active by default:
6 | # ActiveSupport::Inflector.inflections(:en) do |inflect|
7 | # inflect.plural /^(ox)$/i, '\1en'
8 | # inflect.singular /^(ox)en/i, '\1'
9 | # inflect.irregular 'person', 'people'
10 | # inflect.uncountable %w( fish sheep )
11 | # end
12 |
13 | # These inflection rules are supported but not enabled by default:
14 | # ActiveSupport::Inflector.inflections(:en) do |inflect|
15 | # inflect.acronym 'RESTful'
16 | # end
17 |
--------------------------------------------------------------------------------
/config/initializers/mime_types.rb:
--------------------------------------------------------------------------------
1 | Mime::Type.register 'application/vnd.articles+json', :articles_json
2 |
--------------------------------------------------------------------------------
/config/initializers/session_store.rb:
--------------------------------------------------------------------------------
1 | # Be sure to restart your server when you modify this file.
2 |
3 | Rails.application.config.session_store :cookie_store, key: '_rails-api-example_session'
4 |
--------------------------------------------------------------------------------
/config/initializers/wrap_parameters.rb:
--------------------------------------------------------------------------------
1 | # Be sure to restart your server when you modify this file.
2 |
3 | # This file contains settings for ActionController::ParamsWrapper which
4 | # is enabled by default.
5 |
6 | # Enable parameter wrapping for JSON. You can disable this by setting :format to an empty array.
7 | ActiveSupport.on_load(:action_controller) do
8 | wrap_parameters format: [:json] if respond_to?(:wrap_parameters)
9 | end
10 |
11 | # To enable root element in JSON for ActiveRecord objects.
12 | # ActiveSupport.on_load(:active_record) do
13 | # self.include_root_in_json = true
14 | # end
15 |
--------------------------------------------------------------------------------
/config/locales/en.yml:
--------------------------------------------------------------------------------
1 | # Files in the config/locales directory are used for internationalization
2 | # and are automatically loaded by Rails. If you want to use locales other
3 | # than English, add the necessary files in this directory.
4 | #
5 | # To use the locales, use `I18n.t`:
6 | #
7 | # I18n.t 'hello'
8 | #
9 | # In views, this is aliased to just `t`:
10 | #
11 | # <%= t('hello') %>
12 | #
13 | # To use a different locale, set it with `I18n.locale`:
14 | #
15 | # I18n.locale = :es
16 | #
17 | # This would use the information in config/locales/es.yml.
18 | #
19 | # To learn more, please read the Rails Internationalization guide
20 | # available at http://guides.rubyonrails.org/i18n.html.
21 |
22 | en:
23 | hello: "Hello world"
24 |
--------------------------------------------------------------------------------
/config/routes.rb:
--------------------------------------------------------------------------------
1 | Rails.application.routes.draw do
2 | def api_version(version, &routes)
3 | api_constraint = ApiConstraint.new(version: version)
4 | scope(module: "v#{version}", constraints: api_constraint, &routes)
5 | end
6 |
7 | api_version(1) do
8 | resources :articles, only: :index
9 | end
10 |
11 | api_version(2) do
12 | resources :articles, only: :index
13 | end
14 | end
15 |
--------------------------------------------------------------------------------
/config/secrets.yml:
--------------------------------------------------------------------------------
1 | # Be sure to restart your server when you modify this file.
2 |
3 | # Your secret key is used for verifying the integrity of signed cookies.
4 | # If you change this key, all old signed cookies will become invalid!
5 |
6 | # Make sure the secret is at least 30 characters and all random,
7 | # no regular words or you'll be exposed to dictionary attacks.
8 | # You can use `rake secret` to generate a secure secret key.
9 |
10 | # Make sure the secrets in this file are kept private
11 | # if you're sharing your code publicly.
12 |
13 | development:
14 | secret_key_base: 3aa3813a720c78c7d23aec6d54c10941f710a29fb02837707c2652df805759204e245de90cba4c150d26d3412b6abf9b9c04db4977d2b0114892cdffe96ca21b
15 |
16 | test:
17 | secret_key_base: ce27e42cf530490c9a5ecf3df3543899dfd55a7eae26d36920dd15c4ba355e98c63518a9e14a579045cb6656262da521ad4ec060a1aa2fd93a3e4667dabaa5d9
18 |
19 | # Do not keep production secrets in the repository,
20 | # instead read values from the environment.
21 | production:
22 | secret_key_base: <%= ENV["SECRET_KEY_BASE"] %>
23 |
--------------------------------------------------------------------------------
/db/seeds.rb:
--------------------------------------------------------------------------------
1 | # This file should contain all the record creation needed to seed the database with its default values.
2 | # The data can then be loaded with the rake db:seed (or created alongside the db with db:setup).
3 | #
4 | # Examples:
5 | #
6 | # cities = City.create([{ name: 'Chicago' }, { name: 'Copenhagen' }])
7 | # Mayor.create(name: 'Emanuel', city: cities.first)
8 |
--------------------------------------------------------------------------------
/lib/assets/.keep:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/iamvery/rails-api-example/bca42a9912d028e2cf028286657954bd19bf1c1a/lib/assets/.keep
--------------------------------------------------------------------------------
/lib/tasks/.keep:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/iamvery/rails-api-example/bca42a9912d028e2cf028286657954bd19bf1c1a/lib/tasks/.keep
--------------------------------------------------------------------------------
/log/.keep:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/iamvery/rails-api-example/bca42a9912d028e2cf028286657954bd19bf1c1a/log/.keep
--------------------------------------------------------------------------------
/public/404.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | The page you were looking for doesn't exist (404)
5 |
6 |
55 |
56 |
57 |
58 |
59 |
60 |
61 |
The page you were looking for doesn't exist.
62 |
You may have mistyped the address or the page may have moved.
63 |
64 |
If you are the application owner check the logs for more information.
65 |
66 |
67 |
68 |
--------------------------------------------------------------------------------
/public/422.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | The change you wanted was rejected (422)
5 |
6 |
55 |
56 |
57 |
58 |
59 |
60 |
61 |
The change you wanted was rejected.
62 |
Maybe you tried to change something you didn't have access to.
63 |
64 |
If you are the application owner check the logs for more information.
65 |
66 |
67 |
68 |
--------------------------------------------------------------------------------
/public/500.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | We're sorry, but something went wrong (500)
5 |
6 |
55 |
56 |
57 |
58 |
59 |
60 |
61 |
We're sorry, but something went wrong.
62 |
63 |
If you are the application owner check the logs for more information.
64 |
65 |
66 |
67 |
--------------------------------------------------------------------------------
/public/favicon.ico:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/iamvery/rails-api-example/bca42a9912d028e2cf028286657954bd19bf1c1a/public/favicon.ico
--------------------------------------------------------------------------------
/public/robots.txt:
--------------------------------------------------------------------------------
1 | # See http://www.robotstxt.org/robotstxt.html for documentation on how to use the robots.txt file
2 | #
3 | # To ban all spiders from the entire site uncomment the next two lines:
4 | # User-agent: *
5 | # Disallow: /
6 |
--------------------------------------------------------------------------------
/spec/constraints/api_constraint_spec.rb:
--------------------------------------------------------------------------------
1 | require 'spec_helper'
2 | require 'constraints/api_constraint'
3 |
4 | describe ApiConstraint do
5 | let(:request){ double :request }
6 |
7 | describe '#matches?' do
8 | let(:version){ 1 }
9 |
10 | subject(:constraint){ described_class.new(version: version) }
11 |
12 | def header_for_version(version)
13 | "version=#{version}"
14 | end
15 |
16 | it 'matches requests including the versioned vendor mime type' do
17 | headers = { accept: header_for_version(version) }
18 | request.stub(headers: headers)
19 |
20 | expect(constraint.matches?(request)).to be_true
21 | end
22 |
23 | it 'does not match requests for other versions' do
24 | headers = { accept: header_for_version(version+1) }
25 | request.stub(headers: headers)
26 |
27 | expect(constraint.matches?(request)).to be_false
28 | end
29 | end
30 | end
31 |
--------------------------------------------------------------------------------
/spec/request_spec_helper.rb:
--------------------------------------------------------------------------------
1 | # This file is copied to spec/ when you run 'rails generate rspec:install'
2 | ENV["RAILS_ENV"] ||= 'test'
3 | require File.expand_path("../../config/environment", __FILE__)
4 | require 'rspec/rails'
5 | require 'rspec/autorun'
6 |
7 | # Requires supporting ruby files with custom matchers and macros, etc,
8 | # in spec/support/ and its subdirectories.
9 | Dir[Rails.root.join("spec/support/**/*.rb")].each { |f| require f }
10 |
11 | # Checks for pending migrations before tests are run.
12 | # If you are not using ActiveRecord, you can remove this line.
13 | ActiveRecord::Migration.check_pending! if defined?(ActiveRecord::Migration)
14 |
15 | RSpec.configure do |config|
16 | config.fixture_path = "#{::Rails.root}/spec/fixtures"
17 | config.use_transactional_fixtures = true
18 | config.infer_base_class_for_anonymous_controllers = false
19 | end
20 |
--------------------------------------------------------------------------------
/spec/requests/articles_spec.rb:
--------------------------------------------------------------------------------
1 | require 'request_spec_helper'
2 |
3 | describe 'articles endpoint' do
4 | describe 'GET #index' do
5 | describe 'v1' do
6 | it 'responds with an array of articles' do
7 | get '/articles', {}, HTTP_ACCEPT: 'application/vnd.articles+json; version=1'
8 |
9 | json = JSON.parse(response.body)
10 |
11 | # these values are hard-coded in the controller as example
12 | expect(json.count).to eq(1)
13 | expect(json.first['name']).to eq('The Things')
14 | end
15 |
16 | it 'accepts requests with .json suffix' do
17 | get '/articles.json', {}, HTTP_ACCEPT: 'application/vnd.articles+json; version=1'
18 |
19 | json = JSON.parse(response.body)
20 |
21 | expect(json.count).to eq(1)
22 | expect(json.first['name']).to eq('The Things')
23 | end
24 | end
25 |
26 | describe 'v2' do
27 | it 'responds with an array of articles under a root node' do
28 | get '/articles', {}, HTTP_ACCEPT: 'application/vnd.articles+json; version=2'
29 |
30 | json = JSON.parse(response.body)
31 | articles = json.fetch('articles')
32 |
33 | # these values are hard-coded in the controller as example
34 | expect(articles.count).to eq(1)
35 | expect(articles.first['name']).to eq('The Things')
36 | end
37 |
38 | it 'accepts requests with .json suffix' do
39 | get '/articles.json', {}, HTTP_ACCEPT: 'application/vnd.articles+json; version=2'
40 |
41 | json = JSON.parse(response.body)
42 | articles = json.fetch('articles')
43 |
44 | expect(articles.count).to eq(1)
45 | expect(articles.first['name']).to eq('The Things')
46 | end
47 | end
48 | end
49 | end
50 |
--------------------------------------------------------------------------------
/spec/spec_helper.rb:
--------------------------------------------------------------------------------
1 | require 'rspec/core'
2 |
3 | RSpec.configure do |config|
4 | config.order = "random"
5 | end
6 |
--------------------------------------------------------------------------------
/vendor/assets/javascripts/.keep:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/iamvery/rails-api-example/bca42a9912d028e2cf028286657954bd19bf1c1a/vendor/assets/javascripts/.keep
--------------------------------------------------------------------------------
/vendor/assets/stylesheets/.keep:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/iamvery/rails-api-example/bca42a9912d028e2cf028286657954bd19bf1c1a/vendor/assets/stylesheets/.keep
--------------------------------------------------------------------------------