acts_as_api 0.3.11 → 0.4

data/spec/shared_engine/app/assets/javascripts/shared_engine/application.js

@@ -0,0 +1,15 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// the compiled file.
+//
+// WARNING: THE FIRST BLANK LINE MARKS THE END OF WHAT'S TO BE PROCESSED, ANY BLANK LINE SHOULD
+// GO AFTER THE REQUIRES BELOW.
+//
+//= require jquery
+//= require jquery_ujs
+//= require_tree .

data/spec/shared_engine/app/assets/stylesheets/shared_engine/application.css

@@ -0,0 +1,13 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+*/

data/spec/shared_engine/app/controllers/shared_engine/application_controller.rb

@@ -0,0 +1,4 @@
+module SharedEngine
+  class ApplicationController < ActionController::Base
+  end
+end

data/spec/shared_engine/app/controllers/shared_engine/respond_with_users_controller.rb

@@ -0,0 +1,59 @@
+module SharedEngine
+  class RespondWithUsersController < SharedEngine::ApplicationController
+
+    respond_to :json, :xml
+
+    self.responder = ActsAsApi::Responder
+
+    def index
+      @users = User.all.sort_by(&:first_name)
+      respond_with @users, :api_template => params[:api_template].to_sym, :root => :users
+    end
+
+    def index_meta
+      @users = User.all
+      meta_hash = { :page => 1, :total => 999 }
+      respond_with @users, :api_template => params[:api_template].to_sym, :root => :users, :meta => meta_hash
+    end
+  
+    def index_relation
+      @users = User.limit(100).sort_by(&:first_name)
+      respond_with @users, :api_template => params[:api_template].to_sym
+    end  
+
+    def show
+      @user = User.find(params[:id])
+      # :root => :user is only used here because we need it for the node name of the MongoUser model
+      respond_with @user, :api_template => params[:api_template].to_sym, :root => :user
+    end
+
+    def show_meta
+      @user = User.find(params[:id])
+      meta_hash = { :page => 1, :total => 999 }
+      # :root => :user is only used here because we need it for the node name of the MongoUser model
+      respond_with @user, :api_template => params[:api_template].to_sym, :root => :user, :meta => meta_hash
+    end
+
+    def show_default
+      @user = User.find(params[:id])
+      respond_with @user
+    end
+
+    def show_prefix_postfix
+      @user = User.find(params[:id])
+      # :root => :user is only used here because we need it for the node name of the MongoUser model
+      respond_with @user, :api_template => {:template => params[:api_template], :prefix => params[:api_prefix], :postfix => params[:api_postfix]}, :root => :user
+    end
+
+    def create
+      @user = User.new(params[:user])
+
+      if @user.save
+        respond_with @user, :api_template => params[:api_template]
+      else
+        respond_with @user
+      end
+    end
+
+  end
+end

data/spec/shared_engine/app/controllers/shared_engine/users_controller.rb

@@ -0,0 +1,71 @@
+module SharedEngine
+  class UsersController < SharedEngine::ApplicationController
+
+    def index
+      @users = User.all.sort_by(&:first_name)
+
+      respond_to do |format|
+        format.xml  { render_for_api params[:api_template].to_sym, :xml => @users, :root => :users }
+        format.json { render_for_api params[:api_template].to_sym, :json => @users, :root => :users }
+      end
+    end
+
+    def index_meta
+      @users = User.all
+      meta_hash = { :page => 1, :total => 999 }
+
+      respond_to do |format|
+        format.xml  { render_for_api params[:api_template].to_sym, :xml => @users, :root => :users,  :meta => meta_hash }
+        format.json { render_for_api params[:api_template].to_sym, :json => @users, :root => :users, :meta => meta_hash }
+      end
+    end
+  
+    def index_relation
+      @users = User.limit(100).sort_by(&:first_name)
+
+      respond_to do |format|
+        format.xml  { render_for_api params[:api_template].to_sym, :xml => @users }
+        format.json { render_for_api params[:api_template].to_sym, :json => @users }
+      end    
+    end
+
+    def show
+      @user = User.find(params[:id])
+
+      respond_to do |format|
+        # :root => :user is only used here because we need it for the node name of the MongoUser model
+        format.xml  { render_for_api params[:api_template].to_sym, :xml => @user, :root => :user }
+        format.json { render_for_api params[:api_template].to_sym, :json => @user, :root => :user }
+      end
+    end
+
+    def show_meta
+      @user = User.find(params[:id])
+      meta_hash = { :page => 1, :total => 999 }
+      respond_to do |format|
+        # :root => :user is only used here because we need it for the node name of the MongoUser model
+        format.xml  { render_for_api params[:api_template].to_sym, :xml => @user, :root => :user }
+        format.json { render_for_api params[:api_template].to_sym, :json => @user, :root => :user, :meta => meta_hash }
+      end
+    end
+
+    def show_default
+      @user = User.find(params[:id])
+      respond_to do |format|
+        format.xml { render :xml => @user }
+        format.json { render :json => @user }
+      end
+    end
+
+    def show_prefix_postfix
+      @user = User.find(params[:id])
+      template = {:template => params[:api_template], :prefix => params[:api_prefix], :postfix => params[:api_postfix]}
+      respond_to do |format|
+        # :root => :user is only used here because we need it for the node name of the MongoUser model
+        format.xml { render_for_api template, :xml => @user, :root => :user }
+        format.json { render_for_api template, :json => @user, :root => :user }
+      end
+    end
+
+  end
+end

data/spec/shared_engine/app/helpers/shared_engine/application_helper.rb

@@ -0,0 +1,4 @@
+module SharedEngine
+  module ApplicationHelper
+  end
+end

data/spec/shared_engine/app/models/user_template.rb

@@ -0,0 +1,154 @@
+module UserTemplate
+  extend ActiveSupport::Concern
+
+  included do
+    api_accessible :name_only do |t|
+      t.add :first_name
+      t.add :last_name
+    end
+
+    api_accessible :only_full_name do |t|
+      t.add :full_name
+    end
+
+    api_accessible :rename_last_name do |t|
+      t.add :last_name, :as => :family_name
+    end
+
+    api_accessible :rename_full_name do |t|
+      t.add :full_name, :as => :other_full_name
+    end
+
+    api_accessible :with_former_value do |t|
+      t.add :first_name
+      t.add :last_name
+    end
+
+    api_accessible :age_and_first_name, :extend => :with_former_value do |t|
+      t.add :age
+      t.remove :last_name
+    end
+
+    api_accessible :calling_a_proc do |t|
+      t.add Proc.new{|model| model.full_name.upcase  }, :as => :all_caps_name
+      t.add Proc.new{|model| Time.now.class.to_s  }, :as => :without_param
+    end
+
+    api_accessible :calling_a_lambda do |t|
+      t.add lambda{|model| model.full_name.upcase  }, :as => :all_caps_name
+      t.add lambda{|model| Time.now.class.to_s  }, :as => :without_param
+    end
+    api_accessible :include_tasks do |t|
+      t.add :tasks
+    end
+
+    api_accessible :include_profile do |t|
+      t.add :profile
+    end
+
+    api_accessible :other_sub_template do |t|
+      t.add :first_name
+      t.add :tasks, :template => :other_template
+    end
+
+    api_accessible :include_completed_tasks do |t|
+      t.add "tasks.completed.all", :as => :completed_tasks
+    end
+
+    api_accessible :sub_node do |t|
+      t.add Hash[:foo => :say_something], :as => :sub_nodes
+    end
+
+    api_accessible :nested_sub_node do |t|
+      t.add Hash[:foo, Hash[:bar, :last_name]], :as => :sub_nodes
+    end
+
+    api_accessible :nested_sub_hash do |t|
+      t.add :sub_hash
+    end
+
+    api_accessible :if_over_thirty do |t|
+      t.add :first_name
+      t.add :last_name, :if => :over_thirty?
+    end
+
+    api_accessible :if_returns_nil do |t|
+      t.add :first_name
+      t.add :last_name, :if => :return_nil
+    end
+
+    api_accessible :if_over_thirty_proc do |t|
+      t.add :first_name
+      t.add :last_name, :if => lambda{|u| u.over_thirty? }
+    end
+
+    api_accessible :if_returns_nil_proc do |t|
+      t.add :first_name
+      t.add :last_name, :if => lambda{|u| nil }
+    end
+
+    api_accessible :unless_under_thirty do |t|
+      t.add :first_name
+      t.add :last_name, :unless => :under_thirty?
+    end
+
+    api_accessible :unless_returns_nil do |t|
+      t.add :first_name
+      t.add :last_name, :unless => :return_nil
+    end
+
+    api_accessible :unless_under_thirty_proc do |t|
+      t.add :first_name
+      t.add :last_name, :unless => lambda{|u| u.under_thirty? }
+    end
+
+    api_accessible :unless_returns_nil_proc do |t|
+      t.add :first_name
+      t.add :last_name, :unless => lambda{|u| nil }
+    end
+
+    api_accessible :with_prefix_name_only do |t|
+      t.add lambda{|model| 'true' }, :as => :prefix
+      t.add :first_name
+      t.add :last_name
+    end
+
+    api_accessible :name_only_with_postfix do |t|
+      t.add :first_name
+      t.add :last_name
+      t.add lambda{|model| 'true' }, :as => :postfix
+    end
+
+    api_accessible :with_prefix_name_only_with_postfix do |t|
+      t.add lambda{|model| 'true' }, :as => :prefix
+      t.add :first_name
+      t.add :last_name
+      t.add lambda{|model| 'true' }, :as => :postfix
+    end
+
+    def before_api_response(api_response)
+      @before_api_response_called = true
+    end
+
+    def before_api_response_called?
+      !!@before_api_response_called
+    end
+
+    def after_api_response(api_response)
+      @after_api_response_called = true
+    end
+
+    def after_api_response_called?
+      !!@after_api_response_called
+    end
+
+    def skip_api_response=(should_skip)
+      @skip_api_response = should_skip
+    end
+
+    def around_api_response(api_response)
+      @skip_api_response ? { :skipped => true } : yield
+    end
+
+  end
+end

data/spec/shared_engine/app/views/layouts/shared_engine/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>SharedEngine</title>
+  <%= stylesheet_link_tag    "shared_engine/application", :media => "all" %>
+  <%= javascript_include_tag "shared_engine/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/spec/{rails_app → shared_engine}/config/routes.rb

@@ -1,5 +1,4 @@
-RailsApp::Application.routes.draw do
-
+SharedEngine::Engine.routes.draw do
   resources :users do
     collection do
       get 'index_meta'
@@ -15,7 +14,7 @@ RailsApp::Application.routes.draw do
   resources :respond_with_users do
     collection do
       get 'index_meta'
-      get 'index_relation'      
+      get 'index_relation'
     end
     member do
       get 'show_meta'
@@ -23,5 +22,4 @@ RailsApp::Application.routes.draw do
       get 'show_prefix_postfix'
     end
   end
-
 end

data/spec/shared_engine/dummy/README.rdoc

@@ -0,0 +1,261 @@
+== Welcome to Rails
+
+Rails is a web-application framework that includes everything needed to create
+database-backed web applications according to the Model-View-Control pattern.
+
+This pattern splits the view (also called the presentation) into "dumb"
+templates that are primarily responsible for inserting pre-built data in between
+HTML tags. The model contains the "smart" domain objects (such as Account,
+Product, Person, Post) that holds all the business logic and knows how to
+persist themselves to a database. The controller handles the incoming requests
+(such as Save New Account, Update Product, Show Post) by manipulating the model
+and directing data to the view.
+
+In Rails, the model is handled by what's called an object-relational mapping
+layer entitled Active Record. This layer allows you to present the data from
+database rows as objects and embellish these data objects with business logic
+methods. You can read more about Active Record in
+link:files/vendor/rails/activerecord/README.html.
+
+The controller and view are handled by the Action Pack, which handles both
+layers by its two parts: Action View and Action Controller. These two layers
+are bundled in a single package due to their heavy interdependence. This is
+unlike the relationship between the Active Record and Action Pack that is much
+more separate. Each of these packages can be used independently outside of
+Rails. You can read more about Action Pack in
+link:files/vendor/rails/actionpack/README.html.
+
+
+== Getting Started
+
+1. At the command prompt, create a new Rails application:
+       <tt>rails new myapp</tt> (where <tt>myapp</tt> is the application name)
+
+2. Change directory to <tt>myapp</tt> and start the web server:
+       <tt>cd myapp; rails server</tt> (run with --help for options)
+
+3. Go to http://localhost:3000/ and you'll see:
+       "Welcome aboard: You're riding Ruby on Rails!"
+
+4. Follow the guidelines to start developing your application. You can find
+the following resources handy:
+
+* The Getting Started Guide: http://guides.rubyonrails.org/getting_started.html
+* Ruby on Rails Tutorial Book: http://www.railstutorial.org/
+
+
+== Debugging Rails
+
+Sometimes your application goes wrong. Fortunately there are a lot of tools that
+will help you debug it and get it back on the rails.
+
+First area to check is the application log files. Have "tail -f" commands
+running on the server.log and development.log. Rails will automatically display
+debugging and runtime information to these files. Debugging info will also be
+shown in the browser on requests from 127.0.0.1.
+
+You can also log your own messages directly into the log file from your code
+using the Ruby logger class from inside your controllers. Example:
+
+  class WeblogController < ActionController::Base
+    def destroy
+      @weblog = Weblog.find(params[:id])
+      @weblog.destroy
+      logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
+    end
+  end
+
+The result will be a message in your log file along the lines of:
+
+  Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1!
+
+More information on how to use the logger is at http://www.ruby-doc.org/core/
+
+Also, Ruby documentation can be found at http://www.ruby-lang.org/. There are
+several books available online as well:
+
+* Programming Ruby: http://www.ruby-doc.org/docs/ProgrammingRuby/ (Pickaxe)
+* Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide)
+
+These two books will bring you up to speed on the Ruby language and also on
+programming in general.
+
+
+== Debugger
+
+Debugger support is available through the debugger command when you start your
+Mongrel or WEBrick server with --debugger. This means that you can break out of
+execution at any point in the code, investigate and change the model, and then,
+resume execution! You need to install ruby-debug to run the server in debugging
+mode. With gems, use <tt>sudo gem install ruby-debug</tt>. Example:
+
+  class WeblogController < ActionController::Base
+    def index
+      @posts = Post.all
+      debugger
+    end
+  end
+
+So the controller will accept the action, run the first line, then present you
+with a IRB prompt in the server window. Here you can do things like:
+
+  >> @posts.inspect
+  => "[#<Post:0x14a6be8
+          @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>,
+       #<Post:0x14a6620
+          @attributes={"title"=>"Rails", "body"=>"Only ten..", "id"=>"2"}>]"
+  >> @posts.first.title = "hello from a debugger"
+  => "hello from a debugger"
+
+...and even better, you can examine how your runtime objects actually work:
+
+  >> f = @posts.first
+  => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
+  >> f.
+  Display all 152 possibilities? (y or n)
+
+Finally, when you're ready to resume execution, you can enter "cont".
+
+
+== Console
+
+The console is a Ruby shell, which allows you to interact with your
+application's domain model. Here you'll have all parts of the application
+configured, just like it is when the application is running. You can inspect
+domain models, change values, and save to the database. Starting the script
+without arguments will launch it in the development environment.
+
+To start the console, run <tt>rails console</tt> from the application
+directory.
+
+Options:
+
+* Passing the <tt>-s, --sandbox</tt> argument will rollback any modifications
+  made to the database.
+* Passing an environment name as an argument will load the corresponding
+  environment. Example: <tt>rails console production</tt>.
+
+To reload your controllers and models after launching the console run
+<tt>reload!</tt>
+
+More information about irb can be found at:
+link:http://www.rubycentral.org/pickaxe/irb.html
+
+
+== dbconsole
+
+You can go to the command line of your database directly through <tt>rails
+dbconsole</tt>. You would be connected to the database with the credentials
+defined in database.yml. Starting the script without arguments will connect you
+to the development database. Passing an argument will connect you to a different
+database, like <tt>rails dbconsole production</tt>. Currently works for MySQL,
+PostgreSQL and SQLite 3.
+
+== Description of Contents
+
+The default directory structure of a generated Ruby on Rails application:
+
+  |-- app
+  |   |-- assets
+  |       |-- images
+  |       |-- javascripts
+  |       `-- stylesheets
+  |   |-- controllers
+  |   |-- helpers
+  |   |-- mailers
+  |   |-- models
+  |   `-- views
+  |       `-- layouts
+  |-- config
+  |   |-- environments
+  |   |-- initializers
+  |   `-- locales
+  |-- db
+  |-- doc
+  |-- lib
+  |   `-- tasks
+  |-- log
+  |-- public
+  |-- script
+  |-- test
+  |   |-- fixtures
+  |   |-- functional
+  |   |-- integration
+  |   |-- performance
+  |   `-- unit
+  |-- tmp
+  |   |-- cache
+  |   |-- pids
+  |   |-- sessions
+  |   `-- sockets
+  `-- vendor
+      |-- assets
+          `-- stylesheets
+      `-- plugins
+
+app
+  Holds all the code that's specific to this particular application.
+
+app/assets
+  Contains subdirectories for images, stylesheets, and JavaScript files.
+
+app/controllers
+  Holds controllers that should be named like weblogs_controller.rb for
+  automated URL mapping. All controllers should descend from
+  ApplicationController which itself descends from ActionController::Base.
+
+app/models
+  Holds models that should be named like post.rb. Models descend from
+  ActiveRecord::Base by default.
+
+app/views
+  Holds the template files for the view that should be named like
+  weblogs/index.html.erb for the WeblogsController#index action. All views use
+  eRuby syntax by default.
+
+app/views/layouts
+  Holds the template files for layouts to be used with views. This models the
+  common header/footer method of wrapping views. In your views, define a layout
+  using the <tt>layout :default</tt> and create a file named default.html.erb.
+  Inside default.html.erb, call <% yield %> to render the view using this
+  layout.
+
+app/helpers
+  Holds view helpers that should be named like weblogs_helper.rb. These are
+  generated for you automatically when using generators for controllers.
+  Helpers can be used to wrap functionality for your views into methods.
+
+config
+  Configuration files for the Rails environment, the routing map, the database,
+  and other dependencies.
+
+db
+  Contains the database schema in schema.rb. db/migrate contains all the
+  sequence of Migrations for your schema.
+
+doc
+  This directory is where your application documentation will be stored when
+  generated using <tt>rake doc:app</tt>
+
+lib
+  Application specific libraries. Basically, any kind of custom code that
+  doesn't belong under controllers, models, or helpers. This directory is in
+  the load path.
+
+public
+  The directory available for the web server. Also contains the dispatchers and the
+  default HTML files. This should be set as the DOCUMENT_ROOT of your web
+  server.
+
+script
+  Helper scripts for automation and generation.
+
+test
+  Unit and functional tests along with fixtures. When using the rails generate
+  command, template test files will be generated for you and placed in this
+  directory.
+
+vendor
+  External libraries that the application depends on. Also includes the plugins
+  subdirectory. If the app has frozen rails, those gems also go here, under
+  vendor/rails/. This directory is in the load path.