Class: OzonLogistics::Request

Inherits:
Object
  • Object
show all
Defined in:
lib/ozon-logistics/request.rb

Constant Summary collapse

DEFAULT_TIMEOUT =
60
DEFAULT_OPEN_TIMEOUT =
60

Class Attribute Summary collapse

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(access_token: nil, api_endpoint: nil, timeout: nil, open_timeout: nil, proxy: nil, faraday_adapter: nil, symbolize_keys: false, debug: false, logger: nil, test: false) ⇒ Request

Returns a new instance of Request.



8
9
10
11
12
13
14
15
16
17
18
19
20
21
# File 'lib/ozon-logistics/request.rb', line 8

def initialize(access_token: nil, api_endpoint: nil, timeout: nil, open_timeout: nil, proxy: nil, faraday_adapter: nil, symbolize_keys: false, debug: false, logger: nil, test: false)
  @path_parts = []
  @access_token = access_token || self.class.access_token || OzonLogistics.generate_access_token.try(:dig, "access_token")
  @access_token = @access_token.strip if @access_token
  @api_endpoint = api_endpoint || self.class.api_endpoint
  @timeout = timeout || self.class.timeout || DEFAULT_TIMEOUT
  @open_timeout = open_timeout || self.class.open_timeout || DEFAULT_OPEN_TIMEOUT
  @proxy = proxy || self.class.proxy || ENV['OZON_LOGISTICS_PROXY']
  @faraday_adapter = faraday_adapter || self.class.faraday_adapter || Faraday.default_adapter
  @symbolize_keys = symbolize_keys || self.class.symbolize_keys || false
  @debug = debug || self.class.debug || false
  @test = test || self.class.test || false
  @logger = logger || self.class.logger || ::Logger.new(STDOUT)
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

#method_missing(method, *args) ⇒ Object



23
24
25
26
27
28
29
# File 'lib/ozon-logistics/request.rb', line 23

def method_missing(method, *args)
  # To support underscores, we replace them with hyphens when calling the API
  @path_parts << method.to_s.gsub("_", "-").downcase
  @path_parts << args if args.length > 0
  @path_parts.flatten!
  self
end

Class Attribute Details

.access_tokenObject

Returns the value of attribute access_token.



84
85
86
# File 'lib/ozon-logistics/request.rb', line 84

def access_token
  @access_token
end

.api_endpointObject

Returns the value of attribute api_endpoint.



84
85
86
# File 'lib/ozon-logistics/request.rb', line 84

def api_endpoint
  @api_endpoint
end

.debugObject

Returns the value of attribute debug.



84
85
86
# File 'lib/ozon-logistics/request.rb', line 84

def debug
  @debug
end

.faraday_adapterObject

Returns the value of attribute faraday_adapter.



84
85
86
# File 'lib/ozon-logistics/request.rb', line 84

def faraday_adapter
  @faraday_adapter
end

.loggerObject

Returns the value of attribute logger.



84
85
86
# File 'lib/ozon-logistics/request.rb', line 84

def logger
  @logger
end

.open_timeoutObject

Returns the value of attribute open_timeout.



84
85
86
# File 'lib/ozon-logistics/request.rb', line 84

def open_timeout
  @open_timeout
end

.proxyObject

Returns the value of attribute proxy.



84
85
86
# File 'lib/ozon-logistics/request.rb', line 84

def proxy
  @proxy
end

.symbolize_keysObject

Returns the value of attribute symbolize_keys.



84
85
86
# File 'lib/ozon-logistics/request.rb', line 84

def symbolize_keys
  @symbolize_keys
end

.testObject

Returns the value of attribute test.



84
85
86
# File 'lib/ozon-logistics/request.rb', line 84

def test
  @test
end

.timeoutObject

Returns the value of attribute timeout.



84
85
86
# File 'lib/ozon-logistics/request.rb', line 84

def timeout
  @timeout
end

Instance Attribute Details

#access_tokenObject

Returns the value of attribute access_token.



3
4
5
# File 'lib/ozon-logistics/request.rb', line 3

def access_token
  @access_token
end

#api_endpointObject

Returns the value of attribute api_endpoint.



3
4
5
# File 'lib/ozon-logistics/request.rb', line 3

def api_endpoint
  @api_endpoint
end

#debugObject

Returns the value of attribute debug.



3
4
5
# File 'lib/ozon-logistics/request.rb', line 3

def debug
  @debug
end

#faraday_adapterObject

Returns the value of attribute faraday_adapter.



3
4
5
# File 'lib/ozon-logistics/request.rb', line 3

def faraday_adapter
  @faraday_adapter
end

#loggerObject

Returns the value of attribute logger.



3
4
5
# File 'lib/ozon-logistics/request.rb', line 3

def logger
  @logger
end

#open_timeoutObject

Returns the value of attribute open_timeout.



3
4
5
# File 'lib/ozon-logistics/request.rb', line 3

def open_timeout
  @open_timeout
end

#proxyObject

Returns the value of attribute proxy.



3
4
5
# File 'lib/ozon-logistics/request.rb', line 3

def proxy
  @proxy
end

#symbolize_keysObject

Returns the value of attribute symbolize_keys.



3
4
5
# File 'lib/ozon-logistics/request.rb', line 3

def symbolize_keys
  @symbolize_keys
end

#testObject

Returns the value of attribute test.



3
4
5
# File 'lib/ozon-logistics/request.rb', line 3

def test
  @test
end

#timeoutObject

Returns the value of attribute timeout.



3
4
5
# File 'lib/ozon-logistics/request.rb', line 3

def timeout
  @timeout
end

Class Method Details

.method_missing(sym, *args, &block) ⇒ Object



86
87
88
# File 'lib/ozon-logistics/request.rb', line 86

def method_missing(sym, *args, &block)
  new(access_token: self.access_token, api_endpoint: self.api_endpoint, timeout: self.timeout, open_timeout: self.open_timeout, faraday_adapter: self.faraday_adapter, symbolize_keys: self.symbolize_keys, debug: self.debug, proxy: self.proxy, logger: self.logger, test: self.test).send(sym, *args, &block)
end

.respond_to_missing?(method_name, include_private = false) ⇒ Boolean

Returns:

  • (Boolean)


90
91
92
# File 'lib/ozon-logistics/request.rb', line 90

def respond_to_missing?(method_name, include_private = false)
  true
end

Instance Method Details

#create(params: nil, headers: nil, body: {}) ⇒ Object



47
48
49
50
51
# File 'lib/ozon-logistics/request.rb', line 47

def create(params: nil, headers: nil, body: {})
  APIRequest.new(builder: self).post(params: params, headers: headers, body: body)
ensure
  reset
end

#delete(params: nil, headers: nil) ⇒ Object



71
72
73
74
75
# File 'lib/ozon-logistics/request.rb', line 71

def delete(params: nil, headers: nil)
  APIRequest.new(builder: self).delete(params: params, headers: headers)
ensure
  reset
end

#pathObject



43
44
45
# File 'lib/ozon-logistics/request.rb', line 43

def path
  @path_parts.join('/')
end

#respond_to_missing?(method_name, include_private = false) ⇒ Boolean

Returns:

  • (Boolean)


31
32
33
# File 'lib/ozon-logistics/request.rb', line 31

def respond_to_missing?(method_name, include_private = false)
  true
end

#retrieve(params: nil, headers: nil) ⇒ Object



65
66
67
68
69
# File 'lib/ozon-logistics/request.rb', line 65

def retrieve(params: nil, headers: nil)
  APIRequest.new(builder: self).get(params: params, headers: headers)
ensure
  reset
end

#send(*args) ⇒ Object



35
36
37
38
39
40
41
# File 'lib/ozon-logistics/request.rb', line 35

def send(*args)
  if args.length == 0
    method_missing(:send, args)
  else
    __send__(*args)
  end
end

#update(params: nil, headers: nil, body: {}) ⇒ Object



53
54
55
56
57
# File 'lib/ozon-logistics/request.rb', line 53

def update(params: nil, headers: nil, body: {})
  APIRequest.new(builder: self).patch(params: params, headers: headers, body: body)
ensure
  reset
end

#upsert(params: nil, headers: nil, body: {}) ⇒ Object



59
60
61
62
63
# File 'lib/ozon-logistics/request.rb', line 59

def upsert(params: nil, headers: nil, body: {})
  APIRequest.new(builder: self).put(params: params, headers: headers, body: body)
ensure
  reset
end