citygrid_api 0.0.14 → 0.0.15

data/VERSION

@@ -1 +1 @@
-0.0.14
+0.0.15

data/citygrid_api.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "citygrid_api"
-  s.version = "0.0.14"
+  s.version = "0.0.15"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Elpizo Choi"]
-  s.date = "2012-05-18"
+  s.date = "2012-06-25"
   s.description = "Ruby wrapper for CityGrid APIs"
   s.email = "fu7iin@gmail.com"
   s.extra_rdoc_files = [

data/lib/citygrid/api.rb

@@ -128,24 +128,34 @@ class CityGrid
         end
       end
 
-      def parse_multiple_responses response
-        parsing = response.values.select{ |x| x.is_a? Array }.first
-        if parsing.nil? || parsing == []
-          #pp "Response was too hard to parse... letting it through..."
-          return parsing
-        elsif parsing != nil && parsing != []
-          if parsing[0]["response"]
-            parsing = [parsing[0]["response"]["code"], parsing[0]["response"]["message"]]
-            return parsing
-          else
-            # this accomodates geocode response which does not contain a response node
-            #pp "Response was too hard to parse... letting it through..."
-            return nil
-          end
+      def parse_response_status response_body
+        status = nil
+        if response_body["response"] || response_body["responseStatus"]
+          status = response_body["response"] || response_body["responseStatus"]
+        elsif response_body["errors"]
+          # make this throw some kind of content API error
+          errors = "" 
+          response_body["errors"].each { |e| errors += "#{e["error"]} " }
+          status = { "code" => "CONTENT_API_ERROR", "message" => errors  }
+        elsif response_body["code"] && response_body["message"]
+          status = response_body
         else
-          # We should figure out a better way to do this
-          raise CityGridExceptions::APIError.new "Received a JSON error code but it could not be parsed: #{response}"
+          response_body.each_value do |value|
+            case value
+              when Array
+                value.each do |inner_value|
+                  if inner_value["response"] || inner_value["responseStatus"]
+                    status = inner_value["response"] || inner_value["responseStatus"]
+                  end
+                end
+              when Hash
+                if value["response"] || value["responseStatus"]
+                  status = value["response"] || value["responseStatus"]
+                end
+            end
+          end
         end
+        return status
       end
 
       # Transform response into API::Response object
@@ -184,46 +194,23 @@ class CityGrid
           end
         end
 
- 
+        response_status = parse_response_status response
+        
         begin 
           # catch unparsable responses (html etc)
           if !response.parsed_response.is_a?(Hash)
             #pp "[gem] the response was unparsable (response was not a hash)"
             raise CityGridExceptions::ResponseParseError.new req_for_airbrake, response
-          # catch responses not in new response format
-          elsif response["errors"]
-            #pp "[gem] An error in the old response format was caught.  Raising a general response error..."
-            raise CityGridExceptions::ResponseError.new req_for_airbrake, response["errors"], response
-
-          # Parse and handle new response codes 
-          elsif (response["response"] && response["response"]["code"] != "SUCCESS") && 
-                (response["response"] && response["response"]["code"] != 200) && 
-                (response["response"] && response["response"]["code"] != 400) 
-            error_code = response["response"]["code"]
-            #pp "[gem] The response was contained in the first level of the response hash.  Below:"
-            #pp response
-            #pp "found error code: #{error_code}"
-            #pp "****************************************************************************"
-            raise CityGridExceptions.appropriate_error(error_code).new req_for_airbrake, response, response["response"]["message"].to_s #+ " " + CityGridExceptions.print_superclasses(error_code)
-          # if the response is a nested hash/nested hash containing arrays
-          elsif response["totalNumEntries"] && response["response"].nil?
-            #pp "[gem] now parsing a response with multiple entries: #{response}"
-            error_code = parse_multiple_responses(response)
-            #pp "the error code that came back is #{error_code}"
-            if error_code.nil? || error_code == []
-              #pp "[gem] passing over this for now"
-              return CityGrid::API::Response.new response # pass over for now
-            elsif error_code[0] == "SUCCESS" || error_code[0] == 200 || error_code[0] == 400
+          else
+            # Parse and handle new response codes 
+            if !response_status.nil? && response_status["code"] != "SUCCESS" && response_status["code"] != 200
+              raise CityGridExceptions.appropriate_error(response_status["code"]).new req_for_airbrake, response, response_status["message"].to_s #+ " " + CityGridExceptions.print_superclasses(response_status["code"])
+            else
               return CityGrid::API::Response.new response
-            else 
-              #pp "[gem] we found an error and it was #{error_code[1]}"
-                raise CityGridExceptions.appropriate_error(error_code[0]).new req_for_airbrake, response, error_code[1].to_s  + " "# + CityGridExceptions.print_superclasses(error_code[0])
             end
-          else
-            return CityGrid::API::Response.new response
           end
         rescue => ex
-          pp "The gem threw an error: #{ex}"
+          pp "API ERROR: #{ex}"
           raise ex if CityGrid.raise_errors?
         end
       end

data/lib/citygrid/citygrid_exceptions.rb

@@ -74,8 +74,10 @@ module CityGridExceptions
 
   # General Errors
   class SystemErrorTryAgainError < GeneralError; end
-  class SystemErrorUnknownError < GeneralError; end
-  class BadRequestTypeError < GeneralError; end 
+  class SystemErrorUnknownError  < GeneralError; end
+  class BadRequestTypeError      < GeneralError; end 
+  class InvalidRequestBodyError  < GeneralError; end
+  class ContentApiError          < GeneralError; end # this stands in for old format content api errors
 
 
 
@@ -95,19 +97,21 @@ module CityGridExceptions
 
  #Authorization Error
  class PermissionDeniedError < AuthorizationError; end
- class NoPermissionsError < AuthorizationError; end
+ class NoPermissionsError    < AuthorizationError; end
 
  # Request Error
- class ParameterRequiredError            < RequestError; end
- class ParameterRequiredConditionalError < RequestError; end
- class ParameterInvalidError             < RequestError; end
- class ParameterFormatError              < RequestError; end
- class ParameterNotSupportedError        < RequestError; end
- class ParameterRangeTooLowError         < RequestError; end
- class ParameterRangeTooHighError        < RequestError; end
- class ParameterSizeLimitExceededError   < RequestError; end
- class ParameterCannotBeZeroError        < RequestError; end
- class ParameterOnlyOne                  < RequestError; end
+ class ParameterRequiredError                       < RequestError; end
+ class ParameterRequiredConditionalError            < RequestError; end
+ class ParameterInvalidError                        < RequestError; end
+ class ParameterFormatError                         < RequestError; end
+ class ParameterNotSupportedError                   < RequestError; end
+ class ParameterRangeTooLowError                    < RequestError; end
+ class ParameterRangeTooHighError                   < RequestError; end
+ class ParameterSizeLimitExceededError              < RequestError; end
+ class ParameterCannotBeZeroError                   < RequestError; end
+ class ParameterOnlyOneError                        < RequestError; end
+ class ParameterAssociationActionNotPerformedError  < RequestError; end
+ class ParameterActionNotAllowedError               < RequestError; end
 
  # Operator Error
  class OperatorInvalidError < OperatorError; end
@@ -137,38 +141,42 @@ module CityGridExceptions
  class MonthlyBudgetReachedError < SpecificDataError; end
  class QuotaExceededError        < SpecificDataError; end
  class RateExceededError         < SpecificDataError; end
+ class BatchLimitExceededError   < SpecificDataError; end
 
 # unused errors
 #400 => RequestError,
 @possible_errors =
- { 
-  0 => ResponseError, nil => ResponseParseError, "" => ResponseParseError, 
-  401 => AuthenticationError, 403 => RequestError, 405 => RequestError, 406 => HeaderError, 
-  500 => ResponseError, "SYSTEM_ERROR_TRY_AGAIN" => SystemErrorTryAgainError,
-  "SYSTEM_ERROR_UNKNOWN" => SystemErrorUnknownError, "BAD_REQUEST_TYPE" => BadRequestTypeError,
-  "HEADER_CONTENT_TYPE_IS_REQUIRED" => ContentTypeRequiredError, "HEADER_CONTENT_TYPE_INVALID" => ContentTypeInvalidError,
-  "HEADER_ACCEPT_IS_REQUIRED" => AcceptRequiredError, "HEADER_ACCEPT_INVALID" => AcceptInvalidError,
-  "AUTH_TOKEN_INVALID" => AuthTokenInvalidError, "AUTH_TOKEN_EXPIRED" => AuthTokenExpiredError,
-  "AUTH_TOKEN_NONE" => AuthTokenNoneError,
-  "USERNAME_IS_REQUIRED" => UsernameRequiredError, "PASSWORD_IS_REQUIRED" => PasswordRequiredError,
-  "ACCOUNT_NOT_FOUND" => AccountNotFoundError, "PERMISSION_DENIED" => PermissionDeniedError,
-  "NO_PERMISSIONS" => NoPermissionsError, "PARAMETER_REQUIRED" => ParameterRequiredError,
-  "PARAMETER_REQUIRED_CONDITIONAL" => ParameterRequiredConditionalError, "PARAMETER_INVALID" => ParameterInvalidError,
-  "PARAMETER_FORMAT" => ParameterFormatError, "PARAMETER_NOT_SUPPORTED" => ParameterNotSupportedError,
-  "PARAMETER_RANGE_TOO_LOW" => ParameterRangeTooLowError, "PARAMETER_RANGE_TOO_HIGH" => ParameterRangeTooHighError,
-  "PARAMETER_SIZE_LIMIT_EXCEEDED" => ParameterSizeLimitExceededError, "PARAMETER_CANNOT_BE_ZERO" => ParameterCannotBeZeroError,
-  "PARAMETER_ONLY_ONE" => ParameterOnlyOne, "OPERATOR_INVALID" => OperatorInvalidError,
-  "ENTITY_NOT_FOUND" => EntityNotFoundError, "ENTITY_EXISTS" => EntityExistsError,
-  "ENTITY_LIMIT" => EntityLimitError, "ENTITY_ALREADY_IN_USE" => EntityAlreadyInUseError,
-  "ENTITY_EXPIRED" => EntityExpiredError, "ENTITY_INACTIVE" => EntityInactiveError,
-  "ENTITY_NOT_ELIGIBLE" => EntityNotEligibleError, "ENTITY_NOT_MODIFIED" => EntityNotModifiedError,
-  "ENTITY_STATE_INVALID" => EntityStateInvalidError, "ENTITY_MISSING_DATA" => EntityMissingDataError,
-  "DATA_NOT_FOUND" => DataNotFoundError, "ASSOCIATION_EXISTS" => AssociationExistsError,
-  "NO_ASSOCIATION_EXISTS" =>  NoAssociationExistsError, "DUPLICATE" =>  DuplicateError,
-  "DATE_BEFORE_DATE" => DateBeforeDateError, "REMOVE_NOT_ALLOWED" => RemoveNotAllowedError,
-  "MOP_EXPIRED" => MopExpiredError, "ACCOUNT_INACTIVE" => AccountInactiveError,
-  "ACCOUNT_DELINQUENT" => AccountDelinquentError, "MONTHLY_BUDGET_REACHED" => MonthlyBudgetReachedError,
-  "QUOTA_EXCEEDED" => QuotaExceededError,"RATE_EXCEEDED" =>  RateExceededError
+  { 
+    0 => ResponseError, nil => ResponseParseError, "" => ResponseParseError, 400 => RequestError,
+    401 => AuthenticationError, 403 => RequestError, 405 => RequestError, 406 => HeaderError,
+    409 => RequestError, 410 => RequestError, 415 => RequestError, 413 => RequestError, 414 => RequestError, 
+    500 => ResponseError, "CONTENT_API_ERROR" => ContentApiError, "SYSTEM_ERROR_TRY_AGAIN" => SystemErrorTryAgainError,
+    "SYSTEM_ERROR_UNKNOWN" => SystemErrorUnknownError, "BAD_REQUEST_TYPE" => BadRequestTypeError,
+    "INVALID_REQUEST_BODY" => InvalidRequestBodyError,
+    "HEADER_CONTENT_TYPE_IS_REQUIRED" => ContentTypeRequiredError, "HEADER_CONTENT_TYPE_INVALID" => ContentTypeInvalidError,
+    "HEADER_ACCEPT_IS_REQUIRED" => AcceptRequiredError, "HEADER_ACCEPT_INVALID" => AcceptInvalidError,
+    "AUTH_TOKEN_INVALID" => AuthTokenInvalidError, "AUTH_TOKEN_EXPIRED" => AuthTokenExpiredError,
+    "AUTH_TOKEN_NONE" => AuthTokenNoneError,
+    "USERNAME_IS_REQUIRED" => UsernameRequiredError, "PASSWORD_IS_REQUIRED" => PasswordRequiredError,
+    "ACCOUNT_NOT_FOUND" => AccountNotFoundError, "PERMISSION_DENIED" => PermissionDeniedError,
+    "NO_PERMISSIONS" => NoPermissionsError, "PARAMETER_REQUIRED" => ParameterRequiredError,
+    "PARAMETER_REQUIRED_CONDITIONAL" => ParameterRequiredConditionalError, "PARAMETER_INVALID" => ParameterInvalidError,
+    "PARAMETER_FORMAT" => ParameterFormatError, "PARAMETER_NOT_SUPPORTED" => ParameterNotSupportedError,
+    "PARAMETER_RANGE_TOO_LOW" => ParameterRangeTooLowError, "PARAMETER_RANGE_TOO_HIGH" => ParameterRangeTooHighError,
+    "PARAMETER_SIZE_LIMIT_EXCEEDED" => ParameterSizeLimitExceededError, "PARAMETER_CANNOT_BE_ZERO" => ParameterCannotBeZeroError,
+    "PARAMETER_ONLY_ONE" => ParameterOnlyOneError,  "PARAMETER_ASSOCIATION_ACTION_NOT_PERFORMED" => ParameterAssociationActionNotPerformedError,
+    "PARAMETER_ACTION_NOT_ALLOWED" => ParameterActionNotAllowedError, "OPERATOR_INVALID" => OperatorInvalidError,
+    "ENTITY_NOT_FOUND" => EntityNotFoundError, "ENTITY_EXISTS" => EntityExistsError,
+    "ENTITY_LIMIT" => EntityLimitError, "ENTITY_ALREADY_IN_USE" => EntityAlreadyInUseError,
+    "ENTITY_EXPIRED" => EntityExpiredError, "ENTITY_INACTIVE" => EntityInactiveError,
+    "ENTITY_NOT_ELIGIBLE" => EntityNotEligibleError, "ENTITY_NOT_MODIFIED" => EntityNotModifiedError,
+    "ENTITY_STATE_INVALID" => EntityStateInvalidError, "ENTITY_MISSING_DATA" => EntityMissingDataError,
+    "DATA_NOT_FOUND" => DataNotFoundError, "ASSOCIATION_EXISTS" => AssociationExistsError,
+    "NO_ASSOCIATION_EXISTS" =>  NoAssociationExistsError, "DUPLICATE" =>  DuplicateError,
+    "DATE_BEFORE_DATE" => DateBeforeDateError, "REMOVE_NOT_ALLOWED" => RemoveNotAllowedError,
+    "MOP_EXPIRED" => MopExpiredError, "ACCOUNT_INACTIVE" => AccountInactiveError,
+    "ACCOUNT_DELINQUENT" => AccountDelinquentError, "MONTHLY_BUDGET_REACHED" => MonthlyBudgetReachedError,
+    "QUOTA_EXCEEDED" => QuotaExceededError,"RATE_EXCEEDED" =>  RateExceededError, "BATCH_LIMIT_EXCEEDED" => BatchLimitExceededError
   }
 
   def CityGridExceptions.appropriate_error error_code

data/test/api/accounts/test_temp_impersonation.rb

@@ -4,5 +4,5 @@ context "impersonate user" do
 	setup do
 		SessionHelper.gary_test.call_api CityGrid::API::Accounts::TempImpersonation, :impersonate, :customerId => 125902
 	end
-	should("have a different auth token"){ap topic.authToken}
+	should("have a different auth token"){pp topic.authToken}
 end

data/test/api/accounts/test_user.rb

@@ -19,5 +19,5 @@ context "impersonate user" do
 	setup do
 		SessionHelper.gary_test.call_api CityGrid::API::Accounts::User, :impersonate, :customerId => 125902
 	end
-	should("have a different auth token"){ap topic.authToken}
+	should("have a different auth token"){pp topic.authToken}
 end

metadata

@@ -2,7 +2,7 @@
 name: citygrid_api
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.14
+  version: 0.0.15
 platform: ruby
 authors: 
 - Elpizo Choi
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-05-18 00:00:00 Z
+date: 2012-06-25 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: httparty