acts_as_api 0.3.0 → 0.3.1

data/.gitignore

@@ -7,4 +7,5 @@ acts_as_api.tmproj
 spec/rails_app/db/*.sqlite3
 spec/rails_app/tmp/**/*
 spec/rails_app/log/*.log
-.rspec
+.rspec
+.rvmrc

data/acts_as_api.gemspec

@@ -14,10 +14,8 @@ Gem::Specification.new do |s|
 
   s.add_dependency('activemodel','>= 3.0.0')
   s.add_dependency('activesupport','>= 3.0.0')
-  s.add_dependency('rack','>= 1.1.0')  
-  # TODO: Problem in Rails with JSON dependency?!
-  # s.add_dependency('json','>= 1.4.6')
-  
+  s.add_dependency('rack','>= 1.1.0')
+    
   s.add_development_dependency('rails', ['>= 3.0.0'])
   
   s.has_rdoc      = true

data/lib/acts_as_api/api_template.rb

@@ -2,8 +2,21 @@ module ActsAsApi
   #
   class ApiTemplate < Hash
 
+    def options_for(key)
+      @options[key]
+    end
+    
+    def option_for(key, value)
+      @options[key][value] if @options[key]
+    end
+
     def add(val, options = {})
-      self[(options[:as] || val).to_sym] = val
+      item_key = (options[:as] || val).to_sym
+      
+      self[item_key] = val
+      
+      @options ||= {}
+      @options[item_key] = options
     end
 
     def remove(key)

data/lib/acts_as_api/base.rb

@@ -40,9 +40,6 @@ module ActsAsApi
 
       def api_accessible(api_template, options = {}, &block)
 
-        #        return api_accessible_deprecated([api_template]) if api_template.is_a? Hash
-
-
         attributes = api_accessible_attributes(api_template) || ApiTemplate.new
 
         attributes.merge!(api_accessible_attributes(options[:extend])) if options[:extend]
@@ -61,7 +58,6 @@ module ActsAsApi
 
     end
 
-
     module InstanceMethods
 
       # Creates the api response of the model and returns it as a Hash.
@@ -81,29 +77,21 @@ module ActsAsApi
 
             leaf[:item].each do |k,v|
 
+              if leaf[:item].respond_to?(:option_for)
+                sub_template = leaf[:item].option_for(k, :template) || api_template
+              else
+                sub_template = api_template
+              end
+
               case v
               when Symbol
 
                 if self.respond_to?(v)
                   out = send v
-
-                  if out.respond_to?(:as_api_response)
-                    out = out.send(:as_api_response, api_template)
-                  end
-
-                  leaf[:parent][k] = out
-
                 end
 
-              when Proc
-                
+              when Proc                
                 out = v.call(self)
-                
-                if out.respond_to?(:as_api_response)
-                  out = out.send(:as_api_response, api_template)
-                end                
-                
-                leaf[:parent][k] = out
 
               when String
                 # go up the call chain
@@ -112,16 +100,17 @@ module ActsAsApi
                   out = out.send(method.to_sym)
                 end
 
-                if out.respond_to?(:as_api_response)
-                  out = out.send(:as_api_response, api_template)
-                end
-
-                leaf[:parent][k] = out
-
               when Hash
                 leaf[:parent][k] ||= {}
                 queue << { :parent =>  leaf[:parent][k], :item => v}
+                next
+              end
+              
+              if out.respond_to?(:as_api_response)
+                out = out.send(:as_api_response, sub_template)              
               end
+              
+              leaf[:parent][k] = out
 
             end
 

data/lib/acts_as_api/config.rb

@@ -7,7 +7,7 @@ module ActsAsApi
       # The accepted response formats
       # Default is <tt>[:xml, :json]</tt>
       attr_accessor_with_default :accepted_api_formats, [:xml, :json] # :nodoc:
-      
+
       # Holds formats that should be dasherized      
       # Default is <tt>[:xml]</tt>      
       attr_accessor_with_default :dasherize_for, [:xml]

data/lib/acts_as_api/version.rb

@@ -1,4 +1,4 @@
 module ActsAsApi
   
-  VERSION = "0.3.0"
+  VERSION = "0.3.1"
 end

data/spec/controllers/users_controller_spec.rb

@@ -1,6 +1,6 @@
 require File.dirname(__FILE__) + '/../spec_helper.rb'
 
-describe UsersController do
+describe UsersController, :orm => :active_record do
 
   include ApiTestHelpers
 

data/spec/models/base_spec.rb

@@ -1,12 +1,14 @@
 require File.dirname(__FILE__) + '/../spec_helper.rb'
 
-describe "acts_as_api" do
+describe "acts_as_api", :orm => :active_record do
 
   before(:each) do
-    @luke = User.create({ :first_name => 'Luke',      :last_name => 'Skywalker', :age => 25, :active => true  })
+    @luke = User.create({ :first_name => 'Luke',      :last_name => 'Skywalker', :age => 25, :active => true  })  
     @han  = User.create({ :first_name => 'Han',       :last_name => 'Solo',      :age => 35, :active => true  })
     @leia = User.create({ :first_name => 'Princess',  :last_name => 'Leia',      :age => 25, :active => false })
 
+    @luke.profile = Profile.create({ :avatar => 'picard.jpg', :homepage => 'lukasarts.com' })
+
     @destroy_deathstar = @luke.tasks.create({ :heading => "Destroy Deathstar", :description => "XWing, Shoot, BlowUp",  :time_spent => 30,  :done => true })
     @study_with_yoda   = @luke.tasks.create({ :heading => "Study with Yoda",   :description => "Jedi Stuff, ya know",   :time_spent => 60,  :done => true })
     @win_rebellion     = @luke.tasks.create({ :heading => "Win Rebellion",     :description => "no idea yet...",        :time_spent => 180, :done => false })
@@ -273,14 +275,99 @@ describe "acts_as_api" do
     end
     
     describe "including an association (which does acts_as_api) in the api template" do
+      
+      context "has_many" do
+    
+        before(:each) do
+          Task.acts_as_api
+          Task.api_accessible :include_tasks do |t|
+            t.add :heading
+            t.add :done
+          end
+          @response = @luke.as_api_response(:include_tasks)        
+        end
+    
+        it "should return a hash" do
+          @response.should be_kind_of(Hash)
+        end
+    
+        it "should return the correct number of keys" do
+          @response.should have(1).key
+        end
+    
+        it "should return all specified fields" do
+          @response.keys.should include(:tasks)
+        end
+    
+        it "should return the correct values for the specified fields" do
+          @response[:tasks].should be_an Array
+          @response[:tasks].should have(3).tasks
+        end
+    
+        it "should contain the associated child models with the determined api template" do
+          @response[:tasks].each do |task|
+            task.keys.should include(:heading, :done)
+            task.keys.should have(2).attributes
+          end
+        end
+    
+        it "should contain the correct data of the child models" do
+          task_hash = [  @destroy_deathstar, @study_with_yoda, @win_rebellion  ].collect{|t| { :done => t.done, :heading => t.heading } }
+          @response[:tasks].should eql task_hash
+        end
+      
+      end
+      
+      context "has_one" do
+          
+        before(:each) do
+          Profile.acts_as_api
+          Profile.api_accessible :include_profile do |t|
+            t.add :avatar
+            t.add :homepage
+          end
+          @response = @luke.as_api_response(:include_profile)
+        end
+          
+        it "should return a hash" do
+          @response.should be_kind_of(Hash)
+        end
+          
+        it "should return the correct number of keys" do
+          @response.should have(1).key
+        end
+          
+        it "should return all specified fields" do
+          @response.keys.should include(:profile)
+        end
+          
+        it "should return the correct values for the specified fields" do
+          @response[:profile].should be_a Hash
+          @response[:profile].should have(2).attributes
+        end
+          
+        it "should contain the associated child models with the determined api template" do
+          @response[:profile].keys.should include(:avatar, :homepage)
+        end
+          
+        it "should contain the correct data of the child models" do
+          profile_hash = { :avatar => @luke.profile.avatar, :homepage => @luke.profile.homepage }
+          @response[:profile].should eql profile_hash
+        end
+      
+      end      
+      
+    end
+    
+    describe "including an association (which does acts_as_api, but with using another template name) in the api template", :meow => true do
     
       before(:each) do
         Task.acts_as_api
-        Task.api_accessible :include_tasks do |t|
-          t.add :heading
-          t.add :done
+        Task.api_accessible :other_template do |t|
+          t.add :description
+          t.add :time_spent
         end
-        @response = @luke.as_api_response(:include_tasks)
+        @response = @luke.as_api_response(:other_sub_template)
       end
     
       it "should return a hash" do
@@ -288,9 +375,17 @@ describe "acts_as_api" do
       end
     
       it "should return the correct number of keys" do
-        @response.should have(1).key
+        @response.should have(2).keys
+      end
+      
+      it "should return all specified fields" do
+        @response.keys.should include(:first_name)
       end
     
+      it "should return the correct values for the specified fields" do
+        @response.values.should include(@luke.first_name)
+      end      
+    
       it "should return all specified fields" do
         @response.keys.should include(:tasks)
       end
@@ -302,17 +397,17 @@ describe "acts_as_api" do
     
       it "should contain the associated child models with the determined api template" do
         @response[:tasks].each do |task|
-          task.keys.should include(:heading, :done)
+          task.keys.should include(:description, :time_spent)
           task.keys.should have(2).attributes
         end
       end
     
       it "should contain the correct data of the child models" do
-        task_hash = [  @destroy_deathstar, @study_with_yoda, @win_rebellion  ].collect{|t| { :done => t.done, :heading => t.heading } }
+        task_hash = [  @destroy_deathstar, @study_with_yoda, @win_rebellion  ].collect{|t| { :description => t.description, :time_spent => t.time_spent } }
         @response[:tasks].should eql task_hash
       end
     
-    end
+    end        
     
     describe "including a scoped association in the api template" do
     

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

@@ -0,0 +1,3 @@
+class Profile < ActiveRecord::Base
+  belongs_to :user    
+end

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

@@ -2,6 +2,8 @@ class User < ActiveRecord::Base
 
   has_many :tasks
   
+  has_one :profile
+  
   acts_as_api
   
   api_accessible :name_only do |t|
@@ -40,11 +42,19 @@ class User < ActiveRecord::Base
     t.add lambda{|model| model.full_name.upcase  }, :as => :all_caps_name
     t.add lambda{ Time.now.class.to_s  }, :as => :without_param
   end
-  
   User.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

data/spec/rails_app/db/migrate/20110214201640_create_tables.rb

@@ -20,6 +20,14 @@ class CreateTables < ActiveRecord::Migration
       t.datetime "updated_at"
     end
     
+    create_table "profiles", :force => true do |t|
+      t.integer  "user_id"
+      t.string   "avatar"
+      t.string   "homepage"
+      t.datetime "created_at"
+      t.datetime "updated_at"
+    end    
+    
     create_table :untoucheds do |t|
       t.string   "nothing"
       t.timestamps
@@ -29,6 +37,7 @@ class CreateTables < ActiveRecord::Migration
 
   def self.down
     drop_table :untoucheds
+    drop_table :profiles
     drop_table :tasks
     drop_table :users    
   end

data/spec/rails_app/db/schema.rb

@@ -21,6 +21,14 @@ ActiveRecord::Schema.define(:version => 20110214201640) do
     t.datetime "created_at"
     t.datetime "updated_at"
   end
+  
+  create_table "profiles", :force => true do |t|
+    t.integer  "user_id"
+    t.string   "avatar"
+    t.string   "homepage"
+    t.datetime "created_at"
+    t.datetime "updated_at"
+  end  
 
   create_table "users", :force => true do |t|
     t.string   "first_name"
@@ -30,5 +38,10 @@ ActiveRecord::Schema.define(:version => 20110214201640) do
     t.datetime "created_at"
     t.datetime "updated_at"
   end
+  
+  create_table "untoucheds", :force => true do |t|
+    t.string   "nothing"
+    t.timestamps
+  end  
 
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: acts_as_api
 version: !ruby/object:Gem::Version 
-  hash: 19
+  hash: 17
   prerelease: 
   segments: 
   - 0
   - 3
-  - 0
-  version: 0.3.0
+  - 1
+  version: 0.3.1
 platform: ruby
 authors: 
 - "Christian B\xC3\xA4uerlein"
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-22 00:00:00 +01:00
+date: 2011-04-08 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -119,6 +119,7 @@ files:
 - spec/rails_app/app/controllers/respond_with_users_controller.rb
 - spec/rails_app/app/controllers/users_controller.rb
 - spec/rails_app/app/helpers/application_helper.rb
+- spec/rails_app/app/models/profile.rb
 - spec/rails_app/app/models/task.rb
 - spec/rails_app/app/models/untouched.rb
 - spec/rails_app/app/models/user.rb
@@ -192,7 +193,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.4.2
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: Makes creating XML/JSON responses in Rails 3 easy and fun.
@@ -206,6 +207,7 @@ test_files:
 - spec/rails_app/app/controllers/respond_with_users_controller.rb
 - spec/rails_app/app/controllers/users_controller.rb
 - spec/rails_app/app/helpers/application_helper.rb
+- spec/rails_app/app/models/profile.rb
 - spec/rails_app/app/models/task.rb
 - spec/rails_app/app/models/untouched.rb
 - spec/rails_app/app/models/user.rb