easyship 0.1.1 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b78843ee202c13d7e7ffd9fe40f3f6129896959c3ae689070787c9caffbd5d6a
-  data.tar.gz: 72b3086492a9938697547f90e96d126afe88431c93298dbc198b054d858c490d
+  metadata.gz: 812760f6c36e7f28cbdbf710f5828178f3f983dc99f356fa8382877321d616f6
+  data.tar.gz: f3a18b45e2fbf246790b1d0e10dec6d5b2905205833f6b2a436601faa21a557f
 SHA512:
-  metadata.gz: fc149787c49b67629702d71bc0bffba4043b2aff2216e46606a2623a0bbaedb4991aa3d7adadc662a2302ca1b05ad1f570eb8d772fc0fdc1af7acf1f5dab0d96
-  data.tar.gz: 4d602bda8293d6434b3b4e17fba312dfb58792c6cf27b591ef7383613b6eae53d8dcf748fee1ff0a181e32dc618b5cd8e71c12a765dd3f343cc178b910347278
+  metadata.gz: 3c1c3673c3ff7516cb39cd7507c6c49564eaf3989b884bc847874b701bc4d77fc9e87d818f99add52b6bc80832db2fe75eb9be0756e6ceb67731cb29831faeba
+  data.tar.gz: fb50c604914a06b7aaa73e0105cf053f11be690e352acf4692e5e9bcb4f4a892bfe87abaf30dab16c04d6d767c82d6931960733972d63d835992bea3c3a07134

data/CHANGELOG.md

@@ -1,9 +1,25 @@
 ## [Unreleased]
+
+## [v0.1.3](https://github.com/mmarusyk/easyship/tree/v0.1.3) - 2024-06-27
+
+### Fixed
+- Error from v1 is not handled by @mmarusyk
+
+## [v0.1.2](https://github.com/mmarusyk/easyship/tree/v0.1.2) - 2024-06-24
+
+### Features
+- Handle Handle different responses of errors from Easyship (v1, v2,...) by @mmarusyk in https://github.com/mmarusyk/easyship/pull/3
+
+### Fixed
+- Updated README.md by @mmarusyk in https://github.com/mmarusyk/easyship/pull/2
+
+
 ## [v0.1.1](https://github.com/mmarusyk/easyship/tree/v0.1.1) - 2024-06-08
 
 ### Features
 - Add pagination cursor by @mmarusyk in https://github.com/mmarusyk/easyship/pull/1
 
+
 ## [v0.1.0](https://github.com/mmarusyk/easyship/tree/v0.1.0) - 2024-06-08
 
 - Initial release

data/CONTRIBUTORS.md

@@ -0,0 +1,3 @@
+Contributors to Easyship gem include:
+
+* [Michael Marusyk](https://github.com/mmarusyk)

data/README.md

@@ -3,6 +3,13 @@
 This gem provides a simple client for Easyship, offering accessing to Easyship's
     shipping, tracking, and logistics services directly from Ruby applications.
 
+## Requirements
+
+Before you begin, ensure you have met the following requirements:
+
+- Ruby version 3.0.0 or newer. You can check your Ruby version by running `ruby -v`.
+- Bundler installed. You can install Bundler with `gem install bundler`.
+
 ## Installation
 
 Install the gem and add to the application's Gemfile by executing:
@@ -25,7 +32,7 @@ If you have to use in a ruby file:
 ```ruby
 require 'easyship'
 
-Easyship::Configuration.configure do |c|
+Easyship.configure do |c|
   c.url = 'api_url'
   c.api_key = 'your_easyship_api_key'
 end
@@ -41,14 +48,16 @@ If you have to use in Rails:
 
 3. Create a new file in `config/initializers` directory
 ```ruby
-Easyship::Configuration.configure do |config|
+Easyship.configure do |config|
   config.url = 'api_url'
   config.api_key = 'your_easyship_api_key'
 end
 ```
+
 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')
 ```
@@ -79,7 +88,7 @@ Easyship::Client.post('/2023-01/shipment', payload)
 ```
 
 ### Handle errors
-Then using the `easyship` gem in a Rails application, it's important to handle potential errors that may arise during API calls. Here's how you can handle errors gracefully:
+When using the `easyship` gem in a Rails application, it's important to handle potential errors that may arise during API calls. Here's how you can handle errors gracefully:
 
 1. Wrap your API calls in a `begin-rescue` block.
 2. Catch specific errors from the `easyship` gem to handle them accordingly.
@@ -120,7 +129,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/mmarusyk/easyship. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/mmarusyk/easyship/blob/main/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/mmarusyk/easyship. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/mmarusyk/easyship/blob/main/CODE_OF_CONDUCT.md). You can find a list of contributors in the [CONTRIBUTORS.md](https://github.com/mmarusyk/easyship/blob/main/CONTRIBUTORS.md) file.
 
 ## License
 

data/lib/easyship/error.rb

@@ -7,6 +7,7 @@ module Easyship
   class Error
     # rubocop:disable Style::MutableConstant Style::MissingElse
     ERRORS = {
+      400 => Easyship::Errors::BadRequestError,
       401 => Easyship::Errors::InvalidTokenError,
       402 => Easyship::Errors::PaymentRequiredError,
       404 => Easyship::Errors::ResourceNotFoundError,

data/lib/easyship/errors/bad_request_error.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require_relative 'client_error'
+
+module Easyship
+  module Errors
+    # Raised when Easyship returns the HTTP status code 400
+    class BadRequestError < ClientError; end
+  end
+end

data/lib/easyship/middleware/error_handler_middleware.rb

@@ -25,11 +25,33 @@ module Easyship
       end
 
       def body_error(body)
-        body.is_a?(Hash) ? body[:error] : {}
+        return {} unless body.is_a?(Hash)
+
+        if body.key?(:error) && body[:error].is_a?(Hash)
+          format_body_error(body)
+        elsif body.key?(:errors)
+          format_body_errors(body)
+        else
+          format_by_default(body)
+        end
       end
 
       def message(body)
-        body.is_a?(Hash) ? body[:error][:message] : body
+        body_error(body)[:message]
+      end
+
+      def format_body_error(body)
+        body[:error]
+      end
+
+      def format_body_errors(body)
+        errors = Array(body[:errors])
+
+        { details: errors, message: errors.join(', ') }
+      end
+
+      def format_by_default(body)
+        { details: body, message: 'Something went wrong.' }
       end
 
       def json?(body)

data/lib/easyship/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: easyship
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.3
 platform: ruby
 authors:
 - Michael Marusyk
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-06-08 00:00:00.000000000 Z
+date: 2024-06-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -37,6 +37,7 @@ files:
 - ".rubocop.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
+- CONTRIBUTORS.md
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -44,6 +45,7 @@ files:
 - lib/easyship/client.rb
 - lib/easyship/configuration.rb
 - lib/easyship/error.rb
+- lib/easyship/errors/bad_request_error.rb
 - lib/easyship/errors/client_error.rb
 - lib/easyship/errors/easyship_error.rb
 - lib/easyship/errors/invalid_token_error.rb
@@ -81,7 +83,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.9
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: A Ruby client for integrating with Easyship's API for shipping and logistics