tagcrumbs-tagcrumbs 0.3.1

data/spec/fixtures/user_recommendation.xml

@@ -0,0 +1,106 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<recommendation type="UserRecommendation" xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://www.tagcrumbs.com/sascha/recommendations/70.xml">
+  <message>MESSAGE</message>
+  <created_at type="timestamp">2009-02-01T14:41:12+01:00</created_at>
+  <updated_at type="timestamp">2009-03-01T18:02:51+01:00</updated_at>
+  <recommended_user type="User" xlink:href="http://www.tagcrumbs.com/peter.xml">
+    <username>peter</username>
+    <created_at type="timestamp">2008-06-13T11:45:22+02:00</created_at>
+
+    <profile type="Profile" xlink:href="http://www.tagcrumbs.com/peter/profile.xml"/>
+    <picture type="Picture" xlink:href="http://www.tagcrumbs.com/peter/profile/picture.xml"/>
+    <profile_links type="array" xlink:href="http://www.tagcrumbs.com/peter/profile/links.xml"/>
+    <tagcrumbs type="array" xlink:href="http://www.tagcrumbs.com/peter/tagcrumbs.xml"/>
+    <placemarks type="array" xlink:href="http://www.tagcrumbs.com/peter/placemarks.xml"/>
+    <favorites type="array" xlink:href="http://www.tagcrumbs.com/peter/favorites.xml"/>
+    <activities type="array" xlink:href="http://www.tagcrumbs.com/peter/activities.xml"/>
+    <tags type="array" xlink:href="http://www.tagcrumbs.com/peter/tags.xml"/>
+    <places type="array" xlink:href="http://www.tagcrumbs.com/peter/places.xml"/>
+
+    <friendships type="array" xlink:href="http://www.tagcrumbs.com/peter/friends.xml"/>
+    <fanships type="array" xlink:href="http://www.tagcrumbs.com/peter/fans.xml"/>
+    <tagcrumbs_friends type="array" xlink:href="http://www.tagcrumbs.com/peter/friends/tagcrumbs.xml"/>
+    <tagcrumbs_fans type="array" xlink:href="http://www.tagcrumbs.com/peter/fans/tagcrumbs.xml"/>
+  </recommended_user>
+  <user type="User" xlink:href="http://www.tagcrumbs.com/sascha.xml">
+    <username>sascha</username>
+    <created_at type="timestamp">2008-06-12T09:34:00+02:00</created_at>
+
+    <profile type="Profile" xlink:href="http://www.tagcrumbs.com/sascha/profile.xml"/>
+    <settings type="Settings" xlink:href="http://www.tagcrumbs.com/sascha/settings.xml"/>
+    <location type="Location" xlink:href="http://www.tagcrumbs.com/location.xml"/>
+    <suggestions type="Suggestions" xlink:href="http://www.tagcrumbs.com/sascha/tagcrumbs/suggestions.xml"/>
+    <filters type="array" xlink:href="http://www.tagcrumbs.com/sascha/filters.xml"/>
+    <links type="array" xlink:href="http://www.tagcrumbs.com/sascha/links.xml"/>
+    <comments type="array" xlink:href="http://www.tagcrumbs.com/sascha/comments.xml"/>
+    <flags type="array" xlink:href="http://www.tagcrumbs.com/sascha/flags.xml"/>
+    <recommendations type="array" xlink:href="http://www.tagcrumbs.com/sascha/recommendations.xml"/>
+
+    <received_recommendations type="array" xlink:href="http://www.tagcrumbs.com/sascha/recommendations/received.xml"/>
+    <subscriptions type="array" xlink:href="http://www.tagcrumbs.com/sascha/subscriptions.xml"/>
+    <picture type="Picture" xlink:href="http://www.tagcrumbs.com/sascha/profile/picture.xml"/>
+    <profile_links type="array" xlink:href="http://www.tagcrumbs.com/sascha/profile/links.xml"/>
+    <tagcrumbs type="array" xlink:href="http://www.tagcrumbs.com/sascha/tagcrumbs.xml"/>
+    <placemarks type="array" xlink:href="http://www.tagcrumbs.com/sascha/placemarks.xml"/>
+    <favorites type="array" xlink:href="http://www.tagcrumbs.com/sascha/favorites.xml"/>
+    <activities type="array" xlink:href="http://www.tagcrumbs.com/sascha/activities.xml"/>
+    <tags type="array" xlink:href="http://www.tagcrumbs.com/sascha/tags.xml"/>
+
+    <places type="array" xlink:href="http://www.tagcrumbs.com/sascha/places.xml"/>
+    <friendships type="array" xlink:href="http://www.tagcrumbs.com/sascha/friends.xml"/>
+    <fanships type="array" xlink:href="http://www.tagcrumbs.com/sascha/fans.xml"/>
+    <tagcrumbs_friends type="array" xlink:href="http://www.tagcrumbs.com/sascha/friends/tagcrumbs.xml"/>
+    <tagcrumbs_fans type="array" xlink:href="http://www.tagcrumbs.com/sascha/fans/tagcrumbs.xml"/>
+  </user>
+  <tagcrumb type="Placemark" xlink:href="http://www.tagcrumbs.com/sascha/placemarks/placemark-name.xml">
+    <name>PLACEMARK NAME</name>
+
+    <notes>PLACEMARK NOTES</notes>
+    <tag_list>tag1, tag2</tag_list>
+    <latitude type="float">48.7189419455889</latitude>
+    <longitude type="float">8.96329879760742</longitude>
+    <permalink>placemark-name</permalink>
+    <favorites_count type="integer">0</favorites_count>
+
+    <short_url>http://www.tagcrumbs.com/p/ZGM2ZTk</short_url>
+    <created_at type="timestamp">2009-02-01T14:41:11+01:00</created_at>
+    <updated_at type="timestamp">2009-02-20T07:53:06+01:00</updated_at>
+    <private type="boolean">false</private>
+    <city type="City" xlink:href="http://www.tagcrumbs.com/places/germany/states/land-baden-w%C3%BCrttemberg/cities/b%C3%B6blingen.xml"/>
+    <address type="Address" xlink:href="http://www.tagcrumbs.com/sascha/placemarks/placemark-name/address.xml"/>
+    <links type="array" xlink:href="http://www.tagcrumbs.com/sascha/placemarks/placemark-name/links.xml"/>
+
+    <recommendations type="array" xlink:href="http://www.tagcrumbs.com/sascha/placemarks/placemark-name/recommendations.xml"/>
+    <comments type="array" xlink:href="http://www.tagcrumbs.com/sascha/placemarks/placemark-name/comments.xml"/>
+    <user type="User" xlink:href="http://www.tagcrumbs.com/sascha.xml">
+      <username>sascha</username>
+      <created_at type="timestamp">2008-06-12T09:34:00+02:00</created_at>
+      <profile type="Profile" xlink:href="http://www.tagcrumbs.com/sascha/profile.xml"/>
+      <settings type="Settings" xlink:href="http://www.tagcrumbs.com/sascha/settings.xml"/>
+      <location type="Location" xlink:href="http://www.tagcrumbs.com/location.xml"/>
+
+      <suggestions type="Suggestions" xlink:href="http://www.tagcrumbs.com/sascha/tagcrumbs/suggestions.xml"/>
+      <filters type="array" xlink:href="http://www.tagcrumbs.com/sascha/filters.xml"/>
+      <links type="array" xlink:href="http://www.tagcrumbs.com/sascha/links.xml"/>
+      <comments type="array" xlink:href="http://www.tagcrumbs.com/sascha/comments.xml"/>
+      <flags type="array" xlink:href="http://www.tagcrumbs.com/sascha/flags.xml"/>
+      <recommendations type="array" xlink:href="http://www.tagcrumbs.com/sascha/recommendations.xml"/>
+      <received_recommendations type="array" xlink:href="http://www.tagcrumbs.com/sascha/recommendations/received.xml"/>
+      <subscriptions type="array" xlink:href="http://www.tagcrumbs.com/sascha/subscriptions.xml"/>
+      <picture type="Picture" xlink:href="http://www.tagcrumbs.com/sascha/profile/picture.xml"/>
+
+      <profile_links type="array" xlink:href="http://www.tagcrumbs.com/sascha/profile/links.xml"/>
+      <tagcrumbs type="array" xlink:href="http://www.tagcrumbs.com/sascha/tagcrumbs.xml"/>
+      <placemarks type="array" xlink:href="http://www.tagcrumbs.com/sascha/placemarks.xml"/>
+      <favorites type="array" xlink:href="http://www.tagcrumbs.com/sascha/favorites.xml"/>
+      <activities type="array" xlink:href="http://www.tagcrumbs.com/sascha/activities.xml"/>
+      <tags type="array" xlink:href="http://www.tagcrumbs.com/sascha/tags.xml"/>
+      <places type="array" xlink:href="http://www.tagcrumbs.com/sascha/places.xml"/>
+      <friendships type="array" xlink:href="http://www.tagcrumbs.com/sascha/friends.xml"/>
+      <fanships type="array" xlink:href="http://www.tagcrumbs.com/sascha/fans.xml"/>
+
+      <tagcrumbs_friends type="array" xlink:href="http://www.tagcrumbs.com/sascha/friends/tagcrumbs.xml"/>
+      <tagcrumbs_fans type="array" xlink:href="http://www.tagcrumbs.com/sascha/fans/tagcrumbs.xml"/>
+    </user>
+  </tagcrumb>
+</recommendation>

data/spec/fixtures/validation_errors.json

@@ -0,0 +1,5 @@
+{
+	"errors": {
+		"error": ["general message", "two is invalid"]
+	}
+}

data/spec/fixtures/validation_errors.xml

@@ -0,0 +1,5 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<errors>
+	<error>general message</error>
+	<error>two is invalid</error>
+</errors>

data/spec/fixtures/xml_parser.xml

@@ -0,0 +1,13 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<test xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="test_xlink">
+	<child xlink:href="child_xlink">
+		<deep>test</deep>
+	</child>
+	<empty_single attribute="allowed"/>
+	<empty_closed attribute="allowed"></empty_closed>
+	<array>
+		<element>one</element>
+		<element>two</element>
+	</array>
+	<simple>value</simple>
+</test>

data/spec/spec.opts

@@ -0,0 +1 @@
+--colour

data/spec/spec_helper.rb

@@ -0,0 +1,75 @@
+require 'rubygems'
+
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems'
+  gem 'rspec'
+  require 'spec'
+end
+
+
+gem 'chrisk-fakeweb', "1.2.0" 
+require 'fakeweb'
+
+
+dir = File.dirname(__FILE__)
+
+$:.unshift(File.join(dir, '/../lib/'))
+require dir + '/../lib/tagcrumbs'
+
+
+FakeWeb.allow_net_connect = false
+
+# needed to get FakeWeb to work
+class NilClass
+  def dump
+    ''
+  end
+end
+
+
+def fixture_file(filename, format = nil)
+  return '' if filename == ''
+  file_path = File.expand_path(File.dirname(__FILE__) + '/fixtures/' + filename)
+  file_path += ".#{format}" if format
+  File.read(file_path)
+end
+
+def tagcrumbs_url(url, format=nil)
+  if url =~ /^http/
+    u = url
+  else
+    u = "http://www.tagcrumbs.com#{url}"
+  end
+  
+  u += ".#{format}" if format
+  
+  u
+end
+
+# needed to also test it with dev server
+def fakeweb_url(url, format=nil)
+  if url =~ /^http/
+    u = url
+  else
+    u = "#{Tagcrumbs.options[:consumer_options][:site]}#{url}"
+  end
+  
+  u += ".#{format}" if format
+  
+  u
+end
+
+def stub_get(url, filename, status=nil)
+  options = {:string => fixture_file(filename)}
+  options.merge!({:status => status}) unless status.nil?
+  
+  FakeWeb.register_uri(:get, fakeweb_url(url), options)
+end
+
+def stub_post(url, filename)
+  FakeWeb.register_uri(:post, fakeweb_url(url), :string => fixture_file(filename))
+end
+
+

data/spec/tagcrumbs/builders/builder_spec.rb

@@ -0,0 +1,57 @@
+require File.dirname(__FILE__) + '/../../spec_helper'
+
+describe Tagcrumbs::Builder do
+  before(:each) do
+    @builder = Tagcrumbs::Builder.new(nil)
+  end
+  
+  describe "should typecast" do
+    it "time to iso8601" do
+      t = Time.now
+      @builder.typecast(:created_at, t).should == t.iso8601
+    end
+    
+    it "a model to an URL" do
+      m = Tagcrumbs::Model.new
+      m.stub!(:resource_url).and_return('resource_url')
+
+      @builder.typecast(:model, m).should == 'resource_url'
+    end
+    
+    it "everything else" do
+      @builder.typecast(:int, 1).should == 1
+      @builder.typecast(:float, 1.12).should == 1.12
+      @builder.typecast(:string, 'abc').should == 'abc'
+    end
+  end
+  
+  describe "should determine type" do
+    it "on nil" do
+      @builder.determine_type(:anything, nil).should == {:nil => true}
+    end
+    
+    it "for Time" do
+      @builder.determine_type(:anything, Time.now).should == {:type => :timestamp}
+    end
+    
+    it "for Boolean" do
+      @builder.determine_type(:anything, true).should == {:type => :boolean}
+    end
+    
+    it "for Float" do
+      @builder.determine_type(:anything, 1.12).should == {:type => :float}
+    end
+    
+    it "for Integer" do
+      @builder.determine_type(:anything, 1).should == {:type => :integer}
+    end
+    
+    it "for Model" do      
+      @builder.determine_type(:anything, Tagcrumbs::User.new).should == {:type => 'User'}
+    end
+    
+    it "for unkown" do
+      @builder.determine_type(:anything, Tagcrumbs::Requestor.new).should == {}
+    end
+  end
+end

data/spec/tagcrumbs/builders/json_builder_spec.rb

@@ -0,0 +1,47 @@
+require File.dirname(__FILE__) + '/../../spec_helper'
+
+class Tagcrumbs::TestModel < Tagcrumbs::Model
+  readable_attributes :one
+  writeable_attributes :two
+  
+  has_one :modifiable_association, :modifiable => true
+  has_one :unmodifiable_association
+end
+
+describe Tagcrumbs::JsonBuilder do
+  before(:each) do
+    @model = Tagcrumbs::TestModel.new(:one => 1, :two => 'two')
+    
+    @modifiable_association = Tagcrumbs::TestModel.new(:one => 1, :two => 'two')
+    @modifiable_association.resource_url = 'modifiable_resource_url'
+    @model.modifiable_association = @modifiable_association
+    
+    @unmodifiable_association = Tagcrumbs::TestModel.new(:one => 1, :two => 'two')
+    @model.unmodifiable_association = @unmodifiable_association
+    
+    @builder = Tagcrumbs::JsonBuilder.new(@model)
+  end
+  
+  describe "build with badgerfish" do
+    it "and all attributes" do
+      @builder.build(:badgerfish => true, :to_json => false).should == {"test_model" => {:two => {'$' => "two"}, '@type' => 'TestModel', :one => {'$' => nil, '@nil' => true}, :modifiable_association => {'@type' => 'TestModel', '$' => "modifiable_resource_url"}}}
+    end
+    
+    it "and writeable attributes only" do
+      @builder.build(:badgerfish => true, :to_json => false, :modifiable_only => true).should == {"test_model" => {:two => {'$' => "two"}, '@type' => 'TestModel', :modifiable_association => {'@type' => 'TestModel', '$' => "modifiable_resource_url"}}}
+    end
+    
+  end
+  
+  describe "build without badgerfish" do
+    it "and writeable attributes only" do
+      @builder.build(:modifiable_only => true, :to_json => false).should == {"test_model" => {:two => "two", :modifiable_association => "modifiable_resource_url"}}
+    end
+    
+    it "and all attributes" do
+      @builder.build(:to_json => false).should == {"test_model" => {:two => "two", :one => nil, :modifiable_association => "modifiable_resource_url"}}
+    end
+  end
+  
+  
+end

data/spec/tagcrumbs/builders/xml_builder_spec.rb

@@ -0,0 +1,34 @@
+require File.dirname(__FILE__) + '/../../spec_helper'
+
+class Tagcrumbs::TestModel < Tagcrumbs::Model
+  readable_attributes :one
+  writeable_attributes :two
+  
+  has_one :modifiable_association, :modifiable => true
+  has_one :unmodifiable_association
+end
+
+describe Tagcrumbs::XmlBuilder do
+  before(:each) do
+    @model = Tagcrumbs::TestModel.new(:one => 1, :two => 'two')
+    
+    @modifiable_association = Tagcrumbs::TestModel.new(:one => 1, :two => 'two')
+    @modifiable_association.resource_url = 'modifiable_resource_url'
+    @model.modifiable_association = @modifiable_association
+    
+    @unmodifiable_association = Tagcrumbs::TestModel.new(:one => 1, :two => 'two')
+    @model.unmodifiable_association = @unmodifiable_association
+    
+    @builder = Tagcrumbs::XmlBuilder.new(@model)
+  end
+  
+  describe "build" do
+    it "and writeable attributes only" do
+      @builder.build(:modifiable_only => true, :sorted_attributes => true).should == "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<test_model type=\"TestModel\" xmlns:xlink=\"http://www.w3.org/1999/xlink\">\n <modifiable_association type=\"TestModel\">modifiable_resource_url</modifiable_association>\n <two>two</two>\n</test_model>\n"
+    end
+    
+    it "and all attributes" do
+      @builder.build(:sorted_attributes => true).should == "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<test_model type=\"TestModel\" xmlns:xlink=\"http://www.w3.org/1999/xlink\">\n <modifiable_association type=\"TestModel\">modifiable_resource_url</modifiable_association>\n <one nil=\"true\"></one>\n <two>two</two>\n</test_model>\n"
+    end
+  end
+end

data/spec/tagcrumbs/exceptions_spec.rb

@@ -0,0 +1,16 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe Tagcrumbs do
+  it "have exceptions" do
+    Tagcrumbs::UnsupportedFormat.new.is_a?(StandardError)
+    
+    Tagcrumbs::CreateURLMissing.new.is_a?(StandardError)
+    Tagcrumbs::ResourceURLMissing.new.is_a?(StandardError)
+    
+    Tagcrumbs::CreateImpossible.new.is_a?(StandardError)
+    Tagcrumbs::UpdateImpossible.new.is_a?(StandardError)
+    Tagcrumbs::DestroyImpossible.new.is_a?(StandardError)
+    
+    Tagcrumbs::InvalidRequest.new.is_a?(StandardError)
+  end
+end

data/spec/tagcrumbs/node_spec.rb

@@ -0,0 +1,42 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe Tagcrumbs::Node do
+  it "should get attributes" do
+    @node = Tagcrumbs::Node.new('name', 'value', {})
+    
+    @node.name == 'name'
+    @node.value == 'value'
+    @node.properties == {}
+  end
+  
+  describe "typecast value" do
+    it "to nil" do
+      Tagcrumbs::Node.new('name', '', {'nil' => 'true'}).value.should be_nil
+    end
+    
+    it "to integer" do
+      Tagcrumbs::Node.new('name', '1', {'type' => 'integer'}).value.should == 1
+    end
+    
+    it "to float" do
+      Tagcrumbs::Node.new('name', '1.12', {'type' => 'float'}).value.should == 1.12
+    end
+    
+    it "to boolean" do
+      Tagcrumbs::Node.new('name', 'true', {'type' => 'boolean'}).value.should == true
+    end
+    
+    it "to time" do      
+      Tagcrumbs::Node.new('name', Time.now.iso8601, {'type' => 'timestamp'}).value.should be_an_instance_of(Time)
+    end
+    
+    it "to string" do
+      Tagcrumbs::Node.new('name', "&lt;b&gt; bold").value.should == '<b> bold'
+    end
+    
+    it "should not typecast a non-string value" do
+      Tagcrumbs::Node.new('name', 123).value.should == 123
+    end
+  end
+  
+end

data/spec/tagcrumbs/parsers/json_parser_spec.rb

@@ -0,0 +1,117 @@
+require File.dirname(__FILE__) + '/../../spec_helper'
+
+describe Tagcrumbs::JsonParser do
+  before(:each) do
+    @document = fixture_file('json_parser.json')
+    @json = Tagcrumbs::JsonParser.new(@document)
+  end
+  
+  describe "should initialize" do
+    it "with a document and set parser to root element" do
+      parser = Tagcrumbs::JsonParser.new(@document)
+      parser.document.should be_an_instance_of(Hash)
+      parser.document['@xlink:href'].should == 'test_xlink'
+      parser.format.should == :json
+    end
+    
+    it "with a parser" do
+      @json.is_a?(String).should be_false
+      parser = Tagcrumbs::JsonParser.new(@json)
+      
+      parser.document.should == @json.document
+    end
+  end
+  
+  describe "should get node" do
+    it "with success" do
+      node = @json.get_node('child')
+      node.should be_an_instance_of(Hash)
+      node['@xlink:href'].should == 'child_xlink'
+      node['deep'].should == {"$"=>"test"}
+    end
+    
+    it "and not find deeper nested nodes" do
+      node = @json.get_node('deep')
+      node.should be_nil
+    end
+  end
+  
+  describe "should find out if node is loaded" do
+    it "with a loaded node" do
+      parser = Tagcrumbs::JsonParser.new(@json.get_node('child'))
+      parser.node_loaded?.should be_true
+    end
+    
+    it "with an empty single tag" do
+      parser = Tagcrumbs::JsonParser.new(@json.get_node('empty_single'))
+      parser.node_loaded?.should be_false
+    end
+    
+    it "with an empty closed tag" do
+      parser = Tagcrumbs::JsonParser.new(@json.get_node('empty_closed'))
+      parser.node_loaded?.should be_false
+    end
+  end
+  
+  describe "should get nodes by name" do
+    it "in the current level only" do
+      @json.nodes_with_name('element').should == [] # don't get nested nodes
+    end
+    
+    it "with success" do
+      @json = Tagcrumbs::JsonParser.new(@json.get_node('array'))
+      
+      array = @json.nodes_with_name('element')
+      array.should have(2).items
+      array[0].should == 'one'
+      array[1].should == 'two'
+    end
+  end
+  
+  describe "should get attributes" do
+    it "with multiple attributes" do
+      attributes = @json.get_attributes
+      
+      attributes.should have(2).items
+      attributes['xmlns:xlink'].should == 'http://www.w3.org/1999/xlink'
+      attributes['xlink:href'].should == 'test_xlink'
+    end
+    
+    it "without attributes" do
+      @json = Tagcrumbs::JsonParser.new(@json.get_node('array'))
+      
+      @json.get_attributes.should == {}
+    end
+  end
+  
+  describe "should get attribute" do
+    it "with success" do
+      @json.get_attribute('xlink:href').should == 'test_xlink'
+    end
+    
+    it "without an attribute" do
+      @json.get_attribute('unexisting').should be_nil
+    end
+  end
+  
+  describe "should get value" do
+    it "with success" do
+      @json = Tagcrumbs::JsonParser.new(@json.get_node('simple'))
+      
+      @json.get_value.should == 'value'
+    end
+  end
+  
+  describe "should get name" do
+    it "with success" do
+      @json.name.should == 'test'
+    end
+    
+    # TODO_SK: not working, do we need it?
+    # it "with nested element" do
+    #   @json = Tagcrumbs::JsonParser.new(@json.get_node('simple'))
+    #   
+    #   @json.name.should == 'simple'
+    # end
+  end
+end