tagcrumbs 0.3.1

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

data/spec/tagcrumbs/parsers/parser_spec.rb

@@ -0,0 +1,25 @@
+require File.dirname(__FILE__) + '/../../spec_helper'
+
+describe Tagcrumbs::Parser do
+  it "should have a document and format" do
+    parser = Tagcrumbs::Parser.new
+    parser.document = 'document'
+    parser.document.should == 'document'
+    
+    parser.format = 'format'
+    parser.format.should == 'format'
+  end
+  
+  it "should return the correct parser" do
+    Tagcrumbs::Parser.new_for_format('<xml></xml>', :xml).should be_an_instance_of(Tagcrumbs::XmlParser)
+    Tagcrumbs::Parser.new_for_format('{"json": 1}', :json).should be_an_instance_of(Tagcrumbs::JsonParser)
+    
+    parser = Tagcrumbs::JsonParser.new('{"json": 1}')
+    
+    Tagcrumbs::Parser.new_for_format(parser, :json).should == parser
+    
+    lambda {
+      Tagcrumbs::Parser.new_for_format('', :exe)
+    }.should raise_error(Tagcrumbs::UnsupportedFormat)
+  end
+end

data/spec/tagcrumbs/parsers/xml_parser_spec.rb

@@ -0,0 +1,117 @@
+require File.dirname(__FILE__) + '/../../spec_helper'
+
+describe Tagcrumbs::XmlParser do
+  before(:each) do
+    @document = fixture_file('xml_parser.xml')
+    @xml = Tagcrumbs::XmlParser.new(@document)
+  end
+  
+  describe "should initialize" do
+    it "with a document and set parser to root element" do
+      parser = Tagcrumbs::XmlParser.new(@document)
+      parser.document.should be_an_instance_of(Hpricot::Elem)
+      parser.document.name.should == 'test'
+      parser.format.should == :xml
+    end
+    
+    it "with a parser" do
+      @xml.is_a?(String).should be_false
+      parser = Tagcrumbs::XmlParser.new(@xml)
+      
+      parser.document.should == @xml.document
+    end
+  end
+  
+  
+  describe "should get node" do
+    it "with success" do
+      node = @xml.get_node('child')
+      node.should be_an_instance_of(Hpricot::Elem)
+      node.name.should == 'child'
+      node.get_attribute('xlink:href').should == 'child_xlink'
+    end
+    
+    it "and not find deeper nested nodes" do
+      node = @xml.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::XmlParser.new(@xml.get_node('child'))
+      parser.node_loaded?.should be_true
+    end
+    
+    it "with an empty single tag" do
+      parser = Tagcrumbs::XmlParser.new(@xml.get_node('empty_single'))
+      parser.node_loaded?.should be_false
+    end
+    
+    it "with an empty closed tag" do
+      parser = Tagcrumbs::XmlParser.new(@xml.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
+      @xml.nodes_with_name('element').should == [] # don't get nested nodes
+    end
+    
+    it "with success" do
+      @xml = Tagcrumbs::XmlParser.new(@xml.get_node('array'))
+      
+      array = @xml.nodes_with_name('element')
+      array.should have(2).items
+      array[0].innerHTML.should == 'one'
+      array[1].innerHTML.should == 'two'
+    end
+  end
+  
+  describe "should get attributes" do
+    it "with multiple attributes" do
+      attributes = @xml.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
+      @xml = Tagcrumbs::XmlParser.new(@xml.get_node('array'))
+      
+      @xml.get_attributes.should == {}
+    end
+  end
+  
+  describe "should get attribute" do
+    it "with success" do
+      @xml.get_attribute('xlink:href').should == 'test_xlink'
+    end
+    
+    it "without an attribute" do
+      @xml.get_attribute('unexisting').should be_nil
+    end
+  end
+  
+  describe "should get value" do
+    it "with success" do
+      @xml = Tagcrumbs::XmlParser.new(@xml.get_node('simple'))
+      
+      @xml.get_value.should == 'value'
+    end
+  end
+  
+  describe "should get name" do
+    it "with success" do
+      @xml.name.should == 'test'
+    end
+    
+    it "with nested node" do
+      @xml = Tagcrumbs::XmlParser.new(@xml.get_node('simple'))
+      
+      @xml.name.should == 'simple'
+    end
+  end
+end

data/spec/tagcrumbs/proxy_spec.rb

@@ -0,0 +1,48 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe Tagcrumbs::Proxy do
+  before(:each) do
+    @object = mock("MockObject", :class => 'MockObject', :properties => {}, :loaded? => false)
+    @object.stub!(:reload)
+    @object.stub!(:my_name)
+    @object.stub!(:resource_url)
+    
+    @proxy = Tagcrumbs::Proxy.new(@object)
+  end
+  
+  describe "with object loaded" do
+    it "should reload and forward methods to the object" do
+      @object.stub!(:loaded?).and_return(true)
+      
+      @object.should_not_receive(:reload)
+      @object.should_receive(:my_name)
+
+      @proxy.my_name
+    end
+  end
+  
+  describe "with object not loaded" do
+    it "should reload and forward methods to the object" do
+      @object.should_receive(:reload)
+      @object.should_receive(:resource_url).and_return('something')
+      @object.should_receive(:my_name)
+
+      @proxy.my_name
+    end
+  end
+  
+  it "should pass unproxied methods" do
+    @object.should_receive(:resource_url)
+    @object.should_not_receive(:reload)
+    
+    @object.resource_url
+  end
+  
+  it "should pass unknown methods" do
+    @object.should_receive(:abcd)
+    @object.should_not_receive(:reload)
+    
+    @object.abcd
+  end
+
+end

data/spec/tagcrumbs/requestor_spec.rb

@@ -0,0 +1,62 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe Tagcrumbs::Requestor do
+  before(:each) do
+    @requestor = Tagcrumbs::Requestor.new
+  end
+  
+  it "should allow configuration" do
+    @requestor.options.should == Tagcrumbs.options
+    
+    @requestor = Tagcrumbs::Requestor.new(:consumer_token => '123')
+    @requestor.options[:consumer_token].should == '123'
+  end
+  
+  it "should have a consumer" do
+    @requestor.consumer.should be_an_instance_of(OAuth::Consumer)
+  end
+  
+  describe "request token" do
+    it "should exist from configuration" do
+      @requestor = Tagcrumbs::Requestor.new(:consumer_token => 'abc', :consumer_secret => 'def', :consumer_options => {:site => 'http://www.tagcrumbs.com'}, :request_token => '123', :request_secret => '456')
+      @requestor.request_token.should be_an_instance_of(OAuth::RequestToken)
+      @requestor.request_token.token.should == '123'
+      @requestor.request_token.secret.should == '456'
+    end
+    
+    it "should get a new request token" do
+      @requestor = Tagcrumbs::Requestor.new
+      @request_token = mock("OAuth::RequestToken")
+      @consumer = mock("OAuth::Consumer")
+      @consumer.stub!(:get_request_token)
+      @consumer.should_receive(:get_request_token).and_return(@request_token)
+      @requestor.stub!(:consumer).and_return(@consumer)
+      
+      @requestor.request_token.should == @request_token
+    end
+  end
+  
+  describe "access token" do
+    it "should exist from configuration" do
+      @requestor = Tagcrumbs::Requestor.new(:consumer_token => 'abc', :consumer_secret => 'def', :consumer_options => {:site => 'http://www.tagcrumbs.com'}, :access_token => '123', :access_secret => '456')
+      @requestor.access_token.should be_an_instance_of(OAuth::AccessToken)
+      @requestor.access_token.token.should == '123'
+      @requestor.access_token.secret.should == '456'
+    end
+  end
+  
+  it "should build a query string from a hash" do
+    @requestor.send(:path_with_query_string, "path", {:one => 1, :two => 'two'}).should == 'path?one=1&two=two'
+  end
+  
+  it "should have default headers" do
+    @requestor.send(:default_headers, :xml).should == {"Content-Type"=>"application/xml", "Accept"=>"application/xml, text/xml"}
+    @requestor.send(:default_headers, :json).should == {"Content-Type"=>"application/json", "Accept"=>"application/json, text/json"}
+  end
+  
+  it "should raise an error on invalid format on default headers" do
+    lambda {
+      @requestor.send(:default_headers, :abc)
+    }.should raise_error(Tagcrumbs::UnsupportedFormat)
+  end
+end