├── Gemfile ├── Gemfile.lock ├── README.md ├── Rakefile ├── app ├── channels │ └── application_cable │ │ ├── channel.rb │ │ └── connection.rb ├── controllers │ ├── api │ │ └── v1 │ │ │ └── articles_controller.rb │ ├── application_controller.rb │ └── concerns │ │ └── .keep ├── jobs │ └── application_job.rb ├── mailers │ └── application_mailer.rb ├── models │ ├── application_record.rb │ ├── article.rb │ └── concerns │ │ └── .keep └── views │ └── layouts │ ├── mailer.html.erb │ └── mailer.text.erb ├── bin ├── bundle ├── rails ├── rake ├── setup └── update ├── config.ru ├── config ├── application.rb ├── boot.rb ├── cable.yml ├── database.yml ├── environment.rb ├── environments │ ├── development.rb │ ├── production.rb │ └── test.rb ├── initializers │ ├── application_controller_renderer.rb │ ├── backtrace_silencers.rb │ ├── cors.rb │ ├── filter_parameter_logging.rb │ ├── inflections.rb │ ├── mime_types.rb │ └── wrap_parameters.rb ├── locales │ └── en.yml ├── puma.rb ├── routes.rb └── secrets.yml ├── db ├── migrate │ └── 20170627160121_create_articles.rb ├── schema.rb └── seeds.rb ├── lib └── tasks │ └── .keep ├── log ├── .keep └── development.log ├── public └── robots.txt ├── test ├── controllers │ └── .keep ├── fixtures │ ├── .keep │ ├── articles.yml │ └── files │ │ └── .keep ├── integration │ └── .keep ├── mailers │ └── .keep ├── models │ ├── .keep │ └── article_test.rb └── test_helper.rb ├── tmp ├── .keep ├── pids │ └── server.pid └── restart.txt └── vendor └── .keep /Gemfile: -------------------------------------------------------------------------------- 1 | source 'https://rubygems.org' 2 | 3 | git_source(:github) do |repo_name| 4 | repo_name = "#{repo_name}/#{repo_name}" unless repo_name.include?("/") 5 | "https://github.com/#{repo_name}.git" 6 | end 7 | 8 | 9 | # Bundle edge Rails instead: gem 'rails', github: 'rails/rails' 10 | gem 'rails', '~> 5.1.2' 11 | # gem 'sqlite3' 12 | gem 'mysql2' 13 | gem 'puma', '~> 3.7' 14 | 15 | group :development, :test do 16 | # Call 'byebug' anywhere in the code to stop execution and get a debugger console 17 | gem 'byebug', platforms: [:mri, :mingw, :x64_mingw] 18 | end 19 | 20 | group :development do 21 | gem 'faker' 22 | end 23 | 24 | # Windows does not include zoneinfo files, so bundle the tzinfo-data gem 25 | gem 'tzinfo-data', platforms: [:mingw, :mswin, :x64_mingw, :jruby] 26 | -------------------------------------------------------------------------------- /Gemfile.lock: -------------------------------------------------------------------------------- 1 | GEM 2 | remote: https://rubygems.org/ 3 | specs: 4 | actioncable (5.1.2) 5 | actionpack (= 5.1.2) 6 | nio4r (~> 2.0) 7 | websocket-driver (~> 0.6.1) 8 | actionmailer (5.1.2) 9 | actionpack (= 5.1.2) 10 | actionview (= 5.1.2) 11 | activejob (= 5.1.2) 12 | mail (~> 2.5, >= 2.5.4) 13 | rails-dom-testing (~> 2.0) 14 | actionpack (5.1.2) 15 | actionview (= 5.1.2) 16 | activesupport (= 5.1.2) 17 | rack (~> 2.0) 18 | rack-test (~> 0.6.3) 19 | rails-dom-testing (~> 2.0) 20 | rails-html-sanitizer (~> 1.0, >= 1.0.2) 21 | actionview (5.1.2) 22 | activesupport (= 5.1.2) 23 | builder (~> 3.1) 24 | erubi (~> 1.4) 25 | rails-dom-testing (~> 2.0) 26 | rails-html-sanitizer (~> 1.0, >= 1.0.3) 27 | activejob (5.1.2) 28 | activesupport (= 5.1.2) 29 | globalid (>= 0.3.6) 30 | activemodel (5.1.2) 31 | activesupport (= 5.1.2) 32 | activerecord (5.1.2) 33 | activemodel (= 5.1.2) 34 | activesupport (= 5.1.2) 35 | arel (~> 8.0) 36 | activesupport (5.1.2) 37 | concurrent-ruby (~> 1.0, >= 1.0.2) 38 | i18n (~> 0.7) 39 | minitest (~> 5.1) 40 | tzinfo (~> 1.1) 41 | arel (8.0.0) 42 | builder (3.2.3) 43 | byebug (9.0.6) 44 | concurrent-ruby (1.0.5) 45 | erubi (1.6.0) 46 | faker (1.7.3) 47 | i18n (~> 0.5) 48 | globalid (0.4.0) 49 | activesupport (>= 4.2.0) 50 | i18n (0.8.4) 51 | loofah (2.0.3) 52 | nokogiri (>= 1.5.9) 53 | mail (2.6.6) 54 | mime-types (>= 1.16, < 4) 55 | method_source (0.8.2) 56 | mime-types (3.1) 57 | mime-types-data (~> 3.2015) 58 | mime-types-data (3.2016.0521) 59 | mini_portile2 (2.2.0) 60 | minitest (5.10.2) 61 | mysql2 (0.4.6-x86-mingw32) 62 | nio4r (2.1.0) 63 | nokogiri (1.8.0-x86-mingw32) 64 | mini_portile2 (~> 2.2.0) 65 | puma (3.9.1) 66 | rack (2.0.3) 67 | rack-test (0.6.3) 68 | rack (>= 1.0) 69 | rails (5.1.2) 70 | actioncable (= 5.1.2) 71 | actionmailer (= 5.1.2) 72 | actionpack (= 5.1.2) 73 | actionview (= 5.1.2) 74 | activejob (= 5.1.2) 75 | activemodel (= 5.1.2) 76 | activerecord (= 5.1.2) 77 | activesupport (= 5.1.2) 78 | bundler (>= 1.3.0, < 2.0) 79 | railties (= 5.1.2) 80 | sprockets-rails (>= 2.0.0) 81 | rails-dom-testing (2.0.3) 82 | activesupport (>= 4.2.0) 83 | nokogiri (>= 1.6) 84 | rails-html-sanitizer (1.0.3) 85 | loofah (~> 2.0) 86 | railties (5.1.2) 87 | actionpack (= 5.1.2) 88 | activesupport (= 5.1.2) 89 | method_source 90 | rake (>= 0.8.7) 91 | thor (>= 0.18.1, < 2.0) 92 | rake (12.0.0) 93 | sprockets (3.7.1) 94 | concurrent-ruby (~> 1.0) 95 | rack (> 1, < 3) 96 | sprockets-rails (3.2.0) 97 | actionpack (>= 4.0) 98 | activesupport (>= 4.0) 99 | sprockets (>= 3.0.0) 100 | thor (0.19.4) 101 | thread_safe (0.3.6) 102 | tzinfo (1.2.3) 103 | thread_safe (~> 0.1) 104 | tzinfo-data (1.2017.2) 105 | tzinfo (>= 1.0.0) 106 | websocket-driver (0.6.5) 107 | websocket-extensions (>= 0.1.0) 108 | websocket-extensions (0.1.2) 109 | 110 | PLATFORMS 111 | x86-mingw32 112 | 113 | DEPENDENCIES 114 | byebug 115 | faker 116 | mysql2 117 | puma (~> 3.7) 118 | rails (~> 5.1.2) 119 | tzinfo-data 120 | 121 | BUNDLED WITH 122 | 1.13.7 123 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # SIMPLE RAILS 5 REST API 2 | 3 | Example of a basic REST API to perform CRUD functions. Uses MySQL by default. Please add your own database and credentials 4 | 5 | ## INSTALL DEPENDENCIES 6 | ```bash 7 | $ bundle install 8 | ``` 9 | 10 | ## RUN MIGRATION 11 | ```bash 12 | $ rails db:migrate 13 | ``` 14 | 15 | ## RUN SERVER 16 | ```bash 17 | $ rails s 18 | ``` 19 | 20 | 21 | -------------------------------------------------------------------------------- /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_relative 'config/application' 5 | 6 | Rails.application.load_tasks 7 | -------------------------------------------------------------------------------- /app/channels/application_cable/channel.rb: -------------------------------------------------------------------------------- 1 | module ApplicationCable 2 | class Channel < ActionCable::Channel::Base 3 | end 4 | end 5 | -------------------------------------------------------------------------------- /app/channels/application_cable/connection.rb: -------------------------------------------------------------------------------- 1 | module ApplicationCable 2 | class Connection < ActionCable::Connection::Base 3 | end 4 | end 5 | -------------------------------------------------------------------------------- /app/controllers/api/v1/articles_controller.rb: -------------------------------------------------------------------------------- 1 | module Api 2 | module V1 3 | class ArticlesController < ApplicationController 4 | def index 5 | articles = Article.order('created_at DESC'); 6 | render json: {status: 'SUCCESS', message:'Loaded articles', data:articles},status: :ok 7 | end 8 | 9 | def show 10 | article = Article.find(params[:id]) 11 | render json: {status: 'SUCCESS', message:'Loaded article', data:article},status: :ok 12 | end 13 | 14 | def create 15 | article = Article.new(article_params) 16 | 17 | if article.save 18 | render json: {status: 'SUCCESS', message:'Saved article', data:article},status: :ok 19 | else 20 | render json: {status: 'ERROR', message:'Article not saved', data:article.errors},status: :unprocessable_entity 21 | end 22 | end 23 | 24 | def destroy 25 | article = Article.find(params[:id]) 26 | article.destroy 27 | render json: {status: 'SUCCESS', message:'Deleted article', data:article},status: :ok 28 | end 29 | 30 | def update 31 | article = Article.find(params[:id]) 32 | if article.update_attributes(article_params) 33 | render json: {status: 'SUCCESS', message:'Updated article', data:article},status: :ok 34 | else 35 | render json: {status: 'ERROR', message:'Article not updated', data:article.errors},status: :unprocessable_entity 36 | end 37 | end 38 | 39 | private 40 | 41 | def article_params 42 | params.permit(:title, :body) 43 | end 44 | end 45 | end 46 | end 47 | -------------------------------------------------------------------------------- /app/controllers/application_controller.rb: -------------------------------------------------------------------------------- 1 | class ApplicationController < ActionController::API 2 | end 3 | -------------------------------------------------------------------------------- /app/controllers/concerns/.keep: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bradtraversy/simple-rails-rest/76b015aafa2fe32fcf210893ffcfb0bc5c1220f8/app/controllers/concerns/.keep -------------------------------------------------------------------------------- /app/jobs/application_job.rb: -------------------------------------------------------------------------------- 1 | class ApplicationJob < ActiveJob::Base 2 | end 3 | -------------------------------------------------------------------------------- /app/mailers/application_mailer.rb: -------------------------------------------------------------------------------- 1 | class ApplicationMailer < ActionMailer::Base 2 | default from: 'from@example.com' 3 | layout 'mailer' 4 | end 5 | -------------------------------------------------------------------------------- /app/models/application_record.rb: -------------------------------------------------------------------------------- 1 | class ApplicationRecord < ActiveRecord::Base 2 | self.abstract_class = true 3 | end 4 | -------------------------------------------------------------------------------- /app/models/article.rb: -------------------------------------------------------------------------------- 1 | class Article < ApplicationRecord 2 | validates :title, presence: true 3 | validates :body, presence: true 4 | end 5 | -------------------------------------------------------------------------------- /app/models/concerns/.keep: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bradtraversy/simple-rails-rest/76b015aafa2fe32fcf210893ffcfb0bc5c1220f8/app/models/concerns/.keep -------------------------------------------------------------------------------- /app/views/layouts/mailer.html.erb: -------------------------------------------------------------------------------- 1 | 2 | 3 |
4 | 5 | 8 | 9 | 10 | 11 | <%= yield %> 12 | 13 | 14 | -------------------------------------------------------------------------------- /app/views/layouts/mailer.text.erb: -------------------------------------------------------------------------------- 1 | <%= yield %> 2 | -------------------------------------------------------------------------------- /bin/bundle: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env ruby.exe 2 | ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__) 3 | load Gem.bin_path('bundler', 'bundle') 4 | -------------------------------------------------------------------------------- /bin/rails: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env ruby.exe 2 | APP_PATH = File.expand_path('../config/application', __dir__) 3 | require_relative '../config/boot' 4 | require 'rails/commands' 5 | -------------------------------------------------------------------------------- /bin/rake: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env ruby.exe 2 | require_relative '../config/boot' 3 | require 'rake' 4 | Rake.application.run 5 | -------------------------------------------------------------------------------- /bin/setup: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env ruby.exe 2 | require 'pathname' 3 | require 'fileutils' 4 | include FileUtils 5 | 6 | # path to your application root. 7 | APP_ROOT = Pathname.new File.expand_path('../../', __FILE__) 8 | 9 | def system!(*args) 10 | system(*args) || abort("\n== Command #{args} failed ==") 11 | end 12 | 13 | chdir APP_ROOT do 14 | # This script is a starting point to setup your application. 15 | # Add necessary setup steps to this file. 16 | 17 | puts '== Installing dependencies ==' 18 | system! 'gem install bundler --conservative' 19 | system('bundle check') || system!('bundle install') 20 | 21 | 22 | # puts "\n== Copying sample files ==" 23 | # unless File.exist?('config/database.yml') 24 | # cp 'config/database.yml.sample', 'config/database.yml' 25 | # end 26 | 27 | puts "\n== Preparing database ==" 28 | system! 'bin/rails db:setup' 29 | 30 | puts "\n== Removing old logs and tempfiles ==" 31 | system! 'bin/rails log:clear tmp:clear' 32 | 33 | puts "\n== Restarting application server ==" 34 | system! 'bin/rails restart' 35 | end 36 | -------------------------------------------------------------------------------- /bin/update: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env ruby.exe 2 | require 'pathname' 3 | require 'fileutils' 4 | include FileUtils 5 | 6 | # path to your application root. 7 | APP_ROOT = Pathname.new File.expand_path('../../', __FILE__) 8 | 9 | def system!(*args) 10 | system(*args) || abort("\n== Command #{args} failed ==") 11 | end 12 | 13 | chdir APP_ROOT do 14 | # This script is a way to update your development environment automatically. 15 | # Add necessary update steps to this file. 16 | 17 | puts '== Installing dependencies ==' 18 | system! 'gem install bundler --conservative' 19 | system('bundle check') || system!('bundle install') 20 | 21 | puts "\n== Updating database ==" 22 | system! 'bin/rails db:migrate' 23 | 24 | puts "\n== Removing old logs and tempfiles ==" 25 | system! 'bin/rails log:clear tmp:clear' 26 | 27 | puts "\n== Restarting application server ==" 28 | system! 'bin/rails restart' 29 | end 30 | -------------------------------------------------------------------------------- /config.ru: -------------------------------------------------------------------------------- 1 | # This file is used by Rack-based servers to start the application. 2 | 3 | require_relative 'config/environment' 4 | 5 | run Rails.application 6 | -------------------------------------------------------------------------------- /config/application.rb: -------------------------------------------------------------------------------- 1 | require_relative 'boot' 2 | 3 | require "rails" 4 | # Pick the frameworks you want: 5 | require "active_model/railtie" 6 | require "active_job/railtie" 7 | require "active_record/railtie" 8 | require "action_controller/railtie" 9 | require "action_mailer/railtie" 10 | require "action_view/railtie" 11 | require "action_cable/engine" 12 | # require "sprockets/railtie" 13 | require "rails/test_unit/railtie" 14 | 15 | # Require the gems listed in Gemfile, including any gems 16 | # you've limited to :test, :development, or :production. 17 | Bundler.require(*Rails.groups) 18 | 19 | module Myarticles 20 | class Application < Rails::Application 21 | # Initialize configuration defaults for originally generated Rails version. 22 | config.load_defaults 5.1 23 | 24 | # Settings in config/environments/* take precedence over those specified here. 25 | # Application configuration should go into files in config/initializers 26 | # -- all .rb files in that directory are automatically loaded. 27 | 28 | # Only loads a smaller set of middleware suitable for API only apps. 29 | # Middleware like session, flash, cookies can be added back manually. 30 | # Skip views, helpers and assets when generating a new resource. 31 | config.api_only = true 32 | end 33 | end 34 | -------------------------------------------------------------------------------- /config/boot.rb: -------------------------------------------------------------------------------- 1 | ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../Gemfile', __dir__) 2 | 3 | require 'bundler/setup' # Set up gems listed in the Gemfile. 4 | -------------------------------------------------------------------------------- /config/cable.yml: -------------------------------------------------------------------------------- 1 | development: 2 | adapter: async 3 | 4 | test: 5 | adapter: async 6 | 7 | production: 8 | adapter: redis 9 | url: redis://localhost:6379/1 10 | channel_prefix: myarticles_production 11 | -------------------------------------------------------------------------------- /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: mysql2 9 | username: root 10 | password: 123456 11 | pool: <%= ENV.fetch("RAILS_MAX_THREADS") { 5 } %> 12 | timeout: 5000 13 | 14 | development: 15 | <<: *default 16 | database: myarticles 17 | 18 | # Warning: The database defined as "test" will be erased and 19 | # re-generated from your development database when you run "rake". 20 | # Do not set this db to the same as development or production. 21 | test: 22 | <<: *default 23 | database: myarticles 24 | 25 | production: 26 | <<: *default 27 | database: myarticles 28 | -------------------------------------------------------------------------------- /config/environment.rb: -------------------------------------------------------------------------------- 1 | # Load the Rails application. 2 | require_relative 'application' 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. 13 | config.consider_all_requests_local = true 14 | 15 | # Enable/disable caching. By default caching is disabled. 16 | if Rails.root.join('tmp/caching-dev.txt').exist? 17 | config.action_controller.perform_caching = true 18 | 19 | config.cache_store = :memory_store 20 | config.public_file_server.headers = { 21 | 'Cache-Control' => "public, max-age=#{2.days.seconds.to_i}" 22 | } 23 | else 24 | config.action_controller.perform_caching = false 25 | 26 | config.cache_store = :null_store 27 | end 28 | 29 | # Don't care if the mailer can't send. 30 | config.action_mailer.raise_delivery_errors = false 31 | 32 | config.action_mailer.perform_caching = false 33 | 34 | # Print deprecation notices to the Rails logger. 35 | config.active_support.deprecation = :log 36 | 37 | # Raise an error on page load if there are pending migrations. 38 | config.active_record.migration_error = :page_load 39 | 40 | 41 | # Raises error for missing translations 42 | # config.action_view.raise_on_missing_translations = true 43 | 44 | # Use an evented file watcher to asynchronously detect changes in source code, 45 | # routes, locales, etc. This feature depends on the listen gem. 46 | # config.file_watcher = ActiveSupport::EventedFileUpdateChecker 47 | end 48 | -------------------------------------------------------------------------------- /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 | # Attempt to read encrypted secrets from `config/secrets.yml.enc`. 18 | # Requires an encryption key in `ENV["RAILS_MASTER_KEY"]` or 19 | # `config/secrets.yml.key`. 20 | config.read_encrypted_secrets = true 21 | 22 | # Disable serving static files from the `/public` folder by default since 23 | # Apache or NGINX already handles this. 24 | config.public_file_server.enabled = ENV['RAILS_SERVE_STATIC_FILES'].present? 25 | 26 | 27 | # Enable serving of images, stylesheets, and JavaScripts from an asset server. 28 | # config.action_controller.asset_host = 'http://assets.example.com' 29 | 30 | # Specifies the header that your server uses for sending files. 31 | # config.action_dispatch.x_sendfile_header = 'X-Sendfile' # for Apache 32 | # config.action_dispatch.x_sendfile_header = 'X-Accel-Redirect' # for NGINX 33 | 34 | # Mount Action Cable outside main process or domain 35 | # config.action_cable.mount_path = nil 36 | # config.action_cable.url = 'wss://example.com/cable' 37 | # config.action_cable.allowed_request_origins = [ 'http://example.com', /http:\/\/example.*/ ] 38 | 39 | # Force all access to the app over SSL, use Strict-Transport-Security, and use secure cookies. 40 | # config.force_ssl = true 41 | 42 | # Use the lowest log level to ensure availability of diagnostic information 43 | # when problems arise. 44 | config.log_level = :debug 45 | 46 | # Prepend all log lines with the following tags. 47 | config.log_tags = [ :request_id ] 48 | 49 | # Use a different cache store in production. 50 | # config.cache_store = :mem_cache_store 51 | 52 | # Use a real queuing backend for Active Job (and separate queues per environment) 53 | # config.active_job.queue_adapter = :resque 54 | # config.active_job.queue_name_prefix = "myarticles_#{Rails.env}" 55 | config.action_mailer.perform_caching = false 56 | 57 | # Ignore bad email addresses and do not raise email delivery errors. 58 | # Set this to true and configure the email server for immediate delivery to raise delivery errors. 59 | # config.action_mailer.raise_delivery_errors = false 60 | 61 | # Enable locale fallbacks for I18n (makes lookups for any locale fall back to 62 | # the I18n.default_locale when a translation cannot be found). 63 | config.i18n.fallbacks = true 64 | 65 | # Send deprecation notices to registered listeners. 66 | config.active_support.deprecation = :notify 67 | 68 | # Use default logging formatter so that PID and timestamp are not suppressed. 69 | config.log_formatter = ::Logger::Formatter.new 70 | 71 | # Use a different logger for distributed setups. 72 | # require 'syslog/logger' 73 | # config.logger = ActiveSupport::TaggedLogging.new(Syslog::Logger.new 'app-name') 74 | 75 | if ENV["RAILS_LOG_TO_STDOUT"].present? 76 | logger = ActiveSupport::Logger.new(STDOUT) 77 | logger.formatter = config.log_formatter 78 | config.logger = ActiveSupport::TaggedLogging.new(logger) 79 | end 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 public file server for tests with Cache-Control for performance. 16 | config.public_file_server.enabled = true 17 | config.public_file_server.headers = { 18 | 'Cache-Control' => "public, max-age=#{1.hour.seconds.to_i}" 19 | } 20 | 21 | # Show full error reports and disable caching. 22 | config.consider_all_requests_local = true 23 | config.action_controller.perform_caching = false 24 | 25 | # Raise exceptions instead of rendering exception templates. 26 | config.action_dispatch.show_exceptions = false 27 | 28 | # Disable request forgery protection in test environment. 29 | config.action_controller.allow_forgery_protection = false 30 | config.action_mailer.perform_caching = false 31 | 32 | # Tell Action Mailer not to deliver emails to the real world. 33 | # The :test delivery method accumulates sent emails in the 34 | # ActionMailer::Base.deliveries array. 35 | config.action_mailer.delivery_method = :test 36 | 37 | # Print deprecation notices to the stderr. 38 | config.active_support.deprecation = :stderr 39 | 40 | # Raises error for missing translations 41 | # config.action_view.raise_on_missing_translations = true 42 | end 43 | -------------------------------------------------------------------------------- /config/initializers/application_controller_renderer.rb: -------------------------------------------------------------------------------- 1 | # Be sure to restart your server when you modify this file. 2 | 3 | # ApplicationController.renderer.defaults.merge!( 4 | # http_host: 'example.org', 5 | # https: false 6 | # ) 7 | -------------------------------------------------------------------------------- /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/cors.rb: -------------------------------------------------------------------------------- 1 | # Be sure to restart your server when you modify this file. 2 | 3 | # Avoid CORS issues when API is called from the frontend app. 4 | # Handle Cross-Origin Resource Sharing (CORS) in order to accept cross-origin AJAX requests. 5 | 6 | # Read more: https://github.com/cyu/rack-cors 7 | 8 | # Rails.application.config.middleware.insert_before 0, Rack::Cors do 9 | # allow do 10 | # origins 'example.com' 11 | # 12 | # resource '*', 13 | # headers: :any, 14 | # methods: [:get, :post, :put, :patch, :delete, :options, :head] 15 | # end 16 | # end 17 | -------------------------------------------------------------------------------- /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 | # Be sure to restart your server when you modify this file. 2 | 3 | # Add new mime types for use in respond_to blocks: 4 | # Mime::Type.register "text/richtext", :rtf 5 | -------------------------------------------------------------------------------- /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] 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 | # The following keys must be escaped otherwise they will not be retrieved by 20 | # the default I18n backend: 21 | # 22 | # true, false, on, off, yes, no 23 | # 24 | # Instead, surround them with single quotes. 25 | # 26 | # en: 27 | # 'true': 'foo' 28 | # 29 | # To learn more, please read the Rails Internationalization guide 30 | # available at http://guides.rubyonrails.org/i18n.html. 31 | 32 | en: 33 | hello: "Hello world" 34 | -------------------------------------------------------------------------------- /config/puma.rb: -------------------------------------------------------------------------------- 1 | # Puma can serve each request in a thread from an internal thread pool. 2 | # The `threads` method setting takes two numbers: a minimum and maximum. 3 | # Any libraries that use thread pools should be configured to match 4 | # the maximum value specified for Puma. Default is set to 5 threads for minimum 5 | # and maximum; this matches the default thread size of Active Record. 6 | # 7 | threads_count = ENV.fetch("RAILS_MAX_THREADS") { 5 } 8 | threads threads_count, threads_count 9 | 10 | # Specifies the `port` that Puma will listen on to receive requests; default is 3000. 11 | # 12 | port ENV.fetch("PORT") { 3000 } 13 | 14 | # Specifies the `environment` that Puma will run in. 15 | # 16 | environment ENV.fetch("RAILS_ENV") { "development" } 17 | 18 | # Specifies the number of `workers` to boot in clustered mode. 19 | # Workers are forked webserver processes. If using threads and workers together 20 | # the concurrency of the application would be max `threads` * `workers`. 21 | # Workers do not work on JRuby or Windows (both of which do not support 22 | # processes). 23 | # 24 | # workers ENV.fetch("WEB_CONCURRENCY") { 2 } 25 | 26 | # Use the `preload_app!` method when specifying a `workers` number. 27 | # This directive tells Puma to first boot the application and load code 28 | # before forking the application. This takes advantage of Copy On Write 29 | # process behavior so workers use less memory. If you use this option 30 | # you need to make sure to reconnect any threads in the `on_worker_boot` 31 | # block. 32 | # 33 | # preload_app! 34 | 35 | # If you are preloading your application and using Active Record, it's 36 | # recommended that you close any connections to the database before workers 37 | # are forked to prevent connection leakage. 38 | # 39 | # before_fork do 40 | # ActiveRecord::Base.connection_pool.disconnect! if defined?(ActiveRecord) 41 | # end 42 | 43 | # The code in the `on_worker_boot` will be called if you are using 44 | # clustered mode by specifying a number of `workers`. After each worker 45 | # process is booted, this block will be run. If you are using the `preload_app!` 46 | # option, you will want to use this block to reconnect to any threads 47 | # or connections that may have been created at application boot, as Ruby 48 | # cannot share connections between processes. 49 | # 50 | # on_worker_boot do 51 | # ActiveRecord::Base.establish_connection if defined?(ActiveRecord) 52 | # end 53 | # 54 | 55 | # Allow puma to be restarted by `rails restart` command. 56 | plugin :tmp_restart 57 | -------------------------------------------------------------------------------- /config/routes.rb: -------------------------------------------------------------------------------- 1 | Rails.application.routes.draw do 2 | namespace 'api' do 3 | namespace 'v1' do 4 | resources :articles 5 | end 6 | end 7 | end 8 | -------------------------------------------------------------------------------- /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 `rails 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 | # Shared secrets are available across all environments. 14 | 15 | # shared: 16 | # api_key: a1B2c3D4e5F6 17 | 18 | # Environmental secrets are only available for that specific environment. 19 | 20 | development: 21 | secret_key_base: fb97e152ba17fe31f7873d6ac5929620fe87dd0c306139bf43462d5f59bb1c0bb10ad92c915fa53b426970be7ef4682f06c7aac7df31693c45a3ae9cdf909b87 22 | 23 | test: 24 | secret_key_base: 6434f5c6d694a2d43321fde7d9715abcea8256bc5baaf82a43e2c3e036f4f20ac80d284b36cf6dd607380df14e59c50148917d6c0e9a75f7c14ffa1b09300ba4 25 | 26 | # Do not keep production secrets in the unencrypted secrets file. 27 | # Instead, either read values from the environment. 28 | # Or, use `bin/rails secrets:setup` to configure encrypted secrets 29 | # and move the `production:` environment over there. 30 | 31 | production: 32 | secret_key_base: <%= ENV["SECRET_KEY_BASE"] %> 33 | -------------------------------------------------------------------------------- /db/migrate/20170627160121_create_articles.rb: -------------------------------------------------------------------------------- 1 | class CreateArticles < ActiveRecord::Migration[5.1] 2 | def change 3 | create_table :articles do |t| 4 | t.string :title 5 | t.text :body 6 | 7 | t.timestamps 8 | end 9 | end 10 | end 11 | -------------------------------------------------------------------------------- /db/schema.rb: -------------------------------------------------------------------------------- 1 | # This file is auto-generated from the current state of the database. Instead 2 | # of editing this file, please use the migrations feature of Active Record to 3 | # incrementally modify your database, and then regenerate this schema definition. 4 | # 5 | # Note that this schema.rb definition is the authoritative source for your 6 | # database schema. If you need to create the application database on another 7 | # system, you should be using db:schema:load, not running all the migrations 8 | # from scratch. The latter is a flawed and unsustainable approach (the more migrations 9 | # you'll amass, the slower it'll run and the greater likelihood for issues). 10 | # 11 | # It's strongly recommended that you check this file into your version control system. 12 | 13 | ActiveRecord::Schema.define(version: 20170627160121) do 14 | 15 | create_table "articles", force: :cascade, options: "ENGINE=InnoDB DEFAULT CHARSET=latin1" do |t| 16 | t.string "title" 17 | t.text "body" 18 | t.datetime "created_at", null: false 19 | t.datetime "updated_at", null: false 20 | end 21 | 22 | end 23 | -------------------------------------------------------------------------------- /db/seeds.rb: -------------------------------------------------------------------------------- 1 | 5.times do 2 | Article.create({ 3 | title: Faker::Book.title, 4 | body: Faker::Lorem.sentence 5 | }) 6 | end 7 | -------------------------------------------------------------------------------- /lib/tasks/.keep: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bradtraversy/simple-rails-rest/76b015aafa2fe32fcf210893ffcfb0bc5c1220f8/lib/tasks/.keep -------------------------------------------------------------------------------- /log/.keep: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bradtraversy/simple-rails-rest/76b015aafa2fe32fcf210893ffcfb0bc5c1220f8/log/.keep -------------------------------------------------------------------------------- /log/development.log: -------------------------------------------------------------------------------- 1 | Started GET "/" for 127.0.0.1 at 2017-06-27 11:59:37 -0400 2 | Processing by Rails::WelcomeController#index as HTML 3 | Rendering C:/RailsInstaller/Ruby2.3.0/lib/ruby/gems/2.3.0/gems/railties-5.1.2/lib/rails/templates/rails/welcome/index.html.erb 4 | Rendered C:/RailsInstaller/Ruby2.3.0/lib/ruby/gems/2.3.0/gems/railties-5.1.2/lib/rails/templates/rails/welcome/index.html.erb (5.0ms) 5 | Completed 200 OK in 468ms (Views: 28.7ms) 6 | 7 | 8 | [1m[35m (0.0ms)[0m [1m[35mSET @@SESSION.sql_mode = CONCAT(CONCAT(@@sql_mode, ',STRICT_ALL_TABLES'), ',NO_AUTO_VALUE_ON_ZERO'), @@SESSION.sql_auto_is_null = 0, @@SESSION.wait_timeout = 2147483[0m 9 | [1m[35m (22.6ms)[0m [1m[35mCREATE TABLE `schema_migrations` (`version` varchar(255) NOT NULL PRIMARY KEY) ENGINE=InnoDB[0m 10 | [1m[35m (19.1ms)[0m [1m[35mCREATE TABLE `ar_internal_metadata` (`key` varchar(255) NOT NULL PRIMARY KEY, `value` varchar(255), `created_at` datetime NOT NULL, `updated_at` datetime NOT NULL) ENGINE=InnoDB[0m 11 | [1m[35m (0.0ms)[0m [1m[34mSELECT DATABASE() as db[0m 12 | [1m[35m (0.0ms)[0m [1m[34mSELECT GET_LOCK(2253939812606074005, 0)[0m 13 | [1m[35m (0.0ms)[0m [1m[34mSELECT `schema_migrations`.`version` FROM `schema_migrations` ORDER BY `schema_migrations`.`version` ASC[0m 14 | Migrating to CreateArticles (20170627160121) 15 | [1m[35m (19.6ms)[0m [1m[35mCREATE TABLE `articles` (`id` bigint NOT NULL AUTO_INCREMENT PRIMARY KEY, `title` varchar(255), `body` text, `created_at` datetime NOT NULL, `updated_at` datetime NOT NULL) ENGINE=InnoDB[0m 16 | [1m[35m (0.0ms)[0m [1m[35mBEGIN[0m 17 | [1m[35mSQL (0.5ms)[0m [1m[32mINSERT INTO `schema_migrations` (`version`) VALUES ('20170627160121')[0m 18 | [1m[35m (1.0ms)[0m [1m[35mCOMMIT[0m 19 | [1m[36mActiveRecord::InternalMetadata Load (0.0ms)[0m [1m[34mSELECT `ar_internal_metadata`.* FROM `ar_internal_metadata` WHERE `ar_internal_metadata`.`key` = 'environment' LIMIT 1[0m 20 | [1m[35m (0.5ms)[0m [1m[35mBEGIN[0m 21 | [1m[35mSQL (0.5ms)[0m [1m[32mINSERT INTO `ar_internal_metadata` (`key`, `value`, `created_at`, `updated_at`) VALUES ('environment', 'development', '2017-06-27 16:02:36', '2017-06-27 16:02:36')[0m 22 | [1m[35m (1.0ms)[0m [1m[35mCOMMIT[0m 23 | [1m[35m (0.0ms)[0m [1m[34mSELECT RELEASE_LOCK(2253939812606074005)[0m 24 | [1m[35m (0.0ms)[0m [1m[34mSELECT `schema_migrations`.`version` FROM `schema_migrations` ORDER BY `schema_migrations`.`version` ASC[0m 25 | [1m[35m (0.0ms)[0m [1m[35mSHOW CREATE TABLE `articles`[0m 26 | [1m[35m (0.5ms)[0m [1m[35mSHOW TABLE STATUS LIKE 'articles'[0m 27 | [1m[35m (0.5ms)[0m [1m[35mSET @@SESSION.sql_mode = CONCAT(CONCAT(@@sql_mode, ',STRICT_ALL_TABLES'), ',NO_AUTO_VALUE_ON_ZERO'), @@SESSION.sql_auto_is_null = 0, @@SESSION.wait_timeout = 2147483[0m 28 | [1m[35m (0.0ms)[0m [1m[34mSELECT `schema_migrations`.`version` FROM `schema_migrations` ORDER BY `schema_migrations`.`version` ASC[0m 29 | [1m[35m (0.0ms)[0m [1m[35mSET @@SESSION.sql_mode = CONCAT(CONCAT(@@sql_mode, ',STRICT_ALL_TABLES'), ',NO_AUTO_VALUE_ON_ZERO'), @@SESSION.sql_auto_is_null = 0, @@SESSION.wait_timeout = 2147483[0m 30 | [1m[35m (0.0ms)[0m [1m[34mSELECT `schema_migrations`.`version` FROM `schema_migrations` ORDER BY `schema_migrations`.`version` ASC[0m 31 | [1m[35m (0.0ms)[0m [1m[35mBEGIN[0m 32 | [1m[35mSQL (0.5ms)[0m [1m[32mINSERT INTO `articles` (`title`, `body`, `created_at`, `updated_at`) VALUES ('Mr Standfast', 'Expedita praesentium error laboriosam vitae repellat quasi et ex.', '2017-06-27 16:09:46', '2017-06-27 16:09:46')[0m 33 | [1m[35m (1.5ms)[0m [1m[35mCOMMIT[0m 34 | [1m[35m (0.0ms)[0m [1m[35mBEGIN[0m 35 | [1m[35mSQL (0.5ms)[0m [1m[32mINSERT INTO `articles` (`title`, `body`, `created_at`, `updated_at`) VALUES ('The Torment of Others', 'At ex labore quo veritatis ab.', '2017-06-27 16:09:46', '2017-06-27 16:09:46')[0m 36 | [1m[35m (1.0ms)[0m [1m[35mCOMMIT[0m 37 | [1m[35m (0.0ms)[0m [1m[35mBEGIN[0m 38 | [1m[35mSQL (0.5ms)[0m [1m[32mINSERT INTO `articles` (`title`, `body`, `created_at`, `updated_at`) VALUES ('Of Human Bondage', 'Dicta deleniti omnis a.', '2017-06-27 16:09:46', '2017-06-27 16:09:46')[0m 39 | [1m[35m (1.0ms)[0m [1m[35mCOMMIT[0m 40 | [1m[35m (0.0ms)[0m [1m[35mBEGIN[0m 41 | [1m[35mSQL (0.5ms)[0m [1m[32mINSERT INTO `articles` (`title`, `body`, `created_at`, `updated_at`) VALUES ('A Swiftly Tilting Planet', 'Odio perspiciatis quisquam corporis possimus.', '2017-06-27 16:09:46', '2017-06-27 16:09:46')[0m 42 | [1m[35m (0.5ms)[0m [1m[35mCOMMIT[0m 43 | [1m[35m (0.0ms)[0m [1m[35mBEGIN[0m 44 | [1m[35mSQL (0.5ms)[0m [1m[32mINSERT INTO `articles` (`title`, `body`, `created_at`, `updated_at`) VALUES ('Rosemary Sutcliff', 'Sequi aut aut similique.', '2017-06-27 16:09:46', '2017-06-27 16:09:46')[0m 45 | [1m[35m (1.0ms)[0m [1m[35mCOMMIT[0m 46 | Started GET "/api/v1/articles" for 127.0.0.1 at 2017-06-27 12:22:47 -0400 47 | [1m[35m (0.0ms)[0m [1m[35mSET @@SESSION.sql_mode = CONCAT(CONCAT(@@sql_mode, ',STRICT_ALL_TABLES'), ',NO_AUTO_VALUE_ON_ZERO'), @@SESSION.sql_auto_is_null = 0, @@SESSION.wait_timeout = 2147483[0m 48 | [1m[35m (0.0ms)[0m [1m[34mSELECT `schema_migrations`.`version` FROM `schema_migrations` ORDER BY `schema_migrations`.`version` ASC[0m 49 | 50 | SyntaxError (C:/Sites/myarticles/app/controllers/api/v1/articles_controller.rb:2: class/module name must be CONSTANT): 51 | 52 | app/controllers/api/v1/articles_controller.rb:2: class/module name must be CONSTANT 53 | Started GET "/api/v1/articles.json" for 127.0.0.1 at 2017-06-27 12:23:00 -0400 54 | 55 | SyntaxError (C:/Sites/myarticles/app/controllers/api/v1/articles_controller.rb:2: class/module name must be CONSTANT): 56 | 57 | app/controllers/api/v1/articles_controller.rb:2: class/module name must be CONSTANT 58 | Started GET "/api/v1/articles.json" for 127.0.0.1 at 2017-06-27 12:23:01 -0400 59 | 60 | SyntaxError (C:/Sites/myarticles/app/controllers/api/v1/articles_controller.rb:2: class/module name must be CONSTANT): 61 | 62 | app/controllers/api/v1/articles_controller.rb:2: class/module name must be CONSTANT 63 | Started GET "/api/v1/articles.json" for 127.0.0.1 at 2017-06-27 12:25:07 -0400 64 | 65 | SyntaxError (C:/Sites/myarticles/app/controllers/api/v1/articles_controller.rb:2: class/module name must be CONSTANT): 66 | 67 | app/controllers/api/v1/articles_controller.rb:2: class/module name must be CONSTANT 68 | Started GET "/" for 127.0.0.1 at 2017-06-27 12:26:44 -0400 69 | [1m[35m (0.5ms)[0m [1m[35mSET @@SESSION.sql_mode = CONCAT(CONCAT(@@sql_mode, ',STRICT_ALL_TABLES'), ',NO_AUTO_VALUE_ON_ZERO'), @@SESSION.sql_auto_is_null = 0, @@SESSION.wait_timeout = 2147483[0m 70 | Processing by Rails::WelcomeController#index as HTML 71 | Rendering C:/RailsInstaller/Ruby2.3.0/lib/ruby/gems/2.3.0/gems/railties-5.1.2/lib/rails/templates/rails/welcome/index.html.erb 72 | Rendered C:/RailsInstaller/Ruby2.3.0/lib/ruby/gems/2.3.0/gems/railties-5.1.2/lib/rails/templates/rails/welcome/index.html.erb (3.0ms) 73 | Completed 200 OK in 33ms (Views: 16.9ms | ActiveRecord: 0.0ms) 74 | 75 | 76 | Started GET "/api/v1/articles" for 127.0.0.1 at 2017-06-27 12:28:36 -0400 77 | 78 | SyntaxError (C:/Sites/myarticles/app/controllers/api/v1/articles_controller.rb:2: class/module name must be CONSTANT): 79 | 80 | app/controllers/api/v1/articles_controller.rb:2: class/module name must be CONSTANT 81 | Started GET "/api/v1/articles" for 127.0.0.1 at 2017-06-27 12:29:32 -0400 82 | Processing by Api::V1::ArticlesController#index as */* 83 | Completed 500 Internal Server Error in 55ms (ActiveRecord: 0.0ms) 84 | 85 | 86 | 87 | NameError (undefined local variable or method `ok' for #