rails-api 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 200603c563a12a084abd7f3f46fd12ba552a5564
-  data.tar.gz: c757f33c4958d7b161f5b7fd0f744ba61503b48b
+  metadata.gz: 5253c491976015f9cfbe4ed845107e35804473e0
+  data.tar.gz: b74a7076b3aba37160e2b136c0207433a9f94d7c
 SHA512:
-  metadata.gz: 421034d4885439e69a73e417e171dfaf5e8c3fedaca8e90182e0865cbd2d3502f03b25243e9db47084444891f33767689072f309118b88625ca66893dc81f75f
-  data.tar.gz: fbe970847a57d9ba05c9bbfd21016a73bece79ee71a9c0a87b1a7ebcc9e174cbcf5f70c3903dc8abf0d31c4977816f8049c59c587373c013da00173f94e081fb
+  metadata.gz: 1641fe3267a1137ade2ca4323350e8a70a43fde041ecd28e2179a406125796529e5b2ad5f56e80fb47b324213011c35d7b2a4e9eeba24309c38073fa1665ed30
+  data.tar.gz: 44a72a3a29b7178023ada10e2eb6ede998322fcb1af61675c7f127e4a059be36a1d4ce8c8b67471478a931db838de5a0e3461debdda5193a74a32b01c27fbd67

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Santiago Pastorino and Carlos Antonio da Silva
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -84,6 +84,31 @@ This will do two main things for you:
 * Make *ApplicationController* inherit from *ActionController::API* instead of *ActionController::Base*. As with middleware, this will leave out any *ActionController* modules that provide functionality primarily used by browser applications.
 * Configure the generators to skip generating views, helpers and assets when you generate a new resource.
 
+Rails includes all of the sub-frameworks (ActiveRecord, ActionMailer, etc) by default. Some API projects won't need them all, so at the top of config/application.rb, you can replace `require 'rails/all'` with specific sub-frameworks:
+
+    # config/application.rb
+    # require "active_record/railtie"
+    require "action_controller/railtie"
+    require "action_mailer/railtie"
+    # require "sprockets/railtie"
+    require "rails/test_unit/railtie"
+
+This can also be achieved with flags when creating a new **Rails::API** app:
+
+    rails-api new my_api --skip-active-record --skip-sprockets
+
+Note: There are references to ActionMailer and ActiveRecord in the various
+  config/environment files. If you decide to exclude any of these from your project
+  its best to comment these out in case you need them later.
+
+    # comment out this in config/environments/development.rb
+    config.active_record.migration_error = :page_load
+    config.action_mailer.raise_delivery_errors = false
+
+    # comment out this in config/environments/test.rb
+    config.action_mailer.delivery_method = :test
+
+
 #### For already existing apps
 
 If you want to take an existing app and make it a **Rails::API** app, you'll have to do some quick setup manually.
@@ -112,7 +137,7 @@ If you want to use the Rails default middleware stack (avoid the reduction that
 
 ### Serialization
 
-We suggest using [ActiveModel::Serializers][ams] to deserialize your ActiveModel/ActiveRecord objects into the desired response format (e.g. JSON).
+We suggest using [ActiveModel::Serializers][ams] to serialize your ActiveModel/ActiveRecord objects into the desired response format (e.g. JSON).
 
 ### Choosing Middlewares
 
@@ -196,7 +221,7 @@ Some common modules you might want to add:
 * *AbstractController::Translation*: Support for the *l* and *t* localization and translation methods. These delegate to *I18n.translate* and *I18n.localize*.
 * *ActionController::HttpAuthentication::Basic::ControllerMethods* (or *Digest* or *Token*): Support for basic, digest or token HTTP authentication.
 * *AbstractController::Layouts*: Support for layouts when rendering.
-* *ActionController::MimeResponds*: Support for content negotiation (*respond_to*, *respond_with*).
+* *ActionController::MimeResponds* (and *ActionController::ImplicitRender* for Rails 4): Support for content negotiation (*respond_to*, *respond_with*).
 * *ActionController::Cookies*: Support for *cookies*, which includes support for signed and encrypted cookies. This requires the cookie middleware.
 
 The best place to add a module is in your *ApplicationController*. You can also add modules to individual controllers.

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

@@ -1,3 +1,4 @@
+require 'action_view'
 require 'action_controller'
 require 'action_controller/log_subscriber'
 
@@ -145,10 +146,19 @@ module ActionController
       Instrumentation
     ]
 
+    if Rails::VERSION::MAJOR >= 4 && Rails::VERSION::MINOR > 0
+      include AbstractController::Rendering
+      include ActionView::Rendering
+    end
+
     MODULES.each do |mod|
       include mod
     end
 
+    if Rails::VERSION::MAJOR >= 4
+      include StrongParameters
+    end
+
     ActiveSupport.run_load_hooks(:action_controller, self)
   end
 end

data/lib/rails-api/application.rb

@@ -1,12 +1,13 @@
 require 'rails/version'
 require 'rails/application'
 require 'rails-api/public_exceptions'
+require 'rails-api/application/default_rails_four_middleware_stack'
 
 module Rails
   class Application < Engine
     def default_middleware_stack
       if Rails::API.rails4?
-        rails_four_stack
+        DefaultRailsFourMiddlewareStack.new(self, config, paths).build_stack
       else
         rails_three_stack
       end
@@ -36,62 +37,6 @@ module Rails
       setup_generators!
     end
 
-    def rails_four_stack
-      ActionDispatch::MiddlewareStack.new.tap do |middleware|
-        app = self
-        if rack_cache = config.action_dispatch.rack_cache
-          begin
-            require 'rack/cache'
-          rescue LoadError => error
-            error.message << ' Be sure to add rack-cache to your Gemfile'
-            raise
-          end
-
-          if rack_cache == true
-            rack_cache = {
-              metastore: "rails:/",
-              entitystore: "rails:/",
-              verbose: false
-            }
-          end
-
-          require "action_dispatch/http/rack_cache"
-          middleware.use ::Rack::Cache, rack_cache
-        end
-
-        if config.force_ssl
-          middleware.use ::ActionDispatch::SSL, config.ssl_options
-        end
-
-        if config.action_dispatch.x_sendfile_header.present?
-          middleware.use ::Rack::Sendfile, config.action_dispatch.x_sendfile_header
-        end
-
-        if config.serve_static_assets
-          middleware.use ::ActionDispatch::Static, paths["public"].first, config.static_cache_control
-        end
-
-        middleware.use ::Rack::Lock unless config.cache_classes
-        middleware.use ::Rack::Runtime
-        middleware.use ::ActionDispatch::RequestId
-        middleware.use ::Rails::Rack::Logger, config.log_tags # must come after Rack::MethodOverride to properly log overridden methods
-        middleware.use ::ActionDispatch::ShowExceptions, config.exceptions_app || ActionDispatch::PublicExceptions.new(Rails.public_path)
-        middleware.use ::ActionDispatch::DebugExceptions, app
-        middleware.use ::ActionDispatch::RemoteIp, config.action_dispatch.ip_spoofing_check, config.action_dispatch.trusted_proxies
-
-        unless config.cache_classes
-          middleware.use ::ActionDispatch::Reloader, lambda { app.reload_dependencies? }
-        end
-
-        middleware.use ::ActionDispatch::Callbacks
-
-        middleware.use ::ActionDispatch::ParamsParser
-        middleware.use ::Rack::Head
-        middleware.use ::Rack::ConditionalGet
-        middleware.use ::Rack::ETag, "no-cache"
-      end
-    end
-
     def rails_three_stack
       ActionDispatch::MiddlewareStack.new.tap do |middleware|
         if rack_cache = config.action_controller.perform_caching && config.action_dispatch.rack_cache

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

@@ -0,0 +1,101 @@
+module Rails
+  class Application
+    class DefaultRailsFourMiddlewareStack
+      attr_reader :config, :paths, :app
+
+      def initialize(app, config, paths)
+        @app = app
+        @config = config
+        @paths = paths
+      end
+
+      def build_stack
+        ActionDispatch::MiddlewareStack.new.tap do |middleware|
+          if rack_cache = load_rack_cache
+            require "action_dispatch/http/rack_cache"
+            middleware.use ::Rack::Cache, rack_cache
+          end
+
+          if config.force_ssl
+            middleware.use ::ActionDispatch::SSL, config.ssl_options
+          end
+
+          if config.action_dispatch.x_sendfile_header.present?
+            middleware.use ::Rack::Sendfile, config.action_dispatch.x_sendfile_header
+          end
+
+          if config.serve_static_assets
+            middleware.use ::ActionDispatch::Static, paths["public"].first, config.static_cache_control
+          end
+
+          middleware.use ::Rack::Lock unless allow_concurrency?
+          middleware.use ::Rack::Runtime
+          middleware.use ::Rack::MethodOverride unless config.api_only
+          middleware.use ::ActionDispatch::RequestId
+
+          # Must come after Rack::MethodOverride to properly log overridden methods
+          middleware.use ::Rails::Rack::Logger, config.log_tags
+          middleware.use ::ActionDispatch::ShowExceptions, show_exceptions_app
+          middleware.use ::ActionDispatch::DebugExceptions, app
+          middleware.use ::ActionDispatch::RemoteIp, config.action_dispatch.ip_spoofing_check, config.action_dispatch.trusted_proxies
+
+          unless config.cache_classes
+            middleware.use ::ActionDispatch::Reloader, lambda { reload_dependencies? }
+          end
+
+          middleware.use ::ActionDispatch::Callbacks
+          middleware.use ::ActionDispatch::Cookies unless config.api_only
+
+          if !config.api_only && config.session_store
+            if config.force_ssl && !config.session_options.key?(:secure)
+              config.session_options[:secure] = true
+            end
+            middleware.use config.session_store, config.session_options
+            middleware.use ::ActionDispatch::Flash
+          end
+
+          middleware.use ::ActionDispatch::ParamsParser
+          middleware.use ::Rack::Head
+          middleware.use ::Rack::ConditionalGet
+          middleware.use ::Rack::ETag, "no-cache"
+        end
+      end
+
+      private
+
+        def reload_dependencies?
+          config.reload_classes_only_on_change != true || app.reloaders.map(&:updated?).any?
+        end
+
+        def allow_concurrency?
+          config.allow_concurrency.nil? ? config.cache_classes : config.allow_concurrency
+        end
+
+        def load_rack_cache
+          rack_cache = config.action_dispatch.rack_cache
+          return unless rack_cache
+
+          begin
+            require 'rack/cache'
+          rescue LoadError => error
+            error.message << ' Be sure to add rack-cache to your Gemfile'
+            raise
+          end
+
+          if rack_cache == true
+            {
+              metastore: "rails:/",
+              entitystore: "rails:/",
+              verbose: false
+            }
+          else
+            rack_cache
+          end
+        end
+
+        def show_exceptions_app
+          config.exceptions_app || ActionDispatch::PublicExceptions.new(Rails.public_path)
+        end
+    end
+  end
+end

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

@@ -11,7 +11,7 @@
 # if you're sharing your code publicly.
 
 # Although this is not needed for an api-only application, rails4 
-# requires secret_key_base or secret_toke to be defined, otherwise an 
+# requires secret_key_base or secret_token to be defined, otherwise an 
 # error is raised.
 # Using secret_token for rails3 compatibility. Change to secret_key_base
 # to avoid deprecation warning.

data/lib/rails-api/version.rb

@@ -1,5 +1,5 @@
 module Rails
   module API
-    VERSION = "0.1.0"
+    VERSION = '0.2.0'
   end
 end

data/test/api_application/api_application_test.rb

@@ -6,6 +6,10 @@ class OmgController < ActionController::API
   def index
     render :text => "OMG"
   end
+
+  def unauthorized
+    render :text => "get out", :status => :unauthorized
+  end
 end
 
 class ApiApplicationTest < ActiveSupport::TestCase
@@ -15,10 +19,14 @@ class ApiApplicationTest < ActiveSupport::TestCase
 
   def test_boot_api_app
     get "/omg"
-    assert_equal 200, last_response.status
     assert_equal "OMG", last_response.body
   end
 
+  def test_proper_status_set
+    get "/omg/unauthorized"
+    assert_equal 401, last_response.status
+  end
+
   def test_api_middleware_stack
     expected_middleware_stack =
       rails4? ? expected_middleware_stack_rails4 : expected_middleware_stack_rails3

data/test/generators/app_generator_test.rb

@@ -45,7 +45,7 @@ class AppGeneratorTest < Rails::Generators::TestCase
       lib/assets
       log
       test/fixtures
-      test/#{generated_test_funcional_dir}
+      test/#{generated_test_functional_dir}
       test/integration
       test/#{generated_test_unit_dir}
     )

data/test/generators/generators_test_helper.rb

@@ -28,7 +28,7 @@ module GeneratorsTestHelper
     rails4? ? 'models' : 'unit'
   end
 
-  def generated_test_funcional_dir
+  def generated_test_functional_dir
     rails4? ? 'controllers' : 'functional'
   end
 

data/test/generators/scaffold_generator_test.rb

@@ -68,7 +68,7 @@ class ScaffoldGeneratorTest < Rails::Generators::TestCase
       end
     end
 
-    assert_file "test/#{generated_test_funcional_dir}/product_lines_controller_test.rb" do |test|
+    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)

metadata

@@ -1,69 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: rails-api
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Santiago Pastorino and Carlos Antonio da Silva
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-01 00:00:00.000000000 Z
+date: 2014-01-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.2.11
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.2.11
 - !ruby/object:Gem::Dependency
   name: railties
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.2.11
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.2.11
-- !ruby/object:Gem::Dependency
-  name: tzinfo
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 0.3.31
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 0.3.31
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.2.11
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.2.11
 description: |-
@@ -71,28 +57,30 @@ description: |-
                            created for applications that don't require all
                            functionality that a complete Rails application provides
 email:
-- <santiago@wyeworks.com>
-- <carlosantoniodasilva@gmail.com>
+- "<santiago@wyeworks.com>"
+- "<carlosantoniodasilva@gmail.com>"
 executables:
 - rails-api
 extensions: []
 extra_rdoc_files: []
 files:
+- LICENSE
 - README.md
 - bin/rails-api
 - lib/generators/rails/api_resource_route/api_resource_route_generator.rb
+- lib/rails-api.rb
 - lib/rails-api/action_controller/api.rb
 - lib/rails-api/application.rb
+- lib/rails-api/application/default_rails_four_middleware_stack.rb
 - lib/rails-api/generators/rails/app/app_generator.rb
 - 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/secret_token.rb.tt
 - lib/rails-api/templates/rails/app/config/initializers/wrap_parameters.rb.tt
-- lib/rails-api/templates/rails/app/Gemfile
 - lib/rails-api/templates/rails/scaffold_controller/controller.rb
 - lib/rails-api/templates/test_unit/scaffold/functional_test.rb
 - lib/rails-api/version.rb
-- lib/rails-api.rb
 - test/api_application/api_application_test.rb
 - test/api_controller/action_methods_test.rb
 - test/api_controller/conditional_get_test.rb
@@ -107,7 +95,7 @@ files:
 - test/generators/resource_generator_test.rb
 - test/generators/scaffold_generator_test.rb
 - test/test_helper.rb
-homepage: https://github.com/spastorino/rails-api
+homepage: https://github.com/rails-api/rails-api
 licenses:
 - MIT
 metadata: {}
@@ -117,17 +105,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.0
+rubygems_version: 2.2.0
 signing_key: 
 specification_version: 4
 summary: Rails for API only Applications
@@ -146,4 +134,3 @@ test_files:
 - test/generators/resource_generator_test.rb
 - test/generators/scaffold_generator_test.rb
 - test/test_helper.rb
-has_rdoc: