deliveries 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2102df4101cad8142a4673ee79f2d18994309db3e7a5d70ea03281abb4d9c5c5
+  data.tar.gz: 7ffe9bf7dd2546132118c6e1d028cc36f216eb7e2eaad34b6543f76d4090452a
+SHA512:
+  metadata.gz: 44eee42b323ffea42bbdb8d963a69084d5f9196b0b92fa3078954411bbf1e6d22a5e5229564edf53deefebc21cd6ab6e1a05cade53e80c83b214f1b7d4eb7e48
+  data.tar.gz: 7c07fb3e9f88692391d806b18960720f22cf1339574f335c10bce33cef2f14a123ea1ca5fe8cc116d2f5c5ffbee953861851cfacc85dd2a538353af93dad52f9

data/.github/workflows/main.yml

@@ -0,0 +1,19 @@
+name: Ruby
+
+on: [push,pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 2.6.7
+    - name: Run the default task
+      run: |
+        sudo apt-get install poppler-utils
+        gem install bundler -v 2.2.4
+        bundle install
+        bundle exec rake

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+deliveries.log

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,34 @@
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 2.6.7
+  Exclude:
+    - spec/**/*.rb
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: single_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: single_quotes
+
+Metrics:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Layout/LineLength:
+  # We have a lot of very long lines in the code to fix,
+  # this is a start but we should aim to lower it to
+  # at least 120
+  Max: 155
+
+Style/FormatStringToken:
+  Enabled: false
+
+Style/IfUnlessModifier:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,13 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.1.0] - 2021-09-27
+🎉 First release!
+
+[Unreleased]: https://github.com/ecommerce-ventures/deliveries/compare/v0.1.0...HEAD
+[0.1.0]: https://github.com/ecommerce-ventures/deliveries/releases/tag/v0.1.0

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in deliveries.gemspec
+gemspec
+
+gem 'rake', '~> 13.0'
+
+gem 'rspec', '~> 3.0'
+
+gem 'rubocop', '~> 0.80'

data/Gemfile.lock

@@ -0,0 +1,127 @@
+PATH
+  remote: .
+  specs:
+    deliveries (0.1.0)
+      activesupport (>= 5.2.0)
+      hexapdf
+      httparty
+      mini_magick
+      nokogiri
+      savon (~> 2.8)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (6.1.4)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    addressable (2.8.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    akami (1.3.1)
+      gyoku (>= 0.4.0)
+      nokogiri
+    ast (2.4.2)
+    builder (3.2.4)
+    byebug (11.1.3)
+    cmdparse (3.0.7)
+    concurrent-ruby (1.1.9)
+    crack (0.4.5)
+      rexml
+    diff-lcs (1.4.4)
+    geom2d (0.3.1)
+    gyoku (1.3.1)
+      builder (>= 2.1.2)
+    hashdiff (1.0.1)
+    hexapdf (0.15.8)
+      cmdparse (~> 3.0, >= 3.0.3)
+      geom2d (~> 0.3)
+    httparty (0.18.1)
+      mime-types (~> 3.0)
+      multi_xml (>= 0.5.2)
+    httpi (2.4.5)
+      rack
+      socksify
+    i18n (1.8.10)
+      concurrent-ruby (~> 1.0)
+    mime-types (3.3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2021.0704)
+    mini_magick (4.11.0)
+    minitest (5.14.4)
+    multi_xml (0.6.0)
+    nokogiri (1.12.3-x86_64-linux)
+      racc (~> 1.4)
+    nori (2.6.0)
+    parallel (1.20.1)
+    parser (3.0.2.0)
+      ast (~> 2.4.1)
+    public_suffix (4.0.6)
+    racc (1.5.2)
+    rack (2.2.3)
+    rainbow (3.0.0)
+    rake (13.0.6)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.3)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.4)
+    rubocop (0.93.1)
+      parallel (~> 1.10)
+      parser (>= 2.7.1.5)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8)
+      rexml
+      rubocop-ast (>= 0.6.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (1.10.0)
+      parser (>= 3.0.1.1)
+    ruby-progressbar (1.11.0)
+    savon (2.12.1)
+      akami (~> 1.2)
+      builder (>= 2.1.2)
+      gyoku (~> 1.2)
+      httpi (~> 2.3)
+      nokogiri (>= 1.8.1)
+      nori (~> 2.4)
+      wasabi (~> 3.4)
+    socksify (1.7.1)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (1.7.0)
+    wasabi (3.6.1)
+      addressable
+      httpi (~> 2.0)
+      nokogiri (>= 1.4.2)
+    webmock (3.14.0)
+      addressable (>= 2.8.0)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+    zeitwerk (2.4.2)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  byebug
+  deliveries!
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 0.80)
+  webmock (~> 3.5)
+
+BUNDLED WITH
+   2.2.24

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021-present Micolet Web S.L.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,207 @@
+# Deliveries Gem
+
+Deliveries is a gem that gives you the ability to integrate multiple shipping services through different couriers
+
+## Installation
+
+Add the following line to your Gemfile
+
+```bash
+gem 'deliveries'
+```
+Then run:
+
+```bash
+bundle install
+```
+
+## Configuration
+
+Each courier requires a different configuration, below we will leave some examples
+
+#### 1. Mondial Relay
+```bash
+Deliveries.courier(:mondial_relay).configure do |config|
+  config.mondial_relay_merchant = '...'
+  config.mondial_relay_key = '...'
+end
+```
+
+#### 2. Mondial Relay Dual
+```bash
+Deliveries.courier(:mondial_relay_dual).configure do |config|
+  config.dual_carrier_login = '...'
+  config.dual_carrier_password = '...'
+  config.dual_carrier_customer_id = '...'
+  config.countries = {
+    fr: {
+      home_delivery_mode: 'HOC'
+    },
+    de: {
+      home_delivery_mode: 'HOM'
+    },
+    gb: {
+      home_delivery_mode: 'HOM'
+    }
+ }
+end
+```
+
+#### 3. Correos Express
+```bash
+Deliveries.courier(:correos_express).configure do |config|
+  config.username = '...'
+  config.password = '...'
+  config.client_code = '...'
+  config.shipment_sender_code = '...'
+  config.pickup_receiver_code = '...'
+  config.countries = {
+    es: {
+      product: '93'
+    },
+    pt: {
+      product: '63'
+    }
+  }
+end
+```
+
+#### 4. Spring
+```bash
+Deliveries.courier(:spring).configure do |config|
+  config.api_key = '...'
+  config.countries = {
+    gb: {
+      service: 'TRCK'
+    },
+    it: {
+      service: 'TRCK'
+    }
+   }
+   config.default_product = {
+    description: 'ROPA',
+    hs_code: '',
+    origin_country: 'ES',
+    quantity: 1,
+    value: 100
+  }
+end
+```
+
+#### 5. UPS
+```bash
+Deliveries.courier(:ups).configure do |config|
+  config.license_number = '...'
+  config.username = '...'
+  config.password = '...'
+  config.point_account_number = '...'
+  config.home_account_number = '...'
+  config.default_product = {
+    description: 'clothes',
+    weight: '1'
+  }
+end
+```
+
+## Usage
+
+#### Get collection point by country and postcode
+
+```bash
+# Example Using Ups
+
+Deliveries.courier(:ups).get_collection_points(postcode: '...', country: 'it')
+```
+#### Get collection point info
+
+```bash
+# Example Using Mondial Relay
+
+Deliveries.courier(:mondial_relay).get_collection_point(global_point_id: 'mondial_relay~fr~00000~XXXXXX')
+```
+
+#### Create a Shipment
+```bash
+# Example Using Correos Express
+
+sender = Deliveries::Address.new(
+  name: '...',
+  email: 'sender@example.com',
+  phone: '...',
+  country: 'ES',
+  state: '...',
+  city: '...',
+  street: '...',
+  postcode: '...'
+)
+
+receiver = Deliveries::Address.new(
+  name: '...',
+  email: 'receiver@example.com',
+  phone: '...',
+  country: 'ES',
+  state: '...',
+  city: '...',
+  street: '...',
+  postcode: '...'
+)
+
+response = Deliveries.courier(:correos_express).create_shipment(
+  sender: sender,
+  receiver: receiver,
+  collection_point: nil,
+  parcels: 1,
+  reference_code: '...',
+  shipment_date: Date.tomorrow,
+  remarks: nil
+)
+```
+
+#### Create a Pickup
+```bash
+# Example Using Spring
+
+sender = Deliveries::Address.new(
+  name: '...',
+  email: 'sender@example.com',
+  phone: '...',
+  country: 'ES',
+  state: '...',
+  city: '...',
+  street: '...',
+  postcode: '...'
+)
+
+receiver = Deliveries::Address.new(
+  name: '...',
+  email: 'receiver@example.com',
+  phone: '...',
+  country: 'ES',
+  state: '...',
+  city: '...',
+  street: '...',
+  postcode: '...'
+)
+
+response = Deliveries.courier(:spring).create_pickup(
+  sender: sender,
+  receiver: receiver,
+  parcels: 1,
+  reference_code: '...',
+  pickup_date: 2.days.since.to_date
+)
+```
+
+#### Download a Label
+```bash
+# Example Using Spring
+
+label = Deliveries.courier(:spring).get_label(tracking_code: '...')
+
+# And then, we can use it as follows
+
+File.write('label.pdf', label.raw)
+```
+
+## License
+[MIT](https://choosealicense.com/licenses/mit/)

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'deliveries'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/deliveries.gemspec

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require_relative 'lib/deliveries/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'deliveries'
+  spec.version       = Deliveries::VERSION
+  spec.authors       = ['Fran Vega', 'Raúl Rodríguez', 'Roberto Martínez', 'Pedro Guerra']
+  spec.email         = ['admin@micolet.com']
+
+  spec.summary       = 'Library to abstract multiple courier web services.'
+  spec.homepage      = 'https://github.com/ecommerce-ventures/deliveries'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.6.7')
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/ecommerce-ventures/deliveries'
+  spec.metadata['changelog_uri'] = 'https://github.com/ecommerce-ventures/deliveries/CHANGELOG.md'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'activesupport', '>= 5.2.0'
+  spec.add_dependency 'hexapdf'
+  spec.add_dependency 'httparty'
+  spec.add_dependency 'mini_magick'
+  spec.add_dependency 'nokogiri'
+  spec.add_dependency 'savon', '~> 2.8'
+
+  spec.add_development_dependency 'byebug'
+  spec.add_development_dependency 'webmock', '~> 3.5'
+end

data/lib/deliveries/address.rb

@@ -0,0 +1,71 @@
+module Deliveries
+  class Address
+    attr_accessor :name, :email, :phone, :country, :state, :city, :street, :postcode
+
+    COUNTRY_PHONE_PREFIXES = {
+      be: 32,
+      fr: 33,
+      es: 34,
+      it: 39,
+      gb: 44,
+      de: 49,
+      pt: 351
+    }.freeze
+    COUNTRY_TRUNK_PREFIXES = {
+      be: 0,
+      fr: 0,
+      es: nil,
+      it: nil,
+      gb: 0,
+      de: 0,
+      pt: nil
+    }.freeze
+
+    def initialize(**attributes)
+      self.name = attributes[:name]
+      self.email = attributes[:email]
+      self.phone = attributes[:phone]
+      self.country = attributes[:country]
+      self.state = attributes[:state]
+      self.city = attributes[:city]
+      self.street = attributes[:street]
+      self.postcode = attributes[:postcode]
+    end
+
+    def courierize(courier_id)
+      courier_address = %(Deliveries::Couriers::#{courier_id.to_s.camelize}::Address).safe_constantize.new
+      instance_variables.each do |iv|
+        courier_address.instance_variable_set(iv, instance_variable_get(iv))
+      end
+      courier_address
+    end
+
+    protected
+
+    def format_international_phone
+      return '' if @phone.blank? || @country.blank?
+
+      country = @country.downcase.to_sym
+      prefix = COUNTRY_PHONE_PREFIXES[country]
+      trunk_prefix = COUNTRY_TRUNK_PREFIXES[country]
+
+      # Remove white spaces.
+      tmp_phone = @phone.gsub(' ', '')
+
+      # Remove current prefix if present.
+      tmp_phone.gsub!(/\A(00|\+)#{prefix}/, '')
+
+      # Remove trunk prefix to convert it to international.
+      tmp_phone.gsub!(/\A#{trunk_prefix}/, '') if trunk_prefix
+
+      "+#{prefix}#{tmp_phone}"
+    end
+
+    def format_email
+      return '' if @email.blank?
+
+      matches = @email.split(/[+@]/)
+      %(#{matches.first}@#{matches.last})
+    end
+  end
+end

data/lib/deliveries/checkpoint.rb

@@ -0,0 +1,12 @@
+module Deliveries
+  class Checkpoint
+    attr_accessor :status, :location, :tracked_at, :description
+
+    def initialize(status: nil, location: nil, tracked_at: nil, description: nil)
+      self.status = status
+      self.location = location
+      self.tracked_at = tracked_at
+      self.description = description
+    end
+  end
+end

data/lib/deliveries/collection_point.rb

@@ -0,0 +1,45 @@
+module Deliveries
+  class CollectionPoint < Address
+    attr_accessor :courier_id, :point_id, :latitude, :longitude, :url_map, :url_photo
+    attr_writer :timetable
+
+    def initialize(**attributes)
+      super(**attributes)
+
+      self.courier_id = attributes[:courier_id]
+      self.point_id = attributes[:point_id]
+      self.latitude = attributes[:latitude]
+      self.longitude = attributes[:longitude]
+      self.timetable = attributes[:timetable]
+      self.url_map = attributes[:url_map]
+      self.url_photo = attributes[:url_photo]
+    end
+
+    def global_point_id
+      "#{courier_id}~#{country}~#{postcode}~#{point_id}"
+    end
+
+    def timetable(start_day: :monday)
+      raise Error, "Invalid week start day: #{start_day}" unless %i[monday sunday].include?(start_day)
+
+      @timetable&.sort_by do |wday, _slots|
+        if wday.zero? && start_day == :monday
+          7
+        else
+          wday
+        end
+      end&.to_h
+    end
+
+    def self.parse_global_point_id(global_point_id:)
+      global_point = global_point_id.split('~')
+
+      OpenStruct.new(
+        courier_id: global_point[0],
+        country: global_point[1],
+        postcode: global_point[2],
+        point_id: global_point[3]
+      )
+    end
+  end
+end