rails-api 0.0.1 → 0.0.2

data/README.md

@@ -1,5 +1,7 @@
 # Rails::API
 
+[![Build Status](https://secure.travis-ci.org/spastorino/rails-api.png?branch=master)](http://travis-ci.org/spastorino/rails-api)
+
 **Rails::API** is a subset of a normal Rails application, created for applications that don't require all functionality that a complete Rails application provides. It is a bit more lightweight, and consequently a bit faster than a normal Rails application. The main example for its usage is in API applications only, where you usually don't need the entire Rails middleware stack nor template generation.
 
 ## Using Rails for API-only Apps
@@ -76,9 +78,8 @@ Then generate a new **Rails::API** app:
 
     rails-api new my_api
 
-This will do three main things for you:
+This will do two main things for you:
 
-* Make the application inherit from *Rails::ApiApplication* instead of *Rails::Application*. This will configure your application to start with a more limited set of middleware than normal. Specifically, it will not include any middleware primarily useful for browser applications (like cookie support) by default.
 * 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.
 
@@ -92,22 +93,6 @@ Add the gem to your *Gemfile*:
 
 And run `bundle` to install the gem.
 
-In *config/application.rb*, change your *Application* class to inherit from *Rails::ApiApplication*:
-
-```ruby
-# instead of
-module MyApi
-  class Application < Rails::Application
-  end
-end
-
-# do
-module MyApi
-  class Application < Rails::ApiApplication
-  end
-end
-```
-
 Change *app/controllers/application_controller.rb*:
 
 ```ruby
@@ -124,22 +109,22 @@ And comment out the `protect_from_forgery` call if you are using it.
 
 ### Choosing Middlewares
 
-An api application comes with the following middlewares by default.
+An API application comes with the following middlewares by default.
 
-* *Rack::Cache*: Caches responses with public *Cache-Control* headers using HTTP caching semantics.
-* *Rack::Sendfile*: Uses a front-end server's file serving support from your Rails application.
-* *Rack::Lock*: If your application is not marked as threadsafe (`config.threadsafe!`), this middleware will add a mutex around your requests.
-* *ActionDispatch::RequestId*
-* *Rails::Rack::Logger*
-* *Rack::Runtime*: Adds a header to the response listing the total runtime of the request.
-* *ActionDispatch::ShowExceptions*: Rescue exceptions and re-dispatch them to an exception handling application.
 * *ActionDispatch::DebugExceptions*: Log exceptions.
-* *ActionDispatch::RemoteIp*: Protect against IP spoofing attacks.
-* *ActionDispatch::Reloader*: In development mode, support code reloading.
-* *ActionDispatch::ParamsParser*: Parse XML, YAML and JSON parameters when the request's *Content-Type* is one of those.
 * *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::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.
+* *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.
 
@@ -165,7 +150,7 @@ config.middleware.use Rack::MethodOverride
 
 #### Removing Middlewares
 
-If you don't want to use a middleware that is included by default in the api middleware set, you can remove it using *config.middleware.delete*:
+If you don't want to use a middleware that is included by default in the API middleware set, you can remove it using *config.middleware.delete*:
 
 ```ruby
 config.middleware.delete ::Rack::Sendfile
@@ -175,7 +160,7 @@ Keep in mind that removing these features may remove support for certain feature
 
 ### Choosing Controller Modules
 
-An api application (using *ActionController::API*) comes with the following controller modules by default:
+An API application (using *ActionController::API*) comes with the following controller modules by default:
 
 * *ActionController::UrlFor*: Makes *url_for* and friends available
 * *ActionController::Redirecting*: Support for *redirect_to*
@@ -202,14 +187,13 @@ All Action Controller modules know about their dependent modules, so you can fee
 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* (or *Digest* or *Token*): Support for basic, digest or token HTTP authentication.
+* *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::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.
 
-
 ## Contributing
 
 1. Fork it

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

@@ -98,6 +98,8 @@ module ActionController
       def wrap_parameters(*); end
       def helpers_path=(*); end
       def allow_forgery_protection=(*); end
+      def helper_method(*); end
+      def helper(*); end
     end
 
     extend Compabitility

data/lib/rails-api/application.rb

@@ -11,7 +11,7 @@ module Rails
         end
 
         if config.force_ssl
-          middleware.use ::ActionDispatch::SSL, config.ssl_options
+          middleware.use ssl_module, config.ssl_options
         end
 
         if config.action_dispatch.x_sendfile_header.present?
@@ -64,6 +64,15 @@ module Rails
 
     private
 
+    def ssl_module
+      if defined? ::ActionDispatch::SSL
+        ::ActionDispatch::SSL
+      else
+        require 'rack/ssl'
+        ::Rack::SSL
+      end
+    end
+
     def setup_generators!
       generators = config.generators
 

data/lib/rails-api/generators/rails/app/app_generator.rb

@@ -4,3 +4,8 @@ require 'rails/generators/rails/app/app_generator'
 Rails::Generators::AppGenerator.source_paths.unshift(
   File.expand_path('../../../../templates/rails/app', __FILE__)
 )
+
+class Rails::AppBuilder
+  undef tmp
+  undef vendor
+end

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

@@ -9,8 +9,6 @@ gem 'rails-api'
 <%= "gem 'jruby-openssl'\n" if defined?(JRUBY_VERSION) -%>
 <%= "gem 'json'\n" if RUBY_VERSION < "1.9.2" -%>
 
-<%= javascript_gemfile_entry %>
-
 # To use ActiveModel has_secure_password
 # gem 'bcrypt-ruby', '~> 3.0.0'
 

data/lib/rails-api/version.rb

@@ -1,5 +1,5 @@
 module Rails
   module API
-    VERSION = "0.0.1"
+    VERSION = "0.0.2"
   end
 end

data/test/generators/app_generator_test.rb

@@ -10,6 +10,7 @@ class AppGeneratorTest < Rails::Generators::TestCase
     run_generator
 
     default_files.each { |path| assert_file path }
+    skipped_files.each { |path| assert_no_file path }
   end
 
   def test_api_modified_files
@@ -18,6 +19,7 @@ class AppGeneratorTest < Rails::Generators::TestCase
     assert_file "Gemfile" do |content|
       assert_match(/gem 'rails-api'/, content)
       assert_no_match(/gem 'coffee-rails'/, content)
+      assert_no_match(/gem 'jquery-rails'/, content)
       assert_no_match(/gem 'sass-rails'/, content)
     end
     assert_file "app/controllers/application_controller.rb", /ActionController::API/
@@ -47,10 +49,11 @@ class AppGeneratorTest < Rails::Generators::TestCase
        test/functional
        test/integration
        test/performance
-       test/unit
-       vendor
-       vendor/assets
-       tmp/cache
+       test/unit)
+  end
+
+  def skipped_files
+    %w(vendor/assets
        tmp/cache/assets)
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: rails-api
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: false
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - Santiago Pastorino and Carlos Antonio da Silva
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-04-20 00:00:00 -03:00
+date: 2012-06-06 00:00:00 -03:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency