purzelrakete-restful 0.2.1

data/test/fixtures/people.xml.yaml

@@ -0,0 +1,105 @@
+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_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>
+  

data/test/fixtures/pets.xml.yaml

@@ -0,0 +1,21 @@
+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>

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,45 @@
+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 set restful options when set in to_restful method" do
+    
+  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,41 @@
+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
+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,21 @@
+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")
+    @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
+end

data/test/serializers/params_serializer_test.rb

@@ -0,0 +1,44 @@
+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 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 "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,38 @@
+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 "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 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_with_pets)    
+  end
+  
+  specify "serialize to xml, rails style" do
+    xml_should_eql_fixture(@person.to_restful_xml, "people", :with_pets_and_expanded_wallet)
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,129 @@
+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.timestamp :created_at
+      t.timestamp :updated_at
+    end
+
+    create_table :people do |t|
+      t.string :name
+      t.string :current_location
+      t.string :biography
+
+      t.timestamp :created_at      
+      t.timestamp :updated_at
+    end
+
+    create_table :wallets do |t|
+      t.string :person_id
+      t.string :contents
+      
+      t.timestamp :created_at
+      t.timestamp :updated_at
+    end
+  end
+end
+
+require plugin_root.join 'init'
+require 'fixtures/models/pet'
+require 'fixtures/models/wallet'
+require 'fixtures/models/person'
+
+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)
+  
+  actual == expected
+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,93 @@
+--- !ruby/object:Gem::Specification 
+name: purzelrakete-restful
+version: !ruby/object:Gem::Version 
+  version: 0.2.1
+platform: ruby
+authors: 
+- Daniel Bornkessel
+- Rany Keddo
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-08-11 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: 
+email: M4SSIVE@m4ssive.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.markdown
+files: 
+- init.rb
+- lib/restful/apimodel/attribute.rb
+- lib/restful/apimodel/collection.rb
+- lib/restful/apimodel/link.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/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.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 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: 
+- brianmario-yajl-ruby
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 2
+summary: api niceness.
+test_files: []
+