acts_as_api 0.3.10 → 0.3.11

data/History.txt

@@ -1,3 +1,11 @@
+=== 0.3.11 2011-11-06
+
+* Added :postfix, :prefix options for template rendering
+
+=== 0.3.10 2011-10-03
+
+* Fixed Mongoid problems, when no ActiveRecord is available (Ticket #36)
+
 === 0.3.9 2011-09-24
 
 * Spec suite now running on Rails 3.1

data/acts_as_api.gemspec

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# encoding: UTF-8
 $:.push File.expand_path("../lib", __FILE__)
 require "acts_as_api/version"
 

data/lib/acts_as_api/rendering.rb

@@ -8,7 +8,16 @@ module ActsAsApi
     # to simply generate API outputs.
     #
     # The default Rails serializers are used to serialize the data.
-    def render_for_api(api_template, render_options)
+    def render_for_api(api_template_or_options, render_options)
+      if api_template_or_options.is_a?(Hash)
+        api_template = []
+        api_template << api_template_or_options.delete(:prefix)
+        api_template << api_template_or_options.delete(:template)
+        api_template << api_template_or_options.delete(:postfix)
+        api_template = api_template.reject(&:blank?).join('_')
+      else
+        api_template = api_template_or_options
+      end
 
       # extract the api format and model
       api_format_options = {}
@@ -82,4 +91,4 @@ module ActsAsApi
 
   end
 
-end
+end

data/lib/acts_as_api/version.rb

@@ -1,3 +1,3 @@
 module ActsAsApi
-  VERSION = "0.3.10"
+  VERSION = "0.3.11"
 end

data/spec/controllers/respond_with_users_controller_spec.rb

@@ -14,7 +14,6 @@ describe RespondWithUsersController do
 
     # see spec/support/controller_examples.rb
     it_behaves_like "a controller with ActsAsApi responses"
-
   end
 
   context "using mongoid", :orm => :mongoid do

data/spec/models/mongoid_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe Mongoid, :orm => "mongoid" do
+describe "Mongoid", :orm => "mongoid" do
   
   before(:each) do
     setup_mongoid_models
@@ -26,4 +26,4 @@ describe Mongoid, :orm => "mongoid" do
     it_supports "defining a model callback"
   end
   
-end
+end

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

@@ -38,6 +38,12 @@ class RespondWithUsersController < ApplicationController
     respond_with @user
   end
 
+  def show_prefix_postfix
+    @user = @user_model.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_model.new(params[:user])
 

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

@@ -56,4 +56,14 @@ class UsersController < ApplicationController
     end
   end
 
-end
+  def show_prefix_postfix
+    @user = @user_model.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

data/spec/rails_app/app/models/mongo_user.rb

@@ -119,6 +119,25 @@ class MongoUser
     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

data/spec/rails_app/app/models/user.rb

@@ -111,6 +111,25 @@ class User < ActiveRecord::Base
     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

data/spec/rails_app/app/models/vanilla_user.rb

@@ -122,6 +122,25 @@ class VanillaUser
     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

data/spec/rails_app/config/routes.rb

@@ -8,6 +8,7 @@ RailsApp::Application.routes.draw do
     member do
       get 'show_meta'
       get 'show_default'
+      get 'show_prefix_postfix'
     end
   end
 
@@ -19,6 +20,7 @@ RailsApp::Application.routes.draw do
     member do
       get 'show_meta'
       get 'show_default'
+      get 'show_prefix_postfix'
     end
   end
 

data/spec/support/controller_examples.rb

@@ -385,4 +385,80 @@ shared_examples_for "a controller with ActsAsApi responses" do
     end
   end
 
-end
+
+  describe 'api prefix' do
+
+    describe 'get single user' do
+
+      before(:each) do
+        get :show_prefix_postfix, :format => 'xml', :api_template => :name_only, :api_prefix => :with_prefix, :id => @luke.id, :orm => @orm_for_testing
+      end
+
+      it "should have a root node named user" do
+        response_body.should have_selector("user")
+      end
+
+      it "should contain the specified attributes" do
+        response_body.should have_selector("user > prefix")
+        response_body.should have_selector("user > first-name")
+        response_body.should have_selector("user > last-name")
+      end
+
+      it "should not contain the specified attributes" do
+        response_body.should_not have_selector("user > postfix")
+      end
+
+    end
+
+  end
+
+  describe 'api postfix' do
+
+    describe 'get single user' do
+
+      before(:each) do
+        get :show_prefix_postfix, :format => 'xml', :api_template => :name_only, :api_postfix => :with_postfix, :id => @luke.id, :orm => @orm_for_testing
+      end
+
+      it "should have a root node named user" do
+        response_body.should have_selector("user")
+      end
+
+      it "should contain the specified attributes" do
+        response_body.should have_selector("user > first-name")
+        response_body.should have_selector("user > last-name")
+        response_body.should have_selector("user > postfix")
+      end
+
+      it "should not contain the specified attributes" do
+        response_body.should_not have_selector("user > prefix")
+      end
+
+    end
+
+  end
+
+  describe 'api prefix and api postfix' do
+
+    describe 'get single user' do
+
+      before(:each) do
+        get :show_prefix_postfix, :format => 'xml', :api_template => :name_only, :api_prefix => :with_prefix, :api_postfix => :with_postfix, :id => @luke.id, :orm => @orm_for_testing
+      end
+
+      it "should have a root node named user" do
+        response_body.should have_selector("user")
+      end
+
+      it "should contain the specified attributes" do
+        response_body.should have_selector("user > prefix")
+        response_body.should have_selector("user > first-name")
+        response_body.should have_selector("user > last-name")
+        response_body.should have_selector("user > postfix")
+      end
+
+    end
+
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: acts_as_api
 version: !ruby/object:Gem::Version
-  version: 0.3.10
+  version: 0.3.11
   prerelease: 
 platform: ruby
 authors:
@@ -9,12 +9,12 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-10-03 00:00:00.000000000 +02:00
+date: 2011-11-06 00:00:00.000000000 +01:00
 default_executable: 
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
-  requirement: &2257419040 !ruby/object:Gem::Requirement
+  requirement: &2198135880 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,10 +22,10 @@ dependencies:
         version: 3.0.0
   type: :runtime
   prerelease: false
-  version_requirements: *2257419040
+  version_requirements: *2198135880
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &2257418540 !ruby/object:Gem::Requirement
+  requirement: &2198135380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -33,10 +33,10 @@ dependencies:
         version: 3.0.0
   type: :runtime
   prerelease: false
-  version_requirements: *2257418540
+  version_requirements: *2198135380
 - !ruby/object:Gem::Dependency
   name: rack
-  requirement: &2257417900 !ruby/object:Gem::Requirement
+  requirement: &2198134840 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -44,10 +44,10 @@ dependencies:
         version: 1.1.0
   type: :runtime
   prerelease: false
-  version_requirements: *2257417900
+  version_requirements: *2198134840
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &2257417280 !ruby/object:Gem::Requirement
+  requirement: &2198134240 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -55,10 +55,10 @@ dependencies:
         version: 3.1.0
   type: :development
   prerelease: false
-  version_requirements: *2257417280
+  version_requirements: *2198134240
 - !ruby/object:Gem::Dependency
   name: mongoid
-  requirement: &2257416660 !ruby/object:Gem::Requirement
+  requirement: &2198133600 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -66,7 +66,7 @@ dependencies:
         version: 2.0.1
   type: :development
   prerelease: false
-  version_requirements: *2257416660
+  version_requirements: *2198133600
 description: acts_as_api enriches the models and controllers of your app in a rails-like
   way so you can easily determine how your XML/JSON API responses should look like.
 email: