friendly_shipping 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c51440567e32656dd9c373764b43ed8915c7bed5
-  data.tar.gz: ac745c9dd9e1c087ec387c429f761633c15783bc
+  metadata.gz: 2ecad34500f6b87c3aa381a2fe93a9f96d5203f1
+  data.tar.gz: 5c6483ad49ba4ff5cd705dbeb9d44efa3ec865e6
 SHA512:
-  metadata.gz: d8b986a76ea28d2ba06f7d6ad3bfea61748e0d291d95f59b9d1ea826cd6bc0d94b16b5cefe7fd2d9d03f0cbf32762b6a7fc9145d4d06054b3d0bceff2125b723
-  data.tar.gz: faee889795cd2d7588771e9938e1660eec64e3c72e65994dac6e348b4a5aff1eef514d0f1d5ae44a39f0bf2ff47057d1c6a7f68efde8a20ce431b9d50739540f
+  metadata.gz: aeb1401d8bdbda932c92e5b79a9fb7d231e67eb3635210c64c53e90805fffd7a7e98056968289b44197874350543a658327b62d4e69a1d69974d385a6352cf6b
+  data.tar.gz: 52d31ae21c4878b3e95770f59bad92a7f51619b6fb10ebe03d3295a666b9497f79c2ceb1450d366ce3e2e2e45d03cb7c43e122928e7c34f79d702d7d7003e073

data/friendly_shipping.gemspec

@@ -25,6 +25,7 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency "rest-client", "~> 2.0"
   spec.add_runtime_dependency "dry-monads", "~> 1.0"
   spec.add_runtime_dependency "data_uri", "~> 0.0.3"
+  spec.add_runtime_dependency "money", ">= 6.0.0"
   spec.required_ruby_version = '>= 2.4'
 
   spec.add_development_dependency "bundler"

data/lib/friendly_shipping/label.rb

@@ -8,7 +8,9 @@ module FriendlyShipping
                 :data,
                 :label_format,
                 :shipment_cost,
-                :label_data
+                :label_data,
+                :original_request,
+                :original_response
 
     def initialize(
         id: nil,
@@ -19,7 +21,9 @@ module FriendlyShipping
         label_format: nil,
         label_data: nil,
         shipment_cost: nil,
-        data: {}
+        data: {},
+        original_request: nil,
+        original_response: nil
       )
       @id = id
       @shipment_id = shipment_id
@@ -30,6 +34,8 @@ module FriendlyShipping
       @shipment_cost = shipment_cost
       @label_data = label_data
       @data = data
+      @original_request = original_request
+      @original_response = original_response
     end
   end
 end

data/lib/friendly_shipping/rate.rb

@@ -0,0 +1,41 @@
+module FriendlyShipping
+  class Rate
+    class NoAmountsGiven < StandardError; end
+    attr_reader :shipping_method,
+                :amounts,
+                :remote_service_id,
+                :delivery_date,
+                :warnings,
+                :errors,
+                :data,
+                :original_request,
+                :original_response
+
+    def initialize(
+      shipping_method:,
+      amounts:,
+      remote_service_id: nil,
+      delivery_date: nil,
+      warnings: [],
+      errors: [],
+      data: {},
+      original_request: nil,
+      original_response: nil
+    )
+      @remote_service_id = remote_service_id
+      @shipping_method = shipping_method
+      @amounts = amounts
+      @delivery_date = delivery_date
+      @warnings = warnings
+      @errors = errors
+      @data = data
+      @original_request = original_request
+      @original_response = original_response
+    end
+
+    def total_amount
+      raise NoAmountsGiven if amounts.empty?
+      amounts.map { |_name, amount| amount }.sum
+    end
+  end
+end

data/lib/friendly_shipping/request.rb

@@ -0,0 +1,11 @@
+module FriendlyShipping
+  class Request
+    attr_reader :url, :body, :headers
+
+    def initialize(url:, body: nil, headers: {})
+      @url = url
+      @body = body
+      @headers = headers
+    end
+  end
+end

data/lib/friendly_shipping/response.rb

@@ -0,0 +1,11 @@
+module FriendlyShipping
+  class Response
+    attr_reader :status, :body, :headers
+
+    def initialize(status:, body:, headers:)
+      @status = status
+      @body = body
+      @headers = headers
+    end
+  end
+end

data/lib/friendly_shipping/services/ship_engine/client.rb

@@ -0,0 +1,66 @@
+require 'dry/monads/result'
+require 'friendly_shipping/bad_request'
+require 'rest-client'
+
+module FriendlyShipping
+  module Services
+    class ShipEngine
+      class Client
+        extend Dry::Monads::Result::Mixin
+        class <<self
+          def get(request)
+            http_response = ::RestClient.get(
+              request.url, request.headers
+            )
+
+            Success(convert_to_friendly_response(http_response))
+          rescue ::RestClient::Exception => error
+            Failure(error)
+          end
+
+          def post(friendly_shipping_request)
+            http_response = ::RestClient.post(
+              friendly_shipping_request.url,
+              friendly_shipping_request.body,
+              friendly_shipping_request.headers
+            )
+
+            Success(convert_to_friendly_response(http_response))
+          rescue ::RestClient::Exception => error
+            if error.http_code == 400
+              Failure(BadRequest.new(error))
+            else
+              Failure(error)
+            end
+          end
+
+          def put(request)
+            http_response = ::RestClient.put(
+              request.url,
+              request.body,
+              request.headers
+            )
+
+            Success(convert_to_friendly_response(http_response))
+          rescue ::RestClient::Exception => error
+            if error.http_code == 400
+              Failure(BadRequest.new(error))
+            else
+              Failure(error)
+            end
+          end
+
+          private
+
+          def convert_to_friendly_response(http_response)
+            FriendlyShipping::Response.new(
+              status: http_response.code,
+              body: http_response.body,
+              headers: http_response.headers
+            )
+          end
+        end
+      end
+    end
+  end
+end

data/lib/friendly_shipping/services/ship_engine/parse_carrier_response.rb

@@ -11,29 +11,34 @@ module FriendlyShipping
         def call
           parsed_json = JSON.parse(@response.body)
           parsed_json['carriers'].map do |carrier_data|
-            FriendlyShipping::Carrier.new(
+            carrier = FriendlyShipping::Carrier.new(
               id: carrier_data['carrier_id'],
               name: carrier_data['friendly_name'],
               code: carrier_data['carrier_code'],
-              shipping_methods: parse_shipping_methods(carrier_data['services']),
               balance: carrier_data['balance'],
               data: carrier_data
             )
+
+            carrier_data['services'].each do |method_hash|
+              shipping_method = parse_shipping_method(carrier, method_hash)
+              carrier.shipping_methods << shipping_method
+            end
+
+            carrier
           end
         end
 
         private
 
-        def parse_shipping_methods(shipping_methods_data)
-          shipping_methods_data.map do |shipping_method_data|
+        def parse_shipping_method(carrier, shipping_method_data)
             FriendlyShipping::ShippingMethod.new(
+              carrier: carrier,
               name: shipping_method_data["name"],
               service_code: shipping_method_data["service_code"],
               domestic: shipping_method_data["domestic"],
               international: shipping_method_data["international"],
               multi_package: shipping_method_data["is_multi_package_supported"]
             )
-          end
         end
       end
     end

data/lib/friendly_shipping/services/ship_engine/parse_label_response.rb

@@ -5,12 +5,8 @@ module FriendlyShipping
   module Services
     class ShipEngine
       class ParseLabelResponse
-        def initialize(response:)
-          @response = response
-        end
-
-        def call
-          parsed_json = JSON.parse(@response.body)
+        def self.call(request:, response:)
+          parsed_json = JSON.parse(response.body)
           label_uri_string = parsed_json['label_download']['href']
           label_data = nil
           label_url = nil
@@ -29,7 +25,9 @@ module FriendlyShipping
               label_data: label_data,
               label_format: parsed_json['label_format'].to_sym,
               shipment_cost: parsed_json['shipment_cost']['amount'],
-              data: parsed_json
+              data: parsed_json,
+              original_request: request,
+              original_response: response
             )
           ]
         end

data/lib/friendly_shipping/services/ship_engine/parse_rate_estimate_response.rb

@@ -0,0 +1,46 @@
+require 'json'
+require 'money'
+
+module FriendlyShipping
+  module Services
+    class ShipEngine
+      class ParseRateEstimateResponse
+        class << self
+          def call(response:, carriers:, request:)
+            parsed_json = JSON.parse(response.body)
+            parsed_json.map do |rate|
+              carrier = carriers.detect { |c| c.id == rate['carrier_id'] }
+              next unless carrier
+              shipping_method = carrier.shipping_methods.detect { |sm| sm.service_code == rate['service_code'] }
+              next unless shipping_method
+              amounts = get_amounts(rate)
+              FriendlyShipping::Rate.new(
+                shipping_method: shipping_method,
+                amounts: amounts,
+                remote_service_id: rate['rate_id'],
+                delivery_date: Time.parse(rate['estimated_delivery_date']),
+                warnings: rate['warning_messages'],
+                errors: rate['error_messages'],
+                original_request: request,
+                original_response: response
+              )
+            end.compact
+          end
+
+          private
+
+          def get_amounts(rate_hash)
+            [:shipping, :other, :insurance, :confirmation].map do |name|
+              currency = Money::Currency.new(rate_hash["#{name}_amount"]["currency"])
+              amount = rate_hash["#{name}_amount"]["amount"] * currency.subunit_to_unit
+              [
+                name,
+                Money.new(amount, currency)
+              ]
+            end.to_h
+          end
+        end
+      end
+    end
+  end
+end

data/lib/friendly_shipping/services/ship_engine/serialize_label_shipment.rb

@@ -44,12 +44,7 @@ module FriendlyShipping
 
         def serialize_packages(packages)
           packages.map do |package|
-            package_hash = {
-              weight: {
-                value: package.weight.convert_to(:ounce).value.to_f,
-                unit: "ounce"
-              }
-            }
+            package_hash = serialize_weight(package.weight)
             if package.container.properties[:usps_label_messages]
               package_hash.merge!(label_messages: package.container.properties[:usps_label_messages])
             end
@@ -69,6 +64,17 @@ module FriendlyShipping
             package_hash
           end
         end
+        
+        def serialize_weight(weight)
+          ounces = weight.convert_to(:ounce).value.to_f
+          {
+            weight: {
+              # Max weight for USPS First Class is 15.9 oz, not 16 oz
+              value: ounces.between?(15.9, 16) ? 15.9 : ounces,
+              unit: "ounce"
+            }
+          }
+        end
       end
     end
   end

data/lib/friendly_shipping/services/ship_engine/serialize_rate_estimate_request.rb

@@ -0,0 +1,25 @@
+module FriendlyShipping
+  module Services
+    class ShipEngine
+      class SerializeRateEstimateRequest
+        def self.call(shipment:, carriers:)
+          {
+            carrier_ids: carriers.map(&:id),
+            from_country_code: shipment.origin.country.alpha_2_code,
+            from_postal_code: shipment.origin.zip,
+            to_country_code: shipment.destination.country.alpha_2_code,
+            to_postal_code: shipment.destination.zip,
+            to_city_locality: shipment.destination.city,
+            to_state_province: shipment.destination.region.code,
+            weight: {
+              value: shipment.packages.map { |p| p.weight.convert_to(:pound).value.to_f }.sum,
+              unit: 'pound'
+            },
+            confirmation: 'none',
+            address_residential_indicator: shipment.destination.residential? ? "yes" : "no"
+          }
+        end
+      end
+    end
+  end
+end

data/lib/friendly_shipping/services/ship_engine.rb

@@ -1,10 +1,12 @@
 
 require 'dry/monads/result'
-require 'friendly_shipping/rest_client'
+require 'friendly_shipping/services/ship_engine/client'
 require 'friendly_shipping/services/ship_engine/parse_carrier_response'
 require 'friendly_shipping/services/ship_engine/serialize_label_shipment'
+require 'friendly_shipping/services/ship_engine/serialize_rate_estimate_request'
 require 'friendly_shipping/services/ship_engine/parse_label_response'
 require 'friendly_shipping/services/ship_engine/parse_void_response'
+require 'friendly_shipping/services/ship_engine/parse_rate_estimate_response'
 
 module FriendlyShipping
   module Services
@@ -15,36 +17,58 @@ module FriendlyShipping
         labels: "labels"
       }
 
-      def initialize(token:, test: true)
+      def initialize(token:, test: true, client: self.class::Client)
         @token = token
         @test = test
+        @client = client
       end
 
       def carriers
-        path = API_BASE + API_PATHS[:carriers]
-        FriendlyShipping::RestClient.get(path, request_headers).fmap do |response|
+        request = FriendlyShipping::Request.new(
+          url: API_BASE + API_PATHS[:carriers],
+          headers: request_headers
+        )
+        client.get(request).fmap do |response|
           ParseCarrierResponse.new(response: response).call
         end
       end
 
+      def rate_estimates(shipment, carriers)
+        request = FriendlyShipping::Request.new(
+          url: API_BASE + 'rates/estimate',
+          body: SerializeRateEstimateRequest.(shipment: shipment, carriers: carriers).to_json,
+          headers: request_headers
+        )
+        client.post(request).fmap do |response|
+          ParseRateEstimateResponse.(response: response, request: request, carriers: carriers)
+        end
+      end
+
       def labels(shipment)
-        payload = SerializeLabelShipment.new(shipment: shipment).call.merge(test_label: test).to_json
-        path = API_BASE + API_PATHS[:labels]
-        FriendlyShipping::RestClient.post(path, payload, request_headers).fmap do |response|
-          ParseLabelResponse.new(response: response).call
+        request = FriendlyShipping::Request.new(
+          url: API_BASE + API_PATHS[:labels],
+          body: SerializeLabelShipment.new(shipment: shipment).call.merge(test_label: test).to_json,
+          headers: request_headers
+        )
+        client.post(request).fmap do |response|
+          ParseLabelResponse.(request: request, response: response)
         end
       end
 
       def void(label)
-        path = "#{API_BASE}labels/#{label.id}/void"
-        FriendlyShipping::RestClient.put(path, '', request_headers).bind do |response|
+        request = FriendlyShipping::Request.new(
+          url: "#{API_BASE}labels/#{label.id}/void",
+          body: '',
+          headers: request_headers
+        )
+        client.put(request).bind do |response|
           ParseVoidResponse.new(response: response).call
         end
       end
 
       private
 
-      attr_reader :token, :test
+      attr_reader :token, :test, :client
 
       def request_headers
         {

data/lib/friendly_shipping/shipping_method.rb

@@ -1,13 +1,14 @@
 module FriendlyShipping
   class ShippingMethod
-    attr_reader :name, :service_code
+    attr_reader :name, :service_code, :carrier
 
-    def initialize(name: nil, service_code: nil, domestic: nil, international: nil, multi_package: nil)
+    def initialize(name: nil, service_code: nil, domestic: nil, international: nil, multi_package: nil, carrier: nil)
       @name = name
       @service_code = service_code
       @domestic = domestic
       @international = international
       @multi_package = multi_package
+      @carrier = carrier
     end
 
     def domestic?

data/lib/friendly_shipping/version.rb

@@ -1,3 +1,3 @@
 module FriendlyShipping
-  VERSION = "0.2.2"
+  VERSION = "0.2.3"
 end

data/lib/friendly_shipping.rb

@@ -1,10 +1,13 @@
 require "physical"
 
 require "friendly_shipping/version"
+require "friendly_shipping/request"
+require "friendly_shipping/response"
 require "friendly_shipping/carrier"
 require "friendly_shipping/services/ship_engine"
 require "friendly_shipping/shipping_method"
 require "friendly_shipping/label"
+require "friendly_shipping/rate"
 
 module FriendlyShipping
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: friendly_shipping
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors:
 - Martin Meyerhoff
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-05-24 00:00:00.000000000 Z
+date: 2019-06-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: physical
@@ -66,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.0.3
+- !ruby/object:Gem::Dependency
+  name: money
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -131,12 +145,17 @@ files:
 - lib/friendly_shipping/bad_request.rb
 - lib/friendly_shipping/carrier.rb
 - lib/friendly_shipping/label.rb
-- lib/friendly_shipping/rest_client.rb
+- lib/friendly_shipping/rate.rb
+- lib/friendly_shipping/request.rb
+- lib/friendly_shipping/response.rb
 - lib/friendly_shipping/services/ship_engine.rb
+- lib/friendly_shipping/services/ship_engine/client.rb
 - lib/friendly_shipping/services/ship_engine/parse_carrier_response.rb
 - lib/friendly_shipping/services/ship_engine/parse_label_response.rb
+- lib/friendly_shipping/services/ship_engine/parse_rate_estimate_response.rb
 - lib/friendly_shipping/services/ship_engine/parse_void_response.rb
 - lib/friendly_shipping/services/ship_engine/serialize_label_shipment.rb
+- lib/friendly_shipping/services/ship_engine/serialize_rate_estimate_request.rb
 - lib/friendly_shipping/shipping_method.rb
 - lib/friendly_shipping/version.rb
 homepage: https://github.com/friendly_cart/friendly_shipping

data/lib/friendly_shipping/rest_client.rb

@@ -1,53 +0,0 @@
-require 'dry/monads/result'
-require 'friendly_shipping/bad_request'
-require 'rest-client'
-
-module FriendlyShipping
-  class RestClient
-    extend Dry::Monads::Result::Mixin
-    class <<self
-      def get(path, headers)
-        Success(
-          ::RestClient.get(
-            path,
-            headers
-          )
-        )
-      rescue ::RestClient::Exception => error
-        Failure(error)
-      end
-
-      def post(path, payload, headers)
-        Success(
-          ::RestClient.post(
-            path,
-            payload,
-            headers
-          )
-        )
-      rescue ::RestClient::Exception => error
-        if error.http_code == 400
-          Failure(BadRequest.new(error))
-        else
-          Failure(error)
-        end
-      end
-
-      def put(path, payload, headers)
-        Success(
-          ::RestClient.put(
-            path,
-            payload,
-            headers
-          )
-        )
-      rescue ::RestClient::Exception => error
-        if error.http_code == 400
-          Failure(BadRequest.new(error))
-        else
-          Failure(error)
-        end
-      end
-    end
-  end
-end