to_api 1.1.1 → 1.1.2

data/lib/to_api/version.rb

@@ -1,3 +1,3 @@
 module ToApi
-  VERSION = "1.1.1"
+  VERSION = "1.1.2"
 end

data/lib/to_api.rb

@@ -1,32 +1,80 @@
+module ToApiSelf
+  def to_api(*includes)
+    self
+  end
+end
+[ Fixnum, String, DateTime, Date, Time, NilClass ].each do |klass|
+  klass.send(:include, ToApiSelf)
+end
+
+module ToApiInstanceMethods
+  def build_to_api_include_hash(*includes)
+    include_hash = {}
+    includes.each do |i| 
+      if i.kind_of?(Hash)
+        i.each do |k,v|
+          include_hash[k] = v
+        end
+      else
+        include_hash[i] = []
+      end
+    end
+    include_hash
+  end
+end
+
+module ToApiFilter
+  def add_to_api_filter(include_name, &block)
+    @_to_api_filters ||= {}
+    @_to_api_filters[include_name] = block
+  end
+
+  def to_api_filters=(filters)
+    @_to_api_filters = filters
+  end
+
+  def to_api_filters
+    @_to_api_filters ||={}
+    @_to_api_filters
+  end
+end 
+
 if Object.const_defined? :ActiveRecord
+
   class ActiveRecord::Base
+    include ToApiFilter
+
     def to_api(*includes) #assumes all attribute types are fine
       hash = {}
-      valid_includes = (self.class.reflect_on_all_associations.map(&:name).map(&:to_s) | self.valid_api_includes)
+      valid_includes = (self.class.reflect_on_all_associations.map(&:name).map(&:to_s) | self.valid_api_includes | self.attributes.keys)
     
-      include_hash = {}
-      includes.each do |i| 
-        if i.kind_of?(Hash)
-          i.each do |k,v|
-            include_hash[k.to_s] = v
-          end
-        else
-          include_hash[i.to_s] = []
+      include_hash = build_to_api_ar_include_hash(*includes)    
+      include_hash.keys.each do |inc|
+        if to_api_filters.has_key?(inc)
+          child_includes = include_hash.delete(inc) || []
+          hash[inc] = to_api_filters[inc].call self, child_includes
         end
       end
-    
+
       include_hash.delete_if{|k,v| !valid_includes.include?(k.to_s)}
-    
       to_api_attributes.each do |k, v|
-        attribute_includes = include_hash[k] || []
-        v = v.to_api(*attribute_includes) 
-        hash[k] = v
+        unless hash[k]
+          v.to_api_filters = to_api_filters if v.respond_to? :to_api_filters
+
+          attribute_includes = include_hash[k] || []
+          to_api_v = v.to_api(*[attribute_includes].flatten.compact) 
+          hash[k] = to_api_v
+        end
       end
 
-      (include_hash.keys-attributes.keys).each do |relation|
-        relation_includes = include_hash[relation] || []
-        api_obj = self.send(relation)
-        hash[relation.to_s] = api_obj.respond_to?(:to_api) ? api_obj.to_api(*relation_includes) : api_obj
+      (include_hash.keys-to_api_attributes.keys).each do |relation|
+        unless hash[relation]
+          relation_includes = include_hash[relation] || []
+          api_obj = self.send(relation)
+          api_obj.to_api_filters = to_api_filters if api_obj.respond_to? :to_api_filters
+
+          hash[relation.to_s] = api_obj.respond_to?(:to_api) ? api_obj.to_api(*[relation_includes].flatten.compact) : api_obj
+        end
       end
     
       hash
@@ -40,58 +88,69 @@ if Object.const_defined? :ActiveRecord
     def to_api_attributes
       attributes
     end
+
+    private
+    def build_to_api_ar_include_hash(*includes)
+      include_hash = {}
+      includes.each do |i| 
+        if i.kind_of?(Hash)
+          i.each do |k,v|
+            include_hash[k.to_s] = v
+          end
+        else
+          include_hash[i.to_s] = []
+        end
+      end
+      include_hash
+    end
+
   end
 
   #Sadly, Scope isn't enumerable
   class ActiveRecord::NamedScope::Scope
+    include ToApiFilter
     def to_api(*includes)
-      map{|e|e.to_api(*includes)}
+      map{|e|
+        e.to_api_filters = to_api_filters if e.respond_to? :to_api_filters
+        e.to_api(*includes)
+      }
     end
   end
 end
 
-module Enumerable
-  def to_api(*includes)
-    map{|e|e.to_api(*includes)}
-  end
-end
-
-class Fixnum
+class Array
+  include ToApiFilter
   def to_api(*includes)
-    self
-  end
-end
+    map{|e|
+      e.to_api_filters = to_api_filters if e.respond_to? :to_api_filters
 
-class String
-  def to_api(*includes)
-    self
+      e.to_api(*includes)
+    }
   end
 end
 
-class DateTime
-  def to_api(*includes)
-    self
-  end
-end
-
-class Date
+class Hash
+  include ToApiFilter
+  include ToApiInstanceMethods
   def to_api(*includes)
-    self
-  end
-end
+    values = {}
 
-class Time
-  def to_api(*includes)
-    self
-  end
-end
+    include_hash = build_to_api_include_hash(*includes)    
+    
+    include_hash.keys.each do |inc|
+      if to_api_filters.has_key?(inc)
+        child_includes = include_hash[inc]
+        values[inc] = to_api_filters[inc].call self, child_includes
+      end
+    end
 
-class Hash
-  def to_api(*includes)
-    inject({}) do |memo, (k, v)| 
-      memo[k]=v.to_api(*includes)
-      memo
+    (keys-values.keys).each do |k|
+      val = self[k]
+      val.to_api_filters = to_api_filters if val.respond_to? :to_api_filters
+      child_includes = include_hash[k] || []
+      values[k] = val.to_api(*[child_includes].flatten.compact)
     end
+    values
   end
 end
 
@@ -101,8 +160,3 @@ class Symbol
   end
 end
 
-class NilClass
-  def to_api(*includes)
-    self
-  end
-end

data/spec/to_api_spec.rb

@@ -8,6 +8,8 @@ class FakeRecord < ActiveRecord::Base
 end
 
 class OtherFakeRecord < FakeRecord
+  def attributes;{"my_field"=>''};end
+  def my_field;'yar';end
 end
 
 class FakeChildRecord < FakeRecord
@@ -35,8 +37,8 @@ describe '#to_api' do
 
     it "passes on includes" do
       a = "a"
-      a.should_receive(:to_api).with(['bar']).and_return(:apiz)
-      {:one => a}.to_api(['bar']).should == {:one => :apiz}
+      a.should_receive(:to_api).with('bar').and_return(:apiz)
+      {:one => a}.to_api(:one => ['bar']).should == {:one => :apiz}
     end
   end
 
@@ -108,22 +110,6 @@ describe '#to_api' do
     end
   end
 
-  describe Enumerable do
-    class Enumz
-      attr_accessor :kid
-      include Enumerable
-      def each
-        yield @kid
-      end
-    end
-    it "returns to_api of its kids" do
-      e = Enumz.new
-      e.kid = "a"
-      e.kid.should_receive(:to_api).and_return(:apiz)
-      [e.kid].to_api.should == [:apiz]
-    end
-  end
-
   describe ActiveRecord::NamedScope::Scope do
     it "returns to_api of its kids" do
       FakeRecord.should_receive(:reflect_on_all_associations).and_return([mock(:name => "fake_child_records")])
@@ -182,6 +168,10 @@ describe '#to_api' do
       it "includes the to_api'd attributes" do
         @base.to_api["age"].should == :apid_age
       end
+
+      it "allows the inclusion of attributes" do
+        @base.to_api("my_field")["my_field"].should == 'yar'
+      end
     end
 
     describe "with includes" do
@@ -258,8 +248,84 @@ describe '#to_api' do
           @base.to_api("fake_child_records" => "foopy_pantz").should == {"fake_child_records" => [{}]}
         end
       end
+
+      describe "#add_to_api_filter" do
+        it "adds a filter" do
+          @base = OtherFakeRecord.new
+          @base.should_not_receive(:my_field)
+          @base.add_to_api_filter("my_field") do |parent, child_includes|
+            "YO-HO-HO"
+          end
+
+          @base.to_api("my_field")["my_field"].should == "YO-HO-HO"
+        end
+
+        it "sends filter to child" do
+          FakeRecord.stub!(:reflect_on_all_associations => [mock(:name => "kids")])
+          FakeChildRecord.stub!(:reflect_on_all_associations => [mock(:name => "foopy_pantz")])
+
+          @base = FakeRecord.new
+          @base.stub!(:attributes => {})
+
+          @child = FakeChildRecord.new
+
+          @child.stub!(:foopy_pantz => "pantz of foop")
+          
+          @base.should_receive(:kids).and_return([@child])
+
+          @base.add_to_api_filter("foopy_pantz") do |parent, child_includes|
+            "kachaa"
+          end
+
+          @base.to_api("kids" => "foopy_pantz").should == {"kids" => [{"foopy_pantz" => "kachaa"}]}
+        end
+      end
+    end
+  end
+
+  describe "#add_to_api_filter" do
+    before do
+      @subhash = {:b => :c, :d => :e}
+      @hash = {:a => @subhash}
     end
 
+    it "puts blocks return value in for filtered key" do
+      @hash.add_to_api_filter("count") do |parent, child_includes|
+        @hash.count
+      end
+
+      @hash.to_api("count")["count"].should == 1
+    end
+
+    it "nests hashes with filters" do
+      @hash.add_to_api_filter("id") do |parent, child_includes|
+        parent.object_id
+      end
+
+      api_object = @hash.to_api({"id" => "", :a => "id"})
+      api_object["id"].should == @hash.object_id
+      api_object[:a]["id"].should == @subhash.object_id
+    end
+
+    it "nests hashes of hashes with filters" do
+      @hash.add_to_api_filter("id") do |parent, child_includes|
+        parent.object_id
+      end
+
+      api_object = @hash.to_api({"id" => "", :a => {"id" => ""}})
+      api_object["id"].should == @hash.object_id
+      api_object[:a]["id"].should == @subhash.object_id
+    end
+
+    it "nests hashes with filters with hash params" do
+      @hash.add_to_api_filter("id") do |parent, child_includes|
+        parent.object_id
+      end
+
+      api_object = @hash.to_api(:a => "id")
+      api_object["id"].should be_nil
+      api_object[:a]["id"].should == @subhash.object_id
+    end
   end
 end
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: to_api
 version: !ruby/object:Gem::Version 
-  hash: 17
+  hash: 23
   prerelease: false
   segments: 
   - 1
   - 1
-  - 1
-  version: 1.1.1
+  - 2
+  version: 1.1.2
 platform: ruby
 authors: 
 - Shawn Anderson
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-12 00:00:00 -05:00
+date: 2011-01-18 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency