colissimo_label 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5e90802f1cf838c12269ba5ec5727101638c5b06599cbe886bd7eed2829a5778
-  data.tar.gz: cdb13594e2d12b5ffa8d054fb47d5a30c6ed086f8d94505d993adb0ddd69dae3
+  metadata.gz: 6b20cf6d60590b5b229d08dca579e8526540718702f0818282369af8de9568d7
+  data.tar.gz: 6138fdc5edc70493a52af72104ce6df8a5b8f6f060779d5eb3baf63821bae8ae
 SHA512:
-  metadata.gz: 9748ea47123020040a4fa91d90514f3db0badc6c745df86115af7e7d2c4dda8444cd11bf4828be4882430af31f14ab984edc5b1e90bbb78eba8cff75350cd03d
-  data.tar.gz: 1fd5976d56c2ab40cf079aeb55409d17212c28809f98dc770f40fd680180b3445e703987d1fe9d26f1a0a7c2a09f58a1a6adaaac66badae6657302fa37e232e8
+  metadata.gz: a4eb97e5a3e6d55a8fe22895bfb31b6cd7a5d5df0f7c6b21ee8edf40ed5b1e655c1aef84dd2d9017474ae240d51c96d49f46e4cdfef3dca7c8a3d505472b1bb0
+  data.tar.gz: 2b68731fb099899fe85e593dcfc6412e857cc02eb5cd28fec1d838681e11cc1adfb67a12dbe1a5481877f96908f1f01122228a3a7d683096a0237ddf723be6a4

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.4.0
+
+- Add `ColissimoLabel::FindRelayPoint` class to fetch available relay points around an address
+
 ## 0.3.0
 
 - Incorrect README method

data/README.md

@@ -58,6 +58,55 @@ ColissimoLabel.colissimo_local_path = Rails.root.join('public', 'colissimo')
 
 ## Usage
 
+### Fetch relay points
+
+Colissimo webservices provides all relay points around an address.
+
+To get all available relay :
+
+```ruby
+ relay_points = ColissimoLabel::FindRelayPoint.new(
+         {
+           address:      'Address',
+           city:         'City',
+           postcode:     'Postcode',
+           country_code: 'Normalized country code (ex: FR)'
+         },
+         (Date.today + 5.days).strftime('%d/%m/%Y'), # Estimated departure date of the package
+         1000 # Computed weight of the package (in grams)
+       ).perform
+```
+
+It will return an array of relay points with the following data:
+
+```ruby
+{
+        :pickup_id,
+        :name,
+        :address,
+        :postcode,
+        :city,
+        :country,
+        :country_code,
+        :latitude,
+        :longitude,
+        :distance,
+        :max_weight,
+        :parking,
+        business_hours: {
+          :monday,
+          :tuesday,
+          :wednesday,
+          :thursday,
+          :friday,
+          :saturday,
+          :sunday
+        }
+      }
+```
+
+### Generate Colissimo label
+
 To generate a new Colissimo label, use the following methods.
 
 For a national address:
@@ -72,7 +121,7 @@ parcel_number = ColissimoLabel::GenerateLabel.new(
           address:      'Address',
           city:         'City',
           postcode:     'Postcode',
-          country_code: 'Normalized country code'
+          country_code: 'Normalized country code (ex: FR)'
         },
         {
           last_name:    'Last name of the addressee',
@@ -101,7 +150,7 @@ parcel_number = ColissimoLabel::GenerateLabel.new(
           address:      'Address',
           city:         'City',
           postcode:     'Postcode',
-          country_code: 'Normalized country code'
+          country_code: 'Normalized country code (ex: DE)'
         },
         {
           last_name:    'Last name of the addressee',

data/lib/colissimo_label/find_relay_point.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+require 'http'
+
+class ColissimoLabel::FindRelayPoint
+
+  def initialize(addressee_data, estimated_delivery_date, weight_package)
+    @addressee_data          = addressee_data
+    @estimated_delivery_date = estimated_delivery_date
+    @weight_package          = weight_package
+    @errors                  = []
+  end
+
+  def perform
+    response      = perform_request
+    status        = response.code
+    soap_response = response.to_param
+
+    raise StandardError, soap_response if status != 200
+
+    parse         = Nokogiri::XML(soap_response)
+    root          = parse.root
+    error_code    = root.xpath('//errorCode').text
+    error_message = root.xpath('//errorMessage').text
+
+    raise StandardError, error_message if error_code != '0'
+
+    root.xpath('//listePointRetraitAcheminement').map do |point|
+      {
+        pickup_id:      point.at_xpath('identifiant').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,
+        city:           point.at_xpath('localite').text,
+        country:        point.at_xpath('libellePays').text,
+        country_code:   point.at_xpath('codePays').text,
+        latitude:       point.at_xpath('coordGeolocalisationLatitude').text.to_f,
+        longitude:      point.at_xpath('coordGeolocalisationLongitude').text.to_f,
+        distance:       point.at_xpath('distanceEnMetre').text.to_i,
+        max_weight:     point.at_xpath('poidsMaxi').text.to_i,
+        parking:        point.at_xpath('parking').text.to_b,
+        business_hours: {
+          monday:    point.at_xpath('horairesOuvertureLundi').text,
+          tuesday:   point.at_xpath('horairesOuvertureMardi').text,
+          wednesday: point.at_xpath('horairesOuvertureMercredi').text,
+          thursday:  point.at_xpath('horairesOuvertureJeudi').text,
+          friday:    point.at_xpath('horairesOuvertureVendredi').text,
+          saturday:  point.at_xpath('horairesOuvertureSamedi').text,
+          sunday:    point.at_xpath('horairesOuvertureDimanche').text
+        }
+      }
+    end
+  end
+
+  private
+
+  def perform_request
+    HTTP.get(service_url,
+             params: {
+                       accountNumber: ColissimoLabel.contract_number,
+                       password:      ColissimoLabel.contract_password,
+                       address:       @addressee_data[:address],
+                       zipCode:       @addressee_data[:postcode],
+                       city:          @addressee_data[:city],
+                       countryCode:   @addressee_data[:country_code],
+                       shippingDate:  @estimated_delivery_date,
+                       weight:        @weight_package
+                     }.compact)
+  end
+
+  # Services =>
+  # findRDVPointRetraitAcheminement : à partir d’une adresse postale fournie en entrée, restitue les points de retrait les plus proches de cette adresse
+  # findPointRetraitAcheminementByID : à partir d’un Identifiant de Point Retrait (identifiant Point Retrait), restitue le détail des informations associé au Point Retrait transmis
+  def service_url(service = 'findRDVPointRetraitAcheminement')
+    "https://ws.colissimo.fr/pointretrait-ws-cxf/PointRetraitServiceWS/2.0/#{service}"
+  end
+
+end

data/lib/colissimo_label/version.rb

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

data/lib/colissimo_label.rb

@@ -3,6 +3,7 @@
 require 'active_support'
 
 require 'colissimo_label/version'
+require 'colissimo_label/find_relay_point'
 require 'colissimo_label/generate_label'
 
 module ColissimoLabel

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: colissimo_label
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - FloXcoder
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-07-09 00:00:00.000000000 Z
+date: 2019-07-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -159,6 +159,7 @@ files:
 - bin/setup
 - colissimo_label.gemspec
 - lib/colissimo_label.rb
+- lib/colissimo_label/find_relay_point.rb
 - lib/colissimo_label/generate_label.rb
 - lib/colissimo_label/logger.rb
 - lib/colissimo_label/version.rb