rails-api 0.0.3 → 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 200603c563a12a084abd7f3f46fd12ba552a5564
+  data.tar.gz: c757f33c4958d7b161f5b7fd0f744ba61503b48b
+SHA512:
+  metadata.gz: 421034d4885439e69a73e417e171dfaf5e8c3fedaca8e90182e0865cbd2d3502f03b25243e9db47084444891f33767689072f309118b88625ca66893dc81f75f
+  data.tar.gz: fbe970847a57d9ba05c9bbfd21016a73bece79ee71a9c0a87b1a7ebcc9e174cbcf5f70c3903dc8abf0d31c4977816f8049c59c587373c013da00173f94e081fb

data/README.md

@@ -54,7 +54,6 @@ While you could obviously build these up in terms of existing Rack middlewares,
 * Resourceful Routing: If you're building a RESTful JSON API, you want to be using the Rails router. Clean and conventional mapping from HTTP to controllers means not having to spend time thinking about how to model your API in terms of HTTP.
 * URL Generation: The flip side of routing is URL generation. A good API based on HTTP includes URLs (see [the GitHub gist API](http://developer.github.com/v3/gists/) for an example).
 * Header and Redirection Responses: `head :no_content` and `redirect_to user_url(current_user)` come in handy. Sure, you could manually add the response headers, but why?
-* Caching: Rails provides page, action and fragment caching. Fragment caching is especially helpful when building up a nested JSON object.
 * Basic, Digest and Token Authentication: Rails comes with out-of-the-box support for three kinds of HTTP authentication.
 * Instrumentation: Rails 3.0 added an instrumentation API that will trigger registered handlers for a variety of events, such as action processing, sending a file or data, redirection, and database queries. The payload of each event comes with relevant information (for the action processing event, the payload includes the controller, action, params, request format, request method and the request's full path).
 * Generators: This may be passé for advanced Rails users, but it can be nice to generate a resource and get your model, controller, test stubs, and routes created for you in a single command.
@@ -68,6 +67,8 @@ Of course, the Rails boot process also glues together all registered components.
 
 If you're building a Rails application that will be an API server first and foremost, you can start with a more limited subset of Rails and add in features as needed.
 
+**NOTE**: rails-api only supports Ruby 1.9.3 and above.
+
 #### For new apps
 
 Install the gem if you haven't already:
@@ -109,6 +110,10 @@ And comment out the `protect_from_forgery` call if you are using it.
 
 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 deserialize your ActiveModel/ActiveRecord objects into the desired response format (e.g. JSON).
+
 ### Choosing Middlewares
 
 An API application comes with the following middlewares by default.
@@ -142,7 +147,7 @@ Rails ships with a number of other middlewares that you might want to use in an
 * *ActionDispatch::Cookies*: Supports the *cookie* method in *ActionController*, including support for signed and encrypted cookies.
 * *ActionDispatch::Flash*: Supports the *flash* mechanism in *ActionController*.
 * *ActionDispatch::BestStandards*: Tells Internet Explorer to use the most standards-compliant available renderer. In production mode, if ChromeFrame is available, use ChromeFrame.
-* Session Management: If a *config.session_store* is supplied, this middleware makes the session available as the *session* method in *ActionController*.
+* Session Management: If a *config.session_store* is supplied and *config.api_only = false*, this middleware makes the session available as the *session* method in *ActionController*.
 
 Any of these middlewares can be added via:
 
@@ -217,3 +222,5 @@ MIT License.
 ## Mailing List
 
 https://groups.google.com/forum/?fromgroups#!forum/rails-api-core
+
+[ams]: https://github.com/rails-api/active_model_serializers

data/lib/generators/rails/api_resource_route/api_resource_route_generator.rb

@@ -7,7 +7,7 @@ module Rails
         return if options[:actions].present?
         route_config =  regular_class_path.collect{ |namespace| "namespace :#{namespace} do " }.join(" ")
         route_config << "resources :#{file_name.pluralize}"
-        route_config << ", except: :edit"
+        route_config << ", except: [:new, :edit]"
         route_config << " end" * regular_class_path.size
         route route_config
       end

data/lib/rails-api.rb

@@ -1,3 +1,11 @@
 require 'rails-api/version'
 require 'rails-api/action_controller/api'
 require 'rails-api/application'
+
+module Rails
+  module API
+    def self.rails4?
+      Rails::VERSION::MAJOR == 4
+    end
+  end
+end

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

@@ -84,7 +84,7 @@ module ActionController
   class API < Metal
     abstract!
 
-    module Compabitility
+    module Compatibility
       def cache_store; end
       def cache_store=(*); end
       def assets_dir=(*); end
@@ -101,7 +101,7 @@ module ActionController
       def helper(*); end
     end
 
-    extend Compabitility
+    extend Compatibility
 
     # Shortcut helper that returns all the ActionController::API modules except the ones passed in the argument:
     #

data/lib/rails-api/application.rb

@@ -5,7 +5,7 @@ require 'rails-api/public_exceptions'
 module Rails
   class Application < Engine
     def default_middleware_stack
-      if Rails.version =~ /4\..\../
+      if Rails::API.rails4?
         rails_four_stack
       else
         rails_three_stack
@@ -24,6 +24,7 @@ module Rails
 
       generators.rails({
         :helper => false,
+        :assets => false,
         :stylesheets => false,
         :stylesheet_engine => nil,
         :template_engine => nil
@@ -72,7 +73,6 @@ module Rails
 
         middleware.use ::Rack::Lock unless config.cache_classes
         middleware.use ::Rack::Runtime
-        middleware.use ::Rack::MethodOverride
         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)
@@ -84,24 +84,11 @@ module Rails
         end
 
         middleware.use ::ActionDispatch::Callbacks
-        middleware.use ::ActionDispatch::Cookies
-
-        if 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"
-
-        if config.action_dispatch.best_standards_support
-          middleware.use ::ActionDispatch::BestStandardsSupport, config.action_dispatch.best_standards_support
-        end
       end
     end
 

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

@@ -0,0 +1,19 @@
+# Be sure to restart your server when you modify this file.
+
+# Your secret key for verifying the integrity of signed cookies.
+# If you change this key, all old signed cookies will become invalid!
+
+# Make sure the secret is at least 30 characters and all random,
+# no regular words or you'll be exposed to dictionary attacks.
+# You can use `rake secret` to generate a secure secret key.
+
+# Make sure your secret_key_base is kept private
+# 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 
+# error is raised.
+# Using secret_token for rails3 compatibility. Change to secret_key_base
+# to avoid deprecation warning.
+# Can be safely removed in a rails3 api-only application.
+<%= app_const %>.config.secret_token = '<%= app_secret %>'

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

@@ -16,14 +16,6 @@ class <%= controller_class_name %>Controller < ApplicationController
     render json: <%= "@#{singular_table_name}" %>
   end
 
-  # GET <%= route_url %>/new
-  # GET <%= route_url %>/new.json
-  def new
-    @<%= singular_table_name %> = <%= orm_class.build(class_name) %>
-
-    render json: <%= "@#{singular_table_name}" %>
-  end
-
   # POST <%= route_url %>
   # POST <%= route_url %>.json
   def create
@@ -41,7 +33,7 @@ class <%= controller_class_name %>Controller < ApplicationController
   def update
     @<%= singular_table_name %> = <%= orm_class.find(class_name, "params[:id]") %>
 
-    if @<%= orm_instance.update_attributes("params[:#{singular_table_name}]") %>
+    if @<%= Rails::API.rails4? ? orm_instance.update("params[:#{singular_table_name}]") : orm_instance.update_attributes("params[:#{singular_table_name}]") %>
       head :no_content
     else
       render json: <%= "@#{orm_instance.errors}" %>, status: :unprocessable_entity

data/lib/rails-api/templates/test_unit/scaffold/functional_test.rb

@@ -12,11 +12,6 @@ class <%= controller_class_name %>ControllerTest < ActionController::TestCase
     assert_not_nil assigns(:<%= table_name %>)
   end
 
-  test "should get new" do
-    get :new
-    assert_response :success
-  end
-
   test "should create <%= singular_table_name %>" do
     assert_difference('<%= class_name %>.count') do
       post :create, <%= "#{singular_table_name}: { #{attributes_hash} }" %>

data/lib/rails-api/version.rb

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

data/test/api_application/api_application_test.rb

@@ -2,8 +2,6 @@ require 'test_helper'
 require 'action_controller/railtie'
 require 'rack/test'
 
-app.initialize!
-
 class OmgController < ActionController::API
   def index
     render :text => "OMG"
@@ -13,6 +11,8 @@ end
 class ApiApplicationTest < ActiveSupport::TestCase
   include ::Rack::Test::Methods
 
+  app.initialize!
+
   def test_boot_api_app
     get "/omg"
     assert_equal 200, last_response.status
@@ -54,7 +54,6 @@ class ApiApplicationTest < ActiveSupport::TestCase
       "Rack::Lock",
       "ActiveSupport::Cache::Strategy::LocalCache",
       "Rack::Runtime",
-      "Rack::MethodOverride",
       "ActionDispatch::RequestId",
       "Rails::Rack::Logger",
       "ActionDispatch::ShowExceptions",
@@ -62,14 +61,10 @@ class ApiApplicationTest < ActiveSupport::TestCase
       "ActionDispatch::RemoteIp",
       "ActionDispatch::Reloader",
       "ActionDispatch::Callbacks",
-      "ActionDispatch::Cookies",
-      "ActionDispatch::Session::CookieStore",
-      "ActionDispatch::Flash",
       "ActionDispatch::ParamsParser",
       "Rack::Head",
       "Rack::ConditionalGet",
       "Rack::ETag",
-      "ActionDispatch::BestStandardsSupport"
     ]
   end
 end

data/test/api_controller/conditional_get_test.rb

@@ -51,7 +51,7 @@ class ConditionalGetApiTest < ActionController::TestCase
     @request.if_modified_since = @last_modified
     get :one
     assert_equal 304, @response.status.to_i
-    assert_blank @response.body
+    assert @response.body.blank?
     assert_equal @last_modified, @response.headers['Last-Modified']
   end
 end

data/test/generators/app_generator_test.rb

@@ -28,28 +28,37 @@ class AppGeneratorTest < Rails::Generators::TestCase
   private
 
   def default_files
-    %W(.gitignore
-       Gemfile
-       Rakefile
-       config.ru
-       app/controllers
-       app/mailers
-       app/models
-       config/environments
-       config/initializers
-       config/locales
-       db
-       doc
-       lib
-       lib/tasks
-       lib/assets
-       log
-       script/rails
-       test/fixtures
-       test/#{generated_test_funcional_dir}
-       test/integration
-       test/performance
-       test/#{generated_test_unit_dir})
+    files = %W(
+      .gitignore
+      Gemfile
+      Rakefile
+      config.ru
+      app/controllers
+      app/mailers
+      app/models
+      config/environments
+      config/initializers
+      config/locales
+      db
+      lib
+      lib/tasks
+      lib/assets
+      log
+      test/fixtures
+      test/#{generated_test_funcional_dir}
+      test/integration
+      test/#{generated_test_unit_dir}
+    )
+    files.concat rails4? ? default_files_rails4 : default_files_rails3
+    files
+  end
+
+  def default_files_rails3
+    %w(script/rails)
+  end
+
+  def default_files_rails4
+    %w(bin/bundle bin/rails bin/rake)
   end
 
   def skipped_files

data/test/generators/resource_generator_test.rb

@@ -11,7 +11,7 @@ class ResourceGeneratorTest < Rails::Generators::TestCase
     run_generator
 
     assert_file "config/routes.rb" do |route|
-      assert_match(/resources :accounts, except: :edit$/, route)
+      assert_match(/resources :accounts, except: \[:new, :edit\]$/, route)
       assert_no_match(/resources :accounts$/, route)
     end
   end

data/test/generators/scaffold_generator_test.rb

@@ -29,7 +29,7 @@ class ScaffoldGeneratorTest < Rails::Generators::TestCase
 
     # Route
     assert_file "config/routes.rb" do |content|
-      assert_match(/resources :product_lines, except: :edit$/, content)
+      assert_match(/resources :product_lines, except: \[:new, :edit\]$/, content)
       assert_no_match(/resource :product_lines$/, content)
     end
 
@@ -46,10 +46,6 @@ class ScaffoldGeneratorTest < Rails::Generators::TestCase
         assert_match(/@product_line = ProductLine\.find\(params\[:id\]\)/, m)
       end
 
-      assert_instance_method :new, content do |m|
-        assert_match(/@product_line = ProductLine\.new/, m)
-      end
-
       assert_instance_method :create, content do |m|
         assert_match(/@product_line = ProductLine\.new\(params\[:product_line\]\)/, m)
         assert_match(/@product_line\.save/, m)
@@ -58,7 +54,11 @@ class ScaffoldGeneratorTest < Rails::Generators::TestCase
 
       assert_instance_method :update, content do |m|
         assert_match(/@product_line = ProductLine\.find\(params\[:id\]\)/, m)
-        assert_match(/@product_line\.update_attributes\(params\[:product_line\]\)/, m)
+        if rails4?
+          assert_match(/@product_line\.update\(params\[:product_line\]\)/, m)
+        else
+          assert_match(/@product_line\.update_attributes\(params\[:product_line\]\)/, m)
+        end
         assert_match(/@product_line\.errors/, m)
       end
 
@@ -70,8 +70,13 @@ class ScaffoldGeneratorTest < Rails::Generators::TestCase
 
     assert_file "test/#{generated_test_funcional_dir}/product_lines_controller_test.rb" do |test|
       assert_match(/class ProductLinesControllerTest < ActionController::TestCase/, test)
-      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)
+      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
+        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)
+      end
       assert_no_match(/assert_redirected_to/, test)
     end
 
@@ -88,5 +93,6 @@ class ScaffoldGeneratorTest < Rails::Generators::TestCase
     # Assets
     assert_no_file "app/assets/stylesheets/scaffold.css"
     assert_no_file "app/assets/stylesheets/product_lines.css"
+    assert_no_file "app/assets/javascripts/product_lines.js"
   end
 end

data/test/test_helper.rb

@@ -1,50 +1,57 @@
 # Configure Rails Environment
 ENV["RAILS_ENV"] = "test"
 
+require 'bundler/setup'
 require 'rails'
 require 'rails/test_help'
 require 'rails-api'
 
 def rails4?
-  Rails.version.start_with? '4'
+  Rails::API.rails4?
 end
 
-def app
-  @@app ||= Class.new(Rails::Application) do
-    config.active_support.deprecation = :stderr
-    config.generators do |c|
-      c.orm :active_record, :migration => true,
-                            :timestamps => true
-
-      c.test_framework :test_unit, :fixture => true,
-                                   :fixture_replacement => nil
-
-      c.integration_tool :test_unit
-      c.performance_tool :test_unit
+class ActiveSupport::TestCase
+  def self.app
+    @@app ||= Class.new(Rails::Application) do
+      config.active_support.deprecation = :stderr
+      config.generators do |c|
+        c.orm :active_record, :migration => true,
+          :timestamps => true
+
+        c.test_framework :test_unit, :fixture => true,
+          :fixture_replacement => nil
+
+        c.integration_tool :test_unit
+        c.performance_tool :test_unit
+      end
+
+      if rails4?
+        config.eager_load = false
+        config.secret_key_base = 'abc123'
+      end
+
+      def self.name
+        'TestApp'
+      end
     end
+  end
 
-    if rails4?
-      config.eager_load = false
-      config.secret_key_base = 'abc123'
-    end
+  def app
+    self.class.app
+  end
 
-    def self.name
-      'TestApp'
-    end
+  app.routes.append do
+    get ':controller(/:action)'
   end
-end
+  app.routes.finalize!
 
-app.routes.append do
-  get ':controller(/:action)'
+  app.load_generators
 end
-app.routes.finalize!
 
 module ActionController
   class API
-    include app.routes.url_helpers
+    include ActiveSupport::TestCase.app.routes.url_helpers
   end
 end
 
-app.load_generators
-
 Rails.logger = Logger.new("/dev/null")

metadata

@@ -1,52 +1,46 @@
 --- !ruby/object:Gem::Specification
 name: rails-api
 version: !ruby/object:Gem::Version
-  version: 0.0.3
-  prerelease: 
+  version: 0.1.0
 platform: ruby
 authors:
 - Santiago Pastorino and Carlos Antonio da Silva
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-18 00:00:00.000000000 Z
+date: 2013-04-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
-        version: 3.2.6
+        version: 3.2.11
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
-        version: 3.2.6
+        version: 3.2.11
 - !ruby/object:Gem::Dependency
   name: railties
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
-        version: 3.2.6
+        version: 3.2.11
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
-        version: 3.2.6
+        version: 3.2.11
 - !ruby/object:Gem::Dependency
   name: tzinfo
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -54,7 +48,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -62,22 +55,21 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
-        version: 3.2.6
+        version: 3.2.11
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
-        version: 3.2.6
-description: ! "Rails::API is a subset of a normal Rails application,\n                         created
-  for applications that don't require all\n                         functionality
-  that a complete Rails application provides"
+        version: 3.2.11
+description: |-
+  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
 email:
 - <santiago@wyeworks.com>
 - <carlosantoniodasilva@gmail.com>
@@ -94,6 +86,7 @@ files:
 - lib/rails-api/generators/rails/app/app_generator.rb
 - lib/rails-api/public_exceptions.rb
 - 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
@@ -117,27 +110,26 @@ files:
 homepage: https://github.com/spastorino/rails-api
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.0.0
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Rails for API only Applications
 test_files:
 - test/api_application/api_application_test.rb