restful 0.2.20

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,90 @@
+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
+
+  specify 'should serialize a hash with include option correctly - the include option should be passed to the values' do
+    Person.restful_publish(:name)
+    Wallet.restful_publish(:contents)
+    
+    json = {:person => @person}.to_restful_json(:include => :wallet)
+    json_should_eql_fixture(json, "people", :hash_with_rich_person)
+  end
+end

data/test/serializers/params_serializer_test.rb

@@ -0,0 +1,76 @@
+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", :birthday => "1942-01-11")
+    @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 "should be able to serialize objects empty collections" do
+    @person.pets = []
+    expected = 
+      {
+        :name => "Joe Bloggs",
+        :current_location => "Under a tree",
+        :created_at => @person.created_at,
+        :wallet_attributes=>{:contents=>"an old photo, 5 euros in coins"}
+      }
+
+    assert_nothing_raised do
+      actual = @person.to_restful.serialize :params
+      actual.should.== expected
+    end
+  end
+  
+  specify "should render correct date" do
+    actual = @person.to_restful(:birthday).serialize(:params)
+    
+    expected = { :birthday => @person.birthday.to_s(:db) }
+    
+    Person.create(expected).birthday.should.== @person.birthday
+  end
+  
+  specify "serialize to params" do
+    actual = @person.to_restful.serialize(:params)
+  
+    expected = 
+      {
+        :name => "Joe Bloggs",
+        :current_location => "Under a tree",
+        :created_at => @person.created_at,
+        :wallet_attributes=>{:contents=>"an old photo, 5 euros in coins"},
+        :pets_attributes => [ {:name => "mietze"} ]
+      }
+
+    actual.should.== expected
+  end
+  
+  specify "use correct key names for method that include '-' character" do
+    actual = @person.to_restful(:oldest_pet).serialize(:params)
+    
+    expected = { :oldest_pet_attributes => {:name => "mietze"} }
+    
+    actual.should.== expected
+  end
+  
+  specify "serialize to an ar params hash" do    
+    input = xml_fixture("pets")[:gracie]
+    params = Restful.from_xml(input).serialize(:params)
+    clone = Pet.create!(params)
+
+    clone.name.should.== "Gracie"
+    clone.species.should.== 123
+    clone.person_id.should.== @person.id
+  end
+end

data/test/serializers/xml_serializer_test.rb

@@ -0,0 +1,51 @@
+require File.dirname(__FILE__) + '/../test_helper.rb'
+
+context "xml 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 => "1990-03-09")
+    @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 "deserialize from rails style xml" do
+    restful = @person.to_restful
+    expected = restful.serialize(:xml)
+    serializer = Restful::Serializers::XMLSerializer.new
+    resource = serializer.deserialize(expected)    
+    actual = serializer.serialize(resource)
+
+    xml_should_eql(expected, actual)
+  end
+  
+  specify "should serialize date type correctly" do
+    xml_should_eql_fixture(@person.to_restful_xml(:birthday), "people", :joe_with_birthday)  
+  end
+  
+  specify "should convert a NULL inner association such as person.wallet to a link with a null value" do
+    @person.wallet = nil
+
+    xml_should_eql_fixture(@person.to_restful_xml(:restful_options => { :expansion => :collapsed }), "people", :verbose_no_pets)
+  end
+  
+  specify "serialize to xml, rails style" do
+    xml_should_eql_fixture(@person.to_restful_xml, "people", :with_pets_and_expanded_wallet)
+  end
+  
+  specify "should serialize hashes correctly" do
+    @person.pets.create(:species => "cat", :age => 100, :name => "motze")
+    xml_should_eql_fixture(@person.to_restful_xml(:pets_ages_hash), "people", :hashy_person)
+  end
+    
+  specify "should serialize collections correctly" do
+    xml_should_eql_fixture(@person.pets.to_restful_xml, "pets", :pets_array)
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,154 @@
+require 'rubygems'
+require 'ruby-debug'
+require 'active_support'
+require 'active_record'
+require 'action_controller'
+require 'test/spec'
+require 'mocha'
+require 'hpricot'
+require 'xmlsimple'
+require 'yajl'
+require 'pathname'
+require 'stringio'
+
+plugin_test = Pathname.new(File.dirname(__FILE__))
+plugin_root = plugin_test.join '..'
+plugin_lib = plugin_root.join 'lib'
+
+$:.unshift plugin_lib, plugin_test
+
+RAILS_ENV = "test"
+RAILS_ROOT = plugin_root # fake the rails root directory.
+RESTFUL_ROOT = plugin_root
+
+ActiveRecord::Base.logger = Logger.new(STDERR)
+ActiveRecord::Base.logger.level = Logger::ERROR
+ActiveRecord::Base.colorize_logging = false
+ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :dbfile  => ":memory:")
+
+silence_stream(STDOUT) do
+  ActiveRecord::Schema.define do
+    
+    create_table :pets do |t|
+      t.integer :age, :default => 10
+      t.string :name
+      t.integer :species
+      t.integer :person_id
+      t.string :type
+      
+      t.timestamps
+    end
+
+    create_table :houses do |t|
+      t.string :name
+      
+      t.timestamps
+    end
+
+    create_table :people do |t|
+      t.string :name
+      t.string :current_location
+      t.string :biography
+      t.integer :house_id
+      t.date   :birthday
+      t.datetime :last_login
+
+      t.timestamps
+    end
+
+    create_table :wallets do |t|
+      t.string :person_id
+      t.string :contents
+      
+      t.timestamps
+    end
+  end
+end
+
+require plugin_root.join 'init'
+require 'fixtures/models/house'
+require 'fixtures/models/pet'
+require 'fixtures/models/emu'
+require 'fixtures/models/wallet'
+require 'fixtures/models/person'
+require 'fixtures/models/paginated_collection'
+
+Restful::Rails.api_hostname = "http://example.com:3000"
+
+#
+#  Helper methods
+#
+def reset_config
+  Person.restful_config = Restful.cfg
+  Pet.restful_config = Restful.cfg  
+  Wallet.restful_config = Restful.cfg  
+end
+
+def xml_cmp(actual, expected)
+  eq_all_but_zero = Object.new.instance_eval do
+    def ==(other)
+      Integer(other) == 0 ? false : true
+    end
+    self
+  end
+  
+  actual = XmlSimple.xml_in(actual.to_s, 'normalisespace' => eq_all_but_zero) 
+  expected = XmlSimple.xml_in(expected.to_s, 'normalisespace' => eq_all_but_zero) 
+  actual == expected
+end
+
+def json_cmp(actual, expected)
+  actual = Yajl::Parser.parse(actual)
+  expected = Yajl::Parser.parse(expected)
+  puts_hash_diff actual, expected
+  actual == expected
+end
+
+def puts_hash_diff(hash1, hash2, indent = 0)
+  return if hash1 == hash2
+  
+  ((hash1 || {}).keys + (hash2 || {}).keys).uniq.each do |key|
+    next if hash1[key] == hash2[key]
+    print "  "*indent
+    if hash1[key].is_a? Hash or hash2[key].is_a? Hash
+      puts "=== #{key} is a Hash ==="
+      puts_hash_diff(hash1[key] || {}, hash2[key] || {}, indent+2)
+    else
+      printf "%-#{20-indent}s %#{50-indent}s != %-50s\n", key[0..19], hash1[key], hash2[key]
+    end
+  end
+end
+
+def xml_should_eql_fixture(actual, name, key)
+  expected = Hpricot(xml_fixture(name)[key])
+  actual = Hpricot(actual)
+  
+  xml_should_eql(actual, expected)
+end
+
+# doing this tests that the content is the same regardless of attribute order etc. 
+def xml_should_eql(actual, expected)
+  same = xml_cmp(actual, expected)
+  actual.should.== expected unless same  
+end
+
+def json_should_eql_fixture(actual, name, key)  
+  expected = json_fixture(name)[key]
+  json_should_eql(actual, expected)
+end
+
+# doing this tests that the content is the same regardless of attribute order etc. 
+def json_should_eql(actual, expected)
+  same = json_cmp(actual, expected)
+  actual.should.== expected unless same 
+end
+
+def file_fixture(name)
+  template = File.open(RESTFUL_ROOT.join("test", "fixtures", name)).read
+  fixture = ERB.new(template).result(binding)
+  yaml = YAML.load(fixture)
+  yaml.symbolize_keys
+end
+
+def xml_fixture(name); file_fixture("#{ name }.xml.yaml"); end
+def json_fixture(name); file_fixture("#{ name }.json.yaml"); end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification 
+name: restful
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 2
+  - 20
+  version: 0.2.20
+platform: ruby
+authors: 
+- Daniel Bornkessel
+- Rany Keddo
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-08-11 00:00:00 +02:00
+default_executable: 
+dependencies: []
+
+description: 
+email: M4SSIVE@m4ssive.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.markdown
+files: 
+- CHANGES.markdown
+- init.rb
+- lib/restful/apimodel/attribute.rb
+- lib/restful/apimodel/collection.rb
+- lib/restful/apimodel/link.rb
+- lib/restful/apimodel/map.rb
+- lib/restful/apimodel/resource.rb
+- lib/restful/converters/active_record.rb
+- lib/restful/rails/action_controller.rb
+- lib/restful/rails/active_record/configuration.rb
+- lib/restful/rails/active_record/metadata_tools.rb
+- lib/restful/rails.rb
+- lib/restful/serializers/atom_like_serializer.rb
+- lib/restful/serializers/base.rb
+- lib/restful/serializers/hash_serializer.rb
+- lib/restful/serializers/json_serializer.rb
+- lib/restful/serializers/params_serializer.rb
+- lib/restful/serializers/xml_serializer.rb
+- lib/restful.rb
+- LICENSE.markdown
+- rails/init.rb
+- Rakefile
+- README.markdown
+- restful.gemspec
+- test/converters/active_record_converter_test.rb
+- test/converters/basic_types_converter_test.rb
+- test/fixtures/models/paginated_collection.rb
+- test/fixtures/models/person.rb
+- test/fixtures/models/pet.rb
+- test/fixtures/models/wallet.rb
+- test/fixtures/people.json.yaml
+- test/fixtures/people.xml.yaml
+- test/fixtures/pets.json.yaml
+- test/fixtures/pets.xml.yaml
+- test/rails/active_record_metadata_test.rb
+- test/rails/configuration_test.rb
+- test/rails/restful_publish_test.rb
+- test/serializers/atom_serializer_test.rb
+- test/serializers/json_serializer_test.rb
+- test/serializers/params_serializer_test.rb
+- test/serializers/xml_serializer_test.rb
+- test/test_helper.rb
+- TODO.markdown
+has_rdoc: true
+homepage: http://github.com/M4SSIVE/restful
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: 
+- brianmario-yajl-ruby
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: api niceness.
+test_files: []
+