chargebee 1.4.5 → 1.4.6

data/CHANGELOG.md

@@ -1,3 +1,23 @@
+### v1.4.6 (2014-09-16)
+* * *
+
+**Error Model**:
+
+New simpler model for error handling has been implemented. Please see below api document for more details
+
+https://apidocs.chargebee.com/docs/api?lang=ruby#error_handling 
+
+The following attributes in APIError have been deprecated.
+* error_code  (Use api_error_code instead).
+* http_code (Use http_status_code instead).
+* http_body 
+
+The changes are backward compatible. Ensure that  your error handling code is tested after you upgrade to this version.
+
+**APIs Updated**:
+
+Shipping Address support added to *create subscription for a customer* api call.
+
 ### v1.4.5 (2014-08-28)
 * * *
 * Customer id can be passed to the checkout new subscription operation.

data/chargebee.gemspec

@@ -4,8 +4,8 @@ Gem::Specification.new do |s|
   s.rubygems_version = '1.3.5'
 
   s.name              = 'chargebee'
-  s.version           = '1.4.5'
-  s.date              = '2014-08-28'
+  s.version           = '1.4.6'
+  s.date              = '2014-09-16'
 
   s.summary     = "Ruby client for Chargebee API."
   s.description = "Subscription Billing - Simple. Secure. Affordable. More details at www.chargebee.com."
@@ -34,8 +34,8 @@ Gem::Specification.new do |s|
     Rakefile
     chargebee.gemspec
     lib/chargebee.rb
-    lib/chargebee/api_error.rb
     lib/chargebee/environment.rb
+    lib/chargebee/errors.rb
     lib/chargebee/list_result.rb
     lib/chargebee/models/addon.rb
     lib/chargebee/models/address.rb

data/lib/chargebee.rb

@@ -5,7 +5,7 @@ require File.dirname(__FILE__) + '/chargebee/request'
 require File.dirname(__FILE__) + '/chargebee/result'
 require File.dirname(__FILE__) + '/chargebee/list_result'
 
-require File.dirname(__FILE__) + '/chargebee/api_error'
+require File.dirname(__FILE__) + '/chargebee/errors'
 
 require File.dirname(__FILE__) + '/chargebee/models/model'
 require File.dirname(__FILE__) + '/chargebee/models/subscription'
@@ -27,7 +27,7 @@ require File.dirname(__FILE__) + '/chargebee/models/download'
 
 module ChargeBee
 
-  VERSION = '1.4.5'
+  VERSION = '1.4.6'
 
   @@default_env = nil
   @@verify_ca_certs = true

data/lib/chargebee/errors.rb

@@ -0,0 +1,43 @@
+module ChargeBee
+
+  class Error < StandardError
+    attr_reader :original_error
+
+    def initialize(message=nil,original_error = nil)
+        super message
+        @original_error = original_error
+    end
+  end
+
+  class IOError < Error; end
+
+  class APIError < Error
+
+    attr_reader  :http_status_code, :message, :type, :api_error_code, :param, :json_obj,
+                 #Deprecated attributes
+                 :http_code, :http_body, :error_code
+    
+    def initialize(http_code=nil, json_obj = nil)
+      super json_obj[:message]
+      @json_obj = json_obj
+      @http_status_code = http_code
+      @type = json_obj[:type]
+      @api_error_code = json_obj[:api_error_code]
+      @param = json_obj[:param]
+
+      #Deprecated attributes
+      @error_code = json_obj[:error_code]
+      @http_code = http_code
+      @http_body = json_obj.to_s
+    end
+    
+  end
+
+
+  class OperationFailedError < APIError; end
+
+  class InvalidRequestError < APIError;  end
+
+  class PaymentError < APIError;  end
+
+end

data/lib/chargebee/rest.rb

@@ -5,7 +5,7 @@ module ChargeBee
   module Rest
     
     def self.request(method, url, env, params=nil)
-      raise APIError.new('No environment configured.') unless env
+      raise Error.new('No environment configured.') unless env
       api_key = env.api_key
       headers = {}
       
@@ -44,46 +44,48 @@ module ChargeBee
         
       begin
         response = RestClient::Request.execute(opts)
-      rescue Exception => e
-        case(e)
-        when SocketError
-          raise APIError.new("Error while connecting to chargebee. If you see this repeatedly, contact us at support@chargebee.com")
-        when RestClient::ExceptionWithResponse
-          if rcode = e.http_code and rbody = e.http_body
+      rescue RestClient::ExceptionWithResponse => e
+        if rcode = e.http_code and rbody = e.http_body
             raise handle_for_error(e, rcode, rbody)
-          else
-            raise APIError.new(e.message)
-          end
-        when RestClient::Exception
-          raise APIError.new("Unexpected error received: #{e.message}", e.http_code, e.http_body)
         else
-          raise APIError.new(e.message)
+            raise IOError.new("IO Exception when trying to connect to chargebee with url #{opts[:url]} . Reason #{e}",e)
         end
+      rescue Exception => e
+            raise IOError.new("IO Exception when trying to connect to chargebee with url #{opts[:url]} . Reason #{e}",e)        
       end
       rbody = response.body
       rcode = response.code
       begin
         resp = JSON.parse(rbody)
-      rescue JSON::ParserError
-        raise APIError.new("Invalid response object from API", rcode, rbody)
+      rescue Exception => e
+        raise Error.new("Response not in JSON format. Probably not a ChargeBee response \n #{rbody.inspect}",e)
       end
-
       resp = Util.symbolize_keys(resp)
       resp
     end
     
     def self.handle_for_error(e, rcode=nil, rbody=nil)
       if(rcode == 204)
-        raise APIError.new("No response returned by the chargebee api", rcode)
+        raise Error.new("No response returned by the chargebee api. The http status code is #{rcode}")
       end
       begin
         error_obj = JSON.parse(rbody)
         error_obj = Util.symbolize_keys(error_obj)
-      rescue JSON::ParseError
-        raise APIError.new("Invalid JSON response #{rbody.inspect} received with HTTP response code #{rcode}", rcode, rbody)
+      rescue Exception => e
+        raise Error.new("Error response not in JSON format. The http status code is #{rcode} \n #{rbody.inspect}",e)
+      end
+      type = error_obj[:type]
+      if("payment" == type)
+        raise PaymentError.new(rcode, error_obj)
+      elsif("operation_failed" == type)
+        raise OperationFailedError.new(rcode, error_obj)
+      elsif("invalid_request" == type)
+        raise InvalidRequestError.new(rcode, error_obj)
+      else
+        raise APIError.new(rcode, error_obj)
       end
-      raise APIError.new(error_obj.to_s, rcode, rbody, error_obj)
+      
     end
     
   end
-end
+end

data/spec/chargebee_spec.rb

@@ -27,9 +27,9 @@ describe "chargebee" do
       "id"=>"sub_KyVq7DNSNM7CSD",
       "plan_id"=>"free",
       "addons[id][0]"=>"monitor",
-      "addons[quantity][0]"=>2,
+      "addons[quantity][0]"=>"2",
       "addons[id][1]"=>"ssl",
-      "addon_ids[0"=>"addon_one",
+      "addon_ids[0]"=>"addon_one",
       "addon_ids[1]"=>"addon_two",
       "card[first_name]"=>"Rajaraman",
       "card[last_name]"=>"Santhanam",
@@ -95,15 +95,5 @@ describe "chargebee" do
     s.id.should eq('sample_subscription')
   end
 
-  it "should raise APIError when error response is received" do
-    response = mock_response(sample_error, 400)
-    begin
-      @request.expects(:execute).once.raises(RestClient::ExceptionWithResponse.new(response, 400))
-      ChargeBee::Subscription.create({:id => "invalid_subscription"})
-    rescue ChargeBee::APIError => e
-      e.http_code.should eq(400)
-    end
-  end
-
 end
 

data/spec/sample_response.rb

@@ -71,12 +71,3 @@ def sample_event()
     }
   }
 end
-
-def sample_error
-  {
-      :http_code => "400",
-      :error_code => "param_not_present",
-      :message => "plan_id is not present",
-      :param => "plan_id"
-  }
-end

metadata

@@ -1,82 +1,79 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: chargebee
-version: !ruby/object:Gem::Version 
+version: !ruby/object:Gem::Version
+  version: 1.4.6
   prerelease: 
-  version: 1.4.5
 platform: ruby
-authors: 
+authors:
 - Rajaraman S
 - Thiyagarajan T
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2014-08-28 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2014-09-16 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: json_pure
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &9519980 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        version: "1.5"
+      - !ruby/object:Gem::Version
+        version: '1.5'
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: rest-client
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *9519980
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: &9519220 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        version: "1.4"
+      - !ruby/object:Gem::Version
+        version: '1.4'
   type: :runtime
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: rpsec
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: *9519220
+- !ruby/object:Gem::Dependency
+  name: rpsec
+  requirement: &9518120 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
+      - !ruby/object:Gem::Version
         version: 2.9.0
   type: :development
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: mocha
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  version_requirements: *9518120
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: &9516880 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id004
+  prerelease: false
+  version_requirements: *9516880
 description: Subscription Billing - Simple. Secure. Affordable. More details at www.chargebee.com.
-email: 
+email:
 - rr@chargebee.com
 - thiyagu@chargebee.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - README.rdoc
 - LICENSE
-files: 
+files:
 - CHANGELOG.md
 - LICENSE
 - README.rdoc
 - Rakefile
 - chargebee.gemspec
 - lib/chargebee.rb
-- lib/chargebee/api_error.rb
 - lib/chargebee/environment.rb
+- lib/chargebee/errors.rb
 - lib/chargebee/list_result.rb
 - lib/chargebee/models/addon.rb
 - lib/chargebee/models/address.rb
@@ -106,32 +103,30 @@ files:
 - spec/spec_helper.rb
 homepage: https://apidocs.chargebee.com/api/docs?lang=ruby
 licenses: []
-
 post_install_message: 
-rdoc_options: 
+rdoc_options:
 - --charset=UTF-8
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.8.15
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 2
 summary: Ruby client for Chargebee API.
-test_files: 
+test_files:
 - spec/chargebee/list_result_spec.rb
 - spec/chargebee_spec.rb
 - spec/sample_response.rb

data/lib/chargebee/api_error.rb

@@ -1,23 +0,0 @@
-module ChargeBee
-  class APIError < StandardError
-
-    attr_reader :message, :http_code, :http_body, :json_obj, :error_code, :param
-    
-    def initialize(message=nil, http_code=nil, http_body=nil, json_obj = nil)
-      @message = message
-      @http_code = http_code
-      @http_body = http_body
-      @json_obj = json_obj
-      if(json_obj != nil)
-        @error_code = json_obj[:error_code]
-        @param = json_obj[:param]
-      end
-    end
-    
-    def to_s
-      hc = @http_code.nil? ? "" : "(Http Code #{@http_code}) "
-      "#{hc}#{@message}"
-    end
-    
-  end
-end