to_api 1.0.0

data/Gemfile

@@ -0,0 +1,7 @@
+source "http://rubygems.org"
+gem "rake"
+gem "activerecord", "2.3.5"
+group :test do
+    gem 'rspec', '1.3.0', :require => false
+end
+gem "jeweler"

data/Gemfile.lock

@@ -0,0 +1,22 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activerecord (2.3.5)
+      activesupport (= 2.3.5)
+    activesupport (2.3.5)
+    git (1.2.5)
+    jeweler (1.5.1)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    rake (0.8.7)
+    rspec (1.3.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord (= 2.3.5)
+  jeweler
+  rake
+  rspec (= 1.3.0)

data/README

@@ -0,0 +1 @@
+TODO

data/Rakefile

@@ -0,0 +1,39 @@
+require "rubygems"
+require "bundler/setup"
+
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "to_api"
+    gem.rubyforge_project = "to_api"
+    gem.summary = %Q{Helper for simplifying JSON api creation}
+    gem.description = %Q{Helper for simplifying JSON api creation.}
+    gem.email = "shawn42@gmail.com"
+    gem.homepage = "http://github.com/atomicobject/to_api"
+    gem.authors = ["Shawn Anderson","Ryan Fogle"]
+    gem.add_development_dependency "rspec"
+    gem.add_development_dependency "jeweler"
+    gem.add_dependency 'activerecord'
+    gem.test_files = FileList['{spec,test}/**/*.rb']
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+
+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. Install it with: gem install rspec"
+end
+
+# vim: syntax=Ruby

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/lib/to_api.rb

@@ -0,0 +1,84 @@
+class ActiveRecord::Base
+  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)
+    
+    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.delete_if{|k,v| !valid_includes.include?(k)}
+    
+    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
+    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
+    end
+    
+    hash
+  end
+  
+  # override in models
+  def valid_api_includes
+    []
+  end
+end
+
+module Enumerable
+  def to_api(*includes)
+    map{|e|e.to_api(*includes)}
+  end
+end
+
+#Sadly, Scope isn't enumerable
+class ActiveRecord::NamedScope::Scope
+  def to_api(*includes)
+    map{|e|e.to_api(*includes)}
+  end
+end
+
+class Fixnum
+  def to_api(*includes)
+    self
+  end
+end
+
+class String
+  def to_api(*includes)
+    self
+  end
+end
+
+class DateTime
+  def to_api(*includes)
+    to_s(:db)
+  end
+end
+
+class Hash
+  def to_api(*includes)
+    inject({}) do |memo, (k, v)| 
+      memo[k]=v.to_api(*includes)
+      memo
+    end
+  end
+end
+
+class Symbol
+  def to_api(*includes)
+    to_s
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require 'active_record'
+require File.join(File.dirname(__FILE__), "..", "lib", 'to_api')

data/spec/to_api_spec.rb

@@ -0,0 +1,212 @@
+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'
+end
+
+class FakeChildRecord < FakeRecord
+end
+
+describe '#to_api' do
+  shared_examples_for "ignoring includes" do
+    it "ignores includes" do
+      lambda {instance.to_api(['bar']) }.should_not raise_exception
+    end
+  end
+
+  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")
+
+      hash = {:one => obj1, :two => obj2}
+      hash.to_api.should == {
+          :one => "1 to api",
+          :two => "2 to the api",
+      }
+    end
+
+    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}
+    end
+  end
+
+  describe String do
+    it "returns self" do
+      foo = "thequickbrownfoxjumpsoverthelazydog"
+      foo.to_api.should == foo
+    end
+    describe "ingoring includes" do
+      let(:instance) { "foo" }
+      it_should_behave_like "ignoring includes"
+    end
+
+  end
+
+  describe Integer do
+    it "returns self" do
+      foo = 8
+      foo.to_api.should == foo
+    end
+    describe "ingoring includes" do
+      let(:instance) { 8 }
+      it_should_behave_like "ignoring includes"
+    end
+
+  end
+
+  describe Symbol do
+    it "returns string of sym" do
+      :foo.to_api.should == "foo"
+    end
+    describe "ingoring includes" do
+      let(:instance) { :foo }
+      it_should_behave_like "ignoring includes"
+    end
+
+  end
+
+  describe DateTime do
+    it "returns db string for date time" do
+      now = DateTime.parse("2001-11-28 04:01:59")
+      now.to_api.should == "2001-11-28 04:01:59"
+    end
+    describe "ingoring includes" do
+      let(:instance) { DateTime.now }
+      it_should_behave_like "ignoring includes"
+    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")])
+      @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"}]}]
+    end
+  end
+
+  describe Array do
+    it "returns to_api of its kids" do
+      a = "a"
+      a.should_receive(:to_api).and_return(:apiz)
+      [a].to_api.should == [:apiz]
+    end
+
+    it "explodes on non-to_api-able kids" do
+      lambda { [/boom/].to_api }.should raise_exception
+    end
+
+    it "passes on includes" do
+      a = "a"
+      a.should_receive(:to_api).with(['bar']).and_return(:apiz)
+      [a].to_api(['bar']).should == [:apiz]
+    end
+  end
+
+  describe ActiveRecord::Base do
+
+    describe "with attributes" do
+      before do
+        @base = FakeRecord.new
+        @base.stub!(: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
+        @base.stub!(:attributes => {})
+        FakeRecord.stub!(:reflect_on_all_associations => [mock(:name => "foopy_pantz")])
+        @base.stub!(:foopy_pantz => "pantz of foop")
+      end
+
+      it "includes the to_api'd attributes" do
+        @base.to_api("foopy_pantz")["foopy_pantz"].should == "pantz of foop"
+      end
+      
+      it "ignores non association includes" do
+        @base.stub!(: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"
+      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"})
+        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" => [{}]}
+        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" => [{}]}
+        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" => [{}]}
+        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"}}
+        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" => [{}]}
+        end
+      end
+    end
+
+  end
+end
+

data/to_api.gemspec

@@ -0,0 +1,67 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{to_api}
+  s.version = "1.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Shawn Anderson", "Ryan Fogle"]
+  s.date = %q{2010-12-10}
+  s.description = %q{Helper for simplifying JSON api creation.}
+  s.email = %q{shawn42@gmail.com}
+  s.extra_rdoc_files = [
+    "README"
+  ]
+  s.files = [
+    "Gemfile",
+    "Gemfile.lock",
+    "README",
+    "Rakefile",
+    "VERSION",
+    "lib/to_api.rb",
+    "spec/spec_helper.rb",
+    "spec/to_api_spec.rb",
+    "to_api.gemspec"
+  ]
+  s.homepage = %q{http://github.com/atomicobject/to_api}
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{to_api}
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Helper for simplifying JSON api creation}
+  s.test_files = [
+    "spec/spec_helper.rb",
+    "spec/to_api_spec.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<rake>, [">= 0"])
+      s.add_runtime_dependency(%q<activerecord>, ["= 2.3.5"])
+      s.add_runtime_dependency(%q<jeweler>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, [">= 0"])
+      s.add_development_dependency(%q<jeweler>, [">= 0"])
+      s.add_runtime_dependency(%q<activerecord>, [">= 0"])
+    else
+      s.add_dependency(%q<rake>, [">= 0"])
+      s.add_dependency(%q<activerecord>, ["= 2.3.5"])
+      s.add_dependency(%q<jeweler>, [">= 0"])
+      s.add_dependency(%q<rspec>, [">= 0"])
+      s.add_dependency(%q<jeweler>, [">= 0"])
+      s.add_dependency(%q<activerecord>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rake>, [">= 0"])
+    s.add_dependency(%q<activerecord>, ["= 2.3.5"])
+    s.add_dependency(%q<jeweler>, [">= 0"])
+    s.add_dependency(%q<rspec>, [">= 0"])
+    s.add_dependency(%q<jeweler>, [">= 0"])
+    s.add_dependency(%q<activerecord>, [">= 0"])
+  end
+end
+

metadata

@@ -0,0 +1,162 @@
+--- !ruby/object:Gem::Specification 
+name: to_api
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Shawn Anderson
+- Ryan Fogle
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-12-10 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  prerelease: false
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: rake
+  requirement: *id001
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  prerelease: false
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 9
+        segments: 
+        - 2
+        - 3
+        - 5
+        version: 2.3.5
+  name: activerecord
+  requirement: *id002
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  prerelease: false
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: jeweler
+  requirement: *id003
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: rspec
+  requirement: *id004
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  version_requirements: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: jeweler
+  requirement: *id005
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  prerelease: false
+  version_requirements: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: activerecord
+  requirement: *id006
+description: Helper for simplifying JSON api creation.
+email: shawn42@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+files: 
+- Gemfile
+- Gemfile.lock
+- README
+- Rakefile
+- VERSION
+- lib/to_api.rb
+- spec/spec_helper.rb
+- spec/to_api_spec.rb
+- to_api.gemspec
+has_rdoc: true
+homepage: http://github.com/atomicobject/to_api
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: to_api
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Helper for simplifying JSON api creation
+test_files: 
+- spec/spec_helper.rb
+- spec/to_api_spec.rb