envia_ya 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4f34bde2b191a32b39727b9b4ea3bf2f57c754dd8233cd2556255cd4e677cee9
-  data.tar.gz: 1ce242532cabdd9c0abbd16eca0960331ea6e8b87d319c60383ebb0c842e5aad
+  metadata.gz: 9fc329f73f821a86f9156a7b4125820ea86c76647a2582a0d914107b3108aeb0
+  data.tar.gz: ca44bf95c1ee83acee229a2f9042061b5fb00c674c7518fa7e179d4204e4ff8d
 SHA512:
-  metadata.gz: 07c425c77f612ff918874cb5821900173414450266df22f87fea95536f4f456ecc6379416f4ebc1c496412289b6b92e52675bd7ecfb3dcf306ca60cb970a8c25
-  data.tar.gz: 320feecef73e14775d195f8d46107cdbab3da13e9107472ed50f8dab0f0f3d4068dffb780cd4440201b0e7764deaf06ff621eafa95cc643a13381cb6c1ca5eb9
+  metadata.gz: 054ccb47ad4c5dea86aae33bc714e0258e2872dd5b6f2e048daeb35ec71f82233c5ec3f85e89b7ea365623113865f39604cc47cd3fddb920361ae38a20427a94
+  data.tar.gz: 44476ccf9bac235ad80b266bed3babc40ae77b752d054d23a3362ba3edc819e606b8981c25bc36a4c2dc0d3b8656da5d2d9b799c28784ceb82aa0863c0346f1a

data/README

@@ -0,0 +1,60 @@
+# EnviaYa Ruby Gem
+
+## Setup
+
+You can install the gem manually
+
+```bash
+gem install envia_ya
+```
+
+or add it to your Gemfile and use Bundler for installation.
+
+
+```ruby
+gem 'envia_ya'
+```
+
+## Usage
+
+### Set API KEY
+
+First you have to set your API KEY to have access to EnviaYa! API.
+
+```ruby
+EnviaYa::Config.api_key = YOUR_API_KEY
+```
+
+### Rates
+
+#### Rate Shipment
+
+```ruby
+repository = EnviaYa::Rates::Infrastructure::Repositories::RatesHttpRepository.new
+command = EnviaYa::Rates::Application::Commands::CreateRateCommand.new(repository: repository)
+dto = EnviaYa::Rates::Domain::Dtos::CreateRateDto.new(
+  origin_direction: EnviaYa::Rates::Domain::Entities::DirectionEntity.new(
+    postal_code: EnviaYa::Shared::Domain::ValueObjects::PostalCodeValueObject.new('68050'),
+    country_code: 'MX'
+  ),
+  destination_direction: EnviaYa::Rates::Domain::Entities::DirectionEntity.new(
+    postal_code: EnviaYa::Shared::Domain::ValueObjects::PostalCodeValueObject.new('68000'),
+    country_code: 'MX'
+  ),
+  shipment: EnviaYa::Rates::Domain::Entities::ShipmentEntity.new(
+    shipment_type: EnviaYa::Shared::Domain::ValueObjects::ShipmentTypeValueObject.new('Package'),
+    parcels: [
+      EnviaYa::Shared::Domain::Entities::ParcelEntity.new(
+        quantity: 1,
+        weight: 1.0,
+        weight_unit: EnviaYa::Shared::Domain::ValueObjects::WeightUnitValueObject.new('kg'),
+        height: 10.0,
+        length: 10.0,
+        width: 10.0,
+        dimension_unit: EnviaYa::Shared::Domain::ValueObjects::DimensionUnitValueObject.new('cm')
+      )
+    ]
+  )
+)
+command.execute(dto)
+```

data/lib/envia_ya.rb

@@ -1,5 +1,5 @@
 require 'singleton'
-require_relative './modules/rates/infrastructure/repositories/create_rate_repository/create_rate_http_repository.rb'
+require_relative './modules/rates/infrastructure/repositories/rates_http_repository.rb'
 require_relative './modules/rates/application/commands/create_rate_command.rb'
 
 module EnviaYa

data/lib/modules/rates/application/commands/create_rate_command.rb

@@ -1,5 +1,5 @@
 require_relative '../../domain/dtos/create_rate_dto.rb'
-require_relative '../../domain/repositories/create_rate_repository.rb'
+require_relative '../../domain/repositories/rates_repository.rb'
 
 module EnviaYa
   module Rates
@@ -7,15 +7,15 @@ module EnviaYa
       module Commands
         class CreateRateCommand
           def initialize(repository:)
-            raise TypeError, "repository expected CreateRateRepository but got: #{repository.class}" unless repository.is_a?(::EnviaYa::Rates::Domain::Repositories::CreateRateRepository)
+            raise TypeError, "repository expected CreateRateRepository but got: #{repository.class}" unless repository.is_a?(::EnviaYa::Rates::Domain::Repositories::RatesRepository)
             
             @repository = repository
           end
   
           def execute(create_rate_dto)
-            raise TypeError, "create_rate_dto expected CreateRateDto but got: #{create_rate_dto.class}" unless create_rate_dto.is_a?(::EnviaYa::Rates::Domain::Dtos::CreateRateDto)
+            raise TypeError, "expected CreateRateDto but got: #{create_rate_dto.class}" unless create_rate_dto.is_a?(::EnviaYa::Rates::Domain::Dtos::CreateRateDto)
   
-            @repository.execute(create_rate_dto)
+            @repository.create(create_rate_dto)
           end
         end
       end

data/lib/modules/rates/domain/repositories/{create_rate_repository.rb → rates_repository.rb}

@@ -4,8 +4,8 @@ module EnviaYa
   module Rates
     module Domain
       module Repositories
-        class CreateRateRepository
-          def execute(create_rate_dto)
+        class RatesRepository
+          def create(create_rate_dto)
             raise NotImplementedError, "method not implemented yet"
           end
         end

data/lib/modules/rates/infrastructure/repositories/rates_dummy_repository.rb

@@ -0,0 +1,19 @@
+require 'json'
+require_relative '../../domain/repositories/rates_repository.rb'
+require_relative '../../domain/dtos/create_rate_dto.rb'
+
+module EnviaYa
+  module Rates
+    module Infrastructure
+      module Repositories
+        class RatesDummyRepository < ::EnviaYa::Rates::Domain::Repositories::RatesRepository
+          def create(create_rate_dto)
+            raise TypeError, "expected a CreateRateDto but got: #{create_rate_dto.class}" unless create_rate_dto.is_a?(::EnviaYa::Rates::Domain::Dtos::CreateRateDto)
+            
+            return {"UPS":[{"rate_id":"145588212","shipment_id":"21961285","dynamic_service_name":"Saver shipment (4 days)","date":"2021-10-10T03:44:59.278-05:00","carrier":"UPS","carrier_service_name":"Express Saver","carrier_service_code":"65","carrier_logo_url":"https://enviaya-public.s3-us-west-1.amazonaws.com/carriers/ups/ups.png","carrier_logo_url_svg":"https://enviaya-public.s3-us-west-1.amazonaws.com/carriers/ups/ups.svg","estimated_delivery":"2021-10-14","est_transit_time_hours":96,"net_shipping_amount":399.54,"net_surcharges_amount":99.16,"net_total_amount":498.7,"vat_amount":79.8,"vat_rate":16.0,"total_amount":578.5,"currency":"MXN","list_total_amount":508.7,"list_total_amount_currency":"MXN","subsidy_total_amount":null,"service_terms":"","surcharges_break_down":[{"carrier_surcharge_name":"Residential delivery","api_net_amount":58.0,"api_vat_amount":9.28,"api_total_amount":67.28}],"enviaya_service_name":"Express Saver","enviaya_service_code":"EY 8","additional_configuration":null}],"Redpack":[{"rate_id":"145588217","shipment_id":"21961285","dynamic_service_name":"3 Day Delivery","date":"2021-10-10T03:44:59.278-05:00","carrier":"Redpack","carrier_service_name":"Metropolitano","carrier_service_code":"4","carrier_logo_url":"https://enviaya-public.s3-us-west-1.amazonaws.com/carriers/redpack/redpack.png","carrier_logo_url_svg":"https://enviaya-public.s3-us-west-1.amazonaws.com/carriers/redpack/redpack.svg","estimated_delivery":"2021-10-13","est_transit_time_hours":68,"net_shipping_amount":100.98,"net_surcharges_amount":14.68,"net_total_amount":115.66,"vat_amount":18.51,"vat_rate":16.0,"total_amount":134.17,"currency":"MXN","list_total_amount":99.64,"list_total_amount_currency":"MXN","subsidy_total_amount":null,"service_terms":"","surcharges_break_down":[{"carrier_surcharge_name":"Fuel Surcharge","api_net_amount":10.9,"api_vat_amount":1.74,"api_total_amount":12.64}],"enviaya_service_name":"Metropolitano","enviaya_service_code":"EY 52","additional_configuration":null},{"rate_id":"145588216","shipment_id":"21961285","dynamic_service_name":"2 Day Delivery","date":"2021-10-10T03:44:59.278-05:00","carrier":"Redpack","carrier_service_name":"Express","carrier_service_code":"1","carrier_logo_url":"https://enviaya-public.s3-us-west-1.amazonaws.com/carriers/redpack/redpack.png","carrier_logo_url_svg":"https://enviaya-public.s3-us-west-1.amazonaws.com/carriers/redpack/redpack.svg","estimated_delivery":"2021-10-12","est_transit_time_hours":44,"net_shipping_amount":148.32,"net_surcharges_amount":16.61,"net_total_amount":164.93,"vat_amount":26.39,"vat_rate":16.0,"total_amount":191.32,"currency":"MXN","list_total_amount":217.11,"list_total_amount_currency":"MXN","subsidy_total_amount":null,"service_terms":"","surcharges_break_down":[{"carrier_surcharge_name":"Fuel Surcharge","api_net_amount":18.85,"api_vat_amount":3.02,"api_total_amount":21.87}],"enviaya_service_name":"Express","enviaya_service_code":"EY 19","additional_configuration":null}],"Estafeta":[],"Paquetexpress":[],"Tresguerras":[],"Ampm":[],"Sendex":[],"FedEx®":[{"rate_id":"145588213","shipment_id":"21961285","dynamic_service_name":"3 Day Delivery","date":"2021-10-10T03:44:59.278-05:00","carrier":"FedEx","carrier_service_name":"National Saver","carrier_service_code":"FEDEX_EXPRESS_SAVER","carrier_logo_url":"https://enviaya-public.s3-us-west-1.amazonaws.com/carriers/fedex/fedex.png","carrier_logo_url_svg":"https://enviaya-public.s3-us-west-1.amazonaws.com/carriers/fedex/fedex.svg","estimated_delivery":"2021-10-13","est_transit_time_hours":72,"net_shipping_amount":177.44,"net_surcharges_amount":26.79,"net_total_amount":204.23,"vat_amount":32.68,"vat_rate":16.0,"total_amount":236.91,"currency":"MXN","list_total_amount":236.91,"list_total_amount_currency":"MXN","subsidy_total_amount":null,"service_terms":"","surcharges_break_down":[{"carrier_surcharge_name":"Fuel Surcharge","api_net_amount":26.79,"api_vat_amount":4.29,"api_total_amount":31.08}],"enviaya_service_name":"National Saver","enviaya_service_code":"EY 56","additional_configuration":null}],"4-72":[],"warning":[]}
+          end
+        end
+      end
+    end
+  end
+end

data/lib/modules/rates/infrastructure/repositories/rates_http_repository.rb

@@ -0,0 +1,28 @@
+require 'json'
+require 'net/http'
+require 'uri'
+require_relative '../../../shared/infrastructure/connectors/http_connector/http_net_connector.rb'
+require_relative '../../domain/repositories/rates_repository.rb'
+require_relative '../../domain/dtos/create_rate_dto.rb'
+require_relative '../../../shared/domain/value_objects/http_method_value_object.rb'
+
+module EnviaYa
+  module Rates
+    module Infrastructure
+      module Repositories
+        class RatesHttpRepository < ::EnviaYa::Rates::Domain::Repositories::RatesRepository
+          def initialize
+            @http_connector = ::EnviaYa::Shared::Infrastructure::Connectors::HttpConnector::HttpNetConnector.new
+          end
+
+          def create(create_rate_dto)
+            raise TypeError, "expected a CreateRateDto but got: #{create_rate_dto.class}" unless create_rate_dto.is_a?(::EnviaYa::Rates::Domain::Dtos::CreateRateDto)
+
+            response = @http_connector.execute(URI('https://enviaya.com.mx/api/v1/rates'), method: ::EnviaYa::Shared::Domain::ValueObjects::HttpMethodValueObject.new('POST'), body: create_rate_dto.to_hash)
+            JSON.parse(response.body, symbolize_names: true)
+          end
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: envia_ya
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Simply Development
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-10-10 00:00:00.000000000 Z
+date: 2021-10-20 00:00:00.000000000 Z
 dependencies: []
 description:
 email:
@@ -17,15 +17,18 @@ email:
 - j@simply-development.com
 executables: []
 extensions: []
-extra_rdoc_files: []
+extra_rdoc_files:
+- README
 files:
+- README
 - lib/envia_ya.rb
 - lib/modules/rates/application/commands/create_rate_command.rb
 - lib/modules/rates/domain/dtos/create_rate_dto.rb
 - lib/modules/rates/domain/entities/direction_entity.rb
 - lib/modules/rates/domain/entities/shipment_entity.rb
-- lib/modules/rates/domain/repositories/create_rate_repository.rb
-- lib/modules/rates/infrastructure/repositories/create_rate_repository/create_rate_http_repository.rb
+- lib/modules/rates/domain/repositories/rates_repository.rb
+- lib/modules/rates/infrastructure/repositories/rates_dummy_repository.rb
+- lib/modules/rates/infrastructure/repositories/rates_http_repository.rb
 - lib/modules/shared/domain/connectors/http_connector.rb
 - lib/modules/shared/domain/entities/accounts_entity.rb
 - lib/modules/shared/domain/entities/parcel_entity.rb
@@ -39,7 +42,7 @@ files:
 - lib/modules/shared/domain/value_objects/shipment_type_value_object.rb
 - lib/modules/shared/domain/value_objects/weight_unit_value_object.rb
 - lib/modules/shared/infrastructure/connectors/http_connector/http_net_connector.rb
-homepage:
+homepage: https://github.com/Simply-Development/EnviaYa-Ruby-Gem
 licenses:
 - MIT
 metadata: {}

data/lib/modules/rates/infrastructure/repositories/create_rate_repository/create_rate_http_repository.rb

@@ -1,30 +0,0 @@
-require 'json'
-require 'net/http'
-require 'uri'
-require_relative '../../../../shared/infrastructure/connectors/http_connector/http_net_connector.rb'
-require_relative '../../../domain/repositories/create_rate_repository.rb'
-require_relative '../../../domain/dtos/create_rate_dto.rb'
-require_relative '../../../../shared/domain/value_objects/http_method_value_object.rb'
-
-module EnviaYa
-  module Rates
-    module Infrastructure
-      module Repositories
-        module CreateRateRepository
-          class CreateRateHttpRepository < ::EnviaYa::Rates::Domain::Repositories::CreateRateRepository
-            def initialize
-              @http_connector = ::EnviaYa::Shared::Infrastructure::Connectors::HttpConnector::HttpNetConnector.new
-            end
-  
-            def execute(create_rate_dto)
-              raise TypeError, "create_rate_repository expected a CreateRateDto but got: #{create_rate_dto.class}" unless create_rate_dto.is_a?(::EnviaYa::Rates::Domain::Dtos::CreateRateDto)
-  
-              response = @http_connector.execute(URI('https://enviaya.com.mx/api/v1/rates'), method: ::EnviaYa::Shared::Domain::ValueObjects::HttpMethodValueObject.new('POST'), body: create_rate_dto.to_hash)
-              JSON.parse(response.body, symbolize_names: true)
-            end
-          end
-        end
-      end
-    end
-  end
-end