/
connection.rb
226 lines (204 loc) · 8.76 KB
/
connection.rb
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
require 'faraday'
require 'mini_magick'
require 'tempfile'
using Prestashop::Api::Refinement
module Prestashop
module Api
class Connection
attr_reader :api_key, :api_url
# Create new connection. Raise error, when is not possible validate connection from any reason
#
# Prestashop::Api::Connection.new 'TOKEN342', 'mystore.com'
#
def initialize api_key, api_url
@api_key = api_key
self.api_url = api_url
raise InvalidCredentials unless self.test
end
# Convert url to suitable for Prestashop API
#
# @connection.api_url = 'mystore.com' # => http://mystore.com/api/
#
def api_url= origin_url
url = origin_url.match(/^(http|https):\/\/.*/)
url = url.nil? ? 'http://' + origin_url : url.to_s
url << '/' unless url.end_with? '/'
url << 'api/' unless url.end_with? 'api/'
@api_url = url
end
# Create connection based on connection instance, returns +Faraday::Connection+
# which can be usedo for API call
#
def connection
Faraday.new do |builder|
builder.url_prefix = api_url
builder.request :multipart
builder.request :url_encoded
builder.request :retry, 5
builder.response :logger if ENV['DEBUG']
builder.adapter :net_http
builder.basic_auth api_key, ''
end
end
# Generate path for API request
#
# path(:customers, 1) # => "customers/1"
# path(:customers, [1, 5]) # => "customers?id=[1,5]"
#
def path resource, id = nil
path = resource.to_s
path += id.kind_of?(Array) ? "?id=[#{id.join(',')}]" : "/#{id}" if id
path
end
# Generate path for API upload request
#
# upload_path :image, :products, 2 # => /images/products/2
#
def upload_path type, resource, id
"#{type}/#{resource}/#{id}"
end
# Call HEAD on WebService API, returns +true+ if was request successfull or raise error, when request failed.
# Can be called as +check+ instead +head+
#
# head :customer, 2 # => true
# check :customer, 3 # => true
#
def head resource, id = nil
raise ArgumentError, "resource: #{resource} must be string or symbol" unless resource.kind_of?(String) or resource.kind_of?(Symbol)
raise ArgumentError, "id: #{id} must be integer or nil" unless id.to_i.kind_of?(Integer) or id == nil
request_path = path(resource, id)
response = connection.head request_path
if response.success?
true # response.body
else
raise RequestFailed.new(response), response.body.parse_error
end
rescue ParserError
raise ParserError, "Response couldn't be parsed for: #{request_path}. RESPONSE: #{response.body}"
end
alias :check :head
# Call GET on WebService API, returns parsed Prestashop response or raise error, when request failed.
# Can be called as +read+ instead +get+
#
# get :customer, 1 # => {id: 1 ...}
# read :customer, [1,2] # => [{id: 1}, {id: 2}]
#
# available options::
# * filter
# * display
# * sort
# * limit
# * schema
# * date
# * price (product and combination resource only. see http://doc.prestashop.com/display/PS16/Chapter+10+-+Price+management)
#
def get resource, id = nil, opts = {}
id.to_i unless id.kind_of?(Array)
raise ArgumentError, "resource: #{resource} must be string or symbol" unless resource.kind_of?(String) or resource.kind_of?(Symbol)
raise ArgumentError, "id: #{id} must be integer, array or nil" unless id.kind_of?(Integer) or id.kind_of?(Array) or id == nil
white_list = %w(filter display sort limit schema date price)
params = {}
opts.each do |name, value|
if white_list.include? name.to_s.split('[').first
params[name.to_sym] = value
end
end
request_path = path(resource, id)
response = connection.get request_path, params
if response.success?
response.body.parse
else
raise RequestFailed.new(response), response.body.parse_error
end
rescue ParserError
raise ParserError, "Response couldn't be parsed for: #{request_path} with #{params}. RESPONSE: #{response.body}"
end
alias :read :get
# Call POST on WebService API, returns parsed Prestashop response if was request successfull or raise error, when request failed.
# Can be called as +create+ insted of +put+
#
# post :customer, { name: 'Steve' } # => true
#
def post resource, payload
raise ArgumentError, "resource: #{resource} must be string or symbol" unless resource.kind_of?(String) or resource.kind_of?(Symbol)
request_path = path(resource)
response = connection.post request_path, payload
if response.success?
response.body.parse
else
raise RequestFailed.new(response), "#{response.body.parse_error}. XML SENT: #{payload}"
end
rescue ParserError
raise ParserError, "Response couldn't be parsed for: #{request_path}. RESPONSE: #{response.body} XML SENT: #{payload}"
end
alias :create :post
# Call PUT on WebService API, returns parsed Prestashop response if was request successfull or raise error, when request failed.
# Can be called as +update+ instead +put+
#
# put :customer, 1, {surname: 'Jobs'} # => true
# update :customer, 1, {nope: 'Jobs'} # => false
#
def put resource, id, payload
raise ArgumentError, "resource: #{resource} must be string or symbol" unless resource.kind_of?(String) or resource.kind_of?(Symbol)
raise ArgumentError, "id: #{id} must be integer" unless id.to_i.kind_of?(Integer)
request_path = path(resource, id)
response = connection.put request_path, payload
if response.success?
response.body.parse
else
raise RequestFailed.new(response), "#{response.body.parse_error}. XML SENT: #{payload}"
end
rescue ParserError
raise ParserError, "Response couldn't be parsed for: #{request_path}. RESPONSE: #{response.body} XML SENT: #{payload}"
end
alias :update :put
# Call DELETE on WebService API, returns +true+ if was request successfull or raise error, when request failed.
#
# delete :customer, 1 # => true
#
def delete resource, id
raise ArgumentError, "resource: #{resource} must be string or symbol" unless resource.kind_of?(String) or resource.kind_of?(Symbol)
raise ArgumentError, "id: #{id} must be integer" unless id.to_i.kind_of?(Integer)
request_path = path(resource, id)
response = connection.delete request_path
if response.success?
true # response.body
else
raise RequestFailed.new(response), response.body.parse_error
end
rescue ParserError
raise ParserError, "Response couldn't be parsed for: #{request_path}. RESPONSE: #{response.body} XML SENT: #{payload}"
end
alias :destroy :delete
# Send file via payload After that call POST on WebService API, returns parsed Prestashop response if was request successfull or raise error, when request failed.
#
# upload :image, :customer, 2, {image: '/file/to/path.png'}, file
#
# @param type [Type (image, attachement)]
# @param resource [Resource of uploaded item]
# @param id [ID of uploaded item]
# @param payload [Attachement in hash with file path]
# @param file [Original file]
#
def upload type, resource, id, payload, file
raise ArgumentError, "type: #{type} must be string or symbol" unless resource.kind_of?(String) or resource.kind_of?(Symbol)
raise ArgumentError, "resource: #{resource} must be string or symbol" unless resource.kind_of?(String) or resource.kind_of?(Symbol)
raise ArgumentError, "id: #{id} must be integer" unless id.to_i.kind_of?(Integer)
request_path = upload_path(type, resource, id)
response = connection.post request_path, payload
file.destroy!
if response.success?
response.body.parse
else
raise RequestFailed.new(response), response.body.parse_error
end
rescue ParserError
raise ParserError, "Response couldn't be parsed for: #{request_path}. RESPONSE: #{response.body} XML SENT: #{payload}"
end
# Test connection based on current credentials and connection, return true or false, based if request was successfull or not.
def test
connection.get.status == 200 ? true : false
end
end
end
end