magento 0.2.0 → 0.3.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d8bc5f8a39bdb839264e76b211f08b5ce3621340c64e866295456ec136180155
-  data.tar.gz: 4711ecfd3c80b9f52dce500b8d832ebe9dd2f3ef981e9245eb4730bcfc1bc529
+  metadata.gz: 4683ba34529189e0ae2a417065da3514b380463a51ea7b80a95d720e0db5a1e4
+  data.tar.gz: 5ac940a291de0ad07891cf34958d014c0b82e2a4249bf0b205d1622b066c6fff
 SHA512:
-  metadata.gz: c4eeca2012769013e626ffa61689d487ebcf92430cd9a0740254f16bffb2ec11f62b0b8c519446fe314a571a8def6c20e46ce80def22f1ea599ff4350d81c9c3
-  data.tar.gz: df313171a3767e8bf326fbf6bb45aa53010f1a8b3f7469b4cb27cb44b82ea2e30fa19eeb7165fe3380e8c50c89760c38721cdeeb5d24b3236325da94411a1fb9
+  metadata.gz: 57a3425ec1c2cc3a110b650569f8a11ff8957092a52095c47b17c3b4aa6efaea586ebf13543ed10968e7e87047058a894a6d64d136764359cd749b37c286237f
+  data.tar.gz: 966333d6449626d8a929ac6cb6dab27b1e14d18e9d342d599888372d3bd1a2812d2bb4e364f40f38cfdad1e579b38d8f46bfe848c53002fcdeb2c5d63594575e

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/.gitignore

@@ -25,4 +25,4 @@ test/vcr_cassettes
 
 .vscode
 .byebug_history
-test.rb
+/*test.rb

data/README.md

@@ -1,111 +1,186 @@
-# Magento Ruby library
-
-## Install
-
-Add in your Gemfile
-
-```rb
-gem 'magento', '~> 0.2.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
-```
-
-## Product
-
-### Get product details by sku
-
-```rb
-Magento::Product.find_by_sku('sku-test')
-```
-
-## Customer
-
-### Get customer by id
-```rb
-Magento::Customer.find(id) # or
-Magento::Customer.find_by_id(id)
-```
-
-### Get customer by token
-```rb
-Magento::Customer.find_by_token('user_token')
-```
-
-## Countries
-
-### Get available regions for a country
-
-```rb
-country = Magento::Country.find('BR')
-
-country.available_regions
-```
-
-# TODO
-### Get product list
-
-Get all
-```rb
-Magento::Product.all()
-```
-
-Set page and quantity per page
-```rb
-Magento::Product.all(page: 1, page_size: 25) # Default page size is 50
-```
-
-Filter list by attribute
-```rb
-Magento::Product.all(name_like: 'IPhone%')
-
-Magento::Product.all(price_gt: 100, page: 2)
-```
-
-### Search products
-```rb
-Magento::Product.search('tshort')
-```
-
-## Order
-
-### Create Order as admin user
-
-See the [documentation](https://magento.redoc.ly/2.4-admin/#operation/salesOrderRepositoryV1SavePost) to all attributes
-
-```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...
-  }
-)
-```
+# Magento Ruby library
+
+## Install
+
+Add in your Gemfile
+
+```rb
+gem 'magento', '~> 0.3.7'
+```
+
+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).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_
+
+## 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')
+```

data/lib/magento.rb

@@ -1,31 +1,35 @@
-# frozen_string_literal: true
-
-require 'time'
-
-require_relative 'magento/errors'
-require_relative 'magento/request'
-require_relative 'magento/model'
-require_relative 'magento/product'
-require_relative 'magento/country'
-require_relative 'magento/customer'
-
-Dir[File.expand_path('magento/shared/*.rb', __dir__)].map { |f| require f }
-
-module Magento
-  class << self
-    attr_accessor :url, :open_timeout, :timeout, :token, :store
-  end
-
-  self.url            = ENV['MAGENTO_URL']
-  self.open_timeout   = 30
-  self.timeout        = 90
-  self.token          = ENV['MAGENTO_TOKEN']
-  self.store          = ENV['MAGENTO_STORE'] || :all
-
-  def self.production?
-    ENV['RACK_ENV'] == 'production' ||
-      ENV['RAILS_ENV'] == 'production' ||
-      ENV['PRODUCTION'] ||
-      ENV['production']
-  end
-end
+# frozen_string_literal: true
+
+require 'time'
+require 'dry/inflector'
+
+require_relative 'magento/errors'
+require_relative 'magento/request'
+require_relative 'magento/model'
+require_relative 'magento/model_mapper'
+require_relative 'magento/query'
+require_relative 'magento/product'
+require_relative 'magento/country'
+require_relative 'magento/customer'
+require_relative 'magento/order'
+
+Dir[File.expand_path('magento/shared/*.rb', __dir__)].map { |f| require f }
+
+module Magento
+  class << self
+    attr_accessor :url, :open_timeout, :timeout, :token, :store
+  end
+
+  self.url            = ENV['MAGENTO_URL']
+  self.open_timeout   = 30
+  self.timeout        = 90
+  self.token          = ENV['MAGENTO_TOKEN']
+  self.store          = ENV['MAGENTO_STORE'] || :all
+
+  def self.production?
+    ENV['RACK_ENV'] == 'production' ||
+      ENV['RAILS_ENV'] == 'production' ||
+      ENV['PRODUCTION'] ||
+      ENV['production']
+  end
+end

data/lib/magento/category.rb

@@ -0,0 +1,4 @@
+module Magento
+  class Category < Model
+  end
+end

data/lib/magento/country.rb

@@ -1,10 +1,5 @@
-module Magento
-  class Country < Model
-    class << self
-      def find(code)
-        country_hash = request.get("directory/countries/#{code}").parse
-        map_hash Country, country_hash
-      end
-    end
-  end
-end
+module Magento
+  class Country < Model
+    self.endpoint = 'directory/countries'
+  end
+end