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 



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

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

#dhl_express(tracking_number) ⇒ Object 



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

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://etrackings.com/api/v2/tracks'
end

#flash_express(tracking_number) ⇒ Object 



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

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

#jt_express(tracking_number) ⇒ Object 



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

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

#kerry_express(tracking_number) ⇒ Object 



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

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

#lazada_express(tracking_number) ⇒ Object 



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

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

#payload_tracking_number(tracking_number) ⇒ Object 



115
116
117
118
119
 
# File 'lib/etracking/client.rb', line 115

def payload_tracking_number(tracking_number)
  {
    tracking_number: tracking_number
  }
end

#payload_with_courier_and_tracking_number(courier, tracking_number) ⇒ Object 



108
109
110
111
112
113
 
# File 'lib/etracking/client.rb', line 108

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 



101
102
103
104
105
106
 
# File 'lib/etracking/client.rb', line 101

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
53
54
55
 
# File 'lib/etracking/client.rb', line 34

def rest_api(path, payload)
  api_key_required
  key_secret_required

  uri = URI.parse("#{endpoint}#{path}")
  request = Net::HTTP::Post.new(uri)
  request.content_type = "application/json"
  request["Etracking-Api-Key"] = api_key
  request["Etracking-Key-Secret"] = key_secret
  request["Accept-Language"] = language || 'th'
  request.body = payload.to_json
  
  req_options = {
    use_ssl: uri.scheme == "https",
  }
  
  response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http|
    http.request(request)
  end

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

#scg_express(tracking_number) ⇒ Object 



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

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

#shopee_express(tracking_number) ⇒ Object 



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

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

#thailand_post(tracking_number) ⇒ Object 



97
98
99
 
# File 'lib/etracking/client.rb', line 97

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

#track(courier, tracking_number) ⇒ Object 



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

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

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



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

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