magento 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d8bc5f8a39bdb839264e76b211f08b5ce3621340c64e866295456ec136180155
-  data.tar.gz: 4711ecfd3c80b9f52dce500b8d832ebe9dd2f3ef981e9245eb4730bcfc1bc529
+  metadata.gz: 78965c7e294c387a88b86cf0af3a099f54729ca292050d1b0cc71046f6e5de6c
+  data.tar.gz: 7e714fbb399e0ed27946984437d2a4603481f33e98ffa551e5f83b0987518e9c
 SHA512:
-  metadata.gz: c4eeca2012769013e626ffa61689d487ebcf92430cd9a0740254f16bffb2ec11f62b0b8c519446fe314a571a8def6c20e46ce80def22f1ea599ff4350d81c9c3
-  data.tar.gz: df313171a3767e8bf326fbf6bb45aa53010f1a8b3f7469b4cb27cb44b82ea2e30fa19eeb7165fe3380e8c50c89760c38721cdeeb5d24b3236325da94411a1fb9
+  metadata.gz: 36cc52f478ee96696a451b1bf943db80128ca3f333391c628e026305d67d9f242fe699efc7dbbf624707945fdde47cf2f7f87391e24543e8cb4eefe3984d3bd1
+  data.tar.gz: 1f0ab0fd15b026b47ed6de9252e249bb084cd92fd60021beafc90e1341ea7439e2a9d75ad5046fce1cd89a6947626ae2f475fe4fa3c8dca5a88c457ba4502d00

data/.gitignore

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

data/README.md

@@ -5,7 +5,7 @@
 Add in your Gemfile
 
 ```rb
-gem 'magento', '~> 0.2.0'
+gem 'magento', '~> 0.3.0'
 ```
 
 or run
@@ -22,67 +22,102 @@ Magento.token = 'MAGENTO_API_KEY'
 Magento.store = :default # optional, Default is :all
 ```
 
-## Product
-
-### Get product details by sku
-
+## Models
 ```rb
-Magento::Product.find_by_sku('sku-test')
+Magento::Product
+Magento::Order
+Magento::Country
+Magento::Category
 ```
 
-## Customer
+## Get details
 
-### Get customer by id
 ```rb
-Magento::Customer.find(id) # or
-Magento::Customer.find_by_id(id)
+Magento::Product.find('sku-test')
+Magento::Order.find(25)
+Magento::Country.find('BR')
 ```
+\* _same pattern to all models_
+
+**Outside pattern**
+
+Get customer by token
 
-### Get customer by token
 ```rb
 Magento::Customer.find_by_token('user_token')
 ```
 
-## Countries
-
-### Get available regions for a country
+## Get List
 
 ```rb
-country = Magento::Country.find('BR')
+Magento::Product.all
+```
 
-country.available_regions
+#### 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
 ```
 
-# TODO
-### Get product list
+#### Filters:
 
-Get all
 ```rb
-Magento::Product.all()
+Magento::Product.where(name_like: 'IPhone%').all
+Magento::Product.where(price_gt: 100).all
+Magento::Product.where(price_gt: 100, price_lt: 200).all
 ```
 
-Set page and quantity per page
+| 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.all(page: 1, page_size: 25) # Default page size is 50
+Magento::Product.order(:sku).all
+Magento::Product.order(sku: :desc).all
+Magento::Product.order(status: :desc, name: :asc).all
 ```
 
-Filter list by attribute
-```rb
-Magento::Product.all(name_like: 'IPhone%')
+#### Pagination:
 
-Magento::Product.all(price_gt: 100, page: 2)
+```rb
+# Set page and quantity per page
+Magento::Product.page(1).per(25) # Default per is 50
 ```
 
-### Search products
+#### Example of several options together:
 ```rb
-Magento::Product.search('tshort')
+Magento::Product.select(:sku, :name, :price)
+                .where(name_like: 'Tshort%')
+                .order(price: :desc)
+                .per(10)
+                .all
 ```
 
-## Order
+\* _same pattern to all models_
+___
+## \######### TODO \##########
 
-### Create Order as admin user
-
-See the [documentation](https://magento.redoc.ly/2.4-admin/#operation/salesOrderRepositoryV1SavePost) to all attributes
+## Create
 
 ```rb
 Magento::Order.create(
@@ -109,3 +144,33 @@ Magento::Order.create(
   }
 )
 ```
+
+### 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')
+```

data/lib/magento.rb

@@ -1,13 +1,17 @@
 # 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 }
 

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
+    self.endpoint = 'directory/countries'
   end
 end

data/lib/magento/customer.rb

@@ -1,17 +1,12 @@
 module Magento
   class Customer < Model
     class << self
-      def find_by_id(id)
-        customer_hash = request.get("customers/#{id}").parse
-        map_hash Customer, customer_hash
-      end
-
-      alias_method :find, :find_by_id
+      alias_method :find_by_id, :find
 
       def find_by_token(token)
         user_request = Request.new(token: token)
         customer_hash = user_request.get('customers/me').parse
-        map_hash Customer, customer_hash
+        ModelMapper.from_hash(customer_hash).to_model(Customer)
       end
     end
   end

data/lib/magento/model.rb

@@ -1,47 +1,79 @@
 # frozen_string_literal: true
 
-require 'dry/inflector'
+require 'forwardable'
 
 module Magento
   class Model
+    def save
+      body = ModelMapper.from_object(self).to_hash
+      self.class.update(send(self.class.primary_key), body)
+    end
+
+    def update(attrs)
+      raise "#{self.class.name} not saved" if send(self.class.primary_key).nil?
+
+      attrs.each { |key, value| send("#{key}=", value) }
+      save
+    end
+
+    def delete
+      self.class.delete(send(self.class.primary_key))
+    end
+
     class << self
-      protected
+      extend Forwardable
+      
+      def_delegators :query, :all, :page, :per, :order, :select
 
-      def map_hash(klass, values)
-        object = klass.new
-        values.each do |key, value|
-          object.singleton_class.instance_eval { attr_accessor key }
-          if value.is_a?(Hash)
-            class_name = inflector.camelize(inflector.singularize(key))
-            value = map_hash(Object.const_get("Magento::#{class_name}"), value)
-          elsif value.is_a?(Array)
-            value = map_array(key, value)
-          end
-          object.send("#{key}=", value)
-        end
-        object
-      end
-
-      def map_array(key, values)
-        result = []
-        values.each do |value|
-          if value.is_a?(Hash)
-            class_name = inflector.camelize(inflector.singularize(key))
-            result << map_hash(Object.const_get("Magento::#{class_name}"), value)
-          else
-            result << value
-          end
-        end
-        result
+      def find(id)
+        hash = request.get("#{api_resource}/#{id}").parse
+        ModelMapper.from_hash(hash).to_model(self)
       end
 
-      def inflector
-        @inflector ||= Dry::Inflector.new
+      def create(attributes)
+        body = { entity_name => attributes }
+        hash = request.post(api_resource, body).parse
+        ModelMapper.from_hash(hash).to_model(self)
+      end
+
+      def delete(id)
+        request.delete("#{api_resource}/#{id}")
+      end
+
+      def update(id, attributes)
+        body = { entity_name => attributes }
+        hash = request.put("#{api_resource}/#{id}", body).parse
+        ModelMapper.from_hash(hash).to_model(self)
+      end
+
+      def api_resource
+        endpoint || inflector.pluralize(entity_name)
+      end
+
+      def entity_name
+        inflector.underscore(name).sub('magento/', '')
+      end
+
+      def primary_key
+        @primary_key || :id
+      end
+
+      protected
+
+      attr_writer :primary_key
+      attr_accessor :endpoint
+
+      def query
+        Query.new(self)
       end
 
       def request
         @request ||= Request.new
       end
+
+      def inflector
+        @inflector ||= Dry::Inflector.new
+      end
     end
   end
 end

data/lib/magento/model_mapper.rb

@@ -0,0 +1,71 @@
+class ModelMapper
+  def initialize(from)
+    @from = from
+  end
+
+  def to_model(model)
+    map_hash(model, @from)
+  end
+
+  def to_hash
+    self.class.to_hash(@from)
+  end
+
+  def self.from_object(object)
+    new(object)
+  end
+
+  def self.from_hash(values)
+    new(values)
+  end
+
+  def self.to_hash(object)
+    hash = {}
+    object.instance_variables.each do |attr|
+      key   = attr.to_s.delete('@')
+      value = object.send(key)
+      value = to_hash(value) if value.class.name.include?('Magento::')
+      if value.is_a? Array
+        value = value.map do |item|
+          item.class.name.include?('Magento::') ? to_hash(item) : item
+        end
+      end
+      hash[key] = value
+    end
+    hash
+  end
+
+  private
+
+  def map_hash(model, values)
+    object = model.new
+    values.each do |key, value|
+      object.singleton_class.instance_eval { attr_accessor key }
+      if value.is_a?(Hash)
+        class_name = inflector.camelize(inflector.singularize(key))
+        value = map_hash(Object.const_get("Magento::#{class_name}"), value)
+      elsif value.is_a?(Array)
+        value = map_array(key, value)
+      end
+      object.send("#{key}=", value)
+    end
+    object
+  end
+
+  def map_array(key, values)
+    result = []
+    values.each do |value|
+      if value.is_a?(Hash)
+        class_name = inflector.camelize(inflector.singularize(key))
+        result << map_hash(Object.const_get("Magento::#{class_name}"), value)
+      else
+        result << value
+      end
+    end
+    result
+  end
+
+  def inflector
+    @inflector ||= Dry::Inflector.new
+  end
+end

data/lib/magento/order.rb

@@ -0,0 +1,5 @@
+module Magento
+  class Order < Model
+    self.primary_key = :entity_id
+  end
+end

data/lib/magento/product.rb

@@ -1,10 +1,7 @@
 module Magento
   class Product < Model
     class << self
-      def find_by_sku(sku)
-        product_hash = request.get("products/#{sku}").parse
-        map_hash Product, product_hash
-      end
+      alias_method :find_by_sku, :find
     end
   end
 end

data/lib/magento/query.rb

@@ -0,0 +1,141 @@
+# frozen_string_literal: true
+
+require 'cgi'
+
+module Magento
+  class Query
+    ACCEPTED_CONDITIONS = [
+      '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
+    ].freeze
+
+    def initialize(model, request: Request.new)
+      @model = model
+      @request = request
+      @filter_groups = nil
+      @current_page = 1
+      @page_size = 50
+      @sort_orders = nil
+      @fields = nil
+    end
+
+    def where(attributes)
+      self.filter_groups = [] unless filter_groups
+      filters = []
+      attributes.each do |key, value|
+        field, condition = parse_filter(key)
+        filters << { field: field, conditionType: condition, value: value }
+      end
+      filter_groups << { filters: filters }
+      self
+    end
+
+    def page(current_page)
+      self.current_page = current_page
+      self
+    end
+
+    def per(page_size)
+      self.page_size = page_size
+      self
+    end
+
+    def select(*fields)
+      fields = fields.map { |field| parse_field(field) }
+      self.fields = "items[#{fields.join(',')}]"
+      self
+    end
+
+    def order(attributes)
+      if attributes.is_a?(String)
+        self.sort_orders = [{ field: verify_id(attributes), direction: :asc }]
+      elsif attributes.is_a?(Hash)
+        self.sort_orders = []
+        attributes.each do |field, direction|
+          raise "Invalid sort order direction '#{direction}'" unless %w[asc desc].include?(direction.to_s)
+
+          sort_orders << { field: verify_id(field), direction: direction }
+        end
+      end
+      self
+    end
+
+    def all
+      items = request.get("#{endpoint}?#{query_params}").parse['items']
+      items ? items.map { |i| ModelMapper.from_hash(i).to_model(model) } : []
+    end
+
+    private
+
+    attr_accessor :current_page, :filter_groups, :page_size, :request, :sort_orders, :model, :fields
+
+    def endpoint
+      model.api_resource
+    end
+
+    def verify_id(field)
+      return model.primary_key if (field.to_s == 'id') && (field.to_s != model.primary_key.to_s)
+
+      field
+    end
+
+    def query_params
+      query = {
+        searchCriteria: {
+          filterGroups: filter_groups,
+          currentPage: current_page,
+          sortOrders: sort_orders,
+          pageSize: page_size
+        }.compact,
+        fields: fields
+      }.compact
+
+      encode query
+    end
+
+    def parse_filter(key)
+      patter = /(.*)_([a-z]+)$/
+      raise 'Invalid format' unless key.match(patter)
+      raise 'Condition not accepted' unless ACCEPTED_CONDITIONS.include?(key.match(patter)[2])
+
+      key.match(patter).to_a[1..2]
+    end
+
+    def parse_field(value)
+      return verify_id(value) unless value.is_a? Hash
+
+      value.map do |k, v|
+        fields = v.is_a?(Array) ? v.map { |field| parse_field(field) } : [parse_field(v)]
+        "#{k}[#{fields.join(',')}]"
+      end.join(',')
+    end
+
+    def encode(value, key = nil)
+      case value
+      when Hash  then value.map { |k, v| encode(v, append_key(key, k)) }.join('&')
+      when Array then value.each_with_index.map { |v, i| encode(v, "#{key}[#{i}]") }.join('&')
+      when nil   then ''
+      else
+        "#{key}=#{CGI.escape(value.to_s)}"
+      end
+    end
+
+    def append_key(root_key, key)
+      root_key.nil? ? key : "#{root_key}[#{key}]"
+    end
+  end
+end

data/lib/magento/shared/item.rb

@@ -0,0 +1,3 @@
+module Magento
+  class Item; end
+end

data/lib/magento/shared/payment.rb

@@ -0,0 +1,3 @@
+module Magento
+  class Payment; end
+end

data/lib/magento/shared/payment_additional_info.rb

@@ -0,0 +1,3 @@
+module Magento
+  class PaymentAdditionalInfo; end
+end

data/lib/magento/shared/shipping.rb

@@ -0,0 +1,3 @@
+module Magento
+  class Shipping; end
+end

data/lib/magento/shared/shipping_assignment.rb

@@ -0,0 +1,3 @@
+module Magento
+  class ShippingAssignment; end
+end

data/lib/magento/shared/total.rb

@@ -0,0 +1,3 @@
+module Magento
+  class Total; end
+end

data/lib/magento/shared/value.rb

@@ -0,0 +1,3 @@
+module Magento
+  class Value; end
+end

data/magento.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name          = 'magento'
-  s.version       = '0.2.0'
+  s.version       = '0.3.0'
   s.date          = '2020-07-31'
   s.summary       = 'Magento Ruby library'
   s.description   = 'Magento Ruby library'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: magento
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Wallas Faria
@@ -48,23 +48,34 @@ files:
 - Gemfile
 - README.md
 - lib/magento.rb
+- lib/magento/category.rb
 - lib/magento/country.rb
 - lib/magento/customer.rb
 - lib/magento/errors.rb
 - lib/magento/model.rb
+- lib/magento/model_mapper.rb
+- lib/magento/order.rb
 - lib/magento/product.rb
+- lib/magento/query.rb
 - lib/magento/request.rb
 - lib/magento/shared/address.rb
 - lib/magento/shared/available_regions.rb
 - lib/magento/shared/category_link.rb
 - lib/magento/shared/custom_attribute.rb
 - lib/magento/shared/extension_attribute.rb
+- lib/magento/shared/item.rb
 - lib/magento/shared/media_gallery_entry.rb
 - lib/magento/shared/option.rb
+- lib/magento/shared/payment.rb
+- lib/magento/shared/payment_additional_info.rb
 - lib/magento/shared/product_link.rb
 - lib/magento/shared/region.rb
+- lib/magento/shared/shipping.rb
+- lib/magento/shared/shipping_assignment.rb
 - lib/magento/shared/stock_item.rb
 - lib/magento/shared/tier_price.rb
+- lib/magento/shared/total.rb
+- lib/magento/shared/value.rb
 - magento.gemspec
 homepage: https://github.com/WallasFaria/magento-ruby
 licenses: []