easyship 0.1.4 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1c6c501de616b3a63e0d2115bcd85edd664d19457e15cee9ddc39b90460faf06
-  data.tar.gz: c28725fd205ad6c7943bc3af5ec230c6dfa0a3a9a605a36caaab01d9ff6b4120
+  metadata.gz: 7c050cd7909443866f9f0365555f577024aa49ce0065be2a961018385409972d
+  data.tar.gz: a827b2cdaa8207b8723f5a7c2b65efba7c6b7f9e10cf16b46ea36f34aebae763
 SHA512:
-  metadata.gz: d3e59ba1d63fccd367093dd0d0cfa2c4e853be57820384e7ab033929f808adffca7313633009dc6b7804d3c54d8130ab3f8da45586e31c59865a903c4b906e38
-  data.tar.gz: db7d3fb69ea674cfc5a9ee6527193ce637bf123b74d51f104a821de4f0c9273d3cb4d25621e8ea6b885f852f16c09e2c87485e6845b04bb4e1f70ad4aff319d2
+  metadata.gz: 959f2149e8e0d3f33ce0592de28df9718a0fb1c24cdb78909acffbdcecbeab71449b29a1000c03589d24616603214f0f9aa0dc05bad67e96ee413b2acad2a25c
+  data.tar.gz: 0ba62b8bf714db84417d4c2abb13e66738b0510dd0f57997c9403cdbfb81e2fa78029fb9b058d07a5ed943bb5eb8a9054be8929f6a7975b816fc59dda360b781

data/.rubocop.yml

@@ -1,4 +1,5 @@
-require:
+plugins:
+  - rubocop-rake
   - rubocop-rspec
   - rubocop-performance
 
@@ -7,4 +8,7 @@ AllCops:
   NewCops: enable
 
 Style/Copyright:
-  Enabled: false
+  Enabled: false
+
+RSpec/ExampleLength:
+  Max: 10

data/CHANGELOG.md

@@ -1,5 +1,19 @@
 ## [Unreleased]
 
+## [v.0.2.0](https://github.com/mmarusyk/easyship/tree/v0.2.0) - 2025-05-04
+
+### Added
+- Add response_body and response_header to Easyship::Error
+- Deprecate body_error by @mmarusyk in https://github.com/mmarusyk/easyship/pull/9
+- Add badges by @mmarusyk in https://github.com/mmarusyk/easyship/pull/10
+
+
+## [v0.1.5](https://github.com/mmarusyk/easyship/tree/v0.1.5) - 2025-05-03
+
+### Fixed
+- update docs by @troyizzle in https://github.com/mmarusyk/easyship/pull/5
+- Add test coverage by @mmarusyk in https://github.com/mmarusyk/easyship/pull/6
+- Automate release by @mmarusyk in https://github.com/mmarusyk/easyship/pull/7
 
 ## [v0.1.4](https://github.com/mmarusyk/easyship/tree/v0.1.4) - 2024-10-16
 

data/README.md

@@ -1,5 +1,9 @@
 # Easyship
 
+[![Gem Version](https://badge.fury.io/rb/easyship.svg)](https://badge.fury.io/rb/easyship)
+[![Build Status](https://github.com/mmarusyk/easyship/workflows/Ruby/badge.svg)](https://github.com/mmarusyk/easyship/actions?query=workflow%3ARuby)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
 This gem provides a simple client for Easyship, offering accessing to Easyship's
     shipping, tracking, and logistics services directly from Ruby applications.
 
@@ -59,7 +63,7 @@ Configuration supports the next keys: `url`, `api_key`, `per_page`.
 ### Making Requests
 `Easyship::Client` supports the next methods: `get`, `post`, `put`, `delete`.
 ```ruby
-Easyship::Client.get('/2023-01/account')
+Easyship::Client.instance.get('/2023-01/account')
 ```
 
 To make post request:
@@ -84,7 +88,7 @@ payload = {
   ]
 }
 
-Easyship::Client.post('/2023-01/shipment', payload)
+Easyship::Client.instance.post('/2023-01/shipment', payload)
 ```
 
 ### Handle errors
@@ -97,12 +101,21 @@ For example:
 
 ```ruby
 begin
-  Easyship::Client.post('/2023-01/shipment', payload)
+  Easyship::Client.instance.post('/2023-01/shipment', payload)
 rescue Easyship::Errors::RateLimitError => e
   Rails.logger.error("Easyship Error: #{e.message}")
 end
 ```
 
+Each error instance provides these methods:
+
+- `message`: Returns the error message text.
+- `body_error`: Returns an error details **(Deprecated)**.
+- `error`: Returns a hash containing original detailed error object from Easyship.
+- `response_body`: Returns the full response body from the API.
+- `response_headers`: Returns the HTTP headers from the API response.
+
+
 ### Pagination
 The `get` method in the `Easyship::Client` class is designed to support pagination seamlessly when interacting with the Easyship API by passing block of code. This method abstracts the complexity of managing pagination logic, allowing you to retrieve all items across multiple pages with a single method call.
 

data/lib/easyship/error.rb

@@ -5,7 +5,23 @@ Dir[File.join(__dir__, 'errors', '**', '*.rb')].each { |f| require_relative f }
 module Easyship
   # Represents a mapping of HTTP status codes to Easyship-specific classes
   class Error
-    # rubocop:disable Style::MutableConstant Style::MissingElse
+    class << self
+      def for_status(status_code)
+        ERRORS[status_code] || default_error_for(status_code)
+      end
+
+      private
+
+      def default_error_for(status_code)
+        case status_code.to_s
+        when /4\d{2}/
+          Easyship::Errors::ClientError
+        when /5\d{2}/
+          Easyship::Errors::ServerError
+        end
+      end
+    end
+
     ERRORS = {
       400 => Easyship::Errors::BadRequestError,
       401 => Easyship::Errors::InvalidTokenError,
@@ -13,18 +29,6 @@ module Easyship
       404 => Easyship::Errors::ResourceNotFoundError,
       422 => Easyship::Errors::UnprocessableContentError,
       429 => Easyship::Errors::RateLimitError
-    }
-
-    ERRORS.default_proc = proc do |_hash, key|
-      case key.to_s
-      when /4\d{2}/
-        Easyship::Errors::ClientError
-      when /5\d{2}/
-        Easyship::Errors::ServerError
-      end
-    end
-    # rubocop:enable Style::MutableConstant Style::MissingElse
-
-    ERRORS.freeze
+    }.freeze
   end
 end

data/lib/easyship/errors/easyship_error.rb

@@ -4,12 +4,20 @@ module Easyship
   module Errors
     # Represents an error that is raised when an error occurs in the Easyship API.
     class EasyshipError < StandardError
-      attr_reader :message, :body_error
+      attr_reader :message, :error, :response_body, :response_headers
 
-      def initialize(message: '', body_error: {})
+      def initialize(message: '', body_error: {}, error: {}, response_body: nil, response_headers: {})
         super(message)
+        @error = error
         @message = message
         @body_error = body_error
+        @response_body = response_body
+        @response_headers = response_headers
+      end
+
+      def body_error
+        warn '[DEPRECATION] `body_error` is deprecated. Please use `error` instead.'
+        @body_error
       end
     end
   end

data/lib/easyship/middleware/error_handler_middleware.rb

@@ -9,20 +9,33 @@ module Easyship
       def on_complete(env)
         status_code = env[:status].to_i
         body = response_body(env[:body])
+        headers = env[:response_headers]
 
-        handle_status_code(status_code, body)
+        handle_status_code(status_code, headers, body)
       end
 
       private
 
-      def handle_status_code(status_code, body)
-        error_class = Easyship::Error::ERRORS[status_code]
+      def handle_status_code(status_code, headers, body)
+        error_class = Easyship::Error.for_status(status_code)
 
-        raise_error(error_class, body) if error_class
+        raise_error(error_class, headers, body) if error_class
       end
 
-      def raise_error(class_error, body)
-        raise class_error.new(message: message(body), body_error: body_error(body))
+      def raise_error(class_error, headers, body)
+        raise class_error.new(
+          message: message(body),
+          body_error: body_error(body),
+          error: build_error(body),
+          response_body: body,
+          response_headers: headers
+        )
+      end
+
+      def build_error(body)
+        return default_error unless body.is_a?(Hash)
+
+        body[:error]
       end
 
       def body_error(body)
@@ -55,6 +68,10 @@ module Easyship
         { details: body, message: 'Something went wrong.' }
       end
 
+      def default_error
+        { details: [], message: 'Something went wrong.' }
+      end
+
       def response_body(body)
         JSON.parse(body, symbolize_names: true)
       rescue JSON::ParserError

data/lib/easyship/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Easyship
-  VERSION = '0.1.4'
+  VERSION = '0.2.0'
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: easyship
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.2.0
 platform: ruby
 authors:
 - Michael Marusyk
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-10-16 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -68,7 +67,6 @@ metadata:
   allowed_push_host: https://rubygems.org
   source_code_uri: https://github.com/mmarusyk/easyship
   changelog_uri: https://github.com/mmarusyk/easyship/blob/main/CHANGELOG.md
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -83,8 +81,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.16
-signing_key:
+rubygems_version: 3.6.7
 specification_version: 4
 summary: A Ruby client for integrating with Easyship's API for shipping and logistics
   management.