reps_client 0.0.1

data/spec/reps_client/pick_list_spec.rb

@@ -0,0 +1,320 @@
+require 'spec_helper'
+
+describe RepsClient::Prefix do
+  subject { prefix }
+
+  let(:user_list_id) { 42 }
+  let(:list_value) { 'Dr. and Mr.' }
+  
+  context 'with default initialization' do
+    let(:prefix) { RepsClient::Prefix.new }
+
+    its(:prefix_id) { should be_nil }
+    its(:value) { should be_nil }
+  end
+
+  context 'with full initialization' do
+    let(:prefix) do 
+      RepsClient::Prefix.new(:prefix_id => user_list_id.to_s,
+                             :value => list_value)
+    end
+
+    its(:prefix_id) { should == user_list_id }
+    its(:value) { should == list_value }
+  end
+
+  context 'with translation initialization' do
+    let(:prefix) do
+      RepsClient::Prefix.new(:user_list_idy => user_list_id,
+                             :list_value => "         #{list_value}            ")
+    end
+
+    its(:prefix_id) { should == user_list_id }
+    its(:value) { should == list_value }
+  end
+end
+
+describe RepsClient::Suffix do
+  subject { suffix }
+
+  let(:user_list_id) { 42 }
+  let(:list_value) { 'D.D.S.' }
+  
+  context 'with default initialization' do
+    let(:suffix) { RepsClient::Suffix.new }
+
+    its(:suffix_id) { should be_nil }
+    its(:value) { should be_nil }
+  end
+
+  context 'with full initialization' do
+    let(:suffix) do 
+      RepsClient::Suffix.new(:suffix_id => user_list_id.to_s,
+                             :value => list_value)
+    end
+
+    its(:suffix_id) { should == user_list_id }
+    its(:value) { should == list_value }
+  end
+
+  context 'with translation initialization' do
+    let(:suffix) do
+      RepsClient::Suffix.new(:user_list_idy => user_list_id,
+                             :list_value => "         #{list_value}            ")
+    end
+
+    its(:suffix_id) { should == user_list_id }
+    its(:value) { should == list_value }
+  end
+end
+
+describe RepsClient::RelationshipType do
+  subject { relationship_type }
+
+  let(:relationship_type_id) { 42 }
+  let(:relationship_name) { 'Dr. and Mr.' }
+  
+  context 'with default initialization' do
+    let(:relationship_type) { RepsClient::RelationshipType.new }
+
+    its(:relationship_type_id) { should be_nil }
+    its(:name) { should be_nil }
+  end
+
+  context 'with full initialization' do
+    let(:relationship_type) do 
+      RepsClient::RelationshipType.new(:relationship_type_id => relationship_type_id.to_s,
+                                       :name => relationship_name)
+    end
+
+    its(:relationship_type_id) { should == relationship_type_id }
+    its(:name) { should == relationship_name }
+  end
+
+  context 'with translation initialization' do
+    let(:relationship_type) do
+      RepsClient::RelationshipType.new(:relationship_type_idy => relationship_type_id,
+                                       :relationship_name => "         #{relationship_name}            ")
+    end
+
+    its(:relationship_type_id) { should == relationship_type_id }
+    its(:name) { should == relationship_name }
+  end
+end
+
+describe RepsClient::Source do
+  subject { source }
+
+  let(:source_id) { 42 }
+  let(:code) { 'CGSLST' }
+  let(:description) { 'Craigslist ad' }
+
+  context 'with default initialization' do
+    let(:source) { RepsClient::Source.new }
+
+    its(:source_id) { should be_nil }
+    its(:code) { should be_nil }
+    its(:description) { should be_nil }
+  end
+
+  context 'with full initialization' do
+    let(:source) do 
+      RepsClient::Source.new(:source_id => source_id.to_s,
+                             :code => code,
+                             :description => description)
+    end
+
+    its(:source_id) { should == source_id }
+    its(:code) { should == code }
+    its(:description) { should == description }
+  end
+
+  context 'with translation initialization' do
+    let(:source) do
+      RepsClient::Source.new(:source_idy => source_id,
+                             :code => "         #{code}            ",
+                             :description => "   #{description}\n")
+    end
+
+    its(:source_id) { should == source_id }
+    its(:code) { should == code }
+    its(:description) { should == description }
+  end
+end
+
+describe 'pick list methods mixin' do
+  let(:test_object) { RepsClient::Client.new(:enterprise_key => enterprise_key) }
+  let(:enterprise_key) { 'foo' }
+
+  describe "#get_pick_lists" do
+    subject { pick_lists }
+    let(:pick_lists) { test_object.get_pick_lists(community_id) }
+
+    before { savon.stubs('GetPickLists').returns(fixture_name) }
+    let(:fixture_name) { nil }
+
+    context 'with a community id' do
+      let(:community_id) { 42 }
+
+      it_should_behave_like 'a fault handler', 'GetPickLists'
+
+      context 'when there is one prefix' do
+        let(:fixture_name) { :single_prefix }
+
+        it_should_behave_like 'a pick list requester'
+
+        its([:suffix]) { should be_empty }
+        its([:relationship_type]) { should be_empty }
+        its([:source]) { should be_empty }
+        its([:prefix]) { should have(1).prefix }
+
+        describe "the first prefix entry" do
+          subject { pick_lists[:prefix].first }
+
+          its(:prefix_id) { should == 210 }
+          its(:value) { should == 'Attorney' }
+        end
+      end
+
+      context 'when there is one suffix' do
+        let(:fixture_name) { :single_suffix }
+
+        it_should_behave_like 'a pick list requester'
+
+        its([:prefix]) { should be_empty }
+        its([:relationship_type]) { should be_empty }
+        its([:source]) { should be_empty }
+        its([:suffix]) { should have(1).suffix }
+
+        describe "the first suffix entry" do
+          subject { pick_lists[:suffix].first }
+
+          its(:suffix_id) { should == 56 }
+          its(:value) { should == 'D. Pharm.' }
+        end
+      end
+
+      context 'when there is one relationship_type' do
+        let(:fixture_name) { :single_relationship_type }
+
+        it_should_behave_like 'a pick list requester'
+
+        its([:suffix]) { should be_empty }
+        its([:prefix]) { should be_empty }
+        its([:source]) { should be_empty }
+        its([:relationship_type]) { should have(1).entry }
+
+        describe "the first relationship_type entry" do
+          subject { pick_lists[:relationship_type].first }
+
+          its(:relationship_type_id) { should == 84 }
+          its(:name) { should == 'Brother-in-law' }
+        end
+      end
+
+      context 'when there is a single source' do
+        let(:fixture_name) { :single_source }
+
+        it_should_behave_like 'a pick list requester'
+
+        its([:suffix]) { should be_empty }
+        its([:relationship_type]) { should be_empty }
+        its([:prefix]) { should be_empty }
+        its([:source]) { should have(1).entry }
+
+        describe "the first source entry" do
+          subject { pick_lists[:source].first }
+
+          its(:source_id) { should == 321 }
+          its(:code) { should == 'YP104' }
+          its(:description) { should == 'Yellow Pages' }
+        end
+      end
+
+      context 'when there are multiple types of pick lists' do
+        let(:fixture_name) { :full_pick_lists }
+
+        it_should_behave_like 'a pick list requester'
+
+        its([:prefix]) { should have(2).entries }
+
+        describe 'the first prefix entry' do
+          subject { pick_lists[:prefix].first }
+
+          its(:prefix_id) { should == 222 }
+          its(:value) { should == 'Dr. And Mrs.' }
+        end
+
+        describe 'the last prefix entry' do
+          subject { pick_lists[:prefix].last }
+
+          its(:prefix_id) { should == 202 }
+          its(:value) { should == 'Mr. & Mrs.' }
+        end
+
+        its([:suffix]) { should have(2).entries }
+
+        describe 'the first suffix entry' do
+          subject { pick_lists[:suffix].first }
+
+          its(:suffix_id) { should == 90 }
+          its(:value) { should == 'III' }
+        end
+
+        describe 'the last suffix entry' do
+          subject { pick_lists[:suffix].last }
+
+          its(:suffix_id) { should == 36 }
+          its(:value) { should == 'Jr.' }
+        end
+
+        its([:relationship_type]) { should have(2).entries }
+
+        describe 'the first relationship_type entry' do
+          subject { pick_lists[:relationship_type].first }
+
+          its(:relationship_type_id) { should == 82 }
+          its(:name) { should == 'Aunt' }
+        end
+
+        describe 'the last relationship_type entry' do
+          subject { pick_lists[:relationship_type].last }
+
+          its(:relationship_type_id) { should == 91 }
+          its(:name) { should == 'Not specified' }
+        end
+
+        its([:source]) { should have(2).entries }
+
+        describe 'the first source entry' do
+          subject { pick_lists[:source].first }
+
+          its(:source_id) { should == 251 }
+          its(:code) { should == 'DM' }
+          its(:description) { should == 'Direct Mail' }
+        end
+
+        describe 'the last source entry' do
+          subject { pick_lists[:source].last }
+
+          its(:source_id) { should == 713 }
+          its(:code) { should == 'Press & Sun Bulletin' }
+          its(:description) { should == 'Pleasant Surprises' }
+        end
+      end
+    end
+
+    context 'without a community id' do
+      let(:community_id) { nil }
+
+      it 'should not call the remote service' do
+        savon.expects(:get_pick_lists).never
+        subject rescue nil
+      end
+
+      it 'should raise an ArgumentError' do
+        expect { subject }.to raise_error
+      end
+    end
+  end
+end

data/spec/reps_client_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe RepsClient do
+  it "should have a version" do
+    subject::VERSION.should be
+  end
+
+  it { should respond_to(:configure) }
+  it { should respond_to(:reset) }
+  it { should respond_to(:options) }
+end

data/spec/spec_helper.rb

@@ -0,0 +1,21 @@
+require 'rspec'
+
+require 'webmock/rspec'
+require 'fakefs/spec_helpers'
+require 'savon_spec'
+
+Dir[File.join(File.dirname(__FILE__), 'support', '*.rb')].each { |f| require f }
+
+Savon::Spec::Fixture.path = File.expand_path("../fixtures", __FILE__)
+Savon.configure do |config|
+  config.log = false
+end
+
+RSpec.configure do |config|
+  config.include FakeFS::SpecHelpers
+
+  config.include Savon::Spec::Macros
+  config.before { FakeFS::FileSystem.clone(File.expand_path('../fixtures', __FILE__)) }
+end
+
+require 'reps_client'

data/spec/support/fault_handler_shared_examples.rb

@@ -0,0 +1,51 @@
+shared_examples_for 'a fault handler' do |soap_action|
+  before { savon.stubs(soap_action).raises_soap_fault.returns(Savon::Spec::Fixture[:faults, fault_type]) }
+
+  context 'when there is an invalid enterprise key fault' do
+    let(:fault_type) { :invalid_enterprise_key_fault }
+ 
+    it 'should raise a RepsClient invalid enterprise key error' do
+      expect { subject }.to raise_error(RepsClient::InvalidEnterpriseKeyError)
+    end
+
+    it 'should include the faultstring in the error object' do
+      expect { subject }.to raise_error { |e| e.message.should =~ /^System\.Web\.Services\.Protocols\.SoapException: Invalid Enterprise Key/ }
+    end
+
+    it 'should include the faultcode in the error object' do
+      expect { subject }.to raise_error { |e| e.code.should == 'InvalidEnterpriseKey' }
+    end
+  end
+
+  context 'when there is a client fault' do
+    let(:fault_type) { :client_fault }
+
+    it 'should raise a RepsClient service error' do
+      expect { subject }.to raise_error(RepsClient::ServiceError)
+    end
+
+    it 'should include the faultstring in the error object' do
+      expect { subject }.to raise_error { |e| e.message.should =~ /^System\.Web\.Services\.Protocols\.SoapException: Server did not recognize the value of HTTP Header SOAPAction/ }
+    end
+
+    it 'should include the faultcode in the error object' do
+      expect { subject }.to raise_error { |e| e.code.should == 'soap:Client' }
+    end
+  end
+
+  context 'when there is a server fault' do
+    let(:fault_type) { :server_fault }
+
+    it 'should raise a RepsClient service error' do
+      expect { subject }.to raise_error(RepsClient::ServiceError)
+    end
+
+    it 'should include the faultstring in the error object' do
+      expect { subject }.to raise_error { |e| e.message.should =~ /^System\.Web\.Services\.Protocols\.SoapException: Server was unable to process request/ }
+    end
+
+    it 'should include the faultcode in the error object' do
+      expect { subject }.to raise_error { |e| e.code.should == 'soap:Server' }
+    end
+  end
+end

data/spec/support/lead_shared_examples.rb

@@ -0,0 +1,33 @@
+shared_examples_for 'a contact attribute validator' do |attr_name|
+  it { should_not be_valid }
+
+  describe '#validate' do
+    subject { contact.validate }
+
+    it { should have_key(attr_name) }
+
+    describe "the errors on #{attr_name}" do
+      subject { contact.validate[attr_name] }
+
+      it { should have(1).error }
+      its(:first) { should be_an ArgumentError }
+    end
+  end
+end
+
+shared_examples_for 'a prospect attribute validator' do |attr_name|
+  it { should_not be_valid }
+
+  describe '#validate' do
+    subject { prospect.validate }
+
+    it { should have_key(attr_name) }
+
+    describe "the errors on #{attr_name}" do
+      subject { prospect.validate[attr_name] }
+
+      it { should have(1).error }
+      its(:first) { should be_an ArgumentError }
+    end
+  end
+end

data/spec/support/pick_list_shared_examples.rb

@@ -0,0 +1,16 @@
+shared_examples_for 'a pick list requester' do
+  it 'should include the enterprise key when requesting pick lists from the remote service' do
+    savon.expects('GetPickLists').with(has_entry(:enterprise_key => enterprise_key)).returns(fixture_name)
+    subject
+  end
+
+  it 'should include the community id when requesting pick lists from the remote service' do
+    savon.expects('GetPickLists').with(has_entry(:community_id => community_id)).returns(fixture_name)
+    subject
+  end
+
+  it 'should order the parameters correctly when requesting pick lists from the remote service' do
+    savon.expects('GetPickLists').with(has_entry(:order! => [:enterprise_key,:community_id])).returns(fixture_name)
+    subject
+  end
+end