infusionsoft 1.1.6 → 1.1.7a

data/Rakefile

@@ -0,0 +1,3 @@
+require 'rake/testtask'
+
+Rake::TestTask.new

data/infusionsoft.gemspec

@@ -12,6 +12,7 @@ Gem::Specification.new do |gem|
   gem.homepage = 'https://github.com/nateleavitt/infusionsoft'
   gem.require_paths = ['lib']
   gem.required_rubygems_version = Gem::Requirement.new('>= 1.3.6')
+  gem.add_development_dependency 'rake'
 
   gem.version = Infusionsoft::VERSION.dup
 end

data/lib/infusionsoft/api_logger.rb

@@ -1,19 +1,14 @@
 module Infusionsoft
   class APILogger
 
-    def info; end
-    def info(msg); $stdout.print msg end
+    def info(msg); $stdout.puts msg end
 
-    def warn; end
-    def warn(msg); $stdout.print msg end
+    def warn(msg); $stdout.puts msg end
 
-    def error; end
-    def error(msg); $stdout.print msg end
+    def error(msg); $stdout.puts msg end
 
-    def debug; end
-    def debug(msg); $stdout.print msg end
+    def debug(msg); $stdout.puts msg end
 
-    def fatal; end
-    def fatal(msg); $stdout.print msg end
+    def fatal(msg); $stdout.puts msg end
   end
 end

data/lib/infusionsoft/client/email.rb

@@ -144,7 +144,7 @@ module Infusionsoft
       # @return [Boolean] returns true/false if teamplate was updated successfully
       def email_update_template(id, title, category, from, to, cc, bcc, subject,
                                 text_body, html_body, content_type, merge_context)
-        response = get('APIEmailService.updateEmailTemplate', title, category, from,
+        response = get('APIEmailService.updateEmailTemplate', id, title, category, from,
                        to, cc, bcc, subject, text_body, html_body, content_type, merge_context)
       end
     end

data/lib/infusionsoft/connection.rb

@@ -1,4 +1,5 @@
 require "xmlrpc/client"
+require 'infusionsoft/exception_handler'
 
 module Infusionsoft
   module Connection
@@ -18,10 +19,10 @@ module Infusionsoft
       rescue Timeout::Error => timeout
         # Retry up to 5 times on a Timeout before raising it
         ok_to_retry(timeout) ? retry : raise
-      rescue => e
-        # Wrap the underlying error in an InfusionAPIError
-        raise InfusionAPIError.new(e.to_s, e)
-      end
+      rescue XMLRPC::FaultException => xmlrpc_error
+        # Catch all XMLRPC exceptions and rethrow specific exceptions for each type of xmlrpc fault code
+        Infusionsoft::ExceptionHandler.new(xmlrpc_error)
+      end # Purposefully not catching other exceptions so that they can be handled up the stack
 
       api_logger.info "RESULT:#{result.inspect}"
       return result
@@ -39,14 +40,3 @@ module Infusionsoft
 
   end
 end
-
-# Extend StandardError to keep track of Error being wrapped
-# Pattern from Exceptional Ruby by Avdi Grimm (http://avdi.org/talks/exceptional-ruby-2011-02-04/)
-class InfusionAPIError < StandardError
-  attr_reader :original
-    def initialize(msg, original=nil);
-      api_logger.error "ERROR: #{msg}"
-      super(msg);
-      @original = original;
-    end
-end

data/lib/infusionsoft/exception_handler.rb

@@ -0,0 +1,32 @@
+require 'infusionsoft/exceptions'
+
+class Infusionsoft::ExceptionHandler
+
+  ERRORS = {
+      1 => Infusionsoft::InvalidConfigError,
+      2 => Infusionsoft::InvalidKeyError,
+      3 => Infusionsoft::UnexpectedError,
+      4 => Infusionsoft::DatabaseError,
+      5 => Infusionsoft::RecordNotFoundError,
+      6 => Infusionsoft::LoadingError,
+      7 => Infusionsoft::NoTableAccessError,
+      8 => Infusionsoft::NoFieldAccessError,
+      9 => Infusionsoft::NoTableFoundError,
+      10 => Infusionsoft::NoFieldFoundError,
+      11 => Infusionsoft::NoFieldsError,
+      12 => Infusionsoft::InvalidParameterError,
+      13 => Infusionsoft::FailedLoginAttemptError,
+      14 => Infusionsoft::NoAccessError,
+      15 => Infusionsoft::FailedLoginAttemptPasswordExpiredError,
+  }
+
+  def initialize(xmlrpc_exception)
+    error_class = ERRORS[xmlrpc_exception.faultCode]
+    if error_class
+      raise error_class, xmlrpc_exception.faultString
+    else
+      raise InfusionAPIError, xmlrpc_exception.faultString
+    end
+  end
+
+end

data/lib/infusionsoft/exceptions.rb

@@ -0,0 +1,58 @@
+# Extend StandardError to keep track of Error being wrapped
+# Pattern from Exceptional Ruby by Avdi Grimm (http://avdi.org/talks/exceptional-ruby-2011-02-04/)
+class InfusionAPIError < StandardError
+  attr_reader :original
+  def initialize(msg, original=nil);
+  Infusionsoft.api_logger.error "ERROR: #{msg}"
+  super(msg);
+  @original = original;
+  end
+end
+
+module Infusionsoft
+  # For now I'm inheriting from InfusionAPIError so that the code will remain backwards compatible...may be deprecated in the future
+  class InvalidConfigError < InfusionAPIError
+  end
+
+  class InvalidKeyError < InfusionAPIError
+  end
+
+  class UnexpectedError < InfusionAPIError
+  end
+
+  class DatabaseError < InfusionAPIError
+  end
+
+  class RecordNotFoundError < InfusionAPIError
+  end
+
+  class LoadingError < InfusionAPIError
+  end
+
+  class NoTableAccessError < InfusionAPIError
+  end
+
+  class NoFieldAccessError < InfusionAPIError
+  end
+
+  class NoTableFoundError < InfusionAPIError
+  end
+
+  class NoFieldFoundError < InfusionAPIError
+  end
+
+  class NoFieldsError < InfusionAPIError
+  end
+
+  class InvalidParameterError < InfusionAPIError
+  end
+
+  class FailedLoginAttemptError < InfusionAPIError
+  end
+
+  class NoAccessError < InfusionAPIError
+  end
+
+  class FailedLoginAttemptPasswordExpiredError < InfusionAPIError
+  end
+end

data/lib/infusionsoft/version.rb

@@ -1,4 +1,4 @@
 module Infusionsoft
   # The version of the gem
-  VERSION = '1.1.6'.freeze unless defined?(::Infusionsoft::VERSION)
+  VERSION = '1.1.7a'.freeze unless defined?(::Infusionsoft::VERSION)
 end

data/test/test_exceptions.rb

@@ -0,0 +1,113 @@
+require 'test/unit'
+require 'infusionsoft'
+
+
+# override XMLRPC call method
+class XMLRPC::Client
+
+  def call(method, *args)
+    raise XMLRPC::FaultException.new(@@code, @@message)
+  end
+
+  def self.set_fault_response(code, message)
+    @@code = code
+    @@message = message
+  end
+end
+
+class TestLogger
+  def info(msg); end
+  def warn(msg); end
+  def error(msg); end
+  def debug(msg); end
+  def fatal(msg); end
+end
+
+
+class TestExceptions < Test::Unit::TestCase
+
+  def setup
+    Infusionsoft.configure do |c|
+      c.api_logger = TestLogger.new()
+    end
+  end
+
+  def test_should_raise_invalid_config
+    exception_test(Infusionsoft::InvalidConfigError, 1, 'The configuration for the application is invalid.  Usually this is because there has not been a passphrase entered to generate an encrypted key.')
+  end
+
+  def test_should_raise_invalid_key
+    exception_test(Infusionsoft::InvalidKeyError, 2, "The key passed up for authentication was not valid.  It was either empty or didn't match.")
+  end
+
+  def test_should_raise_unexpected_error
+    exception_test(Infusionsoft::UnexpectedError, 3, "An unexpected error has occurred.  There was either an error in the data you passed up or there was an unknown error on")
+  end
+
+  def test_should_raise_database_error
+    exception_test(Infusionsoft::DatabaseError, 4, "There was an error in the database access")
+  end
+
+  def test_should_raise_record_not_found
+    exception_test(Infusionsoft::RecordNotFoundError, 5, "A requested record was not found in the database.")
+  end
+  
+  def test_should_raise_loading_error
+    exception_test(Infusionsoft::LoadingError, 6, "There was a problem loading a record from the database.")
+  end
+
+  def test_should_raise_no_table_access
+    exception_test(Infusionsoft::NoTableAccessError, 7, "A table was accessed without the proper permission")
+  end
+
+  def test_should_raise_no_field_access
+    exception_test(Infusionsoft::NoFieldAccessError, 8, "A field was accessed without the proper permission.")
+  end
+
+  def test_should_raise_no_table_found
+    exception_test(Infusionsoft::NoTableFoundError, 9, "A table was accessed that doesn't exist in the Data Spec.")
+  end
+
+  def test_should_raise_no_field_found
+    exception_test(Infusionsoft::NoFieldFoundError, 10, "A field was accessed that doesn't exist in the Data Spec.")
+  end
+
+  def test_should_raise_no_fields_error
+    exception_test(Infusionsoft::NoFieldsError, 11, "An update or add operation was attempted with no valid fields to update or add.")
+  end
+
+  def test_should_raise_invalid_parameter_error
+    exception_test(Infusionsoft::InvalidParameterError, 12, "Data sent into the call was invalid.")
+  end
+
+  def test_should_raise_failed_login_attempt
+    exception_test(Infusionsoft::FailedLoginAttemptError, 13, "Someone attempted to authenticate a user and failed.")
+  end
+
+  def test_should_raise_no_access_error
+    exception_test(Infusionsoft::NoAccessError, 14, "Someone attempted to access a plugin they are not paying for.")
+  end
+
+  def test_should_raise_failed_login_attempt_password_expired
+    exception_test(Infusionsoft::FailedLoginAttemptPasswordExpiredError, 15, "Someone attempted to authenticate a user and the password is expired.")
+  end
+
+  def test_should_raise_infusionapierror_when_fault_code_unknown
+    exception_test(InfusionAPIError, 42, "Some random error occurred")
+  end
+
+
+  private
+  def exception_test(exception, code, message)
+    XMLRPC::Client.set_fault_response(code, message)
+    caught = false
+    begin
+      Infusionsoft.data_query(:Contact, 1, 0, {}, [:BlahdyDah])
+    rescue exception => e
+      caught = true
+      assert_equal message, e.message
+    end
+    assert_equal true, caught
+  end
+
+end

metadata

@@ -1,16 +1,32 @@
 --- !ruby/object:Gem::Specification
 name: infusionsoft
 version: !ruby/object:Gem::Version
-  version: 1.1.6
-  prerelease: 
+  version: 1.1.7a
+  prerelease: 5
 platform: ruby
 authors:
 - Nathan Leavitt
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-21 00:00:00.000000000 Z
-dependencies: []
+date: 2013-10-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: A Ruby wrapper written for the Infusionsoft API
 email:
 - nate@infusedsystems.com
@@ -21,6 +37,7 @@ files:
 - .gitignore
 - LICENSE.md
 - README.md
+- Rakefile
 - infusionsoft.gemspec
 - lib/infusionsoft.rb
 - lib/infusionsoft/api.rb
@@ -38,9 +55,12 @@ files:
 - lib/infusionsoft/client/version.rb
 - lib/infusionsoft/configuration.rb
 - lib/infusionsoft/connection.rb
+- lib/infusionsoft/exception_handler.rb
+- lib/infusionsoft/exceptions.rb
 - lib/infusionsoft/request.rb
 - lib/infusionsoft/version.rb
 - test/api_infusion_test.rb
+- test/test_exceptions.rb
 homepage: https://github.com/nateleavitt/infusionsoft
 licenses: []
 post_install_message: 
@@ -56,9 +76,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
-  - - ! '>='
+  - - ! '>'
     - !ruby/object:Gem::Version
-      version: 1.3.6
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24