easyship 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7a4f0cee3b11970266c3c8ad8752e912f18805bc0584c134aaba5de84b9c1920
-  data.tar.gz: 647fcc4d41650c6806ab27af95b69e6eaa482a4152243239bd011963531279e5
+  metadata.gz: 0a715ea30361416f3bc58cee44919e36a7ac7dbe85f1f615c2a74350f889bdef
+  data.tar.gz: 297a361bdad68de29061c1cf6aaa09db8aad1573aa9356c069784b564526ca7f
 SHA512:
-  metadata.gz: 23b54e132b58cd333722b18b5cb295f78faf317d8b91e4a5cb822258d7d5d63c4b94815c0f4f92e418c4987afe51697f966a12e476881546fe2b2c369caa0749
-  data.tar.gz: 64a6448f591490294720cfc0291a18e3b5ac89529c72037c09ad5763aa0c4e877d40594d6207491d82315aefabb2a40ccdf0dc787f65811d59c726d4091004e4
+  metadata.gz: bf0c4bded300aa2b72ab47b5ddbd16ba5733c3f515bc403e74322bd4dd5b10b0c9a214aeb629bb257fe0078952b4b5ad0ec4d75e05794666207fcef57d420084
+  data.tar.gz: 394cc54f2400a0f1b86a66340c19e03a42298fe31dc1764ee5c443b8e8fa4e1ddc2af3be5123e2ba4efc781f843c6ab2739481d850d28e83155d178886a8b1a0

data/CHANGELOG.md

@@ -1,5 +1,20 @@
 ## [Unreleased]
 
-## [0.1.0] - 2024-06-08
+## [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,11 +3,18 @@
 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:
 
-    $ bundle add easyhip
+    $ bundle add easyship
 
 If bundler is not being used to manage dependencies, install the gem 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
-hen 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.
@@ -94,15 +103,33 @@ rescue Easyship::Errors::RateLimitError => e
 end
 ```
 
+### 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.
+
+Suppose you want to retrieve a list of shipments that may span multiple pages. Here's how you can use the `get` method:
+
+```ruby
+shipments = []
+
+Easyship::Client.instance.get('/2023-01/shipments') do |page|
+  shipments.concat(page[:shipments])
+end
+
+shipments # Returns all shipments from all pages
+```
+
+To setup items perpage, use the key `per_page` in your configuration.
+
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. Then, eun `rake rubocop` to run the rubocop. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
+
 ## 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/client.rb

@@ -4,6 +4,7 @@ require 'singleton'
 require 'faraday'
 require_relative 'middleware/error_handler_middleware'
 require_relative 'handlers/response_body_handler'
+require_relative 'pagination/cursor'
 
 module Easyship
   # Represents a client to interact with the Easyship API
@@ -15,10 +16,14 @@ module Easyship
       @api_key = Easyship.configuration.api_key
     end
 
-    def get(path, params = {})
-      response = connection.get(path, params)
+    def get(path, params = {}, &block)
+      if block
+        Easyship::Pagination::Cursor.new(self, path, params).all(&block)
+      else
+        response = connection.get(path, params)
 
-      handle_response(response)
+        handle_response(response)
+      end
     end
 
     def post(path, params = {})

data/lib/easyship/configuration.rb

@@ -3,11 +3,12 @@
 module Easyship
   # Represents the configuration settings for the Easyship client.
   class Configuration
-    attr_accessor :url, :api_key
+    attr_accessor :url, :api_key, :per_page
 
     def initialize
       @url = nil
       @api_key = nil
+      @per_page = 100 # Maximum possible number of items per page
     end
   end
 end

data/lib/easyship/handlers/response_body_handler.rb

@@ -5,9 +5,9 @@ module Easyship
     # Handles the response body
     class ResponseBodyHandler
       def self.handle_response(response)
-        JSON.parse(response.body, symbolize_names: true)
-      rescue JSON::ParserError
-        response.body
+        body = response.body
+
+        JSON.parse(body, symbolize_names: true) unless body.nil? || body.empty?
       end
     end
   end

data/lib/easyship/middleware/error_handler_middleware.rb

@@ -25,11 +25,37 @@ 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) && body[:errors].is_a?(Array)
+          format_body_errors_array(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_array(body)
+        { details: body[:errors], message: body[:errors].map { |error| error[:message] }.join(', ') }
+      end
+
+      def format_body_errors(body)
+        { details: body[:errors], message: body[:errors] }
+      end
+
+      def format_by_default(body)
+        { details: body, message: 'Something went wrong.' }
       end
 
       def json?(body)

data/lib/easyship/pagination/cursor.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Easyship
+  module Pagination
+    # Represents a pagination object
+    class Cursor
+      attr_reader :client, :path, :params, :key, :per_page
+
+      def initialize(client, path, params)
+        @client = client
+        @path = path
+        @params = params
+        @per_page = params[:per_page] || Easyship.configuration.per_page
+      end
+
+      def all
+        page = 1
+
+        loop do
+          body = client.get(path, params.merge(page: page, per_page: per_page))
+
+          break if body.nil? || body.empty?
+
+          yield body
+
+          break if body.dig(:meta, :pagination, :next).nil?
+
+          page += 1
+        end
+      end
+    end
+  end
+end

data/lib/easyship/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: easyship
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Michael Marusyk
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-06-08 00:00:00.000000000 Z
+date: 2024-06-24 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
@@ -54,6 +55,7 @@ files:
 - lib/easyship/errors/unprocessable_content_error.rb
 - lib/easyship/handlers/response_body_handler.rb
 - lib/easyship/middleware/error_handler_middleware.rb
+- lib/easyship/pagination/cursor.rb
 - lib/easyship/version.rb
 - sig/easyship.rbs
 homepage: https://rubygems.org/gems/easyship