to_api 1.0.5 → 1.1.0

data/.gitignore

@@ -0,0 +1,12 @@
+pkg
+*.swp
+*.log
+doc
+coverage
+.DS_Store
+.yardoc
+tmp
+tags
+.bundle
+Gemfile.lock
+*.un~

data/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+
+gemspec

data/README.md

@@ -34,7 +34,7 @@ Now just call your to\_api method. You'll get back a hash of arrays, hashes, str
     
 ### 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.
 
@@ -46,4 +46,12 @@ If ActiveRecord is present, ActiveRecord::Base#to\_api transforms and returns th
 
 ### What if I need support for other common classes?
 
-For most classes, it only takes a couple specs and a few lines of code. Send a pull request; we'd love to take your additions.
+For most classes, it only takes a couple specs and a few lines of code. Send a pull request; we'd love to take your additions.
+
+Authors
+=======
+
+* Ryan Fogle (fogle@atomicobject.com)
+* Shawn Anderson (shawn.anderson@atomicobject.com)
+* © 2011 [Atomic Object](http://www.atomicobject.com/)
+* More Atomic Object [open source](http://www.atomicobject.com/pages/Software+Commons) projects

data/Rakefile

@@ -0,0 +1,15 @@
+require 'rubygems'
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+begin
+  require 'spec/rake/spectask'
+  desc "Run the code examples in spec/"
+  Spec::Rake::SpecTask.new(:spec) do |t|
+    t.spec_files = FileList["spec/**/*_spec.rb"]
+  end
+  task :default => :spec
+
+rescue LoadError
+  puts "RSpec (or a dependency) not available. Run: bundle install"
+end

data/lib/to_api/version.rb

@@ -0,0 +1,3 @@
+module ToApi
+  VERSION = "1.1.0"
+end

data/lib/to_api.rb

@@ -17,7 +17,7 @@ if Object.const_defined? :ActiveRecord
     
       include_hash.delete_if{|k,v| !valid_includes.include?(k.to_s)}
     
-      attributes.each do |k, v|
+      to_api_attributes.each do |k, v|
         attribute_includes = include_hash[k] || []
         v = v.to_api(*attribute_includes) if v.respond_to?(:to_api)
         hash[k] = v
@@ -36,6 +36,10 @@ if Object.const_defined? :ActiveRecord
     def valid_api_includes
       []
     end
+
+    def to_api_attributes
+      attributes
+    end
   end
 
   #Sadly, Scope isn't enumerable
@@ -70,6 +74,18 @@ class DateTime
   end
 end
 
+class Date
+  def to_api(*includes)
+    to_s(:db)
+  end
+end
+
+class Time
+  def to_api(*includes)
+    to_s(:db)
+  end
+end
+
 class Hash
   def to_api(*includes)
     inject({}) do |memo, (k, v)| 

data/spec/to_api_spec.rb

@@ -7,6 +7,9 @@ class FakeRecord < ActiveRecord::Base
   named_scope :scopez, :conditions => '1=1'
 end
 
+class OtherFakeRecord < FakeRecord
+end
+
 class FakeChildRecord < FakeRecord
 end
 
@@ -83,6 +86,28 @@ describe '#to_api' do
     end
   end
 
+  describe Date do 
+    it "returns db string for date" do
+      now = Date.parse("2001-11-28")
+      now.to_api.should == "2001-11-28"
+    end
+    describe "ignoring includes" do
+      let(:instance){ Date.today }
+      it_should_behave_like "ignoring includes"
+    end
+  end
+
+  describe Time do
+    it "returns db string for time" do
+      now = Time.parse("2001-11-28 04:01:59")
+      now.to_api.should == "2001-11-28 04:01:59"
+    end
+    describe "ingoring includes" do
+      let(:instance) { Time.now }
+      it_should_behave_like "ignoring includes"
+    end
+  end
+
   describe Enumerable do
     class Enumz
       attr_accessor :kid
@@ -148,6 +173,17 @@ describe '#to_api' do
       end
     end
 
+    describe "with to_api_attributes" do
+      before do
+        @base = OtherFakeRecord.new
+        @base.stub!(:to_api_attributes => {"age" => mock(:to_api => :apid_age)})
+      end
+
+      it "includes the to_api'd attributes" do
+        @base.to_api["age"].should == :apid_age
+      end
+    end
+
     describe "with includes" do
       before do
         @base = FakeRecord.new

data/to_api.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "to_api/version"
+
+Gem::Specification.new do |s|
+  s.name        = "to_api"
+  s.version     = ToApi::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Shawn Anderson", "Ryan Fogle"]
+  s.email       = ["shawn42@gmail.com", "github@atomicobject.com"]
+  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 "rake", ">= 0.8.7"
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: to_api
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 19
   prerelease: false
   segments: 
   - 1
+  - 1
   - 0
-  - 5
-  version: 1.0.5
+  version: 1.1.0
 platform: ruby
 authors: 
 - Shawn Anderson
@@ -16,10 +16,12 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-12-10 00:00:00 -05:00
+date: 2011-01-11 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
+  name: activerecord
+  prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -37,10 +39,10 @@ dependencies:
         - 3
         version: "3"
   type: :development
-  name: activerecord
-  prerelease: false
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -53,10 +55,10 @@ dependencies:
         - 1
         version: 1.3.1
   type: :development
-  name: rspec
-  prerelease: false
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -69,11 +71,11 @@ dependencies:
         - 7
         version: 0.8.7
   type: :development
-  name: rake
-  prerelease: false
   version_requirements: *id003
 description: Helper for simplifying JSON api creation.
-email: shawn42@gmail.com
+email: 
+- shawn42@gmail.com
+- github@atomicobject.com
 executables: []
 
 extensions: []
@@ -81,10 +83,15 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
-- lib/to_api.rb
+- .gitignore
+- Gemfile
 - README.md
+- Rakefile
+- lib/to_api.rb
+- lib/to_api/version.rb
 - spec/spec_helper.rb
 - spec/to_api_spec.rb
+- to_api.gemspec
 has_rdoc: true
 homepage: http://github.com/atomicobject/to_api
 licenses: []