colissimo_label 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6b20cf6d60590b5b229d08dca579e8526540718702f0818282369af8de9568d7
-  data.tar.gz: 6138fdc5edc70493a52af72104ce6df8a5b8f6f060779d5eb3baf63821bae8ae
+  metadata.gz: b85e62f1503ab7a596c1f5fadb2f0a9e1ea0d94bc34e61c027961aeb9f2d5dd9
+  data.tar.gz: b9d1cc9d6c14b846b61f33804093e50b759322d07af2fdc49aa0dda7c3c8063f
 SHA512:
-  metadata.gz: a4eb97e5a3e6d55a8fe22895bfb31b6cd7a5d5df0f7c6b21ee8edf40ed5b1e655c1aef84dd2d9017474ae240d51c96d49f46e4cdfef3dca7c8a3d505472b1bb0
-  data.tar.gz: 2b68731fb099899fe85e593dcfc6412e857cc02eb5cd28fec1d838681e11cc1adfb67a12dbe1a5481877f96908f1f01122228a3a7d683096a0237ddf723be6a4
+  metadata.gz: b0282ebd5555cf445a89cdac2d320dc610ab4fa1d599bca81e305af3b68540c39fa0a41ae5dd18ceb89aa6ebf9ec36f6ac9c614089131ed893fabae0ab1aa2ea
+  data.tar.gz: 93167be7de54a135e7c15106c4e17aa7cba5e67932ee09a724db2bcc4c36fee7c529836d668bccf06949868d2daaa399746ae8945880a4cc29c67e96dd94e4e4

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.5.0
+
+- Add option to generate label with a pickup location id
+
 ## 0.4.0
 
 - Add `ColissimoLabel::FindRelayPoint` class to fetch available relay points around an address

data/README.md

@@ -79,7 +79,7 @@ To get all available relay :
 
 It will return an array of relay points with the following data:
 
-```ruby
+```
 {
         :pickup_id,
         :name,
@@ -138,6 +138,37 @@ parcel_number = ColissimoLabel::GenerateLabel.new(
       ).perform
 ```
 
+For a national address and delivered to a relay point:
+
+```ruby
+parcel_number = ColissimoLabel::GenerateLabel.new(
+        'label_filename', # Name of the file generated
+        'FR', # Normalized country code of the destination
+        9.99, # Amount of the shipping fees (paid by the customer)
+        {
+          company_name: 'Sender company name',
+          address:      'Address',
+          city:         'City',
+          postcode:     'Postcode',
+          country_code: 'Normalized country code (ex: FR)'
+        },
+        {
+          last_name:    'Last name of the addressee',
+          first_name:   'First name of the addressee',
+          address_bis:  'Address bis of the addressee',
+          address:      'Address of the addressee',
+          city:         'City of the addressee',
+          postcode:     'Postcode of the addressee',
+          country_code: 'Normalized country code of the addressee',
+          phone:        'Phone number of the addressee',
+          mobile:       'Mobile number of the addressee',
+          email:        'Email of the addressee'
+        },
+        pickup_id:      'pickup ID',
+        pickup_type:    'BPR or A2P'
+      ).perform
+```
+
 For a foreign address (which required customs declaration):
 
 ```ruby
@@ -164,8 +195,8 @@ parcel_number = ColissimoLabel::GenerateLabel.new(
           mobile:       'Mobile number of the addressee',
           email:        'Email of the addressee'
         },
-        2, # Total weight of the package
-        [ # Details content of your package
+        customs_total_weight: 2, # Total weight of the package
+        customs_data: [ # Details content of your package
           {
             description:   'Product description',
             quantity:      1,

data/lib/colissimo_label/find_relay_point.rb

@@ -28,6 +28,8 @@ class ColissimoLabel::FindRelayPoint
     root.xpath('//listePointRetraitAcheminement').map do |point|
       {
         pickup_id:      point.at_xpath('identifiant').text,
+        pickup_type:    point.at_xpath('typeDePoint
+ ').text,
         name:           point.at_xpath('nom').text,
         address:        [point.at_xpath('adresse1'), point.at_xpath('adresse2'), point.at_xpath('adresse3')].map(&:text).select(&:present?).join(' '),
         postcode:       point.at_xpath('codePostal').text,

data/lib/colissimo_label/generate_label.rb

@@ -4,14 +4,16 @@ require 'http'
 
 class ColissimoLabel::GenerateLabel
 
-  def initialize(filename, destination_country, shipping_fees, sender_data, addressee_data, customs_total_weight = nil, customs_data = nil)
+  def initialize(filename, destination_country, shipping_fees, sender_data, addressee_data, options = {})
     @filename             = filename
     @destination_country  = destination_country
     @shipping_fees        = shipping_fees
     @sender_data          = sender_data
     @addressee_data       = addressee_data
-    @customs_total_weight = customs_total_weight
-    @customs_data         = customs_data
+    @pickup_id            = options.fetch(:pickup_id, nil)
+    @pickup_type          = options.fetch(:pickup_type, nil)
+    @customs_total_weight = options.fetch(:customs_total_weight, nil)
+    @customs_data         = options.fetch(:customs_data, nil)
     @errors               = []
   end
 
@@ -67,14 +69,16 @@ class ColissimoLabel::GenerateLabel
                       },
                       "letter":         {
                                           "service":   {
-                                            "productCode": product_code,
-                                            "depositDate": delivery_date.strftime('%F'),
-                                            "totalAmount": (@shipping_fees * 100).to_i,
+                                            "commercialName": @sender_data[:company_name],
+                                            "productCode":    product_code,
+                                            "depositDate":    delivery_date.strftime('%F'),
+                                            "totalAmount":    (@shipping_fees * 100).to_i,
                                             # "returnTypeChoice": '2' # Retour à la maison en prioritaire
                                           },
                                           "parcel":    {
-                                            "weight": format_weight
-                                          },
+                                                         "weight":           format_weight,
+                                                         "pickupLocationId": @pickup_id
+                                                       }.compact,
                                           "sender":    {
                                             "address": format_sender
                                           },
@@ -118,7 +122,7 @@ class ColissimoLabel::GenerateLabel
       "city": @addressee_data[:city], # Ville
       "zipCode": @addressee_data[:postcode], # Code postal
       "phoneNumber": @addressee_data[:phone], # Numéro de téléphone
-      "mobileNumber": @addressee_data[:mobile], # Numéro de portable
+      "mobileNumber": @addressee_data[:mobile], # Numéro de portable, obligatoire si pickup
       "doorCode1": @addressee_data[:door_code_1], # Code porte 1
       "doorCode2": @addressee_data[:door_code_2], # Code porte 2
       "email": @addressee_data[:email], # Adresse courriel
@@ -175,11 +179,17 @@ class ColissimoLabel::GenerateLabel
     %w[CH].include?(@destination_country)
   end
 
-  # DOM : Colissimo France et International sans signature / DOS : Colissimo France et International avec signature
   # Certains pays, comme l'Allemagne, requiert une signature pour la livraison
+  # DOM : Colissimo France et International sans signature
+  # DOS : Colissimo France et International avec signature
+  # Pays avec Point Relais : https://www.colissimo.entreprise.laposte.fr/fr/offre-europe
+  # BPR : Colissimo - Point Retrait – en Bureau de Poste
+  # A2P : Colissimo - Point Retrait – en relais Pickup ou en consigne Pickup Station
   def product_code
     if %w[DE IT GB LU].include?(@destination_country)
       'DOS'
+    elsif !@pickup_id.nil? && %w[FR].include?(@destination_country)
+      @pickup_type || 'BPR'
     else
       'DOM'
     end

data/lib/colissimo_label/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ColissimoLabel
-  VERSION = '0.4.0'.freeze
+  VERSION = '0.5.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: colissimo_label
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - FloXcoder
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-07-11 00:00:00.000000000 Z
+date: 2019-07-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport