ruby-gls 0.0.4 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1161f9e8417e9964244f2a7fe0ba28547ca155297d892276ea5619dc0f78c8e8
-  data.tar.gz: de9369a3e933f084461833e680fb5e06658ded3878a9678240a2ed540adf7155
+  metadata.gz: ec195d660c69f8c4dfc010c87d6c38127949c715f2bbfde62d29947472d368b1
+  data.tar.gz: 537ca2fc2af3c33bf7bf5012eae7a5db4111a4fceba7a0b28dc884c3ee9a6c42
 SHA512:
-  metadata.gz: afff4c8d267a2c90601f241a44902f2607058ff192177ef58f4ffb3d793f3dadc86c027f99c40f4538444703e68458cfedde32d370ffdbc3fe2f876756fd4d88
-  data.tar.gz: 43b9bca4b55b8503f7107987cd7bd0eedb6c5068e1370cc2c0632310be5b66d58b2d833ad6c432739bbb95ac2499d02b9a5489f5d62053ef31270ecfce064885
+  metadata.gz: 9d7dd576e9a242a0a50f8647e61a2eb6960dde01f04d49847cbed92e1c9705fb5030651a43515722ce82fe2df08b5ccba90a52bfc081ef1bc13db5528dd944a9
+  data.tar.gz: 9135769d192ce68080d42454d13f462f6196e84209ee3805c338069e81dabbb74a56660de57e0e4e4fcb4ec1c413feabd062b4a2b9387e077845dcf916bd7afd

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,69 @@
+require 'ruby-gls/helper'
+
+class RubyGLS::Connection
+  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='0.0.4'
+  VERSION='1.0.3'
 end

data/lib/ruby-gls.rb

@@ -1,69 +1,12 @@
-require 'net/http'
-require 'json'
-
 require 'ruby-gls/version'
 require 'ruby-gls/configuration'
-require 'nokogiri'
+require 'ruby-gls/tracking'
+require 'ruby-gls/client'
+require 'ruby-gls/connection'
+require 'ruby-gls/url'
 
 class RubyGLS
+  extend Tracking
+  
   RubyGLS.configure
-
-  class << self
-
-    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

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: ruby-gls
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 1.0.3
 platform: ruby
 authors:
 - Adem Dinarevic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-06-28 00:00:00.000000000 Z
+date: 2022-07-22 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -46,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: