rails-api 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a4ea50fca1f486fc7d1d232b8295bb67c341a88c
-  data.tar.gz: d2c349cce24922db210c93ff6b3970e221ecf3b2
+  metadata.gz: 77d3d89e4ce4fa7f0c861dc9cedb98d69a5b43f6
+  data.tar.gz: ea09b246ac549fce29ba5968fbf2bca3a82b5327
 SHA512:
-  metadata.gz: eaab8457e8dce7dec7edf508e26f4f3bc87e17f8b0fc8183e05d96ffd9e597687e4a4d765e9ed215aea7570f6ee8e23190558e48fb05e578c536f6b891f96fbf
-  data.tar.gz: e80d72538c688ed519c5aa35d6deb713df62580ce1621f9071e50dc406758263954cc9f255b705c78899b7d54bf885a90d480899b000898d857ac9e0de6c086c
+  metadata.gz: e1247598f6072111eba2674bdc23df065dca70b3bf1031c7e7ea640bf568c64464df55c1cd57652369d4e8cf73bf28b0103fb7dd11a611889ad63c03af1f7063
+  data.tar.gz: 3973dee3bcd9b1f1456af5fac6c1eacb328789c9deab2a14b96a45b3e7289db17f1a081f2732a0458066b10d53748d5ca35c21a366ab8c3c810d7be04165fdd2

data/README.md

@@ -133,29 +133,33 @@ end
 
 And comment out the `protect_from_forgery` call if you are using it. (You aren't using cookie-based authentication for your API, are you?)
 
-If you want to use the Rails default middleware stack (avoid the reduction that rails-api does), you can just add config.api_only = false to config/application.rb file.
+If you want to use the Rails default middleware stack (avoid the reduction that rails-api does), you can just add `config.api_only = false` to `config/application.rb` file.
 
 ### Serialization
 
 We suggest using [ActiveModel::Serializers][ams] to serialize your ActiveModel/ActiveRecord objects into the desired response format (e.g. JSON).
+In `ApplicationController` you need to add `include ActionController::Serialization` to make ActiveModelSerializers work.
+
+
 
 ### Choosing Middlewares
 
 An API application comes with the following middlewares by default.
 
 * *ActionDispatch::DebugExceptions*: Log exceptions.
-* *ActionDispatch::Head*: Dispatch *HEAD* requests as *GET* requests, and return only the status code and headers.
 * *ActionDispatch::ParamsParser*: Parse XML, YAML and JSON parameters when the request's *Content-Type* is one of those.
 * *ActionDispatch::Reloader*: In development mode, support code reloading.
 * *ActionDispatch::RemoteIp*: Protect against IP spoofing attacks.
 * *ActionDispatch::RequestId*: Makes a unique request id available, sending the id to the client via the X-Request-Id header. The unique request id can be used to trace a request end-to-end and would typically end up being part of log files from multiple pieces of the stack.
 * *ActionDispatch::ShowExceptions*: Rescue exceptions and re-dispatch them to an exception handling application.
 * *Rack::Cache*: Caches responses with public *Cache-Control* headers using HTTP caching semantics.
+* *Rack::Head*: Dispatch *HEAD* requests as *GET* requests, and return only the status code and headers.
 * *Rack::ConditionalGet*: Supports the `stale?` feature in Rails controllers.
 * *Rack::ETag*: Automatically set an *ETag* on all string responses. This means that if the same response is returned from a controller for the same URL, the server will return a *304 Not Modified*, even if no additional caching steps are taken. This is primarily a client-side optimization; it reduces bandwidth costs but not server processing time.
 * *Rack::Lock*: If your application is not marked as threadsafe (`config.threadsafe!`), this middleware will add a mutex around your requests.
 * *Rack::Runtime*: Adds a header to the response listing the total runtime of the request.
 * *Rack::Sendfile*: Uses a front-end server's file serving support from your Rails application.
+* *Rack::Head*: Dispatch *HEAD* requests as *GET* requests, and return only the status code and headers.
 * *Rails::Rack::Logger*: Log the request started and flush all loggers after it.
 
 Other plugins, including *ActiveRecord*, may add additional middlewares. In general, these middlewares are agnostic to the type of app you are building, and make sense in an API-only Rails application.

data/lib/rails-api.rb

@@ -5,8 +5,8 @@ require 'rails-api/application'
 
 module Rails
   module API
-    def self.rails4?
-      Rails::VERSION::MAJOR == 4
+    def self.rails3?
+      Rails::VERSION::MAJOR == 3
     end
   end
 end

data/lib/rails-api/action_controller/api.rb

@@ -123,7 +123,6 @@ module ActionController
     end
 
     MODULES = [
-      HideActions,
       UrlFor,
       Redirecting,
       Rendering,
@@ -146,17 +145,25 @@ module ActionController
       Instrumentation
     ]
 
-    if Rails::VERSION::MAJOR >= 4 && Rails::VERSION::MINOR > 0
+    if Rails::VERSION::MAJOR == 5 || (Rails::VERSION::MAJOR == 4 && Rails::VERSION::MINOR > 0)
       include AbstractController::Rendering
       include ActionView::Rendering
     end
 
+    if Rails::VERSION::MAJOR < 5
+      include ActionController::HideActions
+    end
+
     MODULES.each do |mod|
       include mod
     end
 
     DEFAULT_PROTECTED_INSTANCE_VARIABLES = begin
-      (Rails::VERSION::MAJOR < 4 || Rails::VERSION::MINOR < 1) ?  Array : Set
+      if Rails::VERSION::MAJOR == 5 || (Rails::VERSION::MAJOR == 4 && Rails::VERSION::MINOR > 0)
+        Set
+      else
+        Array
+      end
     end.new
 
     def self.protected_instance_variables

data/lib/rails-api/application.rb

@@ -7,10 +7,10 @@ module Rails
     alias_method :rails_default_middleware_stack, :default_middleware_stack
 
     def default_middleware_stack
-      if Rails::API.rails4?
-        DefaultRailsFourMiddlewareStack.new(self, config, paths).build_stack
+      if Rails::API.rails3?
+        rails3_stack
       else
-        rails_3_stack
+        DefaultRailsFourMiddlewareStack.new(self, config, paths).build_stack
       end
     end
 
@@ -37,8 +37,16 @@ module Rails
       config.api_only = true
       setup_generators!
     end
+    
+    def check_serve_static_files
+      if Rails::VERSION::MAJOR >= 5 || (Rails::VERSION::MAJOR == 4 && Rails::VERSION::MINOR > 1)
+        config.serve_static_files
+      else
+        config.serve_static_assets
+      end
+    end
 
-    def rails_3_stack
+    def rails3_stack
       ActionDispatch::MiddlewareStack.new.tap do |middleware|
         if rack_cache = config.action_controller.perform_caching && config.action_dispatch.rack_cache
           require "action_dispatch/http/rack_cache"
@@ -53,11 +61,12 @@ module Rails
         if config.action_dispatch.x_sendfile_header.present?
           middleware.use ::Rack::Sendfile, config.action_dispatch.x_sendfile_header
         end
+        
 
-        if config.serve_static_assets
+        if check_serve_static_files
           middleware.use ::ActionDispatch::Static, paths["public"].first, config.static_cache_control
         end
-
+        
         middleware.use ::Rack::Lock unless config.allow_concurrency
         middleware.use ::Rack::Runtime
         middleware.use ::Rack::MethodOverride unless config.api_only

data/lib/rails-api/application/default_rails_four_middleware_stack.rb

@@ -24,7 +24,7 @@ module Rails
             middleware.use ::Rack::Sendfile, config.action_dispatch.x_sendfile_header
           end
 
-          if config.serve_static_assets
+          if serve_static_files?
             middleware.use ::ActionDispatch::Static, paths["public"].first, config.static_cache_control
           end
 
@@ -63,6 +63,17 @@ module Rails
 
       private
 
+        # `config.serve_static_assets` will be removed in Rails 5.0, and throws
+        # a deprecation warning in Rails >= 4.2. The new option is
+        # `config.serve_static_files`.
+        def serve_static_files?
+          if config.respond_to?(:serve_static_files)
+            config.serve_static_files
+          else
+            config.serve_static_assets
+          end
+        end
+
         def reload_dependencies?
           config.reload_classes_only_on_change != true || app.reloaders.map(&:updated?).any?
         end

data/lib/rails-api/templates/rails/app/Gemfile

@@ -27,7 +27,7 @@ gem '<%= database_gemfile_entry.name -%>'
 <%= "gem 'json'\n" if RUBY_VERSION < "1.9.2" -%>
 
 # To use ActiveModel has_secure_password
-# gem 'bcrypt-ruby', '~> 3.1.2'
+# gem 'bcrypt', '~> 3.1.7'
 
 # To use Jbuilder templates for JSON
 # gem 'jbuilder'

data/lib/rails-api/templates/rails/app/config/initializers/filter_parameter_logging.rb.tt

@@ -0,0 +1,4 @@
+# Be sure to restart your server when you modify this file.
+
+# Configure sensitive parameters which will be filtered from the log file.
+Rails.application.config.filter_parameters += [:password]

data/lib/rails-api/templates/rails/scaffold_controller/controller.rb

@@ -1,5 +1,7 @@
 <% module_namespacing do -%>
 class <%= controller_class_name %>Controller < ApplicationController
+  before_action <%= ":set_#{singular_table_name}" %>, only: [:show, :update, :destroy]
+
   # GET <%= route_url %>
   # GET <%= route_url %>.json
   def index
@@ -11,8 +13,6 @@ class <%= controller_class_name %>Controller < ApplicationController
   # GET <%= route_url %>/1
   # GET <%= route_url %>/1.json
   def show
-    @<%= singular_table_name %> = <%= orm_class.find(class_name, "params[:id]") %>
-
     render json: <%= "@#{singular_table_name}" %>
   end
 
@@ -33,7 +33,7 @@ class <%= controller_class_name %>Controller < ApplicationController
   def update
     @<%= singular_table_name %> = <%= orm_class.find(class_name, "params[:id]") %>
 
-    if @<%= Rails::API.rails4? ? orm_instance.update("#{singular_table_name}_params") : orm_instance.update_attributes("params[:#{singular_table_name}]") %>
+    if @<%= Rails::API.rails3? ? orm_instance.update_attributes("params[:#{singular_table_name}]") : orm_instance.update("#{singular_table_name}_params") %>
       head :no_content
     else
       render json: <%= "@#{orm_instance.errors}" %>, status: :unprocessable_entity
@@ -43,14 +43,17 @@ class <%= controller_class_name %>Controller < ApplicationController
   # DELETE <%= route_url %>/1
   # DELETE <%= route_url %>/1.json
   def destroy
-    @<%= singular_table_name %> = <%= orm_class.find(class_name, "params[:id]") %>
     @<%= orm_instance.destroy %>
 
     head :no_content
   end
 
   private
-    
+
+    def <%= "set_#{singular_table_name}" %>
+      @<%= singular_table_name %> = <%= orm_class.find(class_name, "params[:id]") %>
+    end
+
     def <%= "#{singular_table_name}_params" %>
       <%- if attributes_names.empty? -%>
       params[:<%= singular_table_name %>]

data/lib/rails-api/version.rb

@@ -1,5 +1,5 @@
 module Rails
   module API
-    VERSION = '0.3.1'
+    VERSION = '0.4.0'
   end
 end

data/test/api_application/api_application_test.rb

@@ -29,7 +29,7 @@ class ApiApplicationTest < ActiveSupport::TestCase
 
   def test_api_middleware_stack
     expected_middleware_stack =
-      rails4? ? expected_middleware_stack_rails4 : expected_middleware_stack_rails3
+      rails3? ? expected_middleware_stack_rails3 : expected_middleware_stack_rails
 
     assert_equal expected_middleware_stack, app.middleware.map(&:klass).map(&:name)
   end
@@ -56,7 +56,7 @@ class ApiApplicationTest < ActiveSupport::TestCase
     ]
   end
 
-  def expected_middleware_stack_rails4
+  def expected_middleware_stack_rails
     [
       "ActionDispatch::Static",
       "Rack::Lock",

data/test/api_controller/action_methods_test.rb

@@ -3,15 +3,24 @@ require 'test_helper'
 class ActionMethodsApiController < ActionController::API
   def one; end
   def two; end
-  hide_action :two
+  # Rails 5 does not have method hide_action
+  if Rails::VERSION::MAJOR < 5
+    hide_action :two
+  end
 end
 
 class ActionMethodsApiTest < ActionController::TestCase
   tests ActionMethodsApiController
 
   def test_action_methods
-    assert_equal Set.new(%w(one)),
-                 @controller.class.action_methods,
-                 "#{@controller.controller_path} should not be empty!"
+    if Rails::VERSION::MAJOR < 5
+      assert_equal Set.new(%w(one)),
+                  @controller.class.action_methods,
+                  "#{@controller.controller_path} should not be empty!"
+    else
+      assert_equal Set.new(%w(one two)),
+                  @controller.class.action_methods,
+                  "#{@controller.controller_path} should not be empty!"
+    end
   end
 end

data/test/generators/app_generator_test.rb

@@ -49,7 +49,7 @@ class AppGeneratorTest < Rails::Generators::TestCase
       test/integration
       test/#{generated_test_unit_dir}
     )
-    files.concat rails4? ? default_files_rails4 : default_files_rails3
+    files.concat rails3? ? default_files_rails3 : default_files_rails
     files
   end
 
@@ -57,7 +57,7 @@ class AppGeneratorTest < Rails::Generators::TestCase
     %w(script/rails)
   end
 
-  def default_files_rails4
+  def default_files_rails
     %w(bin/bundle bin/rails bin/rake)
   end
 

data/test/generators/generators_test_helper.rb

@@ -25,11 +25,11 @@ module GeneratorsTestHelper
   end
 
   def generated_test_unit_dir
-    rails4? ? 'models' : 'unit'
+    rails3? ? 'unit' : 'models'
   end
 
   def generated_test_functional_dir
-    rails4? ? 'controllers' : 'functional'
+    rails3? ? 'functional' : 'controllers'
   end
 
   def remove_destination

data/test/generators/scaffold_generator_test.rb

@@ -15,16 +15,16 @@ class ScaffoldGeneratorTest < Rails::Generators::TestCase
     assert_file "test/#{generated_test_unit_dir}/product_line_test.rb", /class ProductLineTest < ActiveSupport::TestCase/
     assert_file "test/fixtures/product_lines.yml"
 
-    if rails4?
-      assert_migration "db/migrate/create_product_lines.rb",
-        /belongs_to :product, index: true/,
-        /references :user, index: true/
-    else
+    if rails3?
       assert_migration "db/migrate/create_product_lines.rb",
         /belongs_to :product/,
         /add_index :product_lines, :product_id/,
         /references :user/,
         /add_index :product_lines, :user_id/
+    else
+      assert_migration "db/migrate/create_product_lines.rb",
+        /belongs_to :product, index: true/,
+        /references :user, index: true/
     end
 
     # Route
@@ -38,12 +38,15 @@ class ScaffoldGeneratorTest < Rails::Generators::TestCase
       assert_match(/class ProductLinesController < ApplicationController/, content)
       assert_no_match(/respond_to/, content)
 
+      assert_match(/before_action :set_product_line, only: \[:show, :update, :destroy\]/, content)
+
       assert_instance_method :index, content do |m|
         assert_match(/@product_lines = ProductLine\.all/, m)
+        assert_match(/render json: @product_lines/, m)
       end
 
       assert_instance_method :show, content do |m|
-        assert_match(/@product_line = ProductLine\.find\(params\[:id\]\)/, m)
+        assert_match(/render json: @product_line/, m)
       end
 
       assert_instance_method :create, content do |m|
@@ -54,19 +57,22 @@ class ScaffoldGeneratorTest < Rails::Generators::TestCase
 
       assert_instance_method :update, content do |m|
         assert_match(/@product_line = ProductLine\.find\(params\[:id\]\)/, m)
-        if rails4?
-          assert_match(/@product_line\.update\(product_line_params\)/, m)
-        else
+        if rails3?
           assert_match(/@product_line\.update_attributes\(product_line_params\)/, m)
+        else
+          assert_match(/@product_line\.update\(product_line_params\)/, m)
         end
         assert_match(/@product_line\.errors/, m)
       end
 
       assert_instance_method :destroy, content do |m|
-        assert_match(/@product_line = ProductLine\.find\(params\[:id\]\)/, m)
         assert_match(/@product_line\.destroy/, m)
       end
 
+      assert_instance_method :set_product_line, content do |m|
+        assert_match(/@product_line = ProductLine\.find\(params\[:id\]\)/, m)
+      end
+
       assert_instance_method :product_line_params, content do |m|
         assert_match(/params\.require\(:product_line\)\.permit\(:title, :product_id, :user_id\)/, m)
       end
@@ -74,12 +80,12 @@ class ScaffoldGeneratorTest < Rails::Generators::TestCase
 
     assert_file "test/#{generated_test_functional_dir}/product_lines_controller_test.rb" do |test|
       assert_match(/class ProductLinesControllerTest < ActionController::TestCase/, test)
-      if rails4?
-        assert_match(/post :create, product_line: \{ product_id: @product_line.product_id, title: @product_line.title, user_id: @product_line.user_id \}/, test)
-        assert_match(/put :update, id: @product_line, product_line: \{ product_id: @product_line.product_id, title: @product_line.title, user_id: @product_line.user_id \}/, test)
-      else
+      if rails3?
         assert_match(/post :create, product_line: \{ title: @product_line.title \}/, test)
         assert_match(/put :update, id: @product_line, product_line: \{ title: @product_line.title \}/, test)
+      else
+        assert_match(/post :create, product_line: \{ product_id: @product_line.product_id, title: @product_line.title, user_id: @product_line.user_id \}/, test)
+        assert_match(/put :update, id: @product_line, product_line: \{ product_id: @product_line.product_id, title: @product_line.title, user_id: @product_line.user_id \}/, test)
       end
       assert_no_match(/assert_redirected_to/, test)
     end

data/test/test_helper.rb

@@ -6,8 +6,8 @@ require 'rails'
 require 'rails/test_help'
 require 'rails-api'
 
-def rails4?
-  Rails::API.rails4?
+def rails3?
+  Rails::API.rails3?
 end
 
 class ActiveSupport::TestCase
@@ -25,7 +25,7 @@ class ActiveSupport::TestCase
         c.performance_tool :test_unit
       end
 
-      if rails4?
+      unless rails3?
         config.eager_load = false
         config.secret_key_base = 'abc123'
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails-api
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Santiago Pastorino and Carlos Antonio da Silva
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-23 00:00:00.000000000 Z
+date: 2015-01-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -76,6 +76,7 @@ files:
 - lib/rails-api/public_exceptions.rb
 - lib/rails-api/templates/rails/app/Gemfile
 - lib/rails-api/templates/rails/app/app/controllers/application_controller.rb.tt
+- lib/rails-api/templates/rails/app/config/initializers/filter_parameter_logging.rb.tt
 - lib/rails-api/templates/rails/app/config/initializers/secret_token.rb.tt
 - lib/rails-api/templates/rails/app/config/initializers/wrap_parameters.rb.tt
 - lib/rails-api/templates/rails/scaffold_controller/controller.rb
@@ -122,15 +123,15 @@ summary: Rails for API only Applications
 test_files:
 - test/test_helper.rb
 - test/api_application/api_application_test.rb
-- test/generators/fixtures/routes.rb
 - test/generators/resource_generator_test.rb
 - test/generators/generators_test_helper.rb
-- test/generators/app_generator_test.rb
 - test/generators/scaffold_generator_test.rb
-- test/api_controller/conditional_get_test.rb
+- test/generators/fixtures/routes.rb
+- test/generators/app_generator_test.rb
 - test/api_controller/url_for_test.rb
-- test/api_controller/renderers_test.rb
 - test/api_controller/force_ssl_test.rb
-- test/api_controller/redirect_to_test.rb
 - test/api_controller/data_streaming_test.rb
+- test/api_controller/redirect_to_test.rb
+- test/api_controller/conditional_get_test.rb
+- test/api_controller/renderers_test.rb
 - test/api_controller/action_methods_test.rb