benjaminkrause-restful 0.2.8

data/test/fixtures/models/pet.rb

@@ -0,0 +1,5 @@
+class Pet < ActiveRecord::Base
+  belongs_to :owner, :class_name => "Person", :foreign_key => "person_id"  
+
+  apiable
+end

data/test/fixtures/models/wallet.rb

@@ -0,0 +1,5 @@
+class Wallet < ActiveRecord::Base
+  belongs_to :person  
+
+  apiable
+end

data/test/fixtures/people.json.yaml

@@ -0,0 +1,94 @@
+bloggs: 
+  |
+    { 
+      "restful_url": "http://example.com:3000/people/<%= @person.to_param %>",
+      "wallet": { 
+        "restful_url": "http://example.com:3000/wallets/<%= @person.wallet.to_param %>",
+        "contents": "an old photo, 5 euros in coins" 
+      },
+      "current_location": "Under a tree",
+      "name": "Joe Bloggs",
+      "pets": [ { 
+        "restful_url": "http://example.com:3000/pets/<%= @person.pets.first.to_param %>", 
+        "name": "mietze" 
+       }],
+      "created_at": "<%= @person.created_at.xmlschema %>"
+    }
+
+bloggs_with_oldest_pet:
+  |
+    { 
+       "restful_url": "http://example.com:3000/people/<%= @person.to_param %>",
+       "oldest_pet": { 
+         "restful_url": "http://example.com:3000/pets/<%= @person.pets.first.to_param %>", 
+         "name": "mietze" 
+       }
+    }
+
+bloggs_with_birthday:
+  |
+    { 
+      "restful_url": "http://example.com:3000/people/<%= @person.to_param %>",
+      "birthday": "<%= @person.birthday.to_s(:db) %>"
+    }
+
+bloggs_with_pets_ages_hash:
+  |
+    { 
+      "restful_url": "http://example.com:3000/people/<%= @person.to_param %>",
+      "pets_ages_hash": {
+        "mietze": 200,
+        "motze": 100
+      }
+    }
+bloggs_with_has_pets:
+  |
+    { 
+      "restful_url": "http://example.com:3000/people/<%= @person.to_param %>",
+      "has_pets": true
+    }
+bloggs_with_hasno_pets:
+  |
+    { 
+      "restful_url": "http://example.com:3000/people/<%= @person.to_param %>",
+      "has_pets": false
+    }
+
+
+bloggs_da_pet_hater:
+  |
+    { 
+      "restful_url": "http://example.com:3000/people/<%= @person.to_param %>",
+      "wallet": { 
+        "restful_url": "http://example.com:3000/wallets/<%= @person.wallet.to_param %>",
+        "contents": "an old photo, 5 euros in coins" 
+      },
+      "current_location": "Under a tree",
+      "name": "Joe Bloggs",
+      "pets": [],
+      "created_at": "<%= @person.created_at.xmlschema %>"
+    }
+    
+hash_with_person:
+  |
+    { 
+      "total_hits": 1, 
+      "a_person": {
+        "restful_url": "http://example.com:3000/people/<%= @person.to_param %>",
+        "name": "Joe Bloggs"
+      }
+    }
+    
+hash_with_people:
+  |
+    { 
+      "total_hits": 2, 
+      "people": [{
+        "restful_url": "http://example.com:3000/people/<%= @person.to_param %>",
+        "name": "Joe Bloggs"
+      },
+      {
+        "restful_url": "http://example.com:3000/people/<%= @person.to_param %>",
+        "name": "Joe Bloggs"
+      }]
+    }

data/test/fixtures/people.xml.yaml

@@ -0,0 +1,123 @@
+joe_bloggs:
+  |
+    <?xml version="1.0" encoding="UTF-8"?>
+    <person>
+      <restful-url type="link">http://example.com:3000/people/<%= @person.id %></restful-url>
+      <name>Joe Bloggs</name>
+      <wallet-restful-url type="link">http://example.com:3000/wallets/<%= @wallet.id %></wallet-restful-url>
+    </person>
+
+no_wallet:
+  |
+    <?xml version="1.0" encoding="UTF-8"?>
+    <person>
+      <restful-url type="link">http://example.com:3000/people/<%= @person.id %></restful-url>
+      <location-sentence><%= @person.location_sentence %></location-sentence>
+    </person>
+    
+with_oldest_pet:
+  |
+    <?xml version="1.0" encoding="UTF-8"?>
+    <person>
+      <restful-url type="link">http://example.com:3000/people/<%= @person.id %></restful-url>
+      <oldest-pet>
+        <restful-url type="link">http://example.com:3000/pets/<%= @person.oldest_pet.id %></restful-url>
+        <name><%= @person.oldest_pet.name %></name>
+        <person-restful-url type="link">http://example.com:3000/people/<%= @person.id %></person-restful-url>
+      </oldest-pet>
+    </person>
+    
+with_oldest_pet_species:
+  |
+    <?xml version="1.0" encoding="UTF-8"?>
+    <person>
+      <restful-url type="link">http://example.com:3000/people/<%= @person.id %></restful-url>
+      <oldest-pet>
+        <restful-url type="link">http://example.com:3000/pets/<%= @person.oldest_pet.id %></restful-url>
+        <species type="integer"><%= @person.oldest_pet.species %></species>
+      </oldest-pet>
+    </person>
+
+joe_with_birthday:
+  |
+    <?xml version="1.0" encoding="UTF-8"?>
+    <person>
+      <restful-url type="link">http://example.com:3000/people/<%= @person.id %></restful-url>
+      <birthday type="date"><%= @person.birthday.to_s(:db) %></birthday>
+    </person>
+
+joe_with_zwiebelleder:    
+  |
+    <?xml version="1.0" encoding="UTF-8"?>
+    <person>
+      <restful-url type="link">http://example.com:3000/people/<%= @person.id %></restful-url>
+      <wallet nil="true"></wallet>
+    </person>
+    
+atom_person:
+  |
+    <?xml version="1.0" encoding="UTF-8"?>
+    <person xml:base="http://example.com:3000">
+      <created-at><%= @person.created_at.xmlschema %></created-at>
+      <link rel="self" href="/people/<%= @person.id %>"/>
+      <name>Joe Bloggs</name>
+      <current-location>Under a tree</current-location>
+      <pets>
+        <pet>
+          <link rel="self" href="/pets/<%= @pet.id %>"/>
+          <name>mietze</name>
+        </pet>
+      </pets>
+      <wallet>
+        <link rel="self" href="/wallets/<%= @wallet.id %>"/>
+        <contents>an old photo, 5 euros in coins</contents>
+      </wallet>
+    </person>
+    
+verbose_with_pets:
+  |
+    <?xml version="1.0" encoding="UTF-8"?>
+    <person>
+      <restful-url type="link">http://example.com:3000/people/<%= @person.id %></restful-url>
+      <name>Joe Bloggs</name>
+      <created-at type="datetime"><%= @person.created_at.xmlschema %></created-at>
+      <current-location>Under a tree</current-location>
+      <pets type="array">
+        <pet>
+          <restful-url type="link">http://example.com:3000/pets/<%= @pet.id %></restful-url>
+          <name>mietze</name>
+        </pet>
+      </pets>
+      <wallet-restful-url type="link" nil="true"></wallet-restful-url>
+    </person>
+    
+with_pets_and_expanded_wallet:
+  |
+    <?xml version="1.0" encoding="UTF-8"?>
+    <person>
+      <restful-url type="link">http://example.com:3000/people/<%= @person.id %></restful-url>
+      <name>Joe Bloggs</name>
+      <created-at type="datetime"><%= @person.created_at.xmlschema %></created-at>
+      <current-location>Under a tree</current-location>
+      <pets type="array">
+        <pet>
+          <restful-url type="link">http://example.com:3000/pets/<%= @pet.id %></restful-url>
+          <name>mietze</name>
+        </pet>
+      </pets>
+      <wallet>
+        <restful-url type="link">http://example.com:3000/wallets/<%= @wallet.id %></restful-url>
+        <contents>an old photo, 5 euros in coins</contents>
+      </wallet>
+    </person>
+    
+hashy_person:
+  |
+    <?xml version="1.0" encoding="UTF-8"?>
+    <person>
+      <restful-url type="link">http://example.com:3000/people/<%= @person.id %></restful-url>
+      <pets-ages-hash>
+        <mietze>200</mietze>
+        <motze>100</motze>
+      </pets-ages-hash>
+    </person>

data/test/fixtures/pets.json.yaml

@@ -0,0 +1,20 @@
+pets_array:
+    |
+      [
+        {
+          "restful_url": "http://example.com:3000/pets/<%= @person.pets.first.to_param %>", 
+          "name": "mietze"
+        }
+      ]
+      
+pets_array_with_total_entries:
+    |
+      {
+        "total_entries": 1001,
+        "pets": [
+          {
+            "restful_url": "http://example.com:3000/pets/<%= @person.pets.first.to_param %>", 
+            "name": "mietze"
+          }      
+        ]
+      }

data/test/fixtures/pets.xml.yaml

@@ -0,0 +1,31 @@
+nameless_pet:
+  |
+    <?xml version="1.0" encoding="UTF-8"?>
+    <pet>
+      <restful-url type="link">http://example.com:3000/pets/<%= @pet.id %></restful-url>
+      <owner>
+        <restful-url type="link">http://example.com:3000/people/<%= @person.id %></restful-url>
+        <name>Joe Bloggs</name>
+        <current-location>Under a tree</current-location>
+        <wallet-restful-url type="link">http://example.com:3000/wallets/<%= @wallet.id %></wallet-restful-url>
+      </owner>
+    </pet>
+    
+gracie:
+  |
+    <?xml version="1.0" encoding="UTF-8"?>
+    <pet>
+      <person-restful-url type="link">http://example.com:3000/people/<%= @person.id %></person-restful-url>
+      <species>123</species>
+      <name>Gracie</name>
+    </pet>
+    
+pets_array:
+  |
+    <?xml version="1.0" encoding="UTF-8"?>
+    <pets>
+      <pet>
+        <restful-url type="link">http://example.com:3000/pets/<%= @pet.id %></restful-url>
+        <name>mietze</name>
+      </pet>
+    </pets>

data/test/rails/active_record_metadata_test.rb

@@ -0,0 +1,23 @@
+require File.dirname(__FILE__) + '/../test_helper.rb'
+
+context "active record metadata" do
+  setup do
+    Person.restful_publish(:name, :pets => [:name, :species])
+    Pet.restful_publish(:person_id, :name) # person_id gets converted to a link automagically.
+    
+    @person = Person.create(:name => "Jimmy Jones", :current_location => "Under a tree")
+    @pet = @person.pets.create(:name => "Mietze", :species => "cat")
+  end
+  
+  teardown do
+    reset_config
+  end
+  
+  specify "should be able to convert a collection to an array of resources" do
+    resources = Restful::Rails.tools.convert_collection_to_resources(@person, :pets, Restful.cfg)
+    pet = resources.first
+
+    resources.size.should.equal 1    
+    pet.url.should.equal @pet.to_restful.url
+  end
+end

data/test/rails/configuration_test.rb

@@ -0,0 +1,40 @@
+require File.dirname(__FILE__) + '/../test_helper.rb'
+
+context "Configuration" do
+  specify "should have an empty whitelist if only restful options are passed in" do
+    config = Restful.cfg
+    config.restful_options[:expansion] = :expanded
+    config.whitelisted.should.empty
+  end
+  
+  specify "should return fields without restful_options via whitelisted" do
+    config = Restful.cfg([:one, :two])
+    config.restful_options[:expansion] = :expanded
+    config.whitelisted.should.not.include :restful_options
+  end
+  
+  specify "should have 0 whitelisted fields if none were specified" do
+  end
+  
+  specify "should know if it has restful_options" do
+    config = Restful.cfg([:one, :two])
+    config.restful_options[:expansion] = :expanded
+    config.restful_options.should.not.empty
+  end
+  
+  specify "should be able to handle nested whitelist attributes" do
+    config = Restful.cfg(:one, :two => [:a, :b])
+    config.nested(:two).whitelisted.should.== [:a,:b]
+  end
+  
+  specify "should know which attributes are published" do
+    config = Restful.cfg(:one, :two => [:a, :b])
+    config.published?(:two).should.== true
+    config.published?(:one).should.== true
+  end
+  
+  specify "should know if it is nested" do
+    config = Restful.cfg(:one, :restful_options => {:nested => true})
+    config.nested?.should.== true
+  end
+end

data/test/rails/restful_publish_test.rb

@@ -0,0 +1,52 @@
+require File.dirname(__FILE__) + '/../test_helper.rb'
+
+context "restful publish" do
+  teardown do
+    reset_config
+  end
+   
+  specify "should result in a method .published?(:attr_key) return true for published attributes" do
+    Pet.restful_publish(:person_id, :name) # person_id gets converted to a link automagically.
+    
+    Pet.restful_config.published?(:name).should.equal true
+    Pet.restful_config.published?(:pets).should.equal false
+    Pet.restful_config.published?(:species).should.equal false
+  end
+  
+  specify "should have restful_options as an empty hash after calling restful_publish" do
+    Person.restful_publish(:name, :pets => [:name, :species])
+    Person.restful_config.restful_options.should.==({})
+  end
+  
+  specify "should include attributes when publishe parameter is passed to to_restful" do
+    Person.restful_publish(:name)
+    Pet.restful_publish(:name)
+    
+    @person = Person.create
+    @pet = @person.pets.create(:name => "Mietze")
+
+    @pet.to_restful(:include => :owner).values.map(&:name).should.include :owner
+    Pet.restful_config.whitelisted.should.not.include? :owner
+  end
+end
+
+context "api publishing with nesting" do
+  teardown do
+    reset_config
+  end
+ 
+  specify "should result in a method .published?(:attr_key) return true for nested attributes" do
+    Person.restful_publish(:name, :pets => [:name, :species])
+    Person.restful_config.published?(:pets).should.equal true
+  end
+  
+  specify "should be invoke to_restful on the nested model with the specified nested attributes" do
+    Person.restful_publish(:name, :pets => [:name, :species])    
+    @person = Person.create(:name => "Joe Bloggs", :current_location => "Under a tree")
+    @pet = @person.pets.create(:name => "Mietze", :species => "cat")
+    
+    Pet.any_instance.expects(:to_restful).with { |arg| arg.whitelisted == [:name, :species] }
+    @person.to_restful
+  end
+end
+

data/test/serializers/atom_serializer_test.rb

@@ -0,0 +1,33 @@
+require File.dirname(__FILE__) + '/../test_helper.rb'
+
+context "params serializer" do
+
+  setup do 
+    Person.restful_publish(:name, :current_location, :pets, :wallet, :created_at)
+    Pet.restful_publish(:name)
+    Wallet.restful_publish(:contents)
+  
+    @person = Person.create(:name => "Joe Bloggs", :current_location => "Under a tree")
+    @pet = @person.pets.create(:species => "cat", :age => 200, :name => "mietze")
+    @wallet = @person.wallet = Wallet.new(:contents => "an old photo, 5 euros in coins")
+    @person.save
+  end
+
+  teardown do
+    reset_config
+  end
+
+  specify "serialize to xml, atom style" do
+    xml_should_eql_fixture(@person.to_restful_atom_like, "people", :atom_person)
+  end
+  
+  specify "deserialize from atom style xml" do
+    restful = @pet.to_restful
+    expected = restful.serialize(:atom_like)
+    serializer = Restful::Serializers::AtomLikeSerializer.new
+    resource = serializer.deserialize(expected)
+    actual = serializer.serialize(resource)
+  
+    xml_should_eql(expected, actual)
+  end
+end

data/test/serializers/json_serializer_test.rb

@@ -0,0 +1,82 @@
+require File.dirname(__FILE__) + '/../test_helper.rb'
+
+context "json serializer" do
+  
+  setup do 
+    Person.restful_publish(:name, :current_location, :pets, :wallet, :created_at)
+    Pet.restful_publish(:name)
+    Wallet.restful_publish(:contents)
+    
+    @person = Person.create(:name => "Joe Bloggs", :current_location => "Under a tree", :birthday => "2009-09-19")
+    @pet = @person.pets.create(:species => "cat", :age => 200, :name => "mietze")
+    @wallet = @person.wallet = Wallet.new(:contents => "an old photo, 5 euros in coins")
+    @person.save
+  end
+  
+  teardown { reset_config }
+
+  specify "serialize to json" do
+    json_should_eql_fixture(@person.to_restful_json, "people", :bloggs)
+  end
+  
+  specify "should be able to serialize objects with empty collections" do
+    @person.pets = []
+    
+    assert_nothing_raised do
+      json_should_eql_fixture(@person.to_restful_json, "people", :bloggs_da_pet_hater)
+    end
+  end
+
+  specify "should serialize date type correctly" do
+    json_should_eql_fixture(@person.to_restful_json(:birthday), "people", :bloggs_with_birthday)  
+  end
+  
+  specify "should not bug out on nil values in date fields" do
+    person = Person.create :created_at => nil, :birthday => nil, :last_login => nil
+    person.created_at = nil
+    expected = "{\"birthday\":null,\"restful_url\":\"http://example.com:3000/people/#{person.to_param}\",\"last_login\":null,\"created_at\":null}"
+    assert_nothing_raised do
+      actual = person.to_restful_json([:created_at, :birthday, :last_login])
+      json_should_eql(actual, expected)
+    end
+  end
+  
+  specify "should serialize hashes correctly" do
+    @person.pets.create(:species => "cat", :age => 100, :name => "motze")
+    json_should_eql_fixture(@person.to_restful_json(:pets_ages_hash), "people", :bloggs_with_pets_ages_hash)
+  end
+  
+  specify "should render boolean values correctly" do
+    json_should_eql_fixture(@person.to_restful_json(:has_pets), "people", :bloggs_with_has_pets)
+    @person.pets = []
+    @person.save!
+    json_should_eql_fixture(@person.to_restful_json(:has_pets), "people", :bloggs_with_hasno_pets)
+  end
+  
+  specify "should not ever use dashes as hash keys but underscores" do
+    assert_nothing_raised do
+      json_should_eql_fixture(@person.to_restful_json(:oldest_pet), "people", :bloggs_with_oldest_pet)
+    end
+  end
+  
+  specify "should serialize collections correctly" do
+    json_should_eql_fixture(@person.pets.to_restful_json, "pets", :pets_array)
+  end    
+  
+  specify "should be able to serialize collections with total entries info" do
+    pets = PaginatedCollection.new(@person.pets)
+    pets.total_entries = 1001
+
+    json_should_eql_fixture(pets.to_restful_json, "pets", :pets_array_with_total_entries)
+  end
+  
+  specify "should be able to serialize a map" do
+    Person.restful_publish(:name)
+    json_should_eql_fixture({ "total_hits" => 1, "a_person" => @person }.to_restful_json, "people", :hash_with_person)
+  end
+  
+  specify "should be able to serialize a map with arrays as values" do
+    Person.restful_publish(:name)
+    json_should_eql_fixture({ "total_hits" => 2, "people" => [ @person, @person ] }.to_restful_json, "people", :hash_with_people)
+  end
+end