acts_as_sdata 1.0.0

data/test/unit/active_record_mixin/to_atom_spec.rb

@@ -0,0 +1,85 @@
+require File.join(File.dirname(__FILE__), '..', 'spec_helper')
+                                                          
+describe SData::ActiveRecordExtensions::Mixin, "#to_atom" do
+  describe "given a class extended by ActiveRecordExtensions" do
+    before :all do
+      class Base
+        extend SData::ActiveRecordExtensions::Mixin
+      end
+    end
+
+    describe "when .acts_as_sdata is called without arguments" do
+      before :each do
+        Base.class_eval { acts_as_sdata }
+        @model = Base.new
+        @model.stub! :id => 1, :name => 'John Smith', :updated_at => Time.now - 1.day, :created_by => @model, :sage_username => 'basic_user' 
+        @model.stub! :sdata_content => "Base ##{@model.id}: #{@model.name}", :attributes => {}
+      end
+
+      it "should return an Atom::Entry instance" do
+        @model.to_atom(:dataset => '-').should be_kind_of(Atom::Entry)
+      end
+
+      it "should assign model name to Atom::Entry#content" do
+        @model.to_atom(:dataset => '-').content.should == 'Base #1: John Smith'
+      end
+
+      it "should assign model name and id to Atom::Entry#title" do
+        @model.to_atom(:dataset => '-').title.should == 'Base 1'
+      end
+
+      it "should assign Atom::Entry#updated" do
+        Time.parse(@model.to_atom(:dataset => '-').updated).should < Time.now-1.day
+        Time.parse(@model.to_atom(:dataset => '-').updated).should > Time.now-1.day-1.minute        
+      end
+
+      it "should assign Atom::Entry#links" do
+        @model.to_atom(:dataset => '-').links.size.should == 1
+        @model.to_atom(:dataset => '-').links[0].rel.should == 'self'
+        @model.to_atom(:dataset => '-').links[0].href.should == "http://www.example.com/sdata/example/myContract/-/bases('1')"
+      end
+
+      it "should assign Atom::Entry#links when param query is present" do
+        @model.to_atom(:dataset => '-', :select => 'attribute').links.size.should == 1
+        @model.to_atom(:dataset => '-', :select => 'attribute').links[0].rel.should == 'self'
+        @model.to_atom(:dataset => '-', :select => 'attribute').links[0].href.should == "http://www.example.com/sdata/example/myContract/-/bases('1')?select=attribute"
+      end
+
+      it "should assign Atom::Entry::id" do
+        @model.to_atom(:dataset => '-').id.should == "http://www.example.com/sdata/example/myContract/-/bases('1')"
+      end
+
+      it "should assign Atom::Entry::categories" do
+        @model.to_atom.categories.size.should == 1
+        @model.to_atom.categories[0].term.should == "base"
+        @model.to_atom.categories[0].label.should == "Base"
+        @model.to_atom.categories[0].scheme.should == "http://schemas.sage.com/sdata/categories"
+      end
+
+#      #QUESTION: Why is it commented out?
+#      it "should expose activerecord attributes in a simple XML extension" do
+#        @model.stub! :attributes => { :last_name => "Washington", :first_name => "George" }
+#        atom_entry = @model.to_atom
+#        atom_entry['http://sdata.sage.com/schemes/attributes'].should == { 'last_name' => ["Washington"], 'first_name' => ["George"] }
+#      end
+    end
+
+    describe "when .acts_as_sdata is called with arguments" do
+      before :each do
+        Base.class_eval do
+          acts_as_sdata :title => lambda { "#{id}: #{name}" },
+                        :content => lambda { "#{name}" }
+        end
+
+        @model = Base.new
+        @model.stub! :id => 1, :name => 'Test', :updated_at => Time.now - 1.day, :created_by => @model, :sage_username => 'basic_user'
+        @model.stub! :sdata_content => "Base ##{@model.id}: #{@model.name}",  :to_xml => ''
+      end
+
+      it "should evaulate given lambda's in the correct context" do
+        @model.to_atom.title.should == '1: Test'
+        @model.to_atom.content.should == 'Base #1: Test'
+      end
+    end
+  end
+end

data/test/unit/atom_entry_mixin/atom_entry_mixin_spec.rb

@@ -0,0 +1,11 @@
+require File.join(File.dirname(__FILE__), '..', 'spec_helper')
+
+include SData
+
+describe "Atom extensions" do
+  describe "given an extended Atom::Entry" do
+    it "should respond to #to_attributes" do
+      Atom::Entry.new.should respond_to(:to_attributes)
+    end
+  end
+end

data/test/unit/atom_entry_mixin/to_attributes_spec.rb

@@ -0,0 +1,30 @@
+require File.join(File.dirname(__FILE__), '..', 'spec_helper')
+
+include SData
+
+describe Atom::Entry, "#to_attributes" do
+  describe "given an Atom::Entry extended with AtomExtensions::Entry" do
+    describe "when model has attributes in a simple XML extension" do
+      before :each do
+        @entry = Atom::Entry.new
+        @entry['http://sdata.sage.com/schemes/attributes', 'first_name'] << 'George'
+        @entry['http://sdata.sage.com/schemes/attributes', 'last_name'] << 'Washington'
+      end
+
+      it "should return an ActiveRecord-friendly hash" do
+        @entry.to_attributes.should == { 'first_name' => 'George', 'last_name' => 'Washington' }
+      end
+
+      describe "when some attribute has multiple values" do
+        before :each do
+          @entry['http://sdata.sage.com/schemes/attributes', 'initials'] << 'G.'
+          @entry['http://sdata.sage.com/schemes/attributes', 'initials'] << 'GW'
+        end
+
+        it "should take the first one" do
+          @entry.to_attributes['initials'].should == 'G.'
+        end
+      end
+    end    
+  end
+end

data/test/unit/class_stubs/address.rb

@@ -0,0 +1,19 @@
+# SData::VirtualBase is uninitialized for some reason without below line
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'spec_helper'))
+
+class Address < SData::VirtualBase
+  
+  attr_writer :city, :created_at, :updated_at, :owner
+  def populate_defaults
+    self.city = @city || "Vancouver"
+    self.created_at = @created_at || Time.now-2.days
+    self.updated_at = @updated_at || Time.now-1.day
+    self
+  end
+
+  define_payload_map  :customer_id         => { :proc => lambda { @customer_id }, :precedence => 2 },
+                      :city                => { :proc => lambda { @city }, :precedence => 2 },
+                      :created_at          => { :proc => lambda { @created_at }, :precedence => 4 },
+                      :updated_at          => { :proc => lambda { @updated_at }, :precedence => 4 }
+
+end

data/test/unit/class_stubs/contact.rb

@@ -0,0 +1,25 @@
+class Contact < ModelBase
+  
+  attr_writer :customer, :name, :created_at, :updated_at
+
+  def baze
+    self
+  end
+
+  def populate_defaults
+    self.id = @id || object_id.abs
+    self.name = @name || "Contact Name"
+    self.created_at = @created_at || Time.now-2.days
+    self.updated_at = @updated_at || Time.now-1.day
+    self
+  end
+
+  def sdata_content
+    "Contact ##{self.id}: #{self.name}"
+  end
+
+  define_payload_map  :name                => { :proc => lambda { @name }, :precedence => 2 },
+                      :customer_id         => { :proc => lambda { @customer_id }, :precedence => 2 },
+                      :created_at          => { :proc => lambda { @created_at }, :precedence => 4 },
+                      :updated_at          => { :proc => lambda { @updated_at }, :precedence => 4 }
+end

data/test/unit/class_stubs/customer.rb

@@ -0,0 +1,70 @@
+class Customer < ModelBase
+
+  attr_writer :created_by, :name, :number, :contacts, :created_at, :updated_at, :address
+  
+  def self.is_a?(value)
+    # Don't really like doing this but don't see a quick better way
+    return true if value == SData::VirtualBase
+    super
+  end
+  def baze
+    self
+  end
+  def populate_defaults
+    self.id = @id || object_id.abs
+    self.name = @name || "Customer Name"
+    self.number = @number || 12345
+    self.contacts = @contacts || build_contacts(:number => 2, :created_by => self)
+    self.created_at = @created_at || Time.now-2.days
+    self.updated_at = @updated_at || Time.now-1.day
+    self.address = @address || Address.new(self)
+    self
+  end
+  
+  def contacts
+    @contacts || []
+  end
+  
+  def default_contact
+    self.contacts[0]
+  end
+
+  def created_by_id
+    @created_by ? @created_by.id : nil
+  end
+
+  def sdata_content
+    "Customer ##{self.id}: #{self.name}"
+  end
+  
+  define_payload_map  :name                => { :proc => lambda { @name }, :precedence => 2 },
+                      :number              => { :proc => lambda { @number }, :precedence => 5 },
+                      :created_at          => { :proc => lambda { @created_at }, :precedence => 3 },
+                      :updated_at          => { :proc => lambda { @updated_at }, :precedence => 3 },
+                      :my_default_contact  => { :proc => lambda { self.default_contact }, :precedence => 3 },
+                      :my_contacts         => { :proc => lambda { @contacts },
+                                                :precedence => 5, #treated as a CHILD of customer
+                                                :type => :child
+                                              },
+                      :associated_contacts => { :proc => lambda { @contacts },
+                                                :precedence => 3,
+                                                :type => :association
+                                              }, #treated as an ASSOCIATION of customer
+                                              
+                      :address             => { :proc => lambda { @address }, :precedence => 5 },
+
+                      :simple_elements     => { :static_value => ['element 1', 'element 2'], :precedence => 6 },
+
+                      :hash_value                => { :static_value => { :simple_object_key => 'simple_object_value' }, :precedence => 6 }
+
+  def build_contacts(options)
+    the_contacts = []
+    for i in 1..options[:number] do
+      c = Contact.new
+      c.id = i
+      c.customer = options[:created_by]
+      the_contacts << c
+    end
+    the_contacts
+  end
+end

data/test/unit/class_stubs/model_base.rb

@@ -0,0 +1,17 @@
+class ModelBase
+  extend SData::PayloadMap
+  attr_accessor :id
+  
+  def self.name
+    super_name = super
+    "SData::Contracts::CrmErp::#{super_name}"
+  end
+
+  def attributes
+    {}
+  end
+  
+  def sdata_options
+    {}
+  end
+end

data/test/unit/class_stubs/payload.rb

@@ -0,0 +1,15 @@
+TradingAccount = Struct.new :id, :uuid
+
+class Payload < Struct.new(:trading_account)
+  def to_xml
+    builder = Nokogiri::XML::Builder.new do |xml|
+      xml.payload(
+        'xmlns:sdata' => "http://schemas.sage.com/sdata/2008/1") {
+          xml['sdata'].tradingAccount :uuid => trading_account.uuid,
+                                      :url => "http://www.billingboss.com/myApp/myContract/-/tradingAccounts!#{trading_account.id}"
+      }
+    end
+
+    builder.to_xml
+  end
+end

data/test/unit/class_stubs/sd_uuid.rb

@@ -0,0 +1,28 @@
+module SData
+  class SdUuid
+    @@test_uuids = []
+    [
+      {:sd_class => 'Customer', :bb_model_type => 'Customer', :bb_model_id => 12345, :uuid => 'CUST-10000'},
+      {:sd_class => 'Address', :bb_model_type => 'Customer', :bb_model_id => 12345, :uuid => 'ADDR-10001'},
+      {:sd_class => 'Contact', :bb_model_type => 'Contact', :bb_model_id => 23456, :uuid => 'CONT-10002'},
+      {:sd_class => 'Contact', :bb_model_type => 'Contact', :bb_model_id => 123, :uuid => 'C-123-456'},
+      {:sd_class => 'Customer', :bb_model_type => 'Customer', :bb_model_id => 23456, :uuid => 'CUST-10003'},
+    ].each do |params|
+      @@test_uuids << OpenStruct.new(params)
+    end
+
+    
+    def self.first(params)
+      match = nil
+      @@test_uuids.each do |record|
+        if (record.sd_class == params[:conditions][:sd_class] and 
+           record.bb_model_type == params[:conditions][:bb_model_type] and 
+           record.bb_model_id == params[:conditions][:bb_model_id]) 
+           
+          match = record 
+        end
+      end
+      return match
+    end
+  end
+end

data/test/unit/class_stubs/user.rb

@@ -0,0 +1,40 @@
+class User < ModelBase
+  
+  attr_writer :name, :password, :customers, :created_at, :updated_at
+  def populate_defaults
+    self.id = @id || object_id.abs
+    self.name = @name || "username"
+    self.password = @password || "user_password"
+    self.customers = @customers || build_customers(:number => 3, :created_by => self)
+    self.created_at = @created_at || Time.now-2.days
+    self.updated_at = @updated_at || Time.now-1.day
+    self
+  end
+
+  def record_id
+    @record ? @record.id : nil
+  end
+
+  def sdata_content
+    "User ##{self.id}: #{self.name}"
+  end
+
+  define_payload_map  :name                => { :proc => lambda { @name }, :precedence => 2 },
+                      :record_id           => { :proc => lambda { @record_id }, :precedence => 2 },
+                      :uuid                => { :proc => lambda { @uuid }, :precedence => 2 },
+                      :created_at          => { :proc => lambda { @created_at }, :precedence => 3 },
+                      :updated_at          => { :proc => lambda { @updated_at }, :precedence => 3 }
+  
+protected
+  
+  def build_customers(options)
+    the_customers = []
+    for i in 1..options[:number] do
+      c = Customer.new
+      c.id = i
+      c.created_by = options[:created_by]
+      the_customers << c
+    end
+    the_customers
+  end  
+end

data/test/unit/conditions_builder_spec.rb

@@ -0,0 +1,54 @@
+require File.join(File.dirname(__FILE__), 'spec_helper')
+
+include SData
+
+describe ConditionsBuilder do
+  describe "#build_conditions" do
+    it "should correctly build equality" do
+      conditions = ConditionsBuilder.build_conditions 'born_at', :eq, '1900'
+      conditions.should == ["#{quoted('born_at')} = ?", '1900']
+    end
+
+    it "should correctly build '>'" do
+      conditions = ConditionsBuilder.build_conditions 'born_at', :gt, '1900'
+      conditions.should == ["#{quoted('born_at')} > ?", '1900']
+    end
+
+    it "should correctly build '<'" do
+      conditions = ConditionsBuilder.build_conditions 'born_at', :lt, '1900'
+      conditions.should == ["#{quoted('born_at')} < ?", '1900']
+    end
+
+    it "should currectly build '<=' " do
+      conditions = ConditionsBuilder.build_conditions 'born_at', :lteq, '1900'
+      conditions.should == ["#{quoted('born_at')} <= ?", '1900']
+    end
+
+    it "should currectly build '>='" do
+      conditions = ConditionsBuilder.build_conditions 'born_at', :gteq, '1900'
+      conditions.should == ["#{quoted('born_at')} >= ?", '1900']
+    end
+
+    it "should currectly build '<>'" do
+      conditions = ConditionsBuilder.build_conditions 'born_at', :ne, '1900'
+      conditions.should == ["#{quoted('born_at')} <> ?", '1900']
+    end
+
+    it "should currectly build 'between'" do
+      conditions = ConditionsBuilder.build_conditions 'born_at', :between, '1900', '1905'
+      conditions.should == ["#{quoted('born_at')} BETWEEN ? AND ?", '1900', '1905']
+    end
+
+    it "should return empty hash is arguments are invalid" do
+      ConditionsBuilder.build_conditions(nil, :gt, 1).should == []
+      ConditionsBuilder.build_conditions('field', :invalid_relation, 1).should == []
+      ConditionsBuilder.build_conditions('field', :gt).should == []
+      ConditionsBuilder.build_conditions('field', :gt, 'value', 'redundant_value').should == []
+      ConditionsBuilder.build_conditions('field', :between, 'insufficient value').should == []
+    end
+
+    def quoted(column_name)
+      ActiveRecord::Base.connection.quote_column_name(column_name)
+    end
+  end    
+end

data/test/unit/controller_mixin/acts_as_sdata_spec.rb

@@ -0,0 +1,29 @@
+require File.join(File.dirname(__FILE__), '..', 'spec_helper')
+
+include SData
+
+describe ControllerMixin, ".acts_as_sdata" do
+  describe "given an ActionController::Base class extended by ControllerMixin" do
+    before :all do
+      Base = Class.new ActionController::Base
+      Base.extend ControllerMixin
+    end
+
+    before :each do
+      @options = { :model => Class.new }
+      Base.acts_as_sdata @options
+    end
+
+    it "should make passed options available for class" do
+      Base.sdata_options.should == @options
+    end
+
+    it "should make passed options available for instances" do
+      Base.new.sdata_options.should == @options
+    end
+
+    it "should include instance methods" do
+      Base.new.should respond_to(:build_sdata_feed)
+    end
+  end
+end

data/test/unit/controller_mixin/build_sdata_feed_spec.rb

@@ -0,0 +1,50 @@
+require File.join(File.dirname(__FILE__), '..', 'spec_helper')
+
+include SData
+
+describe ControllerMixin, "#build_sdata_feed" do
+  describe "given a controller which acts as sdata" do
+    before :all do
+      Base = Class.new(ActionController::Base)
+      Base.extend ControllerMixin
+      Base.__send__ :define_method, :build_sdata_feed, lambda { super }
+
+      Base.acts_as_sdata  :feed => { :id => 'some-unique-id',
+                                     :author => 'Test Author',
+                                     :path => '/test_resource',
+                                     :title => 'List of Test Items' }
+    end
+
+    before :each do
+      @controller = Base.new
+      @controller.stub! :request => OpenStruct.new(
+                                    :protocol => 'http', 
+                                    :host_with_port => 'http://example.com', 
+                                    :request_uri => Base.sdata_options[:feed][:path],
+                                    :path => SData.store_path + '/-/testResource'),
+                        :params => {:dataset => '-'},
+                        :sdata_options => {:feed => {}, :model => OpenStruct.new(:name => 'base', :sdata_resource_kind_url => '')}
+
+                                    
+    end
+    
+    it "should return Atom::Feed instance" do
+      @controller.build_sdata_feed.should be_kind_of(Atom::Feed)
+    end
+
+    it "should not contain any entries" do
+      @controller.build_sdata_feed.entries.should be_empty
+    end
+
+    it "should adopt passed sdata_options" do
+      @controller.build_sdata_feed.id = Base.sdata_options[:feed][:id]
+    end
+    
+    it "should assign categories" do
+      @controller.build_sdata_feed.categories.size.should == 1
+      @controller.build_sdata_feed.categories[0].term.should == 'bases'
+      @controller.build_sdata_feed.categories[0].label.should == 'Bases'
+      @controller.build_sdata_feed.categories[0].scheme.should == "http://schemas.sage.com/sdata/categories"
+    end
+  end
+end