cherby 0.0.3 → 0.0.4

data/cherby.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = "cherby"
-  s.version = "0.0.3"
+  s.version = "0.0.4"
   s.summary = "Cherwell-Ruby bridge"
   s.description = <<-EOS
     Cherby is a Ruby wrapper for the Cherwell Web Service.

data/lib/cherby/business_object.rb

@@ -3,22 +3,27 @@ require 'nokogiri'
 module Cherby
   # Cherwell BusinessObject wrapper, with data represented as an XML DOM
   class BusinessObject
+    # Return the name of this class.
+    #
+    # @return [String]
+    #
+    def self.object_type
+      return self.name.split('::').last
+    end
 
-    # Override this with the value of the BusinessObject's 'Name' attribute
-    @object_name = ''
-    # Fill this with default values for new instances of your BusinessObject
-    @default_values = {}
-
-    class << self
-      attr_accessor :object_name, :default_values
+    # Return the name of this instance's class.
+    #
+    # @return [String]
+    #
+    def object_type
+      return self.class.object_type
     end
 
     # Create a new BusinessObject subclass instance from the given hash of
     # 'FieldName' => 'Field Value'.
     def self.create(fields={})
-      type_name = self.object_name
       builder = Nokogiri::XML::Builder.new {
-        BusinessObject_('Name' => type_name, 'RecID' => 'TODO') {
+        BusinessObject_('Name' => self.object_type, 'RecID' => 'TODO') {
           FieldList_ {
             fields.each { |name, value|
               Field_(value, 'Name' => name)
@@ -35,6 +40,24 @@ module Cherby
     attr_reader :dom
 
     # Create a new BusinessObject instance from the given XML string.
+    #
+    # @param [String] xml
+    #   XML for the BusinessObject to create. The XML must contain a
+    #   `BusinessObject` element, with a `FieldList` element within it,
+    #   containing zero or more `Field` elements, each having a `Name`
+    #   attribute, and a string value. For example:
+    #
+    #       <BusinessObject Name="Customer">
+    #         <FieldList>
+    #           <Field Name="FirstName">Steven</Field>
+    #           <Field Name="LastName">Moffat</Field>
+    #           [...]
+    #         </FieldList>
+    #       </BusinessObject>
+    #
+    # @raise [Cherby::BadFormat]
+    #   If the XML DOM's structure is incorrect
+    #
     def initialize(xml)
       @dom = Nokogiri::XML(xml)
       check_dom_format!
@@ -57,7 +80,11 @@ module Cherby
       return true
     end
 
-    # Return the XML representation of this BusinessObject
+    # Return the XML representation of this BusinessObject.
+    #
+    # @return [String]
+    #   The BusinessObject's XML representation
+    #
     def to_xml
       return @dom.to_xml
     end
@@ -71,6 +98,9 @@ module Cherby
     #   The node for the `Field` element, or `nil` if no Field
     #   with the given `Name` exists.
     #
+    # @raise [Cherby::BadFormat]
+    #   If the XML DOM's structure is incorrect
+    #
     def get_field_node(field_name)
       check_dom_format!
       selector = "BusinessObject > FieldList > Field[@Name=#{field_name}]"
@@ -119,12 +149,12 @@ module Cherby
     #   The date/time string to parse. May or may not include a trailing
     #   [+-]HH:MM or [+-]HHMM.
     #
-    # @param [Integer] tz_offset
+    # @param [Integer] default_tz_offset
     #   Offset in hours (positive or negative) between UTC and the given
-    #   `dt_string`. For example, Eastern Time is `-5`. This is ONLY used if
+    #   `dt_string`. For example, US Eastern Time is `-5`. This is ONLY used if
     #   `dt_string` does NOT include a trailing offset component.
     #
-    def self.parse_datetime(dt_string, tz_offset=-5)
+    def self.parse_datetime(dt_string, default_tz_offset=0)
       begin
         result = DateTime.parse(dt_string)
       rescue
@@ -133,27 +163,37 @@ module Cherby
       # If offset was part of the dt_string, use new_offset to get UTC
       if dt_string =~ /[+-]\d\d:?\d\d$/
         return result.new_offset(0)
-      # Otherwise, subtract the numeric offset to get UTC time
+      # Otherwise, subtract the default offset to get UTC time
       else
-        return result - Rational(tz_offset.to_i, 24)
+        return result - Rational(default_tz_offset.to_i, 24)
       end
     end
 
     # Return the last-modified date/time of this BusinessObject
-    # (LastModDateTime converted to DateTime)
-    def modified
+    # (LastModDateTime converted to DateTime).
+    #
+    # @param [Integer] default_tz_offset
+    #   Offset in hours (positive or negative) between UTC and the given
+    #   `dt_string`. For example, US Eastern Time is `-5`. This is ONLY used if
+    #   `dt_string` does NOT include a trailing offset component.
+    #
+    # @raise [Cherby::MissingData, Cherby::BadFormat]
+    #   If `LastModDateTime` is missing or cannot be parsed, respectively
+    #
+    def modified(default_tz_offset=0)
       last_mod = self['LastModDateTime']
       if last_mod.nil? || last_mod.empty?
-        raise RuntimeError, "BusinessObject is missing LastModDateTime field."
+        raise Cherby::MissingData.new("BusinessObject is missing LastModDateTime field.")
       end
       begin
-        return BusinessObject.parse_datetime(last_mod)
+        return BusinessObject.parse_datetime(last_mod, default_tz_offset)
       rescue(ArgumentError)
-        raise RuntimeError, "Cannot parse LastModDateTime: '#{last_mod}'"
+        raise Cherby::BadFormat.new("Cannot parse LastModDateTime: '#{last_mod}'")
       end
     end
 
     # Return the last-modified time as a human-readable string
+    # TODO: Make this more error-tolerant with a default date?
     def mod_s
       return modified.strftime('%Y-%m-%d %H:%M:%S')
     end

data/lib/cherby/exceptions.rb

@@ -1,7 +1,10 @@
 module Cherby
+  # Base class for all Cherby custom exceptions
   class CherbyError < RuntimeError; end
+
   class LoginFailed < CherbyError; end
   class NotFound < CherbyError; end
+  class MissingData < CherbyError; end
   class BadFormat < CherbyError; end
 
   class SoapError < CherbyError

data/lib/cherby/incident.rb

@@ -6,18 +6,7 @@ require 'cherby/journal_note'
 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",
-      :category           => "Auto Generated",
-      :sub_category       => "JIRA",
-      :impact             => "Inconvenience",
-      :urgency            => "Medium",
-      :priority           => "3",
-    }
-
+    # Return the Incident's public ID
     def id
       self['IncidentID']
     end
@@ -46,7 +35,7 @@ module Cherby
       self["SubcategoryNonHR"] = "JIRA"
     end
 
-    # Return Task instances for all tasks associated with this Incident
+    # Return Task instances for all tasks associated with this Incident.
     #
     # @return [Array<Task>]
     #
@@ -56,7 +45,7 @@ module Cherby
       end
     end
 
-    # Return all journal notes associated with this Incident.
+    # Return all JournalNotes associated with this Incident.
     #
     # @return [Array<JournalNote>]
     #

data/lib/cherby/journal_note.rb

@@ -3,10 +3,6 @@ require 'cherby/business_object'
 
 module Cherby
   class JournalNote < BusinessObject
-    @object_name = 'JournalNote'
-    @default_values = {
-      :details => "",
-    }
   end
 end
 

data/lib/cherby/task.rb

@@ -2,16 +2,14 @@ require 'date'
 require 'cherby/business_object'
 
 module Cherby
+  # Wrapper for Cherwell task objects.
   class Task < BusinessObject
-    @object_name = 'Task'
-    @default_values = {
-      :status             => "New",
-    }
-
+    # Return this task's public ID.
     def id
       self['TaskID']
     end
 
+    # Return true if this task exists in Cherwell.
     def exists?
       return !id.to_s.empty?
     end

data/spec/business_object_spec.rb

@@ -1,25 +1,24 @@
 require_relative 'spec_helper'
 require 'cherby/business_object'
+require 'cherby/exceptions'
 
 # Some BusinessObject subclasses to test with
-class MySubclass < Cherby::BusinessObject
-  @object_name = 'MySubclass'
-  @default_values = {}
-end
-
-class MySubclassNoTemplate < Cherby::BusinessObject
-  @object_name = 'MySubclassNoTemplate'
-  @default_values = {}
-end
-
-class MySubclassNoTemplateFile < Cherby::BusinessObject
-  @object_name = 'MySubclassNoTemplateFile'
-  @default_values = {}
-end
+class MySubclass < Cherby::BusinessObject; end
 
 describe Cherby::BusinessObject do
   context "Class methods" do
+    describe "#object_type" do
+      it "returns the plain class name as a string" do
+        MySubclass.object_type.should == 'MySubclass'
+      end
+    end #object_type
+
     describe "#create" do
+      it "uses object_type as the BusinessObject `Name` attribute" do
+        obj = MySubclass.create({})
+        obj.dom.css("BusinessObject").first.attr('Name').should == 'MySubclass'
+      end
+
       it "sets options in the DOM" do
         obj = MySubclass.create({'First' => 'Eric', 'Last' => 'Idle'})
         first_name = obj.dom.css("BusinessObject[@Name=MySubclass] Field[@Name=First]").first
@@ -58,6 +57,13 @@ describe Cherby::BusinessObject do
 
 
   context "Instance methods" do
+    describe "#object_type" do
+      it "returns the plain class name as a string" do
+        obj = MySubclass.create({})
+        obj.object_type.should == 'MySubclass'
+      end
+    end #object_type
+
     describe "#initialize" do
       it "accepts an XML string" do
         xml = %Q{
@@ -75,7 +81,7 @@ describe Cherby::BusinessObject do
         last_name.content.should == "Idle"
       end
 
-      it "raises BadFormat if XML is missing FieldList" do
+      it "raises Cherby::BadFormat if XML is missing FieldList" do
         xml = %Q{
           <BusinessObject Name="MySubclass">
             <Whatever/>
@@ -87,7 +93,7 @@ describe Cherby::BusinessObject do
           Cherby::BadFormat, /missing 'BusinessObject > FieldList'/)
       end
 
-      it "raises BadFormat if XML is missing BusinessObject" do
+      it "raises Cherby::BadFormat if XML is missing BusinessObject" do
         xml = %Q{
           <Whatever Name="MySubclass"/>
         }
@@ -132,7 +138,7 @@ describe Cherby::BusinessObject do
     end #[]=
 
     describe "#modified" do
-      it "BusinessObject with a valid LastModDateTime value" do
+      it "returns the parsed LastModDateTime if it's a valid date/time string" 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)
@@ -141,14 +147,26 @@ describe Cherby::BusinessObject do
         obj.modified.should == now
       end
 
-      it "BusinessObject with an invalid LastModDateTime value" do
+      it "adjusts by default_tz_offset if LastModDateTime does not include an offset" do
+        # Current time, without timezone offset
+        now_str = DateTime.now.strftime('%Y-%m-%dT%H:%M:%S')
+        now = DateTime.parse(now_str)
+
+        obj = MySubclass.create({'LastModDateTime' => now_str})
+        # Test a bunch of different timezone offsets
+        [-7, -5, -2, 0, 1, 3, 4].each do |offset|
+          obj.modified(offset).should == now - Rational(offset, 24)
+        end
+      end
+
+      it "raises Cherby::BadFormat if LastModDateTime value is invalid" do
         obj = MySubclass.create({'LastModDateTime' => 'bogus'})
         lambda do
           obj.modified
-        end.should raise_error(RuntimeError, /Cannot parse LastModDateTime: 'bogus'/)
+        end.should raise_error(Cherby::BadFormat, /Cannot parse LastModDateTime: 'bogus'/)
       end
 
-      it "BusinessObject without a LastModDateTime field" do
+      it "raises Cherby::MissingData if LastModDateTime is empty" do
         xml = %Q{
           <BusinessObject Name="MySubclass">
             <FieldList>

data/spec/cherwell_spec.rb

@@ -172,8 +172,44 @@ describe Cherby::Cherwell do
       result = @cherwell.get_object_xml(@name, @public_id)
       result.should == xml
     end
+
+    it "raises Cherby::SoapError if Savon::SOAPFault occurs" do
+      soap_fault = Savon::SOAPFault.new('fake-http', 'fake-nori')
+      @cherwell.client.stub(:call_wrap).and_raise(soap_fault)
+      lambda do
+        @cherwell.get_object_xml(@name, @public_id)
+      end.should raise_error { |ex|
+        ex.should be_a(Cherby::SoapError)
+        ex.message.should =~ /SOAPFault from method/
+        ex.http.should == 'fake-http'
+      }
+    end
   end #get_object_xml
 
+  describe "#get_business_object" do
+    before(:each) do
+      @name = 'Thing'
+      @rec_id = '12345678901234567890123456789012'
+      @public_id = '12345'
+      @business_object_xml = %Q{
+        <BusinessObject>
+          <FieldList>
+            <Field Name="Name">#{@name}</Field>
+            <Field Name="RecID">#{@rec_id}</Field>
+          </FieldList>
+        </BusinessObject>
+      }
+      @cherwell.stub(:get_object_xml).
+        with(@name, @public_id).
+        and_return(@business_object_xml)
+    end
+
+    it "returns a BusinessObject instance" do
+      result = @cherwell.get_business_object(@name, @public_id)
+      result.should be_a(Cherby::BusinessObject)
+    end
+  end
+
   describe "#update_object_xml" do
     before(:each) do
       @public_id = '80909'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cherby
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-31 00:00:00.000000000 Z
+date: 2014-04-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httpclient