colissimo_label 0.19.0 → 0.20.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d58ca859be28bd4c1904888ffd0a04ce9f2a0fe3eb4685d530a9c63ac64fc24d
-  data.tar.gz: b0101152eecda5a85baaf0f02e337abde20d525646e4c91751104dbc423cb554
+  metadata.gz: 104d8402162a7daf6fcf0eaa5c7a9246ed709a8a7e97d37ecdc84631721d5da1
+  data.tar.gz: 94e1411b953744780448dcd69aba26ae7d4c4ffad071a7477b6c442f002b71ba
 SHA512:
-  metadata.gz: cf756d30f2c61764de70d2e60dbc0d5d0ecd1dbe75a6411a05457e8981042cddec79ebf37143fd5048a60a057e39649060a2e84614233c0f671be3fa97b012d9
-  data.tar.gz: 01c0681b6bc6c1a619299a6bd94f3151cd8a01ed3ccf4bfe22a8f4fcff77b7b4232cb9f833c5c46d72e2a5fd648869a25bf389f4ad02b5808b5bc3e1576cc423
+  metadata.gz: 04ef4dfe6942583abcddee37a7fb1e2519a44c2380b5223c89d28c26284e5dcb746e59086c41e65cb75e98e457862e7429a2c1867eab551f70a8c085d1e78b9e
+  data.tar.gz: 42008e2705a23bb3305117c87254baebab36dcf97546ccb7374e15c026ff21c6b78341f61fba522f9db7431ad27b13f3669c79b19b733fde67217dff7cdf713c

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+## 0.20.0
+
+- Automatically create the path for label and customs documents
+- Add more parameter options for customs
+- Add parameters for specific addressee and sender reference
+- Update dependencies
+
 ## 0.19.0
 
 - Add new option field: specific TVA number for customs 

data/README.md

@@ -144,6 +144,12 @@ You can add the following option to require the signature:
 with_signature: true
 ```
 
+To provide the insurance value (by default, it depends of the weight of the package), add this parameter:
+
+```
+insurance_value: 100
+```
+
 For a national address and delivered to a relay point:
 
 ```ruby
@@ -201,7 +207,8 @@ parcel_number = ColissimoLabel::GenerateLabel.new(
           mobile:       'Mobile number of the addressee',
           email:        'Email of the addressee'
         },
-        customs_total_weight: 2, # Total weight of the package
+        customs_total_weight: 2, # Total weight of the package, required for customs
+        customs_category: 3, # Type of business (commercial by default)
         customs_data: [ # Details content of your package
           {
             description:   'Product description',
@@ -210,7 +217,7 @@ parcel_number = ColissimoLabel::GenerateLabel.new(
             item_price:    100,
             country_code:  'FR',
             currency_code: 'EUR',
-            customs_code:  'hsCode' # Harmonized system code of your product
+            customs_code:  'hsCode' # Harmonized system code of your product, it's a number or a string (starting with '0')
           }
         ]
       ).perform
@@ -222,7 +229,7 @@ In both cases, if the label cannot be generated it raises a StandardError with t
 
 Colissimo documentation can be found here:
 
-https://www.colissimo.entreprise.laposte.fr/system/files/imagescontent/docs/spec_ws_affranchissement.pdf
+https://www.colissimo.entreprise.laposte.fr/sites/default/files/2021-03/spec_ws_affranchissement.pdf
 
 ## Contributing
 

data/colissimo_label.gemspec

@@ -21,13 +21,13 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_dependency 'rack', '~> 2'
+  spec.add_dependency 'http', '>= 4'
   spec.add_dependency 'activesupport', '>= 5'
   spec.add_dependency 'railties', '>= 5'
-  spec.add_dependency 'http', '~> 4'
 
   spec.add_development_dependency 'bundler', '~> 2'
   spec.add_development_dependency 'rake', '~> 12'
   spec.add_development_dependency 'rspec', '~> 3'
-  spec.add_development_dependency 'simplecov', '~> 0.17'
+  spec.add_development_dependency 'simplecov', '>= 0.16'
   spec.add_development_dependency 'webmock', '~> 3'
 end

data/lib/colissimo_label/generate_label.rb

@@ -3,24 +3,40 @@
 require 'http'
 
 class ColissimoLabel::GenerateLabel
+  class ServiceUnavailable < StandardError; end
 
   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
-    @pickup_id            = options.fetch(:pickup_id, nil)
-    @pickup_type          = options.fetch(:pickup_type, nil)
-    @total_weight         = options.fetch(:total_weight, nil)
+    @filename            = filename
+    @destination_country = destination_country
+    @shipping_fees       = shipping_fees
+
+    @sender_data    = sender_data
+    @addressee_data = addressee_data
+
+    @pickup_id           = options.fetch(:pickup_id, nil)
+    @pickup_type         = options.fetch(:pickup_type, nil)
+    @total_weight        = options.fetch(:total_weight, nil)
+    @product_code        = options.fetch(:product_code, nil)
+    @with_signature      = options.fetch(:with_signature, false)
+    @insurance_value     = options.fetch(:insurance_value, nil)
+    @label_output_format = options.fetch(:label_output_format, 'PDF_10x15_300dpi')
+    @label_path          = options.fetch(:label_path, nil)
+
+    @customs_data         = options.fetch(:customs_data, nil)
     @customs_total_weight = options.fetch(:customs_total_weight, nil)
+    @customs_category     = options.fetch(:customs_category, 3)
     @customs_tva_number   = options.fetch(:customs_tva_number, nil)
-    @customs_data         = options.fetch(:customs_data, nil)
-    @with_signature       = options.fetch(:with_signature, false)
-    @insurance_value      = options.fetch(:insurance_value, nil)
     @eori_number          = options.fetch(:eori_number, nil)
-    @label_output_format  = options.fetch(:label_output_format, 'PDF_10x15_300dpi')
-    @errors               = []
+    @customs_path         = options.fetch(:customs_path, nil)
+    @customs_filename     = options.fetch(:customs_filename, 'customs')
+
+    @order_id         = options.fetch(:order_id, nil)
+    @sender_data      = sender_data
+    @sender_ref_id    = options.fetch(:sender_ref_id, nil)
+    @addressee_data   = addressee_data
+    @addressee_ref_id = options.fetch(:addressee_ref_id, nil)
+
+    @errors = []
   end
 
   def perform
@@ -28,25 +44,32 @@ class ColissimoLabel::GenerateLabel
     status         = response.code
     parts          = response.to_a.last.force_encoding('BINARY').split('Content-ID: ')
     label_filename = @filename + '.' + file_format
-    local_path     = ColissimoLabel.colissimo_local_path&.chomp('/')
+    label_path     = nil
+    customs_path   = nil
 
     if ColissimoLabel.s3_bucket
-      colissimo_pdf = ColissimoLabel.s3_bucket.object(ColissimoLabel.s3_path.chomp('/') + '/' + label_filename)
+      label_path    = ColissimoLabel.s3_path.chomp('/') + '/' + (@label_path.present? ? @label_path + '/' : '')
+      colissimo_pdf = ColissimoLabel.s3_bucket.object(label_path + label_filename)
       colissimo_pdf.put(acl: 'public-read', body: parts[2])
     else
-      File.open(local_path + '/' + label_filename, 'wb') do |file|
+      label_path = ColissimoLabel.colissimo_local_path.chomp('/') + '/' + (@label_path.present? ? @label_path + '/' : '')
+      FileUtils.mkdir_p(label_path) unless File.directory?(label_path)
+      File.open(label_path + label_filename, 'wb') do |file|
         file.write(parts[2])
       end
     end
 
     if require_customs?
-      customs_filename = @filename + '-customs.pdf'
+      customs_filename = @filename + '-' + @customs_filename + '.pdf'
 
       if ColissimoLabel.s3_bucket
-        customs_pdf = ColissimoLabel.s3_bucket.object(ColissimoLabel.s3_path.chomp('/') + '/' + customs_filename)
+        customs_path = ColissimoLabel.s3_path.chomp('/') + '/' + (@customs_path.present? ? @customs_path + '/' : '')
+        customs_pdf  = ColissimoLabel.s3_bucket.object(customs_path + customs_filename)
         customs_pdf.put(acl: 'public-read', body: parts[3])
       else
-        File.open(local_path + '/' + customs_filename, 'wb') do |file|
+        customs_path = ColissimoLabel.colissimo_local_path.chomp('/') + '/' + (@customs_path.present? ? @customs_path + '/' : '')
+        FileUtils.mkdir_p(customs_path) unless File.directory?(customs_path)
+        File.open(customs_path + customs_filename, 'wb') do |file|
           file.write(parts[3])
         end
       end
@@ -54,55 +77,68 @@ class ColissimoLabel::GenerateLabel
 
     if status == 400 || status == 500
       error_message = response.body.to_s.encode('UTF-8', 'binary', invalid: :replace, undef: :replace, replace: '').scan(/"messageContent":"(.*?)"/).last&.first
-      raise StandardError, error_message
+      raise ServiceUnavailable, error_message
     elsif status == 503
-      raise StandardError, { message: 'Colissimo: Service Unavailable' }
+      raise ServiceUnavailable, { message: 'Colissimo: Service Unavailable', code: 503 }.to_json
     else
       if (response_message = response.body.to_s.encode('UTF-8', 'binary', invalid: :replace, undef: :replace, replace: '').scan(/"parcelNumber":"(.*?)",/).last)
         parcel_number = response_message.first
 
-        return parcel_number
+        if ColissimoLabel.s3_bucket
+          return parcel_number
+        else
+          return [parcel_number, label_path, customs_path]
+        end
       else
         error_message = response.body.to_s.encode('UTF-8', 'binary', invalid: :replace, undef: :replace, replace: '').scan(/"messageContent":"(.*?)"/).last&.first
-        raise StandardError, error_message
+        raise ServiceUnavailable, error_message
       end
     end
   end
 
+  def payload
+    build_colissimo_payload
+  end
+
   private
 
   def perform_request(delivery_date = Date.today)
-    HTTP.post(service_url,
-              json: {
-                      "contractNumber": ColissimoLabel.contract_number,
-                      "password":       ColissimoLabel.contract_password,
-                      "outputFormat":   {
-                        "x":                  '0',
-                        "y":                  '0',
-                        "outputPrintingType": @label_output_format
-                      },
-                      "letter":         {
-                                          "service":   {
-                                            "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,
-                                                         "pickupLocationId": @pickup_id,
-                                                         "insuranceValue":   @insurance_value
-                                                       }.compact,
-                                          "sender":    {
-                                            "address": format_sender
-                                          },
-                                          "addressee": {
-                                            "address": format_addressee
-                                          }
-                                        }.merge(customs_letter)
-                    }.merge(customs_fields)
-                     .compact)
+    HTTP.post(service_url, json: build_colissimo_payload(delivery_date))
+  end
+
+  def build_colissimo_payload(delivery_date = Date.today)
+    {
+      "contractNumber": ColissimoLabel.contract_number,
+      "password":       ColissimoLabel.contract_password,
+      "outputFormat":   {
+        "x":                  '0',
+        "y":                  '0',
+        "outputPrintingType": @label_output_format
+      },
+      "letter":         {
+                          "service":   {
+                            "commercialName":   @sender_data[:company_name],
+                            "productCode":      @product_code.presence || product_code,
+                            "depositDate":      delivery_date.strftime('%F'),
+                            "totalAmount":      (@shipping_fees * 100).to_i,
+                            "returnTypeChoice": '2', # Retour à la maison en prioritaire
+                            "orderNumber": @order_id
+                          },
+                          "parcel":    {
+                                         "weight":           @weight,
+                                         "pickupLocationId": @pickup_id,
+                                         "insuranceValue":   @insurance_value
+                                       }.compact,
+                          "sender":    {
+                                         "senderParcelRef": @sender_ref_id,
+                                         "address":         format_sender
+                                       }.compact,
+                          "addressee": {
+                                         "addresseeParcelRef": @addressee_ref_id,
+                                         "address":            format_addressee
+                                       }.compact
+                        }.merge(customs_declaration)
+    }.merge(customs_fields).compact
   end
 
   # Services =>
@@ -133,10 +169,13 @@ class ColissimoLabel::GenerateLabel
       "companyName": @sender_data[:company_name],
       "lastName":    @sender_data[:last_name],
       "firstName":   @sender_data[:first_name],
+      "line0":       @sender_data[:apartment],
+      "line1":       @sender_data[:address_bis],
       "line2":       @sender_data[:address],
       "city":        @sender_data[:city],
       "zipCode":     @sender_data[:postcode],
-      "countryCode": @sender_data[:country_code]
+      "countryCode": @sender_data[:country_code],
+      "phoneNumber": @sender_data[:phone].presence || @sender_data[:mobile]
     }.compact.transform_values(&:strip)
   end
 
@@ -152,7 +191,7 @@ class ColissimoLabel::GenerateLabel
       "countryCode": @addressee_data[:country_code], # Code ISO du pays
       "city": @addressee_data[:city], # Ville
       "zipCode": @addressee_data[:postcode], # Code postal
-      "phoneNumber": @addressee_data[:phone], # Numéro de téléphone
+      "phoneNumber": @addressee_data[:phone].presence || @addressee_data[:mobile], # Numéro de téléphone
       "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
@@ -166,41 +205,42 @@ class ColissimoLabel::GenerateLabel
     if require_customs?
       @customs_total_weight
     else
-      @total_weight ? @total_weight : '0.1'
+      @total_weight.presence || '0.1'
     end
   end
 
   # Déclaration douanière de type CN23
-  def customs_letter
+  def customs_declaration
     if require_customs?
       {
-        "customsDeclarations": {
-          "includeCustomsDeclarations": 1, # Inclure déclaration,
-          "importersReference": @customs_tva_number, # Numéro TVA pour la douane, si besoin
-          "contents": {
-            "article":  @customs_data.map { |customs|
-              {
-                "description":   customs[:description],
-                "quantity":      customs[:quantity]&.to_i,
-                "weight":        customs[:weight]&.to_f.round(2),
-                "value":         customs[:item_price]&.to_f.round(2),
-                "originCountry": customs[:country_code],
-                "currency":      customs[:currency_code],
-                "hsCode":        customs[:customs_code] # Objets d'art, de collection ou d'antiquité (https://pro.douane.gouv.fr/prodouane.asp)
+        "customsDeclarations":
+          {
+            "includeCustomsDeclarations": 1, # Inclure déclaration
+            "importersReference": @customs_tva_number, # Numéro TVA pour la douane, si besoin
+            "contents": {
+              "article":  @customs_data.map { |product_customs|
+                {
+                  "description":   product_customs[:description],
+                  "quantity":      product_customs[:quantity]&.to_i,
+                  "weight":        product_customs[:weight]&.to_f.round(2),
+                  "value":         product_customs[:item_price]&.to_f.round(2),
+                  "originCountry": product_customs[:country_code],
+                  "currency":      product_customs[:currency_code],
+                  "hsCode":        product_customs[:customs_code].presence
+                }.compact
+              },
+              "category": {
+                # Nature de l'envoi
+                # 1 => Cadeau
+                # 2 => Echantillon commercial
+                # 3 => Envoi commercial
+                # 4 => Document
+                # 5 => Autre
+                # 6 => Retour de marchandise
+                "value": @customs_category
               }
-            },
-            "category": {
-              # Nature de l'envoi
-              # 1 => Cadeau
-              # 2 => Echantillon commercial
-              # 3 => Envoi commercial
-              # 4 => Document
-              # 5 => Autre
-              # 6 => Retour de marchandise
-              "value": 3
             }
-          }
-        }
+          }.compact
       }
     else
       {}
@@ -208,7 +248,7 @@ class ColissimoLabel::GenerateLabel
   end
 
   def customs_fields
-    if require_customs?
+    if require_customs? && @eori_number.present?
       {
         "fields": {
           "customField": [
@@ -225,7 +265,7 @@ class ColissimoLabel::GenerateLabel
   end
 
   def require_customs?
-    %w[CH NO US GB].include?(@destination_country)
+    @customs_data.present? || %w[CH NO US GB].include?(@destination_country)
   end
 
   # Certains pays, comme l'Allemagne, requiert une signature pour la livraison

data/lib/colissimo_label/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: colissimo_label
 version: !ruby/object:Gem::Version
-  version: 0.19.0
+  version: 0.20.0
 platform: ruby
 authors:
 - FloXcoder
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-04-09 00:00:00.000000000 Z
+date: 2022-10-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -25,21 +25,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2'
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: http
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5'
+        version: '4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5'
+        version: '4'
 - !ruby/object:Gem::Dependency
-  name: railties
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -53,19 +53,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '5'
 - !ruby/object:Gem::Dependency
-  name: http
+  name: railties
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '4'
+        version: '5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '4'
+        version: '5'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -112,16 +112,16 @@ dependencies:
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.17'
+        version: '0.16'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.17'
+        version: '0.16'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
@@ -182,7 +182,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.3.22
 signing_key: 
 specification_version: 4
 summary: Generate Colissimo label for all countries