magento 0.4.1 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ca2b525890d23f017395642b3be2f67da40a5bdcddba2f95001f2b467fdf832c
-  data.tar.gz: 529d1fa8ee55419914824373462cc7408d3d63f525de916eef3c35f5970bdd36
+  metadata.gz: 4034005945e350699f74bfd858941a2e0295e2f8e3b6fd1d19c605d68da703fe
+  data.tar.gz: 8d6dbbe72502d09f6ea1f437bb52151c767e28ff1ec3e2ab697594b8e59e836e
 SHA512:
-  metadata.gz: d76e0f91f76401fc6494819747e137cff7fe38ec527b071ec1c98ccbc5a70b4c7f074019965b4d7075a26649e1515684a08534ef81e932d3e87b1c8c8677b822
-  data.tar.gz: 7cf8c1c7aa3f80d963bf7d26ee2188c20caee28ce79a5b48c376aa90a0c10586764cbe572bfa883acdc688f77bc27b5f50e00752d631fed26e19ddbb1678eed0
+  metadata.gz: 84b758c7a69c84f75dc877475d24a61518e609339b3bac0d93a3561241d5a7bb6214d2e909923100ed44626bd1eeead86370af7dc03a6c43c5d5c8bcb688d011
+  data.tar.gz: ea6359f11056d8defd7fe4b9d8b1a27c0d45e441a56e9f72ca0cd042b52d87d4c6832c3d14b5c6c1bc7ee9401b623ae859dd22dd503f1b209fccdc5f977c0745

data/README.md

@@ -1,267 +1,286 @@
-# Magento Ruby library
-
-## Install
-
-Add in your Gemfile
-
-```rb
-gem 'magento', '~> 0.4.1'
-```
-
-or run
-
-```sh
-gem install magento
-```
-
-### Setup
-
-```rb
-Magento.url   = 'https://yourstore.com'
-Magento.token = 'MAGENTO_API_KEY'
-Magento.store = :default # optional, Default is :all
-```
-
-## Models
-```rb
-Magento::Product
-Magento::Order
-Magento::Country
-Magento::Category
-```
-
-## Get details
-
-```rb
-Magento::Product.find('sku-test')
-Magento::Order.find(25)
-Magento::Country.find('BR')
-```
-\* _same pattern to all models_
-
-**Outside pattern**
-
-Get customer by token
-
-```rb
-Magento::Customer.find_by_token('user_token')
-```
-
-## Get List
-
-```rb
-Magento::Product.all
-```
-
-#### Select fields:
-```rb
-Magento::Product.select(:id, :sku, :name).all
-Magento::Product.select(:id, :sku, :name, extension_attributes: :category_links).all
-Magento::Product.select(:id, :sku, :name, extension_attributes: [:category_links, :website_ids]).all
-Magento::Product.select(:id, :sku, :name, extension_attributes: [:website_ids, { category_links: :category_id }]).all
-```
-
-#### Filters:
-
-```rb
-Magento::Product.where(name_like: 'IPhone%').all
-Magento::Product.where(price_gt: 100).all
-
-# price > 10 AND price < 20
-Magento::Product.where(price_gt: 10)
-                .where(price_lt: 20).all
-
-# price < 1 OR price > 100
-Magento::Product.where(price_lt: 1, price_gt: 100).all
-
-Magento::Order.where(status_in: [:canceled, :complete]).all
-```
-
-| Condition | Notes |
-| --------- | ----- |
-|eq         | Equals. |
-|finset     | A value within a set of values |
-|from       | The beginning of a range. Must be used with to |
-|gt         | Greater than |
-|gteq       | Greater than or equal |
-|in         | In. The value is an array |
-|like       | Like. The value can contain the SQL wildcard characters when like is specified. |
-|lt         | Less than |
-|lteq       | Less than or equal |
-|moreq      | More or equal |
-|neq        | Not equal |
-|nfinset    | A value that is not within a set of values |
-|nin        | Not in. The value is an array |
-|notnull    | Not null |
-|null       | Null |
-|to         | The end of a range. Must be used with from |
-
-
-#### SortOrder:
-
-```rb
-Magento::Product.order(:sku).all
-Magento::Product.order(sku: :desc).all
-Magento::Product.order(status: :desc, name: :asc).all
-```
-
-#### Pagination:
-
-```rb
-# Set page and quantity per page
-Magento::Product.page(1)       # Current page, Default is 1
-                .page_size(25) # Default is 50
-                .all
-
-# per is an alias to page_size
-Magento::Product.per(25).all
-```
-
-#### Example of several options together:
-```rb
-products = Magento::Product.select(:sku, :name)
-                           .where(name_like: 'biscoito%')
-                           .page(1)
-                           .page_size(5)
-                           .all
-```
-
-\* _same pattern to all models_
-
-### Response
-
-The `all` method retorns a `Magento::RecordCollection` instance
-
-```rb
-products.first
->> <Magento::Product @sku="2100", @name="Biscoito Piraque Salgadinho 100G">
-
-products[0]
->> <Magento::Product @sku="2100", @name="Biscoito Piraque Salgadinho 100G">
-
-products.last
->> <Magento::Product @sku="964", @name="Biscoito Negresco 140 G Original">
-
-products.map(&:sku)
->> ["2100", "792", "836", "913", "964"]
-
-products.size
->> 5
-
-products.current_page
->> 1
-
-products.page_size
->> 5
-
-products.total_count
->> 307
-
-products.filter_groups
->> [<Magento::FilterGroup @filters=[<Magento::Filter @field="name", @value="biscoito%", @condition_type="like">]>]
-```
-
-All Methods:
-
-```rb
-# Information about search criteria
-:current_page
-:page_size
-:total_count
-:filter_groups
-
-# Iterating with the list of items
-:count
-:length
-:size
-
-:first
-:last
-:[]
-:find
-
-:each
-:each_index
-:sample
-
-:map
-:select
-:filter
-:reject
-:collect
-:take
-:take_while
-
-:sort
-:sort_by
-:reverse_each
-:reverse
-
-:all?
-:any?
-:none?
-:one?
-:empty?
-```
-
-## Create
-
-```rb
-Magento::Order.create(
-  customer_firstname: '',
-  customer_lastname: '',
-  customer_email: '',
-  # others attrbutes ...,
-  items: [
-    {
-      sku: '',
-      price: '',
-      qty_ordered: 1,
-      # others attrbutes ...,
-    }
-  ],
-  billing_address: {
-    # attrbutes...
-  },
-  payment: {
-    # attrbutes...
-  },
-  extension_attributes: {
-    # attrbutes...
-  }
-)
-```
-
-### Update
-
-```rb
-product = Magento::Product.find('sku-teste')
-
-product.name = 'Updated name'
-product.save
-
-# or
-
-product.update(name: 'Updated name')
-```
-
-### Delete
-
-```rb
-product = Magento::Product.find('sku-teste')
-
-product.delete
-
-# or
-
-Magento::Product.delete('sku-teste')
-```
-
-___
-
-##TODO:
-
-### Search products
-```rb
-Magento::Product.search('tshort')
-```
+# Magento Ruby library
+
+## Install
+
+Add in your Gemfile
+
+```rb
+gem 'magento', '~> 0.5.1'
+```
+
+or run
+
+```sh
+gem install magento
+```
+
+### Setup
+
+```rb
+Magento.url   = 'https://yourstore.com'
+Magento.token = 'MAGENTO_API_KEY'
+Magento.store = :default # optional, Default is :all
+```
+
+## Models
+```rb
+Magento::Product
+Magento::Order
+Magento::Country
+Magento::Category
+```
+
+## Get details
+
+```rb
+Magento::Product.find('sku-test')
+Magento::Order.find(25)
+Magento::Country.find('BR')
+```
+\* _same pattern to all models_
+
+**Outside pattern**
+
+Get customer by token
+
+```rb
+Magento::Customer.find_by_token('user_token')
+```
+
+## Get List
+
+```rb
+Magento::Product.all
+```
+
+#### Select fields:
+```rb
+Magento::Product.select(:id, :sku, :name).all
+Magento::Product.select(:id, :sku, :name, extension_attributes: :category_links).all
+Magento::Product.select(:id, :sku, :name, extension_attributes: [:category_links, :website_ids]).all
+Magento::Product.select(:id, :sku, :name, extension_attributes: [:website_ids, { category_links: :category_id }]).all
+```
+
+#### Filters:
+
+```rb
+Magento::Product.where(name_like: 'IPhone%').all
+Magento::Product.where(price_gt: 100).all
+
+# price > 10 AND price < 20
+Magento::Product.where(price_gt: 10)
+                .where(price_lt: 20).all
+
+# price < 1 OR price > 100
+Magento::Product.where(price_lt: 1, price_gt: 100).all
+
+Magento::Order.where(status_in: [:canceled, :complete]).all
+```
+
+| Condition | Notes |
+| --------- | ----- |
+|eq         | Equals. |
+|finset     | A value within a set of values |
+|from       | The beginning of a range. Must be used with to |
+|gt         | Greater than |
+|gteq       | Greater than or equal |
+|in         | In. The value is an array |
+|like       | Like. The value can contain the SQL wildcard characters when like is specified. |
+|lt         | Less than |
+|lteq       | Less than or equal |
+|moreq      | More or equal |
+|neq        | Not equal |
+|nfinset    | A value that is not within a set of values |
+|nin        | Not in. The value is an array |
+|notnull    | Not null |
+|null       | Null |
+|to         | The end of a range. Must be used with from |
+
+
+#### SortOrder:
+
+```rb
+Magento::Product.order(:sku).all
+Magento::Product.order(sku: :desc).all
+Magento::Product.order(status: :desc, name: :asc).all
+```
+
+#### Pagination:
+
+```rb
+# Set page and quantity per page
+Magento::Product.page(1)       # Current page, Default is 1
+                .page_size(25) # Default is 50
+                .all
+
+# per is an alias to page_size
+Magento::Product.per(25).all
+```
+
+#### Example of several options together:
+```rb
+products = Magento::Product.select(:sku, :name)
+                           .where(name_like: 'biscoito%')
+                           .page(1)
+                           .page_size(5)
+                           .all
+```
+
+\* _same pattern to all models_
+
+### Response
+
+The `all` method retorns a `Magento::RecordCollection` instance
+
+```rb
+products.first
+>> <Magento::Product @sku="2100", @name="Biscoito Piraque Salgadinho 100G">
+
+products[0]
+>> <Magento::Product @sku="2100", @name="Biscoito Piraque Salgadinho 100G">
+
+products.last
+>> <Magento::Product @sku="964", @name="Biscoito Negresco 140 G Original">
+
+products.map(&:sku)
+>> ["2100", "792", "836", "913", "964"]
+
+products.size
+>> 5
+
+products.current_page
+>> 1
+
+products.page_size
+>> 5
+
+products.total_count
+>> 307
+
+products.filter_groups
+>> [<Magento::FilterGroup @filters=[<Magento::Filter @field="name", @value="biscoito%", @condition_type="like">]>]
+```
+
+All Methods:
+
+```rb
+# Information about search criteria
+:current_page
+:page_size
+:total_count
+:filter_groups
+
+# Iterating with the list of items
+:count
+:length
+:size
+
+:first
+:last
+:[]
+:find
+
+:each
+:each_with_index
+:sample
+
+:map
+:select
+:filter
+:reject
+:collect
+:take
+:take_while
+
+:sort
+:sort_by
+:reverse_each
+:reverse
+
+:all?
+:any?
+:none?
+:one?
+:empty?
+```
+
+## Create
+
+```rb
+Magento::Order.create(
+  customer_firstname: '',
+  customer_lastname: '',
+  customer_email: '',
+  # others attrbutes ...,
+  items: [
+    {
+      sku: '',
+      price: '',
+      qty_ordered: 1,
+      # others attrbutes ...,
+    }
+  ],
+  billing_address: {
+    # attrbutes...
+  },
+  payment: {
+    # attrbutes...
+  },
+  extension_attributes: {
+    # attrbutes...
+  }
+)
+```
+
+### Update
+
+```rb
+product = Magento::Product.find('sku-teste')
+
+product.name = 'Updated name'
+product.save
+
+# or
+
+product.update(name: 'Updated name')
+```
+
+### Delete
+
+```rb
+product = Magento::Product.find('sku-teste')
+
+product.delete
+
+# or
+
+Magento::Product.delete('sku-teste')
+```
+
+## GuestCart
+
+Set payment information to finish the order
+```rb
+cart = Magento::GuestCart.find('gXsepZcgJbY8RCJXgGioKOO9iBCR20r7')
+
+# or use "build" to not request information from the magento API
+cart = Magento::GuestCart.build(
+  cart_id: 'aj8oUtY1Qi44Fror6UWVN7ftX1idbBKN'
+)
+
+cart.payment_information(
+  email: 'customer@gmail.com',
+  payment: { method: 'cashondelivery' }
+)
+
+>> "234575" # return the order id
+```
+
+___
+
+##TODO:
+
+### Search products
+```rb
+Magento::Product.search('tshort')
+```