Class: Etracking::Client

Inherits:
Object
  • Object
show all
Defined in:
lib/etracking/client.rb

Overview

API Client of eTracking SDK for Ruby

@client ||= Etracking::Client.new do |config|
   config.api_key = ENV["etracking_api_key"]
   config.key_secret = ENV["etracking_key_secret"]
   config.language = ENV["etracking_language"] || 'TH'
end

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options = {}) {|_self| ... } ⇒ Etracking::Client

Initialize a new client.

Parameters:

  • options (Hash) (defaults to: {})

Yields:

  • (_self)

Yield Parameters:



23
24
25
26
27
28
 
# File 'lib/etracking/client.rb', line 23

def initialize(options = {})
  options.each do |key, value|
    instance_variable_set("@#{key}", value)
  end
  yield(self) if block_given?
end

Instance Attribute Details

#api_key ⇒ Object

@return [String]



17
18
19
 
# File 'lib/etracking/client.rb', line 17

def api_key
  @api_key
end

#key_secret ⇒ Object

@return [String]



17
18
19
 
# File 'lib/etracking/client.rb', line 17

def key_secret
  @key_secret
end

#language ⇒ Object

@return [String]



17
18
19
 
# File 'lib/etracking/client.rb', line 17

def language
  @language
end

Instance Method Details

#auto_detect(tracking_number) ⇒ Object 



54
55
56
 
# File 'lib/etracking/client.rb', line 54

def auto_detect(tracking_number)
  rest_api('/auto_detect', payload_tracking_number(tracking_number))
end

#dhl_express(tracking_number) ⇒ Object 



66
67
68
 
# File 'lib/etracking/client.rb', line 66

def dhl_express(tracking_number)
  rest_api('/dhl_express', payload_tracking_number(tracking_number))
end

#endpoint ⇒ Object 



30
31
32
 
# File 'lib/etracking/client.rb', line 30

def endpoint
  'https://api.etrackings.com/v2/tracks'
end

#flash_express(tracking_number) ⇒ Object 



70
71
72
 
# File 'lib/etracking/client.rb', line 70

def flash_express(tracking_number)
  rest_api('/flash_express', payload_tracking_number(tracking_number))
end

#jt_express(tracking_number) ⇒ Object 



74
75
76
 
# File 'lib/etracking/client.rb', line 74

def jt_express(tracking_number)
  rest_api('/jt_express', payload_tracking_number(tracking_number))
end

#kerry_express(tracking_number) ⇒ Object 



78
79
80
 
# File 'lib/etracking/client.rb', line 78

def kerry_express(tracking_number)
  rest_api('/kerry_express', payload_tracking_number(tracking_number))
end

#lazada_express(tracking_number) ⇒ Object 



82
83
84
 
# File 'lib/etracking/client.rb', line 82

def lazada_express(tracking_number)
  rest_api('/lazada_express', payload_tracking_number(tracking_number))
end

#payload_tracking_number(tracking_number) ⇒ Object 



112
113
114
115
116
 
# File 'lib/etracking/client.rb', line 112

def payload_tracking_number(tracking_number)
  {
    tracking_number: tracking_number
  }
end

#payload_with_courier_and_tracking_number(courier, tracking_number) ⇒ Object 



105
106
107
108
109
110
 
# File 'lib/etracking/client.rb', line 105

def payload_with_courier_and_tracking_number(courier, tracking_number)
  {
    courier: courier,
    tracking_number: tracking_number
  }
end

#payload_with_courier_and_tracking_numbers(courier, tracking_numbers) ⇒ Object 



98
99
100
101
102
103
 
# File 'lib/etracking/client.rb', line 98

def payload_with_courier_and_tracking_numbers(courier, tracking_numbers)
  {
    courier: courier,
    tracking_numbers: tracking_numbers
  }
end

#rest_api(path, payload) ⇒ Object 



34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
 
# File 'lib/etracking/client.rb', line 34

def rest_api(path, payload)
  api_key_required
  key_secret_required

  url = URI("#{endpoint}#{path}")

  https = Net::HTTP.new(url.host, url.port);
  https.use_ssl = true

  request = Net::HTTP::Post.new(url)
  request["etracking-api-key"] = api_key
  request["etracking-key-secret"] = key_secret
  request["accept-language"] = language || 'th'
  request["content-type"] = ["application/json", "text/plain"]
  request.body = payload.to_json
  response = https.request(request)

  JSON.parse(response.read_body, { symbolize_names: true } )
end

#scg_express(tracking_number) ⇒ Object 



86
87
88
 
# File 'lib/etracking/client.rb', line 86

def scg_express(tracking_number)
  rest_api('/scg_express', payload_tracking_number(tracking_number))
end

#shopee_express(tracking_number) ⇒ Object 



90
91
92
 
# File 'lib/etracking/client.rb', line 90

def shopee_express(tracking_number)
  rest_api('/shopee_express', payload_tracking_number(tracking_number))
end

#thailand_post(tracking_number) ⇒ Object 



94
95
96
 
# File 'lib/etracking/client.rb', line 94

def thailand_post(tracking_number)
  rest_api('/thailand_post', payload_tracking_number(tracking_number))
end

#track(courier, tracking_number) ⇒ Object 



62
63
64
 
# File 'lib/etracking/client.rb', line 62

def track(courier, tracking_number)
  rest_api('/find', payload_with_courier_and_tracking_number(courier, tracking_number))
end

#tracks(courier, tracking_numbers = []) ⇒ Object 



58
59
60
 
# File 'lib/etracking/client.rb', line 58

def tracks(courier, tracking_numbers = [])
  rest_api('', payload_with_courier_and_tracking_numbers(courier, tracking_number))
end