etapper 0.0.0

data/spec/fixtures/phones_api.yml

@@ -0,0 +1,14 @@
+---
+!seq:Etapper::API::ArrayOfPhone 
+  - !ruby/object:Etapper::API::Phone 
+    number: 555-222-3333
+    type: Home
+  - !ruby/object:Etapper::API::Phone 
+    number: 555-777-8888
+    type: Business
+  - !ruby/object:Etapper::API::Phone 
+    number: 555-321-5432
+    type: Mobile
+  - !ruby/object:Etapper::API::Phone 
+    number: 555-987-6543
+    type: Fax

data/spec/gift_spec.rb

@@ -0,0 +1,55 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+require File.dirname(__FILE__) + '/shared_journal_entry_spec'
+
+describe Etapper::Gift do
+  @api_methods = %w{
+      amount
+      nonDeductibleAmount
+      fund
+      campaign
+      approach
+      letter
+      receipt
+      tributeAccountRef
+      tributeAccountName
+      recognitionName
+      recognitionType
+      offsettingRef
+      segmentedTransactionRef
+      originalAccountRef
+      originalAccountName
+      originalTransactionRef
+    }
+  
+  @api_readonly_methods = %w{
+      tributeAccountRef
+      tributeAccountName
+      offsettingRef
+      segmentedTransactionRef
+      originalAccountRef
+      originalAccountName
+      originalTransactionRef
+    }
+  
+  before(:all) do
+    @api_collection = YAML.load_file(File.dirname(__FILE__) + '/fixtures/gifts_api.yml')
+    @api_object = @api_collection.data.first
+    @api_accounts = YAML.load_file(File.dirname(__FILE__) + '/fixtures/accounts_api.yml')
+    @api_account = Etapper::Account.new(@api_accounts['MashalSaif'])
+  end
+
+  before(:each) do
+    @dummy.stubs(:getGift).with("1441.0.23787729").returns(@api_object)
+    @dummy.stubs(:getJournalEntries).returns(@api_object)
+    @this = Etapper::Gift.new(@api_object)
+  end
+
+  it_should_behave_like "a Journal Entry class"
+  
+
+
+  
+
+
+
+end

data/spec/hashable_spec.rb

@@ -0,0 +1,39 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+class TestHashable
+  include Etapper::Hashable
+  
+  attr_accessor :key, :value
+  
+  def initialize(key, value)
+    @key, @value = key, value
+  end
+end
+
+describe "Hashable module" do
+  before(:each) do
+    @test = TestHashable.new(:foo, "bar")
+  end
+  
+  it "can return a hash" do
+    @test.to_hash.should == {:foo => "bar"}
+  end
+  
+  it "appends a new value to a nonexistent hash" do
+    h = @test.append_to_hash(h)
+    h.should == {:foo => "bar"}
+  end
+  
+  it "appends a new value to an existing hash" do
+    h = {:yoo => "yar"}
+    h = @test.append_to_hash(h)
+    h.should == {:foo => "bar", :yoo => "yar"}
+  end
+  
+  it "turns duplicate keys into an array of values and appends" do
+    h = {:foo => "far"}
+    h = @test.append_to_hash(h)
+    h.should == {:foo => ["far", "bar"]}
+  end
+  
+end

data/spec/journal_entry_collection_spec.rb

@@ -0,0 +1,84 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+describe Etapper::JournalEntryCollection do
+  before(:each) do
+    j = []
+    # This fixture file is a collection of 99 journal entries from Emilie Townes.
+    File.open(File.dirname(__FILE__) + '/fixtures/journal_entries_api_all.yml') do |file|
+      YAML.load_documents(file) do |yaml|
+        j << yaml
+      end
+    end
+    @dummy.stubs(:getJournalEntries).returns(j[0],j[1],j[2],j[3],j[4])
+    @account_collection = YAML.load_file(File.dirname(__FILE__) + '/fixtures/accounts_api.yml')
+    @account = @account_collection['EmilieTownes']
+    @this = Etapper::JournalEntryCollection.new(@account, :count => 20)
+  end
+  
+  it "requires an account" do
+    lambda{Etapper::JournalEntryCollection.new}.should raise_error(Etapper::RequiredFieldError, "An account is required!")
+  end
+  
+  it "knows its request" do
+    @this.request.should be_a_kind_of(Etapper::API::PagedJournalEntriesRequest)
+  end
+  
+  it "can take a type as a symbol" do
+    jc = Etapper::JournalEntryCollection.new(@account, :type => :gift)
+    jc.request.types.should == [5]
+  end
+  
+  it "can take an array of types" do
+    jc = Etapper::JournalEntryCollection.new(@account, :types => [:gift, :contact])
+    jc.request.types.should == [5, 2]
+  end
+  
+  it "can take a count of records to retrieve at a time" do
+    jc = Etapper::JournalEntryCollection.new(@account, :count => 5)
+    jc.request.count.should == 5
+  end
+  
+  it "can take a starting record number" do
+    jc = Etapper::JournalEntryCollection.new(@account, :start => 11)
+    jc.request.start.should == 11
+  end
+  
+  it "can take a query" do
+    jc = Etapper::JournalEntryCollection.new(@account, :baseQuery => "Steve's Queries::Test Journal Entries")
+    jc.request.baseQuery.should == "Steve's Queries::Test Journal Entries"
+  end
+  
+  it "can take a start date" do
+    jc = Etapper::JournalEntryCollection.new(@account, :startDate => DateTime.parse("1/5/2009 7:59 PM"))
+    jc.request.startDate.to_s.should == "2009-05-01"
+  end
+
+  it "can take an end date" do
+    jc = Etapper::JournalEntryCollection.new(@account, :endDate => DateTime.parse("2/2/2009 7:59 PM"))
+    jc.request.endDate.to_s.should == "2009-02-02"
+  end
+  
+  it "knows if it's complete the first time" do
+    @this.complete?.should be_false
+  end
+  
+  it "knows its size" do
+    @this.size.should == 99
+  end
+  
+  it "returns eTapper objects of the appropriate type" do
+    @this.first.should be_a_kind_of Etapper::Contact
+  end
+  
+  it "knows its account" do
+    @this.account.should == @account
+  end
+  
+  it "can add journal entries to the account" do
+    @dummy.expects(:addGift).returns("111.1.1111")
+    gift = Etapper::Gift.new
+    (@this << gift).should == @this
+    @this.size.should == 100
+  end
+     
+end

data/spec/phone_hash_spec.rb

@@ -0,0 +1,15 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require File.expand_path(File.dirname(__FILE__) + '/shared_etap_hash_spec')
+
+describe Etapper::PhoneHash do
+  before(:each) do
+    @basearray = YAML.load_file(File.dirname(__FILE__) + '/fixtures/phones_api.yml')
+    @etaphash = Etapper::PhoneHash.new(@basearray)
+    @keymethod = :type
+    @valmethod = :number
+    @secondarymethod = :number
+  end
+  it_should_behave_like "an implementation of EtapHash"
+  
+  
+end

data/spec/phone_spec.rb

@@ -0,0 +1,29 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "Phone" do
+  it "requires a type" do
+    lambda {d = Etapper::Phone.new(:type => nil, :number => "404-777-8888")}.should raise_error(Etapper::BadValueError, "You must supply a valid type!")
+  end
+  
+  it "requires a number" do
+    lambda {d = Etapper::Phone.new(:type => :business)}.should raise_error(Etapper::BadValueError, "You must supply a phone number!")
+  end
+  
+  it "can return a hash" do
+    d = Etapper::Phone.new(:type => :business, :number => "404-777-8888")
+    d.to_hash.should == {:business => "404-777-8888"}
+  end
+  
+  it "can return its base" do
+    d = Etapper::Phone.new(:type => :business, :number => "404-777-8888")
+    d.base.should be_a(Etapper::API::Phone)
+  end
+
+  it "can be given an API::Phone type" do
+    p = Etapper::API::Phone.new('123-456-7890','Mobile')
+    d = Etapper::Phone.new(p)
+    d.type.should == :mobile
+    d.number.should == "123-456-7890"
+    d.base.should === p
+  end 
+end

data/spec/proxying_spec.rb

@@ -0,0 +1,34 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe "Method Proxying" do
+  before(:each) do
+    @client = Etapper::Client.instance
+    @client.username = 'etapper_johntest'
+    @client.password = 'mypass'
+  end
+  
+  it "attempts to call methods on the driver if they aren't defined by the client" do
+    @dummy.expects(:blah)
+    @client.blah
+  end
+  
+  it "passes any parameters it receives to the driver" do
+    @dummy.expects(:blah).with(1, 'yo')
+    @client.blah(1, 'yo')
+  end
+  
+  it "tries to connect if it wasn't already" do
+    @dummy.stubs(:logout)
+    @client.disconnect
+    @dummy.expects(:login).returns("")
+    @dummy.expects(:blah)
+    @client.blah
+  end
+  
+  it "does not try to connect if it was already connected" do
+    @dummy.expects(:login).never
+    @dummy.expects(:blah)
+    @client.blah
+  end
+    
+end

data/spec/shared_etap_abstract_spec.rb

@@ -0,0 +1,30 @@
+shared_examples_for "an Etapper abstract type" do
+  def api_base
+    described_class.name.gsub(/::/, "::API::")
+  end
+
+  @api_methods.each do |attribute|
+    it "knows its #{attribute}" do
+      eval("@this.#{attribute}").should == eval("@api_object.#{attribute}")
+    end
+  end
+  
+  (@api_methods - @api_readonly_methods).each do |attribute|
+    it "can set its #{attribute}" do
+      eval("@this.#{attribute} = 'foo'")
+      eval("@this.#{attribute}").should == 'foo'
+    end
+  end
+      
+  @api_readonly_methods.each do |attribute|
+    it "cannot set #{attribute}" do
+      eval("lambda \{@this.#{attribute} = 'foo'\}").should raise_error(Etapper::ReadOnlyError)
+    end
+  end
+  
+  it "returns its base" do
+    @this.base.class.name.should == api_base
+  end
+  
+      
+end

data/spec/shared_etap_hash_spec.rb

@@ -0,0 +1,38 @@
+shared_examples_for "an implementation of EtapHash" do
+  it "acts like a Hash" do
+    @etaphash.should be_a_kind_of(Hash)
+  end
+  
+  it "knows what it represents" do
+    @etaphash.base.should == @basearray
+  end
+  
+  it "returns the hashed value when called" do
+    @basearray.each do |item| 
+      cell = @etaphash[item.send(@keymethod).symbolize]
+      val = item.send(@valmethod)
+      if cell.kind_of?(Array)
+        cell.should include(val)
+      else
+        cell.should == val
+      end
+    end
+  end
+  
+  it "can set the hashed value in the base" do
+    @etaphash[:fax] = 'foobar'
+    @basearray.last.send(@valmethod).should == 'foobar'
+  end
+
+  it "can return the full Etapper object" do
+    base = @basearray.last
+    key = base.send(@keymethod).symbolize
+    sec = base.send(@secondarymethod)
+    @etaphash.detailed[key].send(@secondarymethod).should == sec
+  end
+
+  it "makes new values in the base when a key is added" do
+    @etaphash[:voice] = 'yowza'
+    @basearray.last.send(@valmethod).should == 'yowza'
+  end
+end

data/spec/shared_journal_entry_spec.rb

@@ -0,0 +1,80 @@
+require File.dirname(__FILE__) + '/shared_etap_abstract_spec'
+
+shared_examples_for "a Journal Entry class" do
+  
+  
+  # Also assumes these arrays were already initialized with class-specific fields
+  @api_methods += %w{
+      accountRef
+      accountName
+      ref
+      final
+      date
+      note
+    }
+  
+  @api_readonly_methods += %w{
+      type
+      accountRef
+      accountName
+      ref
+    }
+  
+  it_should_behave_like "an Etapper abstract type"
+  
+  it "always has a type" do
+    je = described_class.new
+    je.type.should == described_class.symbolize
+  end
+  
+  it "sets the base type if it's a new record" do
+    je = described_class.new
+    je.base.type.should == Etapper::JournalEntry::TYPES[described_class.symbolize]
+  end
+  
+  it "maps defined values to fields" do
+    dv = Etapper::API::DefinedValue.new(0, 0, "foo", "1.1.1", "bar", "2.2.2")
+    @this.base.definedValues << dv
+    @this.foo.should == "bar"
+  end
+
+  it "knows its account" do
+    @dummy.expects(:getAccount).once.with("4310.0.2276679").returns(@api_accounts['MashalSaif'])
+    @this.account.should == @api_account
+  end
+  
+  describe "retrieval" do
+    before(:each) do
+      
+    end
+    it "implements the 'find' method" do
+      described_class.should respond_to(:find)
+    end
+    
+    it "gets the single gift if given a ref" do
+      @dummy.expects(described_class.getter).with("1441.0.23787729").returns(@api_object)
+      g = described_class.find("1441.0.23787729")
+      g.should be_a_kind_of(described_class)
+      g.base.should == @api_object
+    end
+    
+    it "can find a collection by account" do
+      @dummy.expects(:getDuplicateAccount).once.returns(@api_accounts['MashalSaif'])
+      @dummy.expects(:getJournalEntries).returns(@api_collection)
+      g = described_class.find(:account => "mashalsaif@gmail.com")
+      g.count.should == @api_collection.count
+    end
+    
+  end
+  
+  
+  describe "creation and update" do
+    it "allows an account to be set after creation" do
+      @this = described_class.new
+      @this.account = @api_account
+      @this.account.should == @api_account
+    end
+    
+  end
+  
+end

data/spec/spec.opts

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

data/spec/spec_helper.rb

@@ -0,0 +1,34 @@
+require 'rubygems'
+require 'spec'
+require 'mocha'
+
+class TestError < StandardError; end
+
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+$:.unshift(File.dirname(__FILE__))
+
+ENV["ETAPPER_USERNAME"] = 'etapper_johntest'
+ENV["ETAPPER_PASSWORD"] = 'mypass'
+
+require 'etapper'
+require 'stub_driver'
+
+if ENV["ETAPPER_LIVE"] == 'true' then
+  Spec::TEST_LIVE = true
+  Spec::TEST_URL = Etapper::ETAP_URL
+else
+  Spec::TEST_LIVE = false
+  Spec::TEST_URL = '### ORIGINAL URL ###'
+end
+
+# Take our toys out of the toybox
+def client
+  Etapper.client
+end
+
+Spec::Runner.configure do |config|
+  config.mock_with :mocha
+  
+  config.include(MockDriver) unless Spec::TEST_LIVE
+end
+