acts_as_api_sequel 0.0.1

data/spec/active_record_dummy/public/robots.txt

@@ -0,0 +1,5 @@
+# See http://www.robotstxt.org/wc/norobots.html for documentation on how to use the robots.txt file
+#
+# To ban all spiders from the entire site uncomment the next two lines:
+# User-Agent: *
+# Disallow: /

data/spec/active_record_dummy/script/rails

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails 3 gems installed from the root of your application.
+
+APP_PATH = File.expand_path('../../config/application',  __FILE__)
+require File.expand_path('../../config/boot',  __FILE__)
+require 'rails/commands'

data/spec/controllers/plain_objects_controller_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+
+describe SharedEngine::PlainObjectsController do
+  include ApiTestHelpers
+
+  before(:each) do
+    class SharedEngine::PlainObjectsController
+      include SimpleFixtures
+    end
+  end
+
+  describe 'get all users as a an array of plain objects, autodetecting the root node name' do
+
+    before(:each) do
+      get :index, :format => 'json', :api_template => :name_only
+    end
+
+    it "should have a root node named users" do
+      response_body_json.should have_key("plain_objects")
+    end
+
+    it "should contain all users" do
+      response_body_json["plain_objects"].should be_a(Array)
+    end
+
+    it "should contain the specified attributes" do
+      response_body_json["plain_objects"].first.should have_key("first_name")
+      response_body_json["plain_objects"].first.should have_key("last_name")
+    end
+
+    it "should contain the specified values" do
+      response_body_json["plain_objects"].first["first_name"].should eql("Han")
+      response_body_json["plain_objects"].first["last_name"].should eql("Solo")
+    end
+  end
+end

data/spec/controllers/respond_with_users_controller_spec.rb

@@ -0,0 +1,142 @@
+require 'spec_helper'
+#
+# RSpec.configure do |config|
+#   config.include SharedEngine::Engine.routes.url_helpers
+# end
+
+describe SharedEngine::RespondWithUsersController do
+
+  before(:each) do
+    setup_models
+  end
+
+  after(:each) do
+   clean_up_models
+  end
+
+  # see spec/support/controller_examples.rb
+  it_behaves_like "a controller with ActsAsApi responses"
+
+  describe "default ActionController::Responder behavior" do
+
+    context 'json responses' do
+
+      context "creating valid models" do
+
+        before(:each) do
+          post :create, :user => { :first_name => "Luke", :last_name => "Skywalker" }, :api_template => :name_only, :format => 'json'
+        end
+
+        it "should return HTTP 201 status" do
+          response.code.should == "201"
+        end
+
+        it "should contain the specified attributes" do
+          response_body_json["user"].should have_key("first_name")
+          response_body_json["user"].should have_key("last_name")
+        end
+
+        it "should contain the specified values" do
+          response_body_json["user"]["first_name"].should eql("Luke")
+          response_body_json["user"]["last_name"].should eql("Skywalker")
+        end
+      end
+
+      context "creating invalid models" do
+
+        before(:each) do
+          post :create, :user => {}, :api_template => :name_only, :format => 'json'
+        end
+
+        it "should return HTTP 422 status" do
+          response.code.should == "422"
+        end
+
+        it "should return errors as json" do
+          response_body_json['errors']['first_name'].should include("can't be blank")
+          response_body_json['errors']['last_name'].should include("can't be blank")
+        end
+
+      end
+      
+      context "returning all models without default root and no order" do
+
+        before(:each) do
+          get :index_no_root_no_order, :api_template => :name_only, :format => 'json'
+        end
+
+        it "should return HTTP 200 status" do
+          response.code.should == "200"
+        end
+
+        it "should contain the specified attributes" do
+          response_body_json["users"].each do |user|
+            user.should have_key( "first_name" )
+            user.should have_key( "last_name" )
+          end
+        end
+
+      end
+
+    end
+
+    context 'xml responses' do
+
+      context "creating valid models" do
+
+        before(:each) do
+          post :create, :user => { :first_name => "Luke", :last_name => "Skywalker" }, :api_template => :name_only, :format => 'xml'
+        end
+
+        it "should return HTTP 201 status" do
+          response.code.should == "201"
+        end
+
+        it "should include HTTP Location header" do
+          response.headers["Location"].should match "/shared/users/#{User.last.id}"
+        end
+
+        it "should contain the specified attributes" do
+          response_body.should have_selector("user > first-name")
+          response_body.should have_selector("user > last-name")
+        end
+
+      end
+
+      context "creating invalid models" do
+
+        before(:each) do
+          post :create, :user => {}, :api_template => :name_only, :format => 'xml'
+        end
+
+        it "should return HTTP 422 status" do
+          response.code.should == "422"
+        end
+
+        it "should return errors as xml" do
+          response_body.should have_selector("errors > error")
+        end
+
+      end
+
+      context "returning all models without default root and no order" do
+
+        before(:each) do
+          get :index_no_root_no_order, :api_template => :name_only, :format => 'xml'
+        end
+
+        it "should return HTTP 200 status" do
+          response.code.should == "200"
+        end
+
+        it "should contain the specified attributes" do
+          response_body.should have_selector( "users > user > first-name", :count => 3 )
+          response_body.should have_selector( "users > user > last-name", :count => 3 )
+        end
+
+      end
+    end
+
+  end
+
+end

data/spec/controllers/users_controller_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+describe SharedEngine::UsersController do
+  
+  before(:each) do
+    setup_models
+  end
+
+  after(:each) do
+   clean_up_models
+  end
+
+  # see spec/support/controller_examples.rb
+  it_behaves_like "a controller with ActsAsApi responses"
+end

data/spec/models/model_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+describe "Models" do
+  
+  before(:each) do
+    setup_models
+  end
+
+  after(:each) do
+    clean_up_models
+  end
+  
+  describe :act_as_api do
+    it_supports "including an association in the api template"
+    it_supports "calling a closure in the api template"
+    it_supports "conditional if statements"
+    it_supports "conditional unless statements" 
+    it_supports "acts_as_api is enabled"
+    it_supports "extending a given api template"
+    it_supports "calling a method in the api template"
+    it_supports "renaming"
+    it_supports "listing attributes in the api template"
+    it_supports "creating a sub hash in the api template"
+    it_supports "trying to render an api template that is not defined"
+    # deactivated for vanilla ruby as acts_as_api won't get mixed into any class
+    it_supports "untouched models" 
+    it_supports "defining a model callback"
+    it_supports "options"
+  end
+  
+end

data/spec/mongoid_dummy/.gitignore

@@ -0,0 +1,15 @@
+# See http://help.github.com/ignore-files/ for more about ignoring files.
+#
+# If you find yourself ignoring temporary files generated by your text editor
+# or operating system, you probably want to add a global ignore instead:
+#   git config --global core.excludesfile ~/.gitignore_global
+
+# Ignore bundler config
+/.bundle
+
+# Ignore the default SQLite database.
+/db/*.sqlite3
+
+# Ignore all logfiles and tempfiles.
+/log/*.log
+/tmp

data/spec/mongoid_dummy/Gemfile

@@ -0,0 +1,18 @@
+source 'https://rubygems.org'
+
+gem 'rails', '3.2.3'
+
+# Bundle edge Rails instead:
+# gem 'rails', :git => 'git://github.com/rails/rails.git'
+
+
+gem "bson_ext"
+gem "mongoid", ">= 3.0.0.rc"
+
+gem 'shared_engine', :path => '../shared_engine'
+gem 'acts_as_api', :path => '../../'
+
+group :test do
+  gem 'rspec-rails', '>= 2.5.0'
+  gem 'webrat'  
+end

data/spec/mongoid_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.