to_api 1.1.4 → 1.2.0

data/.ruby-version

@@ -0,0 +1 @@
+1.9.3-p448

data/Gemfile

@@ -1,3 +1,3 @@
-source :rubygems
+source "https://rubygems.org"
 
-gemspec
+gemspec

data/README.md

@@ -10,39 +10,45 @@ Models shouldn't know about formats. Controllers shouldn't know what attributes
 
 ### How do I use it?
 
-Implement to_api on your data objects to return a hash with all needed attributes.
+Implement `to_api` on your data objects to return a hash with all needed attributes.
 
-    class Person
-      attr_accessor :first_name, :last_name, :secret
+```ruby
+class Person
+  attr_accessor :first_name, :last_name, :secret
   
-      def to_api
-        {:first_name => @first_name, :last_name => @last_name}.to_api
-      end
-    end
+  def to_api
+    {:first_name => @first_name, :last_name => @last_name}.to_api
+  end
+end
     
-    class Group
-      attr_accessor :name, :description, :people
+class Group
+  attr_accessor :name, :description, :people
       
-      def to_api
-        {:name => @name, :description => @description, :people => @people}.to_api
-      end
-    end
+  def to_api
+    {:name => @name, :description => @description, :people => @people}.to_api
+  end
+end
+```
 
 Now just call your to\_api method. You'll get back a hash of arrays, hashes, strings, numbers, and nil. All of these are very easily converted to a format of your choice.
 
-    JSON.generate(group.to_api)
+```ruby
+JSON.generate(group.to_api)
+```
     
-### If I have to implement to\_api, what does the gem do for me?
+### If I have to implement `to_api`, what does the gem do for me?
 
-The gem provides to\_api for common Ruby classes, allowing simple conversion to json, xml, yaml, etc. Hash and Enumerable transform all their contents, allowing your data objects to simply call to\_api on a hash of relevant attributes.
+The gem provides `to_api` for common Ruby classes, allowing simple conversion to JSON, XML, YAML, etc. Hash and Enumerable transform all their contents, allowing your data objects to simply call `to_api` on a hash of relevant attributes.
 
 Fixnum, String, DateTime, Symbol, and NilClass are also provided.
 
 ### What about Ruby on Rails?
 
-If ActiveRecord is present, ActiveRecord::Base#to\_api transforms and returns the attributes hash. It also supports an :includes option that mirrors the ActiveRecord finder usage.
+If ActiveRecord is present, `ActiveRecord::Base#to_api` transforms and returns the attributes hash. It also supports an `:includes` option that mirrors the ActiveRecord finder usage.
 
-    person.to_api([{:groups => :members}, :interests])
+```ruby
+person.to_api([{:groups => :members}, :interests])
+```
 
 ### What if I need support for other common classes?
 

data/lib/to_api/version.rb

@@ -1,3 +1,3 @@
 module ToApi
-  VERSION = "1.1.4"
+  VERSION = "1.2.0"
 end

data/lib/to_api.rb

@@ -10,7 +10,7 @@ end
 module ToApiInstanceMethods
   def build_to_api_include_hash(*includes)
     include_hash = {}
-    includes.each do |i| 
+    includes.each do |i|
       if i.kind_of?(Hash)
         i.each do |k,v|
           include_hash[k] = v
@@ -34,10 +34,13 @@ module ToApiFilter
   end
 
   def to_api_filters
-    @_to_api_filters ||={}
-    @_to_api_filters
+    if frozen?
+      @_to_api_filters || {}
+    else
+      @_to_api_filters ||= {}
+    end
   end
-end 
+end
 
 if Object.const_defined? :ActiveRecord
 
@@ -47,8 +50,8 @@ if Object.const_defined? :ActiveRecord
     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 | self.attributes.keys)
-    
-      include_hash = build_to_api_ar_include_hash(*includes)    
+
+      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) || []
@@ -62,7 +65,7 @@ if Object.const_defined? :ActiveRecord
           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) 
+          to_api_v = v.to_api(*[attribute_includes].flatten.compact)
           hash[k] = to_api_v
         end
       end
@@ -76,7 +79,7 @@ if Object.const_defined? :ActiveRecord
           hash[relation.to_s] = api_obj.respond_to?(:to_api) ? api_obj.to_api(*[relation_includes].flatten.compact) : api_obj
         end
       end
-    
+
       hash
     end
 
@@ -92,7 +95,7 @@ if Object.const_defined? :ActiveRecord
     private
     def build_to_api_ar_include_hash(*includes)
       include_hash = {}
-      includes.each do |i| 
+      includes.each do |i|
         if i.kind_of?(Hash)
           i.each do |k,v|
             include_hash[k.to_s] = v
@@ -106,14 +109,16 @@ if Object.const_defined? :ActiveRecord
 
   end
 
-  #Sadly, Scope isn't enumerable
-  class ActiveRecord::NamedScope::Scope
-    include ToApiFilter
-    def to_api(*includes)
-      map{|e|
-        e.to_api_filters = to_api_filters if e.respond_to? :to_api_filters
-        e.to_api(*includes)
-      }
+  if defined?(ActiveRecord::NamedScope)
+    #Sadly, Scope isn't enumerable
+    class ActiveRecord::NamedScope::Scope
+      include ToApiFilter
+      def 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
 end
@@ -135,8 +140,8 @@ class Hash
   def to_api(*includes)
     values = {}
 
-    include_hash = build_to_api_include_hash(*includes)    
-    
+    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]

data/spec/spec_helper.rb

@@ -1,5 +1,48 @@
 require "rubygems"
 require "bundler/setup"
-require 'spec'
+require 'rspec'
 require 'active_record'
+require 'pry'
 require 'to_api'
+
+ActiveRecord::Base.establish_connection(
+  :adapter => 'sqlite3',
+  :database => ':memory:'
+)
+
+ActiveRecord::Schema.define do
+  self.verbose = false
+
+  create_table :fake_records, :force => true do |t|
+    t.integer :age
+    t.string :my_field
+    t.integer :associated_record_id
+    t.integer :other_record_id
+    t.integer :group_id
+  end
+
+  create_table :associated_records, :force => true do |t|
+    t.string :name
+  end
+
+  create_table :other_records, :force => true do |t|
+    t.string :description
+  end
+
+  create_table :groups, :force => true do |t|
+    t.string :group_name
+  end
+
+  create_table :child_records, :force => true do |t|
+    t.integer :fake_record_id
+    t.string :name
+    t.integer :category_id
+  end
+
+  create_table :categories, :force => true do |t|
+    t.string :name
+  end
+end
+
+RSpec.configure do |config|
+end

data/spec/to_api_spec.rb

@@ -1,18 +1,36 @@
 require 'spec_helper'
 
 class FakeRecord < ActiveRecord::Base
-  def attributes;{};end
-  def attributes_from_column_definition;[];end
-  def self.columns_hash;{};end
-  named_scope :scopez, :conditions => '1=1'
+  belongs_to :associated_record
+  belongs_to :other_record
+  belongs_to :group
+  has_many :child_records
+
+  if respond_to?(:named_scope)
+    named_scope :scopez, :conditions => '1=1'
+  else
+    scope :scopez, :conditions => '1=1'
+  end
+
+  attr_accessor :yarg
+
+  def valid_api_includes
+    [:associated_record, :other_record]
+  end
 end
 
-class OtherFakeRecord < FakeRecord
-  def attributes;{"my_field"=>''};end
-  def my_field;'yar';end
+class ChildRecord < ActiveRecord::Base
+  belongs_to :category
 end
 
-class FakeChildRecord < FakeRecord
+class AssociatedRecord < ActiveRecord::Base
+end
+
+class OtherRecord < ActiveRecord::Base
+end
+
+class Category < ActiveRecord::Base
+
 end
 
 describe '#to_api' do
@@ -25,8 +43,8 @@ describe '#to_api' do
   describe Hash do
 
     it "returns a new hash with all values to_api'ed" do
-      obj1 = stub('1', :to_api => "1 to api")
-      obj2 = mock('2', :to_api => "2 to the api")
+      obj1 = double('1', :to_api => "1 to api")
+      obj2 = double('2', :to_api => "2 to the api")
 
       hash = {:one => obj1, :two => obj2}
       hash.to_api.should == {
@@ -99,7 +117,7 @@ describe '#to_api' do
     end
   end
 
-  describe Date do 
+  describe Date do
     it "returns self" do
       now = Date.today
       now.to_api.should == now
@@ -141,14 +159,10 @@ describe '#to_api' do
     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")])
-      @base = FakeRecord.new
-      @base.should_receive(:fake_child_records).and_return([{"foo" => "bar"}])
-
-      FakeRecord.stub!(:find_every => [@base])
-      FakeRecord.scopez.to_api("fake_child_records").should == [{"fake_child_records" => [{"foo" => "bar"}]}]
+  describe 'named scopes' do
+    it "returns to_api of the matching records" do
+      @base = FakeRecord.create(my_field: "Some Value")
+      FakeRecord.scopez.to_api.should == [@base.to_api]
     end
   end
 
@@ -169,7 +183,7 @@ describe '#to_api' do
       [a].to_api(['bar']).should == [:apiz]
     end
   end
-  
+
   describe nil do
     it "returns nil" do
       nil.to_api.should be_nil
@@ -182,22 +196,26 @@ describe '#to_api' do
     describe "with attributes" do
       before do
         @base = FakeRecord.new
-        @base.stub!(:attributes => {"age" => mock(:to_api => :apid_age)})
+        @base.age = 95
+        @base.my_field = "why yes"
       end
 
       it "includes the to_api'd attributes" do
-        @base.to_api["age"].should == :apid_age
+        result = @base.to_api
+        result["age"].should == 95
+        result["my_field"].should == "why yes"
       end
     end
 
     describe "with to_api_attributes" do
       before do
-        @base = OtherFakeRecord.new
-        @base.stub!(:to_api_attributes => {"age" => mock(:to_api => :apid_age)})
+        @base = FakeRecord.new
+        @base.age = 65
+        @base.my_field = "yar"
       end
 
       it "includes the to_api'd attributes" do
-        @base.to_api["age"].should == :apid_age
+        @base.to_api["age"].should == 65
       end
 
       it "allows the inclusion of attributes" do
@@ -207,83 +225,79 @@ describe '#to_api' do
 
     describe "with includes" do
       before do
-        @base = FakeRecord.new
-        @base.stub!(:attributes => {})
-        FakeRecord.stub!(:reflect_on_all_associations => [mock(:name => "foopy_pantz")])
-        @base.stub!(:foopy_pantz => "pantz of foop")
+        @base = FakeRecord.new(:my_field => "some value")
+        @base.save!
+        @associated_record = @base.create_associated_record("name" => "Joe")
       end
 
       it "includes the to_api'd attributes" do
-        @base.to_api("foopy_pantz")["foopy_pantz"].should == "pantz of foop"
+        # Without specifying an include the associated_record is not automatically included
+        @base.to_api["associated_record"].should be_nil
+
+        # But specify the association and it gets pulled in
+        @base.to_api("associated_record")["associated_record"]["name"].should == "Joe"
       end
-      
+
       it "allows symbols" do
-        @base.to_api(:foopy_pantz)["foopy_pantz"].should == "pantz of foop"
+        @base.to_api(:associated_record)["associated_record"]["name"].should == "Joe"
       end
-      
+
       it "ignores non association includes" do
-        @base.stub!(:yarg => "YYYYARRGG")
+        @base.yarg = "YYYYARRGG"
         @base.to_api("yarg")["yarg"].should be_nil
       end
-      
+
       it "allows for explicitly declaring allowable includes" do
-        @base.stub!(:foo => "FOO")
-        @base.stub!(:valid_api_includes => ["foo"])
-        @base.to_api("foo")["foo"].should == "FOO"
+        @base.to_api("associated_record")["associated_record"]["name"].should == "Joe"
+
+        # 'group' is not listed in valid_api_includes, so it won't be included even when requested
+        @base.to_api("group")["group"].should be_nil
       end
-      
+
       describe "versions of params" do
-      
+
         before do
-          FakeChildRecord.stub!(:reflect_on_all_associations => [mock(:name => "foopy_pantz")])
-          @child = FakeChildRecord.new
-          @child.stub!(:foopy_pantz => "pantz of foop")
-  
-          FakeRecord.should_receive(:reflect_on_all_associations).and_return([mock(:name => "fake_child_records"), mock(:name => "other_relation")])  
-          @base = FakeRecord.new
-          
-          @base.should_receive(:fake_child_records).and_return([@child])
-          @other_child = mock(:to_api => {"foo"=>"bar"})
+          @base = FakeRecord.create
+          @child = @base.child_records.create(:name => "Jane")
+          @child_category = @child.create_category(:name => "Child Category")
+          @other_record = @base.create_other_record(:description => "Some Other Record")
         end
-        
+
         it "only passes includes to the correct objects" do
-          @child.should_receive(:to_api).with().and_return({})
-          @base.to_api("fake_child_records","foopy_pantz").should == {"fake_child_records" => [{}]}
+          @base.to_api("child_records", "foo_records")["child_records"].should == [@child.to_api]
         end
-        
-        
+
         it "takes a single arg" do
-          @child.should_receive(:to_api).with().and_return({})
-          @base.to_api("fake_child_records").should == {"fake_child_records" => [{}]}
+          result = @base.to_api("child_records")
+          result["child_records"].should == [@child.to_api]
+          result["child_records"].first["category"].should be_nil
+          result["other_record"].should be_nil
         end
-        
+
         it "takes array with singles" do
-          @child.should_receive(:to_api).with().and_return({})
-          @base.to_api("fake_child_records","foopy_pantz").should == {"fake_child_records" => [{}]}
+          result = @base.to_api("child_records", "other_record")
+          result["child_records"].should == [@child.to_api]
+          result["other_record"].should == @other_record.to_api
         end
-        
-        it "takes array with subhash" do
-          @child.should_receive(:to_api).with("foopy_pantz").and_return({})
-          @base.should_receive(:other_relation).and_return(@other_child)
-          @base.to_api({"fake_child_records" => "foopy_pantz"}, "other_relation").should == {"fake_child_records" => [{}], "other_relation" => {"foo"=>"bar"}}
+
+        it "takes array with subhash and singles" do
+          result = @base.to_api({"child_records" => "category"}, "other_record")
+          result["child_records"].should == [@child.to_api("category")]
+          result["child_records"].first["category"]["name"].should == @child_category.name
+          result["other_record"].should == @other_record.to_api
         end
 
         it "takes array with subhash as symbols" do
-          @child.should_receive(:to_api).with(:foopy_pantz).and_return({})
-          @base.should_receive(:other_relation).and_return(@other_child)
-          @base.to_api({:fake_child_records => :foopy_pantz}, :other_relation).should == {"fake_child_records" => [{}], "other_relation" => {"foo"=>"bar"}}
-        end        
-
-        it "takes array with singles and subhashes" do
-          @child.should_receive(:to_api).with("foopy_pantz").and_return({})
-          @base.to_api("fake_child_records" => "foopy_pantz").should == {"fake_child_records" => [{}]}
+          result = @base.to_api({:child_records => :category}, :other_record)
+          result["child_records"].should == [@child.to_api("category")]
+          result["child_records"].first["category"]["name"].should == @child_category.name
+          result["other_record"].should == @other_record.to_api
         end
       end
 
       describe "#add_to_api_filter" do
         it "adds a filter" do
-          @base = OtherFakeRecord.new
-          @base.should_not_receive(:my_field)
+          @base = FakeRecord.new(:my_field => "foo")
           @base.add_to_api_filter("my_field") do |parent, child_includes|
             "YO-HO-HO"
           end
@@ -292,23 +306,28 @@ describe '#to_api' do
         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 => {})
+          @base = FakeRecord.create
+          @child = @base.child_records.create(:name => "Jane")
 
-          @child = FakeChildRecord.new
+          @base.add_to_api_filter("category") do |parent, child_includes|
+            "Not the real category"
+          end
 
-          @child.stub!(:foopy_pantz => "pantz of foop")
-          
-          @base.should_receive(:kids).and_return([@child])
+          result = @base.to_api("child_records" => "category")
+          child = result["child_records"].first
+          child["name"].should == @child.name
+          child["category"].should == "Not the real category"
+        end
 
-          @base.add_to_api_filter("foopy_pantz") do |parent, child_includes|
-            "kachaa"
-          end
+        it "doesn't blow up when a frozen object gets to_api'd" do
+          models = [FakeRecord.new, FakeRecord.new]
+          models.freeze
 
-          @base.to_api("kids" => "foopy_pantz").should == {"kids" => [{"foopy_pantz" => "kachaa"}]}
+          result = models.to_api
+          result.should == [
+            models[0].to_api,
+            models[1].to_api,
+          ]
         end
       end
     end

data/to_api.gemspec

@@ -11,15 +11,18 @@ Gem::Specification.new do |s|
   s.homepage    = "http://github.com/atomicobject/to_api"
   s.summary     = %q{Helper for simplifying JSON api creation}
   s.description = %q{Helper for simplifying JSON api creation.}
-  
+
   s.rubyforge_project = "to_api"
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
-  
-  s.add_development_dependency "activerecord", [">= 2.3", "< 3"]
-  s.add_development_dependency "rspec", "= 1.3.1"
+
+  s.add_development_dependency "activerecord", ["3.2.15"]
+  # s.add_development_dependency "activerecord", [">= 2.3", "< 3"]
+  s.add_development_dependency "rspec", "= 2.14.1"
   s.add_development_dependency "rake", ">= 0.8.7"
+  s.add_development_dependency "pry"
+  s.add_development_dependency "sqlite3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: to_api
 version: !ruby/object:Gem::Version
-  version: 1.1.4
+  version: 1.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -10,30 +10,24 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-22 00:00:00.000000000 Z
+date: 2013-11-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '2.3'
-    - - <
+    - - '='
       - !ruby/object:Gem::Version
-        version: '3'
+        version: 3.2.15
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '2.3'
-    - - <
+    - - '='
       - !ruby/object:Gem::Version
-        version: '3'
+        version: 3.2.15
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -41,7 +35,7 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.3.1
+        version: 2.14.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -49,7 +43,7 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.3.1
+        version: 2.14.1
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -66,6 +60,38 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 0.8.7
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Helper for simplifying JSON api creation.
 email:
 - shawn42@gmail.com
@@ -75,6 +101,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .ruby-version
 - Gemfile
 - README.md
 - Rakefile
@@ -103,7 +130,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: to_api
-rubygems_version: 1.8.21
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Helper for simplifying JSON api creation