ruby-gls 1.0.2 → 1.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9b7cde32a4268f0464679ee590c06a28e88347dd4679ec53f508ad9c04bc93eb
-  data.tar.gz: 51d153dc3da485baed746ee194958311c454d8913752adc31680323458627e4d
+  metadata.gz: 6accd06ac3fecb994bf65820e2a2387c20694fac5c87ad5aa794195957623c46
+  data.tar.gz: 00ce366ae98be2d9988fc673f216ff94b1b8cf0ad61f5783daa04ce347f9aba1
 SHA512:
-  metadata.gz: b44a115a0ba6af3b3a1324754026457be216645c04b997c1d8cb7bb3c66031137eb600777f80c4264d8ff750b7b86f31801b6280eafdb8021103e7d0dfbb1166
-  data.tar.gz: 7598bc94db828061be69c75fdbc4b304d22ef0f9ffb5e20762d5df75d1fcd4e5897c248b737cd5469a4b97f97ddbfe537aadbe47709ba150ef093fc8bd97ffa7
+  metadata.gz: 6bdfce2fe2f2ae250ae9adebfabd31dab844fa9bcea37e12fe824a88489409cab24c392fd199e2d5f79fe6ff57cd396d54d66b95be57a5c5a541388d8130a7c9
+  data.tar.gz: bee48c83d3b8e59df1101c0b38a01c8bb837fea4b3a039a45cd420b3be056d0d5a60b17af7fa0806f79db982e92a2462f50d75dae7f88ab469e0ce7290fb7669

data/lib/ruby-gls/client.rb

@@ -0,0 +1,65 @@
+require 'rest-client'
+require 'json'
+require "base64"
+
+class RubyGLS::Client
+  
+  attr_reader :base_url, :basic_auth, :username, :password, :contact_id
+
+  def initialize(base_url, basic_auth, username, password, contact_id)
+    @base_url = base_url
+    @basic_auth = basic_auth
+    @username = username
+    @password = password
+    @contact_id = contact_id
+
+    raise ArgumentError('Either basic_auth or username and password not provided') unless basic_auth || (username && password)
+  end
+
+  def action(path, http_method: :post, payload: {})
+    begin 
+      response = ::RestClient::Request.execute(
+        method: http_method,
+        url: full_url(path),
+        payload: payload.to_json,
+        headers: headers,
+        timeout: 5,
+        verify_ssl: ::OpenSSL::SSL::VERIFY_NONE
+      )
+    rescue => e
+      return struct_response.new(false, { error: e.message })
+    end
+
+    parse(response)
+  end
+
+  def get_basic_auth
+    return basic_auth if basic_auth
+
+    Base64.encode64("#{username}:#{password}")
+  end
+
+  def headers
+    {
+      'User-Agent': "RubyGLS client v#{RubyGLS::VERSION})",
+      'Content-Type': 'application/glsVersion1+json',
+      'Accept': 'application/glsVersion1+json, application/json',
+      'Authorization': "Basic #{get_basic_auth}"
+    }
+  end
+
+  def full_url(path)
+    "#{base_url}#{path}"
+  end
+
+  def parse(response)
+    success       = (200..308).to_a.include?(response.code.to_i) ? true : false
+    hash_response = JSON.parse(response.body)
+
+    struct_response.new(success, hash_response)
+  end
+
+  def struct_response
+    Struct.new(:success?, :hash_response)
+  end
+end

data/lib/ruby-gls/connection.rb

@@ -0,0 +1,71 @@
+require 'ruby-gls/helper'
+require 'ruby-gls/tracking'
+
+class RubyGLS::Connection
+  extend RubyGLS::Tracking
+  include RubyGLS::Helper
+
+  attr_reader :client
+
+  def initialize(base_url:, basic_auth: nil, username: nil, password: nil, contact_id: nil)
+    @client = RubyGLS::Client.new(base_url, basic_auth, username, password, contact_id)
+  end
+
+  #
+  # https://shipit.gls-group.eu/webservices/3_0_6/doxygen/WS-REST-API/rest_shipment_processing.html#REST_API_REST_F_114
+  #
+  def create_parcel(**opts)
+    payload = opts 
+    payload[:Shipment][:Shipper][:ContactID] = client.contact_id
+    
+    action(RubyGLS::URL::CREATE_PARCEL, payload: payload)
+  end
+  
+  #
+  # https://shipit.gls-group.eu/webservices/3_0_6/doxygen/WS-REST-API/rest_shipment_processing.html#REST_API_REST_F_115
+  #
+  def validate_parcels(**opts)
+    payload = opts 
+    payload[:Shipment][:Shipper][:ContactID] = client.contact_id
+
+    action(RubyGLS::URL::VALIDATE_PARCELS, payload: opts)
+  end
+
+  #
+  # https://shipit.gls-group.eu/webservices/3_0_6/doxygen/WS-REST-API/rest_shipment_processing.html#REST_API_REST_F_117
+  #
+  def get_allowed_services(**opts)
+    action(RubyGLS::URL::GET_ALLOWED_SERVICES, payload: opts)
+  end
+
+  #
+  # https://shipit.gls-group.eu/webservices/3_0_6/doxygen/WS-REST-API/rest_shipment_processing.html#REST_API_REST_F_116
+  #
+  def cancel_parcel(tracking_number)
+    path = replace_string(RubyGLS::URL::CANCEL_PARCEL, ':parcel_id', tracking_number)
+
+    action(RubyGLS::URL::CANCEL_PARCEL)
+  end
+
+  #    
+  # https://shipit.gls-group.eu/webservices/3_0_6/doxygen/WS-REST-API/rest_shipment_processing.html#REST_API_REST_F_119
+  #
+  def update_parcel_weight(**opts)
+    action(RubyGLS::URL::UPDATE_PARCEL_WEIGHT, payload: opts)
+  end
+
+  #
+  # https://shipit.gls-group.eu/webservices/3_0_6/doxygen/WS-REST-API/rest_shipment_processing.html#REST_API_REST_F_118
+  #
+  def get_end_of_day_report(date)
+    path = replace_string(RubyGLS::URL::GET_END_OF_DAY_REPORT, ':date', date)
+    
+    action(path)
+  end
+
+  private
+
+  def action(path, payload: {})
+    client.action(path, payload: payload)
+  end
+end

data/lib/ruby-gls/helper.rb

@@ -0,0 +1,7 @@
+class RubyGLS
+  module Helper
+    def replace_string(full, substring, to_replace)
+      full.sub!(substring, to_replace.to_s)
+    end
+  end
+end

data/lib/ruby-gls/tracking.rb

@@ -0,0 +1,62 @@
+require 'net/http'
+require 'json'
+require 'nokogiri'
+
+class RubyGLS
+  module Tracking
+    def find(tracking_number)
+      uri = URI(generate_url(tracking_number))
+      res  = Net::HTTP.get_response(uri)
+      
+      parsed = JSON.parse(res.body)
+
+      key = parsed.dig('content').keys.last
+      html = parsed.dig('content', key, 'html')
+
+      doc = Nokogiri::HTML(html)
+      
+      status = doc.css('.trigger-status').text.strip
+      status_desc = doc.css('.text-primary.lead strong').text.strip
+      parcel_number = doc.css('.row.justify-content-left').text&.strip&.split(':')&.last&.strip
+
+      detailed = [].tap do |arr|
+        doc.css('.data_table tbody tr').each do |row|
+          
+          date, time, parcel_status, loc = row.css('td').map(&:text).map(&:strip)
+          
+          arr << {
+            date: date,
+            time: time,
+            parcel_status: parcel_status,
+            location: loc
+          }
+        end
+      end
+      
+      if status == ""
+        status      = 'Not found' 
+        status_desc = "No tracking information found for #{tracking_number}"
+      end
+
+      {
+        tracking_number: tracking_number,
+        status: status,
+        status_description: status_desc,
+        parcel_number: parcel_number,
+        detailed_tracking: detailed
+      }
+    rescue => e
+      {
+        tracking_number: tracking_number,
+        status: 'Not found',
+        status_description: "#{e.message}"
+      }
+    end
+
+    private
+
+    def generate_url(tracking_number)
+      RubyGLS.config.base_url + "&match=#{tracking_number}"
+    end
+  end
+end

data/lib/ruby-gls/url.rb

@@ -0,0 +1,8 @@
+module RubyGLS::URL
+  CREATE_PARCEL         = '/backend/rs/shipments'
+  CANCEL_PARCEL         = '/backend/rs/shipments/cancel/:parcel_id'
+  GET_ALLOWED_SERVICES  = '/backend/rs/shipments/allowedservices'
+  VALIDATE_PARCELS      = '/backend/rs/shipments/validate'
+  GET_END_OF_DAY_REPORT = '/backend/rs/shipments/endofday?date=:date'
+  UPDATE_PARCEL_WEIGHT  = '/backend/rs/shipments/updateparcelweight'
+end

data/lib/ruby-gls/version.rb

@@ -1,3 +1,3 @@
 class RubyGLS
-  VERSION='1.0.2'
+  VERSION='1.0.5'
 end

data/lib/ruby-gls.rb

@@ -1,12 +1,9 @@
 require 'ruby-gls/version'
 require 'ruby-gls/configuration'
-require 'ruby-gls/tracking'
 require 'ruby-gls/client'
 require 'ruby-gls/connection'
 require 'ruby-gls/url'
 
-class RubyGLS
-  extend Tracking
-  
+class RubyGLS  
   RubyGLS.configure
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby-gls
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.5
 platform: ruby
 authors:
 - Adem Dinarevic
@@ -60,7 +60,12 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/ruby-gls.rb
+- lib/ruby-gls/client.rb
 - lib/ruby-gls/configuration.rb
+- lib/ruby-gls/connection.rb
+- lib/ruby-gls/helper.rb
+- lib/ruby-gls/tracking.rb
+- lib/ruby-gls/url.rb
 - lib/ruby-gls/version.rb
 homepage: https://github.com/ademdc/ruby-gls
 licenses: