cherby 0.0.1

data/lib/cherby/templates/journal_note.mustache

@@ -0,0 +1,30 @@
+<?xml version="1.0" encoding="utf-8"?>
+<BusinessObject Name="JournalNote" RecID="{{rec_id}}">
+  <FieldList>
+    <!-- Fields common to all BusinessObjects -->
+    <Field Name="RecID">{{rec_id}}</Field>
+    <Field Name="CreatedDateTime">{{created_date_time}}</Field>
+    <Field Name="CreatedBy">{{created_by}}</Field>
+    <Field Name="CreatedByID"></Field>
+    <Field Name="LastModDateTime">{{last_mod_date_time}}</Field>
+    <Field Name="LastModBy">{{last_mod_by}}</Field>
+    <Field Name="LastModByID"></Field>
+    <Field Name="OwnedBy">{{owned_by}}</Field>
+    <Field Name="OwnedByTeam">{{owned_by_team}}</Field>
+    <Field Name="OwnerID"></Field>
+    <Field Name="OwnerTeamID"></Field>
+    <!-- Unused fields? -->
+    <Field Name="LastModTimeStamp"/>
+
+    <Field Name="JournalTypeID">{{journal_type_id}}</Field>
+    <Field Name="JournalTypeName">Note</Field>
+    <Field Name="ParentTypeID">{{parent_type_id}}</Field>
+    <Field Name="ParentRecordID">{{parent_record_id}}</Field>
+    <Field Name="Details">{{details}}</Field>
+    <Field Name="Priority">Normal</Field>
+    <Field Name="ShowInSelfService">TRUE</Field>
+    <Field Name="QuickJournal"/>
+    <Field Name="IncomingEmail">FALSE</Field>
+  </FieldList>
+</BusinessObject>
+

data/lib/cherby/templates/journal_note_relationship.mustache

@@ -0,0 +1,3 @@
+<Relationship Name="Incident has Notes" TargetObjectID="{{target_object_id}}" TargetObjectName="JournalNote" Type="Owns">
+  {{{note_business_object}}}
+</Relationship>

data/lib/cherby/templates/task.mustache

@@ -0,0 +1,67 @@
+<?xml version="1.0" encoding="utf-8"?>
+<BusinessObject Name="Task" RecID="{{rec_id}}">
+  <FieldList>
+    <!-- Fields common to all BusinessObjects -->
+    <Field Name="RecID">{{rec_id}}</Field>
+    <Field Name="CreatedDateTime">{{created_date_time}}</Field>
+    <Field Name="CreatedBy">{{created_by}}</Field>
+    <Field Name="CreatedByID"></Field>
+    <Field Name="LastModDateTime">{{last_mod_date_time}}</Field>
+    <Field Name="LastModBy">{{last_mod_by}}</Field>
+    <Field Name="LastModByID"></Field>
+    <Field Name="OwnedBy">{{owned_by}}</Field>
+    <Field Name="OwnedByTeam">{{owned_by_team}}</Field>
+    <Field Name="OwnerID"></Field>
+    <Field Name="OwnerTeamID"></Field>
+    <!-- Unused fields? -->
+    <Field Name="LastModTimeStamp"/>
+
+    <Field Name="TaskType">Action</Field>
+    <Field Name="TaskDescription">{{task_description}}</Field>
+    <Field Name="StartDateTime">{{start_date_time}}</Field>
+    <Field Name="ParentID">{{parent_id}}</Field>
+    <Field Name="ParentTypeID">{{parent_type_id}}</Field>
+    <Field Name="AssignedToID"></Field>
+    <Field Name="AssignedTo"></Field>
+    <Field Name="AssignedToTeamID"></Field>
+    <Field Name="AssignedToTeam"></Field>
+    <Field Name="Notes">{{notes}}</Field>
+    <Field Name="AcknowledgedByID"></Field>
+    <Field Name="AcknowledgedBy"></Field>
+    <Field Name="AcknowledgedDateTime">0001-01-01T00:00:00</Field>
+    <Field Name="AcknowledgedComment"></Field>
+    <Field Name="ResolvedByID"></Field>
+    <Field Name="ResolvedBy"></Field>
+    <Field Name="ResolvedDateTime">0001-01-01T00:00:00</Field>
+    <Field Name="ResolutionCode">{{resolution_code}}</Field>
+    <Field Name="CompletionDetails">{{completion_details}}</Field>
+    <Field Name="TaskDurationInHours">0.00</Field>
+    <Field Name="Status">{{status}}</Field>
+    <Field Name="Availabiltiy"></Field>
+    <Field Name="Email"></Field>
+    <Field Name="Phone"></Field>
+    <Field Name="CellPhone"></Field>
+    <Field Name="LimitAssigneeByTeam"></Field>
+    <Field Name="ParentTypeName">Incident</Field>
+    <Field Name="ParentPublicID">{{parent_public_id}}</Field>
+    <Field Name="TaskOrder">0.00</Field>
+    <Field Name="ParentActivity"></Field>
+    <Field Name="ActivityOrder">0</Field>
+    <Field Name="ParentActivityOrder">0</Field>
+    <Field Name="DependsOnName"></Field>
+    <Field Name="DependsOnID"></Field>
+    <Field Name="TaskActive">TRUE</Field>
+    <Field Name="DependsOnStatus"></Field>
+    <Field Name="Name"></Field>
+    <Field Name="EndDateTime">{{end_date_time}}</Field>
+    <Field Name="Location"></Field>
+    <Field Name="OwnedByNonCherwellUser">FALSE</Field>
+    <Field Name="TaskID">{{task_id}}</Field>
+    <Field Name="OwnedByEmail">{{owned_by_email}}</Field>
+    <Field Name="TeamNotified">FALSE</Field>
+    <Field Name="ActiveBy"></Field>
+    <Field Name="ActiveByID"></Field>
+    <Field Name="ActiveDateTime">0001-01-01T00:00:00</Field>
+    <Field Name="CreatedByCustomer">FALSE</Field>
+  </FieldList>
+</BusinessObject>

data/lib/cherby/templates/task_relationship.mustache

@@ -0,0 +1,3 @@
+<Relationship Name="Incident Has Tasks" TargetObjectName="Task" Type="Owns">
+  {{{task_business_object}}}
+</Relationship>

data/lib/cherby/templates/test/simple.mustache

@@ -0,0 +1,8 @@
+<?xml version="1.0"?>
+<BusinessObject Name="MySubclass">
+  <FieldList>
+    <Field Name="First">{{first_name}}</Field>
+    <Field Name="Last">{{last_name}}</Field>
+    <Field Name="LastModDateTime">{{last_mod_date_time}}</Field>
+  </FieldList>
+</BusinessObject>

data/spec/business_object_spec.rb

@@ -0,0 +1,250 @@
+require_relative 'spec_helper'
+require 'cherby/business_object'
+
+# Some BusinessObject subclasses to test with
+class MySubclass < Cherby::BusinessObject
+  @object_name = 'MySubclass'
+  @template = 'test/simple'
+  @default_values = {}
+end
+
+class MySubclassNoTemplate < Cherby::BusinessObject
+  @object_name = 'MySubclassNoTemplate'
+  @template = ''
+  @default_values = {}
+end
+
+class MySubclassNoTemplateFile < Cherby::BusinessObject
+  @object_name = 'MySubclassNoTemplateFile'
+  @template = 'no_such_file'
+  @default_values = {}
+end
+
+describe Cherby::BusinessObject do
+  context "Class methods" do
+    describe "#create" do
+      it "sets options in the DOM" do
+        obj = MySubclass.create({:first_name => 'Eric', :last_name => 'Idle'})
+        first_name = obj.dom.css("BusinessObject[@Name=MySubclass] Field[@Name=First]").first
+        last_name = obj.dom.css("BusinessObject[@Name=MySubclass] Field[@Name=Last]").first
+        first_name.content.should == "Eric"
+        last_name.content.should == "Idle"
+      end
+
+      it "raises an exception when no template is provided" do
+        lambda do
+          MySubclassNoTemplate.create
+        end.should raise_error(RuntimeError, /No template defined/)
+      end
+
+      it "raises an exception if the template file is nonexistent" do
+        lambda do
+          MySubclassNoTemplateFile.create
+        end.should raise_error(Errno::ENOENT, /No such file/)
+      end
+    end #create
+
+    describe "#parse_datetime" do
+      it "works with timezone offset" do
+        bo = Cherby::BusinessObject
+        dt = bo.parse_datetime("2012-02-09T09:42:13-05:00")
+        dt.to_s.should == "2012-02-09T14:42:13+00:00"
+
+        dt = bo.parse_datetime("2012-02-09T09:42:13.123-0500")
+        dt.to_s.should == "2012-02-09T14:42:13+00:00"
+      end
+
+      it "works without timezone offset" do
+        bo = Cherby::BusinessObject
+        dt = bo.parse_datetime("2012-02-09T09:42:13", -5)
+        dt.to_s.should == "2012-02-09T14:42:13+00:00"
+      end
+
+      it "raises ArgumentError for invalid datetime string" do
+        bo = Cherby::BusinessObject
+        lambda do
+          bo.parse_datetime("bogus-datetime")
+        end.should raise_error(ArgumentError, /Could not parse/)
+      end
+
+    end #parse_datetime
+
+  end # Class methods
+
+
+  context "Instance methods" do
+    describe "#initialize" do
+      it "accepts an XML string" do
+        xml = %Q{
+          <BusinessObject Name="MySubclass">
+            <FieldList>
+              <Field Name="First">Eric</Field>
+              <Field Name="Last">Idle</Field>
+            </FieldList>
+          </BusinessObject>
+        }
+        obj = MySubclass.new(xml)
+        first_name = obj.dom.css("BusinessObject[@Name=MySubclass] Field[@Name=First]").first
+        last_name = obj.dom.css("BusinessObject[@Name=MySubclass] Field[@Name=Last]").first
+        first_name.content.should == "Eric"
+        last_name.content.should == "Idle"
+      end
+
+    end #initialize
+
+    describe "#[]" do
+      it "returns the value in the named field" do
+        obj = MySubclass.create({:first_name => 'Eric', :last_name => 'Idle'})
+        obj['First'].should == 'Eric'
+        obj['Last'].should == 'Idle'
+      end
+    end #[]
+
+    describe "#[]=" do
+      it "puts a value in the named field" do
+        obj = MySubclass.create({:first_name => 'Eric', :last_name => 'Idle'})
+        obj['First'] = 'Terry'
+        obj['Last'] = 'Jones'
+        obj['First'].should == 'Terry'
+        obj['Last'].should == 'Jones'
+      end
+    end #[]=
+
+    describe "#modified" do
+      it "BusinessObject with a valid LastModDateTime value" do
+        # Parse the string version of now in order to truncate extra precision
+        # (otherwise the date won't compare equal later)
+        now = DateTime.parse(DateTime.now.to_s)
+
+        obj = MySubclass.create({:last_mod_date_time => now})
+        obj.modified.should == now
+      end
+
+      it "BusinessObject with an invalid LastModDateTime value" do
+        obj = MySubclass.create({:last_mod_date_time => 'bogus'})
+        lambda do
+          obj.modified
+        end.should raise_error(RuntimeError, /Cannot parse LastModDateTime: 'bogus'/)
+      end
+
+      it "BusinessObject without a LastModDateTime field" do
+        xml = %Q{
+          <BusinessObject Name="MySubclass">
+            <FieldList>
+            </FieldList>
+          </BusinessObject>
+        }
+        obj = MySubclass.new(xml)
+        lambda do
+          obj.modified
+        end.should raise_error(RuntimeError, /missing LastModDateTime/)
+      end
+    end #modified
+
+    describe "#mod_s" do
+      it "TODO"
+    end #mod_s
+
+    describe "#newer_than?" do
+      before(:each) do
+        @now = DateTime.now
+        @older = MySubclass.create({:last_mod_date_time => (@now - 1)})
+        @newer = MySubclass.create({:last_mod_date_time => @now})
+      end
+
+      it "true when this one was modified more recently than another" do
+        @newer.newer_than?(@older).should be_true
+      end
+
+      it "false when this one was modified less recently than another" do
+        @older.newer_than?(@newer).should be_false
+      end
+    end #newer_than?
+
+    describe "#to_xml" do
+      it "TODO"
+    end #to_xml
+
+    describe "#get_field_node" do
+      before(:each) do
+        xml = %Q{
+          <BusinessObject Name="MySubclass">
+            <FieldList>
+              <Field Name="First">Eric</Field>
+              <Field Name="Last">Idle</Field>
+            </FieldList>
+          </BusinessObject>
+        }
+        @obj = MySubclass.new(xml)
+      end
+
+      it "returns the Field having the given Name" do
+        first_node = @obj.get_field_node('First')
+        first_node.should be_a(Nokogiri::XML::Node)
+        first_node.attr('Name').should == 'First'
+        first_node.inner_html.should == 'Eric'
+      end
+
+      it "returns nil when a Field with the given Name is not found" do
+        @obj.get_field_node('Bogus').should be_nil
+      end
+    end #get_field_node
+
+    describe "#field_values" do
+      before(:each) do
+        xml = %Q{
+          <BusinessObject Name="MySubclass">
+            <FieldList>
+              <Field Name="First">Eric</Field>
+              <Field Name="Last">Pierce</Field>
+            </FieldList>
+            <Relationship Name="Other fields">
+              <FieldList>
+                <Field Name="Middle">Matthew</Field>
+              </FieldList>
+            </Relationship>
+          </BusinessObject>
+        }
+        @obj = MySubclass.new(xml)
+      end
+
+      it "includes fields inside the main FieldList element only" do
+        @obj.field_values.should include('First')
+        @obj.field_values.should include('Last')
+        @obj.field_values.should_not include('Middle')
+      end
+
+      it "hashes field names to their values" do
+        @obj.field_values['First'].should == 'Eric'
+        @obj.field_values['Last'].should == 'Pierce'
+      end
+    end
+
+    describe "#copy_fields_from" do
+      before(:each) do
+        xml = %Q{
+          <BusinessObject Name="MySubclass">
+            <FieldList>
+              <Field Name="Status">Original Status</Field>
+              <Field Name="Description">Original Description</Field>
+              <Field Name="Comment">Original Comment</Field>
+            </FieldList>
+          </BusinessObject>
+        }
+        @obj1 = MySubclass.new(xml)
+        @obj2 = MySubclass.new(xml)
+      end
+
+      it "copies fields from another BusinessObject" do
+        @obj2['Status'] = 'Modified Status'
+        @obj2['Description'] = 'Modified Description'
+
+        @obj1.copy_fields_from(@obj2, 'Status', 'Description')
+        @obj1['Status'].should == 'Modified Status'
+        @obj1['Description'].should == 'Modified Description'
+        @obj1['Comment'].should == 'Original Comment'
+      end
+    end
+  end # Instance methods
+end # Cherby::BusinessObject
+

data/spec/cherwell_spec.rb

@@ -0,0 +1,300 @@
+require_relative 'spec_helper'
+require 'cherby/cherwell'
+require 'cherby/exceptions'
+require 'savon/mock/spec_helper'
+
+describe Cherby::Cherwell do
+  include Savon::SpecHelper
+
+  before(:all) do
+    savon.mock!
+  end
+
+  after(:all) do
+    savon.unmock!
+  end
+
+  before(:each) do
+    # TODO: Mock this!
+    @config = {
+      'url' => CHERWELL_WSDL,
+      'username' => 'somebody',
+      'password' => 'somepass',
+    }
+    @cherwell = Cherby::Cherwell.new(CHERWELL_WSDL)
+  end
+
+  describe "#initialize" do
+    it "sets configuration from a hash"
+    it "creates a new Cherby::Client instance" do
+      @cherwell.client.should be_a(Cherby::Client)
+    end
+  end #initialize
+
+  describe "#login" do
+    it "success when Cherwell returns a true status" do
+      login_response = savon_response('Login', 'true')
+      savon.expects(:login).with(:message => :any).
+        returns(login_response)
+      @cherwell.login.should be_true
+    end
+
+    it "raises Cherby::LoginFailed when client.login raises any exception" do
+      error = "Arbitrary exception message"
+      @cherwell.client.stub(:call).with(:login, :message => anything).
+        and_raise(RuntimeError.new(error))
+      lambda do
+        @cherwell.login
+      end.should raise_error(Cherby::LoginFailed, error)
+    end
+
+    it "raises Cherby::LoginFailed when Cherwell returns a false status" do
+      savon.expects(:login).with(:message => :any).
+        returns(savon_response('Login', 'false'))
+      lambda do
+        @cherwell.login
+      end.should raise_error(
+        Cherby::LoginFailed,
+        /Cherwell returned false status/)
+    end
+  end #login
+
+  describe "#logout" do
+    it "returns true when Cherwell returns a true status" do
+      savon.expects(:logout).with(:message => :any).
+        returns(savon_response('Logout', 'true'))
+      @cherwell.logout.should be_true
+    end
+
+    it "returns false when Cherwell returns a false status" do
+      savon.expects(:logout).with(:message => :any).
+        returns(savon_response('Logout', 'false'))
+      @cherwell.logout.should be_false
+    end
+  end #logout
+
+  describe "#incident" do
+    it "returns a Cherby::Incident instance" do
+      incident_id = '51949'
+      incident_xml = File.read(File.join(DATA_DIR, 'incident.xml'))
+      @cherwell.stub(:get_object_xml).
+        with('Incident', incident_id).
+        and_return(incident_xml)
+      @cherwell.incident(incident_id).should be_a(Cherby::Incident)
+    end
+  end #incident
+
+  describe "#task" do
+    it "returns a Cherby::Task instance" do
+      task_id = '12345'
+      task_xml = File.read(File.join(DATA_DIR, 'task.xml'))
+      @cherwell.stub(:get_object_xml).
+        with('Task', task_id).
+        and_return(task_xml)
+      @cherwell.task(task_id).should be_a(Cherby::Task)
+    end
+  end #task
+
+  describe "#get_object_xml" do
+    before(:each) do
+      @name = 'Thing'
+      @rec_id = '12345678901234567890123456789012'
+      @public_id = '12345'
+      @thing_xml = %Q{
+        <FieldList>
+          <Field Name="Name">#{@name}</Field>
+          <Field Name="RecID">#{@rec_id}</Field>
+        </FieldList>
+      }
+    end
+
+    it "invokes GetBusinessObject for 32-character RecID" do
+      savon.expects(:get_business_object).with(
+        :message => {
+          :busObNameOrId => @name,
+          :busObRecId => @rec_id,
+        }
+      ).returns(
+        savon_response('GetBusinessObject', @thing_xml)
+      )
+      @cherwell.get_object_xml(@name, @rec_id)
+    end
+
+    it "invokes GetBusinessObjectByPublicId for < 32-character IDs" do
+      savon.expects(:get_business_object_by_public_id).with(
+        :message => {
+          :busObNameOrId => @name,
+          :busObPublicId => @public_id,
+        }
+      ).returns(
+        savon_response('GetBusinessObjectByPublicId', @thing_xml)
+      )
+      @cherwell.get_object_xml(@name, @public_id)
+    end
+
+    it "returns a raw XML response string" do
+      xml = "<Foo>Bar</Foo>"
+      savon.expects(:get_business_object_by_public_id).with(
+        :message => :any
+      ).returns(
+        savon_response('GetBusinessObjectByPublicId', xml)
+      )
+      result = @cherwell.get_object_xml(@name, @public_id)
+      result.should == xml
+    end
+
+    it "raises a Cherby::SoapError if a Savon::Error occurs" do
+      soap_fault = Savon::Error.new("Kaboom")
+      @cherwell.client.stub(:call).and_raise(soap_fault)
+      lambda do
+        @cherwell.get_object_xml(@name, @public_id)
+      end.should raise_error(
+        Cherby::SoapError, /Kaboom/)
+    end
+  end #get_object_xml
+
+  describe "#update_object_xml" do
+    before(:each) do
+      @public_id = '80909'
+      @xml = %Q{
+        <Foo>Bar</Foo>
+      }
+    end
+
+    it "invokes UpdateBusinessObjectByPublicId with the given XML" do
+      savon.expects(:update_business_object_by_public_id).with(
+        :message => {
+          :busObNameOrId => 'Incident',
+          :busObPublicId => @public_id,
+          :updateXml => @xml
+        }
+      ).returns(
+        savon_response('UpdateBusinessObjectByPublicId', 'true')
+      )
+      @cherwell.stub(:last_error => nil)
+      @cherwell.update_object_xml('Incident', @public_id, @xml)
+    end
+
+    it "returns the #last_error string" do
+      savon.expects(:update_business_object_by_public_id).
+        with(:message => :any).
+        returns(savon_response('UpdateBusinessObjectByPublicId', 'false'))
+
+      error_message = "Failed to update object"
+      @cherwell.stub(:last_error => error_message)
+      result = @cherwell.update_object_xml('Incident', @public_id, @xml)
+      result.should == error_message
+    end
+  end #update_object_xml
+
+  describe "#save_incident" do
+    before(:each) do
+      @public_id = '62521'
+      @incident_data = {
+        :incident_id => @public_id,
+        :service => 'Consulting Services',
+        :sub_category => 'New/Modified Functionality',
+        :priority => '4',
+      }
+      @incident = Cherby::Incident.create(@incident_data)
+      @cherwell.stub(:last_error => nil)
+    end
+
+    it "invokes UpdateBusinessObjectByPublicId with the Incident XML" do
+      savon.expects(:update_business_object_by_public_id).with(
+        :message => {
+          :busObNameOrId => 'Incident',
+          :busObPublicId => @public_id,
+          :updateXml => @incident.to_xml
+        }
+      ).returns(
+        savon_response('UpdateBusinessObjectByPublicId', 'true')
+      )
+      @cherwell.save_incident(@incident)
+    end
+  end #save_incident
+
+  describe "#save_task" do
+    before(:each) do
+      @public_id = '90210'
+      @task_data = {
+        :task_id => @public_id,
+        :parent_id => '90000'
+      }
+      @task = Cherby::Task.create(@task_data)
+      @cherwell.stub(:last_error => nil)
+    end
+
+    it "invokes UpdateBusinessObjectByPublicId with the Task XML" do
+      savon.expects(:update_business_object_by_public_id).with(
+        :message => {
+          :busObNameOrId => 'Task',
+          :busObPublicId => @public_id,
+          :updateXml => @task.to_xml
+        }
+      ).returns(
+        savon_response('UpdateBusinessObjectByPublicId', 'true')
+      )
+      @cherwell.save_task(@task)
+    end
+  end #save_task
+
+  describe "#create_incident" do
+    before(:each) do
+      @incident_data = {
+        :service => 'Consulting Services',
+        :sub_category => 'New/Modified Functionality',
+        :priority => '4',
+      }
+      @public_id = '54321'
+    end
+
+    it "invokes CreateBusinessObject with incident XML" do
+      savon.expects(:create_business_object).with(
+        :message => {
+          :busObNameOrId => 'Incident',
+          :creationXml => Cherby::Incident.create(@incident_data).to_xml
+        }
+      ).returns(
+        savon_response('CreateBusinessObject', @public_id)
+      )
+      @cherwell.create_incident(@incident_data)
+    end
+
+    it "returns a Cherby::Incident instance with IncidentID set" do
+      savon.expects(:create_business_object).with(:message => :any).returns(
+        savon_response('CreateBusinessObject', @public_id)
+      )
+      result = @cherwell.create_incident(@incident_data)
+      result.should be_a(Cherby::Incident)
+      result['IncidentID'].should == @public_id
+    end
+
+    it "returns nil if incident creation failed (Cherwell returned nil)" do
+      savon.expects(:create_business_object).with(:message => :any).returns(
+        savon_response('CreateBusinessObject', nil)
+      )
+      result = @cherwell.create_incident(@incident_data)
+      result.should be_nil
+    end
+  end #create_incident
+
+  describe "#last_error" do
+    it "returns the GetLastError response text" do
+      error_message = "Object reference not set to an instance of an object"
+      savon.expects(:get_last_error).with(:message => {}).returns(
+        savon_response('GetLastError', error_message)
+      )
+      @cherwell.last_error.should == error_message
+    end
+
+    it "returns nil if GetLastError returns nil" do
+      savon.expects(:get_last_error).with(:message => {}).returns(
+        savon_response('GetLastError', nil)
+      )
+      @cherwell.last_error.should be_nil
+    end
+  end #last_error
+
+end # describe Cherby::Cherwell
+