mr_speedy_ruby 1.0.0.pre.alpha.3 → 1.0.0.pre.alpha.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 165397e3f490933a9629fab7f1ccdbbc46f8dfb930c377c71435a8d719de64e1
-  data.tar.gz: fe00bea9f37148d44c08fcb6ec69b0c8b53db1e556afa828b89a542feca152d8
+  metadata.gz: 5d2c2406e33ada4b65dd88f1ab38466a18290dd9d83f0c29df982c419c660f48
+  data.tar.gz: 4d201453a1d10a717e4f338692f2c94fe6362ee1c94632d23377dcec6277616d
 SHA512:
-  metadata.gz: 3c0e07138c3bfc72d5ed0692dd896c754e9e5c42455b345b9b6c546a180c32ed646962ae583d86c20109b3f758682efeda2436c5758dad7021d83a437cfdb90b
-  data.tar.gz: 9013f4c7096f909db62dab0e812d682dc8a10f3bca1026cd50fcfdb912df815d0e60dc1b7824eb1e7a251aeb924daa4d6b1e857698149b2125e309c8f9f7b197
+  metadata.gz: 1ac74e3e6d1ea3def5a5154248c1ed121659c410baea0a8009d8f35aba30ac65e0f54cce422eaf2fcfd0219a1409eb2fd36ba83277980e6c2fabe7ee142198a7
+  data.tar.gz: cdcf8e9499ff5e501a76bcf7ce259d36edfeefd2e39029ff63872241df60948308022150b30730eb22ca6a6e38a9a552517cabade835bd7b930dda90fc44b285

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    mr_speedy_ruby (1.0.0.pre.alpha.3)
+    mr_speedy_ruby (1.0.0.pre.alpha.4)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -160,7 +160,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 - [ ] Draft Delivery Deletion
 - [ ] Draft Delivery List
 - [ ] API Setting Update
-- [ ] Request Error Handling
+- [x] Request Error Handling
 
 ## License
 

data/lib/mr_speedy_ruby/base.rb

@@ -48,6 +48,8 @@ module MrSpeedyRuby
       response = send_request("post", endpoint, token, payload)
 
       response_body = JSON.parse(response.body)
+      validate_error(response: response_body)
+
       response_body
     end
 
@@ -62,6 +64,8 @@ module MrSpeedyRuby
       response = send_request("get", endpoint, token, payload)
 
       response_body = JSON.parse(response.body)
+      validate_error(response: response_body)
+
       response_body
     end
 
@@ -97,5 +101,15 @@ module MrSpeedyRuby
         http.request(request)
       end
     end
+
+    # Error Validator
+    # @since 1.0.0-alpha.4
+    #
+    # @raise [Error] response error
+    def validate_error(response:)
+      success = response["is_successful"]
+      error = response["errors"]&.first || ""
+      MrSpeedyRuby::ErrorParser.raise_errors_from(code: error) unless success
+    end
   end
 end

data/lib/mr_speedy_ruby/error.rb

@@ -0,0 +1,212 @@
+module MrSpeedyRuby
+  # Base Error Class
+  # @since 1.0.0-alpha.4
+  #
+  # @raise [Error] base error
+  class Error < StandardError; end
+
+  # Error Module
+  # @since 1.0.0-alpha.4
+  # @see https://apitest.mrspeedy.ph/business-api/doc#common-errors
+  #
+  # @raise [MrSpeedyError] base mr.speedy error
+  class MrSpeedyError < Error
+    def initialize(msg = nil)
+      @message = msg
+    end
+  end
+
+  # Mr.Speedy Unexpected Error Class
+  # @since 1.0.0-alpha.4
+  # @raise [Error] mr.speedy unexpected error
+  class UnexpectedError < MrSpeedyError
+    def to_s
+      @message || "Unexpected error. Please let us know at api@mrspeedy.ph."
+    end
+  end
+
+  # Mr.Speedy Invalid API Version Error Class
+  # @since 1.0.0-alpah.4
+  # @raise [Error] mr.speedy invalid api version error
+  class InvalidAPIVersion < MrSpeedyError
+    def to_s
+      @message || "Unknown API version."
+    end
+  end
+
+  # Mr.Speedy Required API Upgrade Error Class
+  # @since 1.0.0-alpha.4
+  # @raise [Error] mr.speedy required api upgrade error
+  class RequiredAPIUpgrade < MrSpeedyError
+    def to_s
+      message = "Requested API version was discontinued."\
+                " You should use the latest version instead."
+      @message || message
+    end
+  end
+
+  # Mr.Speedy Request Limit Exceeded Error Class
+  # @since 1.0.0-alpha.4
+  # @raise [Error] mr.speedy request limit exceeded error
+  class RequestLimitExceeded < MrSpeedyError
+    def to_s
+      @message || "You have reached an API usage limit."
+    end
+  end
+
+  # Mr.Speedy Required Auth Token Error Class
+  # @since 1.0.0-alpha.4
+  # @raise [Error] mr.speedy missing auth token error
+  class RequiredAuthToken < MrSpeedyError
+    def to_s
+      @message || "X-DV-Auth-Token header is missing from the request."
+    end
+  end
+
+  # Mr.Speedy Invalid Auth Token Error Class
+  # @since 1.0.0-alpha.4
+  # @raise [Error] mr.speedy invalid auth token error
+  class InvalidAuthToken < MrSpeedyError
+    def to_s
+      @message || "X-DV-Auth-Token you are sending is invalid."
+    end
+  end
+
+  # Mr.Speedy Required GET Method Error Class
+  # @since 1.0.0-alpha.4
+  # @raise [Error] mr.speedy invalid http method error
+  class RequiredMethodGET < MrSpeedyError
+    def to_s
+      @message || "HTTP method GET is required."
+    end
+  end
+
+  # Mr.Speedy Required POST Method Error Class
+  # @since 1.0.0-alpha.4
+  # @raise [Error] mr.speedy invalid http method error
+  class RequiredMethodPOST < MrSpeedyError
+    def to_s
+      @message || "HTTP method POST is required."
+    end
+  end
+
+  # Mr.Speedy Invalid POST Json Error Class
+  # @since 1.0.0-alpha.4
+  # @raise [Error] mr.speedy invalid post json error
+  class InvalidPOSTJson < MrSpeedyError
+    def to_s
+      @message || "POST request body must be in JSON format."
+    end
+  end
+
+  # Mr.Speedy Invalid Parameters Error Class
+  # @since 1.0.0-alpha.4
+  # @raise [Error] mr.speedy invalid parameters error
+  class InvalidParameters < MrSpeedyError
+    def to_s
+      @message || "Request parameters contain errors"
+    end
+  end
+
+  # Mr.Speedy Unapproved Contract Error Class
+  # @since 1.0.0-alpha.4
+  # @raise [Error] mr.speedy unapproved contract error
+  class UnapprovedContract < MrSpeedyError
+    def to_s
+      @message || "Your agreement is not approved yet (for legal entities)."
+    end
+  end
+
+  # Mr.Speedy Service Unavailable Error Class
+  # @since 1.0.0-alpha.4
+  # @raise [Error] mr.speedy service unavailable error
+  class ServiceUnavailable < MrSpeedyError
+    def to_s
+      @message || "Our service is temporarily unavailable. Please try again later."
+    end
+  end
+
+  # Mr.Speedy Invalid API Method Error Class
+  # @since 1.0.0-alpha.4
+  # @raise [Error] mr.speedy invalid api method error
+  class InvalidAPIMethod < MrSpeedyError
+    def to_s
+      @message || "Unknown API method was requested."
+    end
+  end
+
+  # Mr.Speedy Buyout Not Allowed Error Class
+  # @since 1.0.0-alpha.4
+  # @raise [Error] mr.speedy buyout not allowed error
+  class BuyoutNotAllowed < MrSpeedyError
+    def to_s
+      @message || "You do not have access to buyout feature."
+    end
+  end
+
+  # Mr.Speedy Order Cannot Be Edited Error Class
+  # @since 1.0.0-alpha.4
+  # @raise [Error] mr.speedy order cannot be edited error
+  class OrderCannotBeEdited < MrSpeedyError
+    def to_s
+      @message || "Order cannot be edited."
+    end
+  end
+
+  # Mr.Speedy Order Cannot Be Canceled Error Class
+  # @since 1.0.0-alpha.4
+  # @raise [Error] mr.speedy order cannot be edited error
+  class OrderCannotBeCanceled < MrSpeedyError
+    def to_s
+      @message || "Order cannot be canceled."
+    end
+  end
+
+  # Mr.Speedy Insufficient Balance Error Class
+  # @since 1.0.0-alpha.4
+  # @raise [Error] mr.speedy insufficient balance error
+  class InsufficientBalance < MrSpeedyError
+    def to_s
+      @message || "Your balance is too low (for legal entities)."
+    end
+  end
+
+  # Mr.Speedy Buyout Amount Limit Exceeded Error Class
+  # @since 1.0.0-alpha.4
+  # @raise [Error] mr.speedy buyout amount limit exceeded error
+  class BuyoutAmountLimitExceeded < MrSpeedyError
+    def to_s
+      message = "Total buyout amount in your active orders is too large. "\
+                "You do not have sufficient balance / credit limit to place"\
+                " the new order."
+      @message || message
+    end
+  end
+
+  # Mr.Speedy Route Not Found Error Class
+  # @since 1.0.0-alpha.4
+  # @raise [Error] mr.speedy route not found error
+  class RouteNotFound < MrSpeedyError
+    def to_s
+      @message || "Route not found."
+    end
+  end
+
+  # Mr.Speedy Total Payment Amount Limit Exceeded Error Class
+  # @since 1.0.0-alpha.4
+  # @raise [Error] mr.speedy total payment amount limit exceeded error
+  class TotalPaymentAmountLimitExceeded < MrSpeedyError
+    def to_s
+      @message || "Exceeded maximum order price."
+    end
+  end
+
+  # Mr.Speedy Duplicate Order Error Class
+  # @since 1.0.0-alpha.4
+  # @raise [Error] mr.speedy duplicate order error
+  class OrderIsDuplicate < MrSpeedyError
+    def to_s
+      @message || "Duplicate order rejected"
+    end
+  end
+end

data/lib/mr_speedy_ruby/error_parser.rb

@@ -0,0 +1,60 @@
+module MrSpeedyRuby
+  # Error Parser Class
+  # @since 1.0.0-alpha.4
+  class ErrorParser
+    # Mr.Speedy Error Codes
+    # @since 1.0.0-alpha.4
+    #
+    # @see https://apitest.mrspeedy.ph/business-api/doc#common-errors
+    ERROR_CODES = {
+      "unexpected_error"                    => UnexpectedError,
+      "invalid_api_version"                 => InvalidAPIVersion,
+      "required_api_upgrade"                => RequiredAPIUpgrade,
+      "request_limit_exceeded"              => RequestLimitExceeded,
+      "required_auth_token"                 => RequiredAuthToken,
+      "invalid_auth_token"                  => InvalidAuthToken,
+      "required_method_get"                 => RequiredMethodGET,
+      "required_method_post"                => RequiredMethodPOST,
+      "invalid_post_json"                   => InvalidPOSTJson,
+      "invalid_parameters"                  => InvalidParameters,
+      "unapproved_contract"                 => UnapprovedContract,
+      "service_unavailable"                 => ServiceUnavailable,
+      "invalid_api_method"                  => InvalidAPIMethod,
+      "buyout_not_allowed"                  => BuyoutNotAllowed,
+      "order_cannot_be_edited"              => OrderCannotBeEdited,
+      "order_cannot_be_canceled"            => OrderCannotBeCanceled,
+      "insufficient_balance"                => InsufficientBalance,
+      "buyout_amount_limit_exceeded"        => BuyoutAmountLimitExceeded,
+      "route_not_found"                     => RouteNotFound,
+      "total_payment_amount_limit_exceeded" => TotalPaymentAmountLimitExceeded,
+      "order_is_duplicate"                  => OrderIsDuplicate,
+    }.freeze
+
+    class << self
+      # Raise Error from Response Status
+      # @param code [String] error code
+      def raise_errors_from(code:)
+        raise_error_for(code)
+
+        # Default to Unexpected Error
+        raise UnexpectedError
+      end
+
+      private
+
+      # Raise Error from Response Status
+      # @param code [String] error code
+      #
+      # @private
+      #
+      # @raise [MrSpeedyRuby::MrSpeedyError] raise code based error
+      def raise_error_for(code)
+        error = ERROR_CODES[code]
+
+        # Constantize string class
+        # @see https://stackoverflow.com/a/5924541
+        raise Object.const_get("MrSpeedyRuby::#{error}") if error
+      end
+    end
+  end
+end

data/lib/mr_speedy_ruby/version.rb

@@ -1,3 +1,3 @@
 module MrSpeedyRuby
-  VERSION = "1.0.0-alpha.3"
+  VERSION = "1.0.0-alpha.4"
 end

data/lib/mr_speedy_ruby.rb

@@ -1,7 +1,8 @@
 require "mr_speedy_ruby/version"
 require "mr_speedy_ruby/client"
+require "mr_speedy_ruby/error"
+require "mr_speedy_ruby/error_parser"
 
 # Mr Speedy Namespace Module
 module MrSpeedyRuby
-  class Error < StandardError; end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mr_speedy_ruby
 version: !ruby/object:Gem::Version
-  version: 1.0.0.pre.alpha.3
+  version: 1.0.0.pre.alpha.4
 platform: ruby
 authors:
 - Peter John Alvarado
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-05-13 00:00:00.000000000 Z
+date: 2020-05-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -136,6 +136,8 @@ files:
 - lib/mr_speedy_ruby.rb
 - lib/mr_speedy_ruby/base.rb
 - lib/mr_speedy_ruby/client.rb
+- lib/mr_speedy_ruby/error.rb
+- lib/mr_speedy_ruby/error_parser.rb
 - lib/mr_speedy_ruby/lib/hash_refinement.rb
 - lib/mr_speedy_ruby/order.rb
 - lib/mr_speedy_ruby/version.rb