magento 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 78965c7e294c387a88b86cf0af3a099f54729ca292050d1b0cc71046f6e5de6c
-  data.tar.gz: 7e714fbb399e0ed27946984437d2a4603481f33e98ffa551e5f83b0987518e9c
+  metadata.gz: 10797b41b2292eb765414cf4757cca8e92d6eeaa604ae3c59da76763e11dce9e
+  data.tar.gz: 683f76e2c1b7215e279459bd5eca921caba0e58fe18d299a29c256a0a5e11b94
 SHA512:
-  metadata.gz: 36cc52f478ee96696a451b1bf943db80128ca3f333391c628e026305d67d9f242fe699efc7dbbf624707945fdde47cf2f7f87391e24543e8cb4eefe3984d3bd1
-  data.tar.gz: 1f0ab0fd15b026b47ed6de9252e249bb084cd92fd60021beafc90e1341ea7439e2a9d75ad5046fce1cd89a6947626ae2f475fe4fa3c8dca5a88c457ba4502d00
+  metadata.gz: c8c44416f426c6c57bd402cd2d794027ce811bdd1d2e001502d19ffc785e3cb16b26d01fa983c1a3e1582a2d2a6b18f33a3a6f472230069abb33d75263676060
+  data.tar.gz: 5175d8d609601f3b207e29f92cfa38fff076c7ec51a225c274cbdfbd5d6a81edc99e3f8069ebeed100b838899add3c875c70054afa2de70601d69148270ad521

data/.github/workflows/gem-push.yml

@@ -0,0 +1,42 @@
+name: Ruby Gem
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  build:
+    name: Build + Publish
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby 2.6
+      uses: actions/setup-ruby@v1
+      with:
+        ruby-version: 2.6.x
+
+    - name: Publish to GPR
+      run: |
+        mkdir -p $HOME/.gem
+        touch $HOME/.gem/credentials
+        chmod 0600 $HOME/.gem/credentials
+        printf -- "---\n:github: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+        gem build magento-ruby.gemspec
+        gem push --KEY github --host https://rubygems.pkg.github.com/${OWNER} *.gem
+      env:
+        GEM_HOST_API_KEY: "Bearer ${{secrets.GITHUB_TOKEN}}"
+        OWNER: ${{ github.repository_owner }}
+
+    - name: Publish to RubyGems
+      run: |
+        mkdir -p $HOME/.gem
+        touch $HOME/.gem/credentials
+        chmod 0600 $HOME/.gem/credentials
+        printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+        gem build magento.gemspec
+        gem push magento-[0-9]*.gem
+      env:
+        GEM_HOST_API_KEY: "${{secrets.RUBYGEMS_AUTH_TOKEN}}"

data/README.md

@@ -1,176 +1,221 @@
-# Magento Ruby library
-
-## Install
-
-Add in your Gemfile
-
-```rb
-gem 'magento', '~> 0.3.0'
-```
-
-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
-Magento::Product.where(price_gt: 100, price_lt: 200).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 can contain a comma-separated list of values. |
-|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 can contain a comma-separated list of values. |
-|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).per(25) # Default per is 50
-```
-
-#### Example of several options together:
-```rb
-Magento::Product.select(:sku, :name, :price)
-                .where(name_like: 'Tshort%')
-                .order(price: :desc)
-                .per(10)
-                .all
-```
-
-\* _same pattern to all models_
-___
-## \######### TODO \##########
-
-## 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')
-```
-
-### Search products
-```rb
-Magento::Product.search('tshort')
-```
+# Magento Ruby library
+
+## Install
+
+Add in your Gemfile
+
+```rb
+gem 'magento', '~> 0.4.0'
+```
+
+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
+```
+
+## 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')
+```