to_api 1.0.4 → 1.0.5

data/README.md

@@ -0,0 +1,49 @@
+Description
+===========
+
+A lightweight, format-agnostic API transformation gem.
+
+Synopsis
+========
+
+Models shouldn't know about formats. Controllers shouldn't know what attributes your domain objects have. It should be trivial to serve the same data in multiple formats.
+
+### How do I use it?
+
+Implement to_api on your data objects to return a hash with all needed attributes.
+
+    class Person
+      attr_accessor :first_name, :last_name, :secret
+  
+      def to_api
+        {:first_name => @first_name, :last_name => @last_name}.to_api
+      end
+    end
+    
+    class Group
+      attr_accessor :name, :description, :people
+      
+      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)
+    
+### 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.
+
+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.
+
+    person.to_api([{:groups => :members}, :interests])
+
+### 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.

data/lib/to_api.rb

@@ -8,14 +8,14 @@ if Object.const_defined? :ActiveRecord
       includes.each do |i| 
         if i.kind_of?(Hash)
           i.each do |k,v|
-            include_hash[k] = v
+            include_hash[k.to_s] = v
           end
         else
-          include_hash[i] = []
+          include_hash[i.to_s] = []
         end
       end
     
-      include_hash.delete_if{|k,v| !valid_includes.include?(k)}
+      include_hash.delete_if{|k,v| !valid_includes.include?(k.to_s)}
     
       attributes.each do |k, v|
         attribute_includes = include_hash[k] || []

data/spec/to_api_spec.rb

@@ -160,6 +160,10 @@ describe '#to_api' do
         @base.to_api("foopy_pantz")["foopy_pantz"].should == "pantz of foop"
       end
       
+      it "allows symbols" 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
@@ -206,7 +210,13 @@ describe '#to_api' do
           @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 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" => [{}]}

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: to_api
 version: !ruby/object:Gem::Version 
-  hash: 31
+  hash: 29
   prerelease: false
   segments: 
   - 1
   - 0
-  - 4
-  version: 1.0.4
+  - 5
+  version: 1.0.5
 platform: ruby
 authors: 
 - Shawn Anderson
@@ -82,7 +82,7 @@ extra_rdoc_files: []
 
 files: 
 - lib/to_api.rb
-- README
+- README.md
 - spec/spec_helper.rb
 - spec/to_api_spec.rb
 has_rdoc: true

data/README

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