magento 0.4.2 → 0.5.2
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +286 -267
- data/lib/magento.rb +44 -43
- data/lib/magento/customer.rb +17 -13
- data/lib/magento/guest_cart.rb +69 -0
- data/lib/magento/model.rb +84 -79
- data/lib/magento/model_mapper.rb +50 -54
- data/lib/magento/order.rb +22 -1
- data/lib/magento/record_collection.rb +36 -44
- data/lib/magento/request.rb +79 -108
- data/lib/magento/shared/billing_address.rb +4 -0
- data/lib/magento/shared/currency.rb +4 -0
- data/lib/magento/shared/search_criterium.rb +6 -5
- data/lib/magento/shared/sort_order.rb +4 -0
- data/lib/magento/shared/status_history.rb +4 -0
- data/lib/magento/version.rb +2 -2
- metadata +6 -1
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 3ec9a551229c89e38aeefc3fc16d06df17a65282ef90884806b377557948b937
|
4
|
+
data.tar.gz: f8a9f9fed4e02f4f03024b954f20296e7a49f01f7b5e711e229cec8996958f19
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: bbb2271813f664e794e1849d81deca715b09eb17d169f2f08eb3e53e93563973df87bbf27a5ccf986d23033a7d851f7790552d11bd3d325ce3933fe5addf7be8
|
7
|
+
data.tar.gz: 8dd937f8fdca3eaa2ab3546ca53cc5f2a60c604046482815383245d89b8c758a8b93f0ecf175d5b15e448ada04fa31ff7a3a1b554fdb0f10739db16d223ba5d2
|
data/README.md
CHANGED
@@ -1,267 +1,286 @@
|
|
1
|
-
# Magento Ruby library
|
2
|
-
|
3
|
-
## Install
|
4
|
-
|
5
|
-
Add in your Gemfile
|
6
|
-
|
7
|
-
```rb
|
8
|
-
gem 'magento', '~> 0.
|
9
|
-
```
|
10
|
-
|
11
|
-
or run
|
12
|
-
|
13
|
-
```sh
|
14
|
-
gem install magento
|
15
|
-
```
|
16
|
-
|
17
|
-
### Setup
|
18
|
-
|
19
|
-
```rb
|
20
|
-
Magento.url = 'https://yourstore.com'
|
21
|
-
Magento.token = 'MAGENTO_API_KEY'
|
22
|
-
Magento.store = :default # optional, Default is :all
|
23
|
-
```
|
24
|
-
|
25
|
-
## Models
|
26
|
-
```rb
|
27
|
-
Magento::Product
|
28
|
-
Magento::Order
|
29
|
-
Magento::Country
|
30
|
-
Magento::Category
|
31
|
-
```
|
32
|
-
|
33
|
-
## Get details
|
34
|
-
|
35
|
-
```rb
|
36
|
-
Magento::Product.find('sku-test')
|
37
|
-
Magento::Order.find(25)
|
38
|
-
Magento::Country.find('BR')
|
39
|
-
```
|
40
|
-
\* _same pattern to all models_
|
41
|
-
|
42
|
-
**Outside pattern**
|
43
|
-
|
44
|
-
Get customer by token
|
45
|
-
|
46
|
-
```rb
|
47
|
-
Magento::Customer.find_by_token('user_token')
|
48
|
-
```
|
49
|
-
|
50
|
-
## Get List
|
51
|
-
|
52
|
-
```rb
|
53
|
-
Magento::Product.all
|
54
|
-
```
|
55
|
-
|
56
|
-
#### Select fields:
|
57
|
-
```rb
|
58
|
-
Magento::Product.select(:id, :sku, :name).all
|
59
|
-
Magento::Product.select(:id, :sku, :name, extension_attributes: :category_links).all
|
60
|
-
Magento::Product.select(:id, :sku, :name, extension_attributes: [:category_links, :website_ids]).all
|
61
|
-
Magento::Product.select(:id, :sku, :name, extension_attributes: [:website_ids, { category_links: :category_id }]).all
|
62
|
-
```
|
63
|
-
|
64
|
-
#### Filters:
|
65
|
-
|
66
|
-
```rb
|
67
|
-
Magento::Product.where(name_like: 'IPhone%').all
|
68
|
-
Magento::Product.where(price_gt: 100).all
|
69
|
-
|
70
|
-
# price > 10 AND price < 20
|
71
|
-
Magento::Product.where(price_gt: 10)
|
72
|
-
.where(price_lt: 20).all
|
73
|
-
|
74
|
-
# price < 1 OR price > 100
|
75
|
-
Magento::Product.where(price_lt: 1, price_gt: 100).all
|
76
|
-
|
77
|
-
Magento::Order.where(status_in: [:canceled, :complete]).all
|
78
|
-
```
|
79
|
-
|
80
|
-
| Condition | Notes |
|
81
|
-
| --------- | ----- |
|
82
|
-
|eq | Equals. |
|
83
|
-
|finset | A value within a set of values |
|
84
|
-
|from | The beginning of a range. Must be used with to |
|
85
|
-
|gt | Greater than |
|
86
|
-
|gteq | Greater than or equal |
|
87
|
-
|in | In. The value is an array |
|
88
|
-
|like | Like. The value can contain the SQL wildcard characters when like is specified. |
|
89
|
-
|lt | Less than |
|
90
|
-
|lteq | Less than or equal |
|
91
|
-
|moreq | More or equal |
|
92
|
-
|neq | Not equal |
|
93
|
-
|nfinset | A value that is not within a set of values |
|
94
|
-
|nin | Not in. The value is an array |
|
95
|
-
|notnull | Not null |
|
96
|
-
|null | Null |
|
97
|
-
|to | The end of a range. Must be used with from |
|
98
|
-
|
99
|
-
|
100
|
-
#### SortOrder:
|
101
|
-
|
102
|
-
```rb
|
103
|
-
Magento::Product.order(:sku).all
|
104
|
-
Magento::Product.order(sku: :desc).all
|
105
|
-
Magento::Product.order(status: :desc, name: :asc).all
|
106
|
-
```
|
107
|
-
|
108
|
-
#### Pagination:
|
109
|
-
|
110
|
-
```rb
|
111
|
-
# Set page and quantity per page
|
112
|
-
Magento::Product.page(1) # Current page, Default is 1
|
113
|
-
.page_size(25) # Default is 50
|
114
|
-
.all
|
115
|
-
|
116
|
-
# per is an alias to page_size
|
117
|
-
Magento::Product.per(25).all
|
118
|
-
```
|
119
|
-
|
120
|
-
#### Example of several options together:
|
121
|
-
```rb
|
122
|
-
products = Magento::Product.select(:sku, :name)
|
123
|
-
.where(name_like: 'biscoito%')
|
124
|
-
.page(1)
|
125
|
-
.page_size(5)
|
126
|
-
.all
|
127
|
-
```
|
128
|
-
|
129
|
-
\* _same pattern to all models_
|
130
|
-
|
131
|
-
### Response
|
132
|
-
|
133
|
-
The `all` method retorns a `Magento::RecordCollection` instance
|
134
|
-
|
135
|
-
```rb
|
136
|
-
products.first
|
137
|
-
>> <Magento::Product @sku="2100", @name="Biscoito Piraque Salgadinho 100G">
|
138
|
-
|
139
|
-
products[0]
|
140
|
-
>> <Magento::Product @sku="2100", @name="Biscoito Piraque Salgadinho 100G">
|
141
|
-
|
142
|
-
products.last
|
143
|
-
>> <Magento::Product @sku="964", @name="Biscoito Negresco 140 G Original">
|
144
|
-
|
145
|
-
products.map(&:sku)
|
146
|
-
>> ["2100", "792", "836", "913", "964"]
|
147
|
-
|
148
|
-
products.size
|
149
|
-
>> 5
|
150
|
-
|
151
|
-
products.current_page
|
152
|
-
>> 1
|
153
|
-
|
154
|
-
products.page_size
|
155
|
-
>> 5
|
156
|
-
|
157
|
-
products.total_count
|
158
|
-
>> 307
|
159
|
-
|
160
|
-
products.filter_groups
|
161
|
-
>> [<Magento::FilterGroup @filters=[<Magento::Filter @field="name", @value="biscoito%", @condition_type="like">]>]
|
162
|
-
```
|
163
|
-
|
164
|
-
All Methods:
|
165
|
-
|
166
|
-
```rb
|
167
|
-
# Information about search criteria
|
168
|
-
:current_page
|
169
|
-
:page_size
|
170
|
-
:total_count
|
171
|
-
:filter_groups
|
172
|
-
|
173
|
-
# Iterating with the list of items
|
174
|
-
:count
|
175
|
-
:length
|
176
|
-
:size
|
177
|
-
|
178
|
-
:first
|
179
|
-
:last
|
180
|
-
:[]
|
181
|
-
:find
|
182
|
-
|
183
|
-
:each
|
184
|
-
:each_with_index
|
185
|
-
:sample
|
186
|
-
|
187
|
-
:map
|
188
|
-
:select
|
189
|
-
:filter
|
190
|
-
:reject
|
191
|
-
:collect
|
192
|
-
:take
|
193
|
-
:take_while
|
194
|
-
|
195
|
-
:sort
|
196
|
-
:sort_by
|
197
|
-
:reverse_each
|
198
|
-
:reverse
|
199
|
-
|
200
|
-
:all?
|
201
|
-
:any?
|
202
|
-
:none?
|
203
|
-
:one?
|
204
|
-
:empty?
|
205
|
-
```
|
206
|
-
|
207
|
-
## Create
|
208
|
-
|
209
|
-
```rb
|
210
|
-
Magento::Order.create(
|
211
|
-
customer_firstname: '',
|
212
|
-
customer_lastname: '',
|
213
|
-
customer_email: '',
|
214
|
-
# others attrbutes ...,
|
215
|
-
items: [
|
216
|
-
{
|
217
|
-
sku: '',
|
218
|
-
price: '',
|
219
|
-
qty_ordered: 1,
|
220
|
-
# others attrbutes ...,
|
221
|
-
}
|
222
|
-
],
|
223
|
-
billing_address: {
|
224
|
-
# attrbutes...
|
225
|
-
},
|
226
|
-
payment: {
|
227
|
-
# attrbutes...
|
228
|
-
},
|
229
|
-
extension_attributes: {
|
230
|
-
# attrbutes...
|
231
|
-
}
|
232
|
-
)
|
233
|
-
```
|
234
|
-
|
235
|
-
### Update
|
236
|
-
|
237
|
-
```rb
|
238
|
-
product = Magento::Product.find('sku-teste')
|
239
|
-
|
240
|
-
product.name = 'Updated name'
|
241
|
-
product.save
|
242
|
-
|
243
|
-
# or
|
244
|
-
|
245
|
-
product.update(name: 'Updated name')
|
246
|
-
```
|
247
|
-
|
248
|
-
### Delete
|
249
|
-
|
250
|
-
```rb
|
251
|
-
product = Magento::Product.find('sku-teste')
|
252
|
-
|
253
|
-
product.delete
|
254
|
-
|
255
|
-
# or
|
256
|
-
|
257
|
-
Magento::Product.delete('sku-teste')
|
258
|
-
```
|
259
|
-
|
260
|
-
|
261
|
-
|
262
|
-
|
263
|
-
|
264
|
-
|
265
|
-
|
266
|
-
|
267
|
-
|
1
|
+
# Magento Ruby library
|
2
|
+
|
3
|
+
## Install
|
4
|
+
|
5
|
+
Add in your Gemfile
|
6
|
+
|
7
|
+
```rb
|
8
|
+
gem 'magento', '~> 0.5.2'
|
9
|
+
```
|
10
|
+
|
11
|
+
or run
|
12
|
+
|
13
|
+
```sh
|
14
|
+
gem install magento
|
15
|
+
```
|
16
|
+
|
17
|
+
### Setup
|
18
|
+
|
19
|
+
```rb
|
20
|
+
Magento.url = 'https://yourstore.com'
|
21
|
+
Magento.token = 'MAGENTO_API_KEY'
|
22
|
+
Magento.store = :default # optional, Default is :all
|
23
|
+
```
|
24
|
+
|
25
|
+
## Models
|
26
|
+
```rb
|
27
|
+
Magento::Product
|
28
|
+
Magento::Order
|
29
|
+
Magento::Country
|
30
|
+
Magento::Category
|
31
|
+
```
|
32
|
+
|
33
|
+
## Get details
|
34
|
+
|
35
|
+
```rb
|
36
|
+
Magento::Product.find('sku-test')
|
37
|
+
Magento::Order.find(25)
|
38
|
+
Magento::Country.find('BR')
|
39
|
+
```
|
40
|
+
\* _same pattern to all models_
|
41
|
+
|
42
|
+
**Outside pattern**
|
43
|
+
|
44
|
+
Get customer by token
|
45
|
+
|
46
|
+
```rb
|
47
|
+
Magento::Customer.find_by_token('user_token')
|
48
|
+
```
|
49
|
+
|
50
|
+
## Get List
|
51
|
+
|
52
|
+
```rb
|
53
|
+
Magento::Product.all
|
54
|
+
```
|
55
|
+
|
56
|
+
#### Select fields:
|
57
|
+
```rb
|
58
|
+
Magento::Product.select(:id, :sku, :name).all
|
59
|
+
Magento::Product.select(:id, :sku, :name, extension_attributes: :category_links).all
|
60
|
+
Magento::Product.select(:id, :sku, :name, extension_attributes: [:category_links, :website_ids]).all
|
61
|
+
Magento::Product.select(:id, :sku, :name, extension_attributes: [:website_ids, { category_links: :category_id }]).all
|
62
|
+
```
|
63
|
+
|
64
|
+
#### Filters:
|
65
|
+
|
66
|
+
```rb
|
67
|
+
Magento::Product.where(name_like: 'IPhone%').all
|
68
|
+
Magento::Product.where(price_gt: 100).all
|
69
|
+
|
70
|
+
# price > 10 AND price < 20
|
71
|
+
Magento::Product.where(price_gt: 10)
|
72
|
+
.where(price_lt: 20).all
|
73
|
+
|
74
|
+
# price < 1 OR price > 100
|
75
|
+
Magento::Product.where(price_lt: 1, price_gt: 100).all
|
76
|
+
|
77
|
+
Magento::Order.where(status_in: [:canceled, :complete]).all
|
78
|
+
```
|
79
|
+
|
80
|
+
| Condition | Notes |
|
81
|
+
| --------- | ----- |
|
82
|
+
|eq | Equals. |
|
83
|
+
|finset | A value within a set of values |
|
84
|
+
|from | The beginning of a range. Must be used with to |
|
85
|
+
|gt | Greater than |
|
86
|
+
|gteq | Greater than or equal |
|
87
|
+
|in | In. The value is an array |
|
88
|
+
|like | Like. The value can contain the SQL wildcard characters when like is specified. |
|
89
|
+
|lt | Less than |
|
90
|
+
|lteq | Less than or equal |
|
91
|
+
|moreq | More or equal |
|
92
|
+
|neq | Not equal |
|
93
|
+
|nfinset | A value that is not within a set of values |
|
94
|
+
|nin | Not in. The value is an array |
|
95
|
+
|notnull | Not null |
|
96
|
+
|null | Null |
|
97
|
+
|to | The end of a range. Must be used with from |
|
98
|
+
|
99
|
+
|
100
|
+
#### SortOrder:
|
101
|
+
|
102
|
+
```rb
|
103
|
+
Magento::Product.order(:sku).all
|
104
|
+
Magento::Product.order(sku: :desc).all
|
105
|
+
Magento::Product.order(status: :desc, name: :asc).all
|
106
|
+
```
|
107
|
+
|
108
|
+
#### Pagination:
|
109
|
+
|
110
|
+
```rb
|
111
|
+
# Set page and quantity per page
|
112
|
+
Magento::Product.page(1) # Current page, Default is 1
|
113
|
+
.page_size(25) # Default is 50
|
114
|
+
.all
|
115
|
+
|
116
|
+
# per is an alias to page_size
|
117
|
+
Magento::Product.per(25).all
|
118
|
+
```
|
119
|
+
|
120
|
+
#### Example of several options together:
|
121
|
+
```rb
|
122
|
+
products = Magento::Product.select(:sku, :name)
|
123
|
+
.where(name_like: 'biscoito%')
|
124
|
+
.page(1)
|
125
|
+
.page_size(5)
|
126
|
+
.all
|
127
|
+
```
|
128
|
+
|
129
|
+
\* _same pattern to all models_
|
130
|
+
|
131
|
+
### Response
|
132
|
+
|
133
|
+
The `all` method retorns a `Magento::RecordCollection` instance
|
134
|
+
|
135
|
+
```rb
|
136
|
+
products.first
|
137
|
+
>> <Magento::Product @sku="2100", @name="Biscoito Piraque Salgadinho 100G">
|
138
|
+
|
139
|
+
products[0]
|
140
|
+
>> <Magento::Product @sku="2100", @name="Biscoito Piraque Salgadinho 100G">
|
141
|
+
|
142
|
+
products.last
|
143
|
+
>> <Magento::Product @sku="964", @name="Biscoito Negresco 140 G Original">
|
144
|
+
|
145
|
+
products.map(&:sku)
|
146
|
+
>> ["2100", "792", "836", "913", "964"]
|
147
|
+
|
148
|
+
products.size
|
149
|
+
>> 5
|
150
|
+
|
151
|
+
products.current_page
|
152
|
+
>> 1
|
153
|
+
|
154
|
+
products.page_size
|
155
|
+
>> 5
|
156
|
+
|
157
|
+
products.total_count
|
158
|
+
>> 307
|
159
|
+
|
160
|
+
products.filter_groups
|
161
|
+
>> [<Magento::FilterGroup @filters=[<Magento::Filter @field="name", @value="biscoito%", @condition_type="like">]>]
|
162
|
+
```
|
163
|
+
|
164
|
+
All Methods:
|
165
|
+
|
166
|
+
```rb
|
167
|
+
# Information about search criteria
|
168
|
+
:current_page
|
169
|
+
:page_size
|
170
|
+
:total_count
|
171
|
+
:filter_groups
|
172
|
+
|
173
|
+
# Iterating with the list of items
|
174
|
+
:count
|
175
|
+
:length
|
176
|
+
:size
|
177
|
+
|
178
|
+
:first
|
179
|
+
:last
|
180
|
+
:[]
|
181
|
+
:find
|
182
|
+
|
183
|
+
:each
|
184
|
+
:each_with_index
|
185
|
+
:sample
|
186
|
+
|
187
|
+
:map
|
188
|
+
:select
|
189
|
+
:filter
|
190
|
+
:reject
|
191
|
+
:collect
|
192
|
+
:take
|
193
|
+
:take_while
|
194
|
+
|
195
|
+
:sort
|
196
|
+
:sort_by
|
197
|
+
:reverse_each
|
198
|
+
:reverse
|
199
|
+
|
200
|
+
:all?
|
201
|
+
:any?
|
202
|
+
:none?
|
203
|
+
:one?
|
204
|
+
:empty?
|
205
|
+
```
|
206
|
+
|
207
|
+
## Create
|
208
|
+
|
209
|
+
```rb
|
210
|
+
Magento::Order.create(
|
211
|
+
customer_firstname: '',
|
212
|
+
customer_lastname: '',
|
213
|
+
customer_email: '',
|
214
|
+
# others attrbutes ...,
|
215
|
+
items: [
|
216
|
+
{
|
217
|
+
sku: '',
|
218
|
+
price: '',
|
219
|
+
qty_ordered: 1,
|
220
|
+
# others attrbutes ...,
|
221
|
+
}
|
222
|
+
],
|
223
|
+
billing_address: {
|
224
|
+
# attrbutes...
|
225
|
+
},
|
226
|
+
payment: {
|
227
|
+
# attrbutes...
|
228
|
+
},
|
229
|
+
extension_attributes: {
|
230
|
+
# attrbutes...
|
231
|
+
}
|
232
|
+
)
|
233
|
+
```
|
234
|
+
|
235
|
+
### Update
|
236
|
+
|
237
|
+
```rb
|
238
|
+
product = Magento::Product.find('sku-teste')
|
239
|
+
|
240
|
+
product.name = 'Updated name'
|
241
|
+
product.save
|
242
|
+
|
243
|
+
# or
|
244
|
+
|
245
|
+
product.update(name: 'Updated name')
|
246
|
+
```
|
247
|
+
|
248
|
+
### Delete
|
249
|
+
|
250
|
+
```rb
|
251
|
+
product = Magento::Product.find('sku-teste')
|
252
|
+
|
253
|
+
product.delete
|
254
|
+
|
255
|
+
# or
|
256
|
+
|
257
|
+
Magento::Product.delete('sku-teste')
|
258
|
+
```
|
259
|
+
|
260
|
+
## GuestCart
|
261
|
+
|
262
|
+
Set payment information to finish the order
|
263
|
+
```rb
|
264
|
+
cart = Magento::GuestCart.find('gXsepZcgJbY8RCJXgGioKOO9iBCR20r7')
|
265
|
+
|
266
|
+
# or use "build" to not request information from the magento API
|
267
|
+
cart = Magento::GuestCart.build(
|
268
|
+
cart_id: 'aj8oUtY1Qi44Fror6UWVN7ftX1idbBKN'
|
269
|
+
)
|
270
|
+
|
271
|
+
cart.payment_information(
|
272
|
+
email: 'customer@gmail.com',
|
273
|
+
payment: { method: 'cashondelivery' }
|
274
|
+
)
|
275
|
+
|
276
|
+
>> "234575" # return the order id
|
277
|
+
```
|
278
|
+
|
279
|
+
___
|
280
|
+
|
281
|
+
##TODO:
|
282
|
+
|
283
|
+
### Search products
|
284
|
+
```rb
|
285
|
+
Magento::Product.search('tshort')
|
286
|
+
```
|