Merge pull request #4 from Cielo24/feature/CLC-1068

CLC-1068: Fix error handling issues

Author: ccoakley

cielo24_gem/cielo24-0.0.17.gem

@@ -23,4 +23,5 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'httpclient', '~> 2.6.0.1'
   spec.add_dependency 'hashie', '~> 3.4.2'
   spec.add_dependency 'tzinfo', '~> 1.2.2'
+  spec.add_dependency 'tzinfo-data', '~> 1.2015.7'
 end

cielo24_gem/cielo24.gemspec

@@ -223,7 +223,7 @@ def aggregate_statistics(api_token, metrics=nil, group_by=nil, start_date=nil, e
       # account_id parameter named sub_account for clarity
       query_hash[:account_id] = sub_account unless sub_account.nil?
       response = WebUtils.get_json(@base_url + AGGREGATE_STATISTICS_PATH, 'GET', WebUtils::BASIC_TIMEOUT, query_hash)
-      return Mash.new(response)
+      Mash.new(response)
     end
 
     ##############################

cielo24_gem/lib/cielo24/actions.rb

@@ -7,6 +7,7 @@ class WebUtils
     require 'logger'
     require 'tzinfo'
     include JSON
+    include TZInfo
 
     BASIC_TIMEOUT = 60           # seconds (1 minute)
     DOWNLOAD_TIMEOUT = 300       # seconds (5 minutes)
@@ -16,7 +17,7 @@ class WebUtils
 
     def self.get_json(uri, method, timeout, query=nil, headers=nil, body=nil)
       response = http_request(uri, method, timeout, query, headers, body)
-      return JSON.parse(response)
+      return json_parse(response)
     end
 
     def self.http_request(uri, method, timeout, query=nil, headers=nil, body=nil)
@@ -35,8 +36,8 @@ def self.http_request(uri, method, timeout, query=nil, headers=nil, body=nil)
           if response.status_code == 200 or response.status_code == 204
             return response.body
           else
-            json = JSON.parse(response.body)
-            raise WebError.new(json['ErrorType'], json['ErrorComment'])
+            json = json_parse(response.body)
+            raise WebError.new(response.status_code, json['ErrorType'], json['ErrorComment'])
           end
 
         }
@@ -47,29 +48,55 @@ def self.http_request(uri, method, timeout, query=nil, headers=nil, body=nil)
 
     def self.to_utc(s)
       return s if s.empty?
-      tz = TZInfo::Timezone.get(SERVER_TZ)
+      tz = Timezone.get(SERVER_TZ)
       local = DateTime.iso8601(s)
       utc = tz.local_to_utc local
       format = '%Y-%m-%dT%H:%M:%S.%L%z' # iso8601 with milliseconds
       utc.strftime(format)
     end
+
+    def self.json_parse(s)
+      begin
+        return JSON.parse(s)
+      rescue JSON::ParserError
+        raise ParsingError.new("Bad JSON String: \"#{s}\"")
+      end
+    end
   end
 
-  class WebError < StandardError
+  class CieloError < StandardError
     attr_reader :type
     def initialize(type, comment)
       super(comment)
       @type = type
     end
 
     def to_s
-      return @type + ' - ' + super.to_s
+      "#{@type} - #{super.to_s}"
+    end
+  end
+
+  class WebError < CieloError
+    attr_reader :status_code
+    def initialize(status_code, type, comment)
+      super(type, comment)
+      @status_code = status_code
+    end
+
+    def to_s
+      "#{@status_code}:#{super.to_s}"
+    end
+  end
+
+  class TimeoutError < CieloError
+    def initialize(message)
+      super('TIMEOUT_ERROR', message)
     end
   end
 
-  class TimeoutError < StandardError
+  class ParsingError < CieloError
     def initialize(message)
-      super(message)
+      super('PARSING_ERROR', message)
     end
   end
 end

cielo24_gem/lib/cielo24/web_utils.rb

@@ -39,6 +39,7 @@ def test_logout
       fail('Should not be able to use the API with invalid API token')
     rescue WebError => e
       assert_equal(ErrorType::BAD_API_TOKEN, e.type, 'Unexpected error type')
+      assert_equal(400, e.status_code, 'Unexpected http status code')
     end
   end
 
@@ -62,6 +63,7 @@ def test_remove_api_key
       fail('Should not be able to login using invalid API key')
     rescue WebError => e
       assert_equal(ErrorType::ACCOUNT_UNPRIVILEGED, e.type, 'Unexpected error type')
+      assert_equal(400, e.status_code, 'Unexpected http status code')
     end
   end