cherby 0.0.2 → 0.0.3

data/cherby.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = "cherby"
-  s.version = "0.0.2"
+  s.version = "0.0.3"
   s.summary = "Cherwell-Ruby bridge"
   s.description = <<-EOS
     Cherby is a Ruby wrapper for the Cherwell Web Service.
@@ -14,7 +14,6 @@ Gem::Specification.new do |s|
   s.add_dependency 'savon', '>= 2.3.0'
   s.add_dependency 'yajl-ruby'
   s.add_dependency 'nokogiri'
-  s.add_dependency 'mustache'
 
   s.add_development_dependency "rake"
   s.add_development_dependency "simplecov"

data/lib/cherby/business_object.rb

@@ -34,9 +34,27 @@ module Cherby
 
     attr_reader :dom
 
-    # Create a new instance populated with the given XML string
+    # Create a new BusinessObject instance from the given XML string.
     def initialize(xml)
       @dom = Nokogiri::XML(xml)
+      check_dom_format!
+    end
+
+    # Ensure the @dom is in the expected format for BusinessObjects.
+    #
+    # @raise [Cherby::BadFormat]
+    #   If the DOM's structure is incorrect
+    #
+    def check_dom_format!
+      # Ensure XML is in expected format for BusinessObjects
+      if @dom.css('BusinessObject').empty?
+        raise Cherby::BadFormat.new(
+          "BusinessObject XML is missing 'BusinessObject' element")
+      elsif @dom.css('BusinessObject > FieldList').empty?
+        raise Cherby::BadFormat.new(
+          "BusinessObject XML is missing 'BusinessObject > FieldList' element")
+      end
+      return true
     end
 
     # Return the XML representation of this BusinessObject
@@ -45,9 +63,30 @@ module Cherby
     end
 
     # Return the node of the field with the given name.
+    #
+    # @param [String] field_name
+    #   The `Name` attribute of the `Field` element to get.
+    #
+    # @return [Nokogiri::XML::Node, nil]
+    #   The node for the `Field` element, or `nil` if no Field
+    #   with the given `Name` exists.
+    #
     def get_field_node(field_name)
+      check_dom_format!
       selector = "BusinessObject > FieldList > Field[@Name=#{field_name}]"
-      element = @dom.css(selector).first
+      return @dom.css(selector).first
+    end
+
+    # Get a `Field` node with the given name, or create one if it doesn't exist.
+    #
+    # @param [String] field_name
+    #   The `Name` attribute of the `Field` element to get or create.
+    #
+    # @return [Nokogiri::XML::Node]
+    #   The node for the existing or new `Field` element.
+    #
+    def get_or_create_field_node(field_name)
+      element = get_field_node(field_name)
       if element.nil?
         element = Nokogiri::XML::Node.new('Field', @dom)
         element['Name'] = field_name
@@ -126,19 +165,16 @@ module Cherby
     end
 
     # Return the content in the field with the given name.
-    # TODO: Exception for unknown field name
     def [](field_name)
-      if field = get_field_node(field_name)
-        return field.content
-      end
+      field = get_field_node(field_name)
+      return field.content if field
+      return nil
     end
 
     # Modify the content in the field with the given name.
-    # TODO: Exception for unknown field name
     def []=(field_name, value)
-      if field = get_field_node(field_name)
-        field.content = value.to_s
-      end
+      field = get_or_create_field_node(field_name)
+      field.content = value.to_s
     end
 
     # Copy designated fields from one BusinessObject to another.

data/lib/cherby/cherwell.rb

@@ -41,7 +41,7 @@ module Cherby
     # @return [Boolean]
     #   `true` if login was successful
     #
-    # @raise [LoginFailed]
+    # @raise [Cherby::LoginFailed]
     #   If login failed for any reason
     #
     def login(username=nil, password=nil)
@@ -53,7 +53,7 @@ module Cherby
         response = @client.call(:login, :message => creds)
       rescue => e
         # This can happen if a bad URL is given
-        raise LoginFailed, e.message
+        raise Cherby::LoginFailed, e.message
       else
         if response.body[:login_response][:login_result] == true
           # FIXME: Using the workaround described in this issue:
@@ -66,7 +66,7 @@ module Cherby
           return true
         # This can happen if invalid credentials are given
         else
-          raise LoginFailed, "Cherwell returned false status"
+          raise Cherby::LoginFailed, "Cherwell returned false status"
         end
       end
     end
@@ -85,9 +85,18 @@ module Cherby
     #
     # @return [Incident]
     #
+    # @raise [Cherby::NotFound]
+    #   If an error occurs when fetching the incident.
+    #   The `message` attribute includes the error from Cherwell.
+    #
     def incident(id)
       incident_xml = get_object_xml('Incident', id)
-      return Incident.new(incident_xml.to_s)
+      error = self.last_error
+      if error
+        raise Cherby::NotFound.new("Cannot find Incident '#{id}': #{error}")
+      else
+        return Incident.new(incident_xml.to_s)
+      end
     end
 
     # Get the Cherwell task with the given public ID, and return a Task
@@ -95,9 +104,18 @@ module Cherby
     #
     # @return [Task]
     #
+    # @raise [Cherby::NotFound]
+    #   If an error occurs when fetching the task.
+    #   The `message` attribute includes the error from Cherwell.
+    #
     def task(id)
       task_xml = get_object_xml('Task', id)
-      return Task.new(task_xml.to_s)
+      error = self.last_error
+      if error
+        raise Cherby::NotFound.new("Cannot find Task '#{id}': #{error}")
+      else
+        return Task.new(task_xml.to_s)
+      end
     end
 
     # Get a business object based on its public ID or RecID, and return the
@@ -127,6 +145,9 @@ module Cherby
     # @return [String]
     #   Raw XML response string.
     #
+    # @raise [Cherby::SoapError]
+    #   If a Savon::SOAPFault occurs when making the request.
+    #
     def get_object_xml(object_type, id)
       # Assemble the SOAP body
       body = {:busObNameOrId => object_type}
@@ -143,13 +164,19 @@ module Cherby
 
       begin
         result = @client.call_wrap(method, body)
-      rescue Savon::Error => e
-        raise SoapError, e.message
+      rescue Savon::SOAPFault => e
+        raise Cherby::SoapError.new(
+          "SOAPFault from method '#{method}'", e.http)
       else
-        return result
+        return result.to_s
       end
     end
 
+    # Get a BusinessObject instance
+    def get_business_object(object_type, id)
+      xml = self.get_object_xml(object_type, id)
+      return BusinessObject.new(xml)
+    end
 
     # Update a given Cherwell object by submitting its XML to the SOAP
     # interface.

data/lib/cherby/exceptions.rb

@@ -1,6 +1,15 @@
 module Cherby
   class CherbyError < RuntimeError; end
   class LoginFailed < CherbyError; end
-  class SoapError < CherbyError; end
+  class NotFound < CherbyError; end
+  class BadFormat < CherbyError; end
+
+  class SoapError < CherbyError
+    attr_reader :http
+    def initialize(message, http=nil)
+      super(message)
+      @http = http
+    end
+  end
 end # module Cherby
 

data/lib/cherby/incident.rb

@@ -7,6 +7,7 @@ module Cherby
   # Wrapper for Cherwell incident objects.
   class Incident < BusinessObject
     @object_name = 'Incident'
+    # FIXME: Rename these and make use of them?
     @default_values = {
       :service            => "Auto Generated",
       :service_group      => "Auto Generated",

data/spec/business_object_spec.rb

@@ -75,14 +75,44 @@ describe Cherby::BusinessObject do
         last_name.content.should == "Idle"
       end
 
+      it "raises BadFormat if XML is missing FieldList" do
+        xml = %Q{
+          <BusinessObject Name="MySubclass">
+            <Whatever/>
+          </BusinessObject>
+        }
+        lambda do
+          @obj = MySubclass.new(xml)
+        end.should raise_error(
+          Cherby::BadFormat, /missing 'BusinessObject > FieldList'/)
+      end
+
+      it "raises BadFormat if XML is missing BusinessObject" do
+        xml = %Q{
+          <Whatever Name="MySubclass"/>
+        }
+        lambda do
+          @obj = MySubclass.new(xml)
+        end.should raise_error(
+          Cherby::BadFormat, /missing 'BusinessObject'/)
+      end
     end #initialize
 
+    describe "#check_dom_format!" do
+      it "TODO"
+    end #check_dom_format!
+
     describe "#[]" do
       it "returns the value in the named field" do
         obj = MySubclass.create({'First' => 'Eric', 'Last' => 'Idle'})
         obj['First'].should == 'Eric'
         obj['Last'].should == 'Idle'
       end
+
+      it "returns nil if the field doesn't exist" do
+        obj = MySubclass.create({'First' => 'Eric', 'Last' => 'Idle'})
+        obj['Middle'].should be_nil
+      end
     end #[]
 
     describe "#[]=" do
@@ -169,6 +199,11 @@ describe Cherby::BusinessObject do
         @obj = MySubclass.new(xml)
       end
 
+      it "checks the DOM format" do
+        @obj.should_receive(:check_dom_format!).and_return(true)
+        @obj.get_field_node('First')
+      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)
@@ -176,13 +211,44 @@ describe Cherby::BusinessObject do
         first_node.inner_html.should == 'Eric'
       end
 
-      it "creates a new Field if it doesn't exist" do
+      it "returns nil if the field doesn't exist" do
         middle_node = @obj.get_field_node('Middle')
+        middle_node.should be_nil
+      end
+    end #get_field_node
+
+    describe "#get_or_create_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 "checks the DOM format" do
+        @obj.should_receive(:check_dom_format!).and_return(true)
+        @obj.get_or_create_field_node('First')
+      end
+
+      it "returns the Field having the given Name" do
+        first_node = @obj.get_or_create_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 "creates a new Field if it doesn't exist" do
+        middle_node = @obj.get_or_create_field_node('Middle')
         middle_node.should be_a(Nokogiri::XML::Node)
         middle_node.attr('Name').should == 'Middle'
         middle_node.inner_html.should == ''
       end
-    end #get_field_node
+    end #get_or_create_field_node
 
     describe "#field_values" do
       before(:each) do

data/spec/cherwell_spec.rb

@@ -77,22 +77,52 @@ describe Cherby::Cherwell do
     it "returns a Cherby::Incident instance" do
       incident_id = '51949'
       incident_xml = File.read(File.join(DATA_DIR, 'incident.xml'))
+      @cherwell.stub(:last_error => nil)
       @cherwell.stub(:get_object_xml).
         with('Incident', incident_id).
         and_return(incident_xml)
       @cherwell.incident(incident_id).should be_a(Cherby::Incident)
     end
+
+    it "raises Cherby::NotFound if incident is not found" do
+      incident_id = '99999'
+      empty_xml = File.read(File.join(DATA_DIR, 'empty.xml'))
+      @cherwell.stub(:get_object_xml).
+        with('Incident', incident_id).
+        and_return(empty_xml)
+
+      error = "Specified Business Object not found"
+      @cherwell.stub(:last_error => error)
+      lambda do
+        @cherwell.incident(incident_id)
+      end.should raise_error(Cherby::NotFound, /#{error}/)
+    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(:last_error => nil)
       @cherwell.stub(:get_object_xml).
         with('Task', task_id).
         and_return(task_xml)
       @cherwell.task(task_id).should be_a(Cherby::Task)
     end
+
+    it "raises a Cherby::NotFound if task is not found" do
+      task_id = '99999'
+      empty_xml = File.read(File.join(DATA_DIR, 'empty.xml'))
+      @cherwell.stub(:get_object_xml).
+        with('Task', task_id).
+        and_return(empty_xml)
+
+      error = "Specified Business Object not found"
+      @cherwell.stub(:last_error => error)
+      lambda do
+        @cherwell.task(task_id)
+      end.should raise_error(Cherby::NotFound, /#{error}/)
+    end
   end #task
 
   describe "#get_object_xml" do
@@ -142,15 +172,6 @@ describe Cherby::Cherwell do
       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

data/spec/data/empty.xml

@@ -0,0 +1 @@
+<?xml version="1.0"?>

data/spec/spec_helper.rb

@@ -3,7 +3,6 @@ require 'simplecov'
 SimpleCov.start if ENV['COVERAGE']
 
 require 'rspec'
-require 'mustache'
 
 ROOT_DIR = File.absolute_path(File.join(File.dirname(__FILE__), '..'))
 LIB_DIR = File.join(ROOT_DIR, 'lib')
@@ -14,19 +13,23 @@ CONFIG_FILE = File.join(ROOT_DIR, 'config', 'test-config.yml')
 CHERWELL_WSDL = File.join(DATA_DIR, 'cherwell.wsdl')
 $LOAD_PATH.unshift(LIB_DIR)
 
-class XMLTemplate < Mustache
-  self.template_path = XML_DIR
-end
-
 RSpec.configure do |config|
-  def xml_envelope(body)
-    return XMLTemplate.render_file('soap_envelope', :body => body)
-  end
-
   def xml_response(method, body)
-    wrapped_body = XMLTemplate.render_file(
-      'method_response_result', :method => method, :body => body)
-    return xml_envelope(wrapped_body)
+    env_attrs = {
+      'xmlns:soap' => "http://schemas.xmlsoap.org/soap/envelope/",
+      'xmlns:xsi' => "http://www.w3.org/2001/XMLSchema-instance",
+      'xmlns:xsd' => "http://www.w3.org/2001/XMLSchema",
+    }
+    builder = Nokogiri::XML::Builder.new do |xml|
+      xml['soap'].Envelope(env_attrs) do |env|
+        env.Body do
+          env.send(:"#{method}Response", 'xmlns' => 'http://cherwellsoftware.com') do
+            env.send(:"#{method}Result", body)
+          end
+        end
+      end
+    end
+    return builder.to_xml
   end
 
   def savon_response(method, body)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cherby
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-25 00:00:00.000000000 Z
+date: 2014-03-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httpclient
@@ -75,22 +75,6 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: mustache
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -215,6 +199,7 @@ files:
 - spec/cherwell_spec.rb
 - spec/client_spec.rb
 - spec/data/cherwell.wsdl
+- spec/data/empty.xml
 - spec/data/incident.xml
 - spec/data/login_false.xml
 - spec/data/login_true.xml
@@ -223,8 +208,6 @@ files:
 - spec/journal_note_spec.rb
 - spec/spec_helper.rb
 - spec/task_spec.rb
-- spec/xml/method_response_result.mustache
-- spec/xml/soap_envelope.mustache
 - tasks/pry.rake
 - tasks/spec.rake
 homepage: http://github.com/a-e/cherby

data/spec/xml/method_response_result.mustache

@@ -1,4 +0,0 @@
-<{{method}}Response xmlns="http://cherwellsoftware.com">
-  <{{method}}Result>{{body}}</{{method}}Result>
-</{{method}}Response>
-

data/spec/xml/soap_envelope.mustache

@@ -1,6 +0,0 @@
-<?xml version="1.0" encoding="utf-8"?>
-<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
-  <soap:Body>
-    {{{body}}}
-  </soap:Body>
-</soap:Envelope>