seko_ecom_api 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cd52f793929f84a440a74e2170e943719a1db83c26340c440ba85db6e89b0dd0
-  data.tar.gz: 9c86a38d6183547d6f06a3a680685f85e5981b9520fefd4ca152cbaccfe77330
+  metadata.gz: e954285218ea275abf3769be91fbee63820e52b26a2d81b41bea12a8dd2c029f
+  data.tar.gz: a1ba313382593828b9f93b72d72892f7eced6ac658cedff0ae5a4828c29368d5
 SHA512:
-  metadata.gz: 18d06b8c534513c5ac781a50c3691bbe941f1d189c5e1c1470d5e0115b3abd70879795da67efe65f1f672730ab6977c03f6e015b88a107c8ac2de53cdd89bd8c
-  data.tar.gz: 98b548e8646b07a9e916468287046aeb7f833aea20192e1cb5c58789251353ecb9cde3ddeba0586aad99d98cea71279a9f55735a680fcfbd84a52e5f04cfb794
+  metadata.gz: c446549dcd16705c5da5ec518224785665461ff8a3178fed02938966024e0deadaaeb07f7f60e969f5a323eaabb5e519eb38d09cae155a5a958266b0121149d1
+  data.tar.gz: 3af01c7e4a794ab7749d3d2787833f5c408332139587cb53bf80e0ff95779a9a61029cd90535110b81587bbe0387500634f8bdf58ecf0be0dedb77450fb53b68

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    seko_ecom_api (0.1.0)
+    seko_ecom_api (0.1.1)
       activesupport
       faraday (~> 2.7)
       faraday-encoding
@@ -20,11 +20,13 @@ GEM
     ast (2.4.2)
     coderay (1.1.3)
     concurrent-ruby (1.2.2)
+    crack (0.4.5)
+      rexml
     diff-lcs (1.5.0)
     domain_name (0.5.20190701)
       unf (>= 0.0.5, < 1.0.0)
     dotenv (2.8.1)
-    faraday (2.7.4)
+    faraday (2.7.5)
       faraday-net_http (>= 2.0, < 3.1)
       ruby2_keywords (>= 0.0.4)
     faraday-encoding (0.0.5)
@@ -37,6 +39,7 @@ GEM
     ffi-compiler (1.0.1)
       ffi (>= 1.0.0)
       rake
+    hashdiff (1.0.1)
     http (5.1.1)
       addressable (~> 2.8)
       http-cookie (~> 1.0)
@@ -97,6 +100,10 @@ GEM
       unf_ext
     unf_ext (0.0.8.2)
     unicode-display_width (2.4.2)
+    webmock (3.18.1)
+      addressable (>= 2.8.0)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
 
 PLATFORMS
   arm64-darwin-21
@@ -108,6 +115,7 @@ DEPENDENCIES
   rspec
   rubocop (~> 1.21)
   seko_ecom_api!
+  webmock
 
 BUNDLED WITH
    2.3.18

data/README.md

@@ -40,12 +40,12 @@ omni_returns_client.create_shipment(params)
 # For example:
 destination = {
 	"address" : {
-	"building_name" : "",
-	"street_address": "123th St",
-	"suburb": "Los Angeles",
-	"city": "CA",
-	"post_code": "90013",
-	"country_code": "US"
+		"building_name" : "",
+		"street_address": "123th St",
+		"suburb": "Los Angeles",
+		"city": "CA",
+		"post_code": "90013",
+		"country_code": "US"
 	}
 }
 ```
@@ -56,6 +56,7 @@ omni_returns_client = SekoEcomAPI::OmniReturnsClient.new(access_key: ENV['ACCESS
 ```
 
 For error handling, you might encounter SekoEcomAPI::Error and SekoEcomAPI::ParseError
+
 ```ruby
 begin
 	omni_returns_client.create_shipment(params)
@@ -70,7 +71,23 @@ end
 ```
 
 ### OmniParcel
-TBA
+
+```ruby
+omni_parcel_client = SekoEcomAPI::OmniParcelClient.new(access_key: ENV['ACCESS_KEY'])
+
+# Retrieve rates
+omni_parcel_client.retrieve_rates(params)
+```
+
+For error handle, there will only be SekoEcomAPI::Error with the Validation errors message
+
+```ruby
+begin
+  omni_parcel_client.retrieve_rates(params)
+rescue SekoEcomAPI::Error => err
+end
+
+```
 
 ## Development
 

data/lib/seko_ecom_api/clients/omni_parcel_client.rb

@@ -0,0 +1,55 @@
+require 'faraday'
+require 'faraday/encoding'
+require 'faraday/http'
+
+module SekoEcomAPI
+  class OmniParcelClient
+    include Client
+
+    BASE_URL = 'https://api.omniparcel.com/'
+    TEST_BASE_URL = 'https://staging.omniparcel.com/'
+
+    attr_reader :access_key, :adapter, :test, :conn_opts
+
+    def initialize(access_key:, adapter: :http, test: false, conn_opts: {})
+      @access_key = access_key
+      @adapter = adapter
+      @test = test
+      @conn_opts = conn_opts
+    end
+
+    def retrieve_rates(params)
+      response = handle_response post_request('ratesqueryv1/availablerates', params: params)
+
+      available_rates = response['available']&.map { |rate| Rate.new(rate) }
+      rejected_rates = response['rejected']&.map { |rate| Rate.new(rate) }
+      hidden_rates = response['hidden']&.map { |rate| Rate.new(rate) }
+
+      Struct.new(:available, :rejected, :hidden).new(available_rates, rejected_rates, hidden_rates)
+    end
+
+    def connection
+      @connection ||= Faraday.new do |conn|
+        conn.url_prefix = test ? TEST_BASE_URL : BASE_URL
+        conn.options.merge!(conn_opts)
+        conn.headers['Access_Key'] = access_key
+        conn.request :json
+        conn.response :json, content_type: 'application/json'
+        conn.response :encoding
+        conn.adapter adapter
+      end
+    end
+
+    private
+
+    def handle_response(response)
+      super
+      transformed_body = response.body.deep_transform_keys(&:underscore)
+
+      validation_errors = transformed_body['validation_errors']
+      raise Error, "Something went wrong. Validation errors message: #{validation_errors}" if validation_errors.present?
+
+      transformed_body
+    end
+  end
+end

data/lib/seko_ecom_api/clients/omni_returns_client.rb

@@ -24,8 +24,6 @@ module SekoEcomAPI
       Shipment.new(response)
     end
 
-    private
-
     def connection
       @connection ||= Faraday.new do |conn|
         conn.url_prefix = test ? TEST_BASE_URL : BASE_URL
@@ -38,6 +36,10 @@ module SekoEcomAPI
       end
     end
 
+    private
+
+    # since Seko seems to send a 200 OK response even if there're errors
+    # we will need to also check for errors in the response body
     def handle_response(response)
       super
       parsed_response = parse_response(response)
@@ -48,6 +50,9 @@ module SekoEcomAPI
       parsed_response
     end
 
+    # need to be manual parsed here instead of in the middleware
+    # since Seko response's Content-Type is always in 'text/html'
+    # with the response body can be in JSON or in html
     def parse_response(response)
       parsed_response = JSON.parse(response.body)
       parsed_response.deep_transform_keys(&:underscore)

data/lib/seko_ecom_api/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SekoEcomAPI
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

data/lib/seko_ecom_api.rb

@@ -11,5 +11,6 @@ module SekoEcomAPI
   autoload :Shipment, 'seko_ecom_api/objects/shipment'
 
   # Clients
+  autoload :OmniParcelClient, 'seko_ecom_api/clients/omni_parcel_client'
   autoload :OmniReturnsClient, 'seko_ecom_api/clients/omni_returns_client'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: seko_ecom_api
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Jane Trang Mai Nguyen
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-06-08 00:00:00.000000000 Z
+date: 2023-06-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -108,6 +108,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description:
 email:
 - jane.trangm@gmail.com
@@ -126,6 +140,7 @@ files:
 - Rakefile
 - lib/seko_ecom_api.rb
 - lib/seko_ecom_api/client.rb
+- lib/seko_ecom_api/clients/omni_parcel_client.rb
 - lib/seko_ecom_api/clients/omni_returns_client.rb
 - lib/seko_ecom_api/error.rb
 - lib/seko_ecom_api/object.rb