magento 0.3.7 → 0.4.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4683ba34529189e0ae2a417065da3514b380463a51ea7b80a95d720e0db5a1e4
-  data.tar.gz: 5ac940a291de0ad07891cf34958d014c0b82e2a4249bf0b205d1622b066c6fff
+  metadata.gz: af61beeba0846cab8e23f29034500fe562898978552a23da76e0024fd7a93fa1
+  data.tar.gz: cdcffc887ee8a9b420b9d8262744b248d8b31330a938a64704a95a392e7f7bc1
 SHA512:
-  metadata.gz: 57a3425ec1c2cc3a110b650569f8a11ff8957092a52095c47b17c3b4aa6efaea586ebf13543ed10968e7e87047058a894a6d64d136764359cd749b37c286237f
-  data.tar.gz: 966333d6449626d8a929ac6cb6dab27b1e14d18e9d342d599888372d3bd1a2812d2bb4e364f40f38cfdad1e579b38d8f46bfe848c53002fcdeb2c5d63594575e
+  metadata.gz: b1643ee9ac6bf85537296ea21b2968c9926d896b59c571fc18807736d98eaa9e4f8fe1578754a34012d56b11304c32d5c8a9f38d8a32ea4ae3d750011f3a1e01
+  data.tar.gz: 44cceb73112da8dcebff5233ffec93a34dac3bc56126871b768a8ab8306044e42395bfd7b5c2fa8a77cfb911403253f60e84c84981ef17398387f4ff89d9a4a8

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

@@ -2,9 +2,9 @@ name: Ruby Gem
 
 on:
   push:
-    branches: [ master ]
+    branches: [ release ]
   pull_request:
-    branches: [ master ]
+    branches: [ release ]
 
 jobs:
   build:

data/README.md

@@ -1,186 +1,267 @@
-# 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')
-```
+# Magento Ruby library
+
+## Install
+
+Add in your Gemfile
+
+```rb
+gem 'magento', '~> 0.4.4'
+```
+
+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')
+```
+
+___
+
+##TODO:
+
+### Search products
+```rb
+Magento::Product.search('tshort')
+```

data/lib/magento.rb

@@ -7,7 +7,9 @@ require_relative 'magento/errors'
 require_relative 'magento/request'
 require_relative 'magento/model'
 require_relative 'magento/model_mapper'
+require_relative 'magento/record_collection'
 require_relative 'magento/query'
+require_relative 'magento/category'
 require_relative 'magento/product'
 require_relative 'magento/country'
 require_relative 'magento/customer'
@@ -18,6 +20,12 @@ Dir[File.expand_path('magento/shared/*.rb', __dir__)].map { |f| require f }
 module Magento
   class << self
     attr_accessor :url, :open_timeout, :timeout, :token, :store
+
+    def inflector
+      @inflector ||= Dry::Inflector.new do |inflections|
+        inflections.singular 'children_data', 'category'
+      end
+    end
   end
 
   self.url            = ENV['MAGENTO_URL']

data/lib/magento/model.rb

@@ -20,10 +20,14 @@ module Magento
       self.class.delete(send(self.class.primary_key))
     end
 
+    def id
+      @id || send(self.class.primary_key)
+    end
+
     class << self
       extend Forwardable
       
-      def_delegators :query, :all, :page, :per, :order, :select, :where
+      def_delegators :query, :all, :page, :per, :page_size, :order, :select, :where
 
       def find(id)
         hash = request.get("#{api_resource}/#{id}").parse
@@ -47,11 +51,11 @@ module Magento
       end
 
       def api_resource
-        endpoint || inflector.pluralize(entity_name)
+        endpoint || Magento.inflector.pluralize(entity_name)
       end
 
       def entity_name
-        inflector.underscore(name).sub('magento/', '')
+        Magento.inflector.underscore(name).sub('magento/', '')
       end
 
       def primary_key
@@ -70,10 +74,6 @@ module Magento
       def request
         @request ||= Request.new
       end
-
-      def inflector
-        @inflector ||= Dry::Inflector.new
-      end
     end
   end
 end

data/lib/magento/model_mapper.rb

@@ -4,11 +4,11 @@ class ModelMapper
   end
 
   def to_model(model)
-    map_hash(model, @from)
+    map_hash(model, @from) if @from
   end
 
   def to_hash
-    self.class.to_hash(@from)
+    self.class.to_hash(@from) if @from
   end
 
   def self.from_object(object)
@@ -42,7 +42,7 @@ class ModelMapper
     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))
+        class_name = Magento.inflector.camelize(Magento.inflector.singularize(key))
         value = map_hash(Object.const_get("Magento::#{class_name}"), value)
       elsif value.is_a?(Array)
         value = map_array(key, value)
@@ -56,7 +56,7 @@ class ModelMapper
     result = []
     values.each do |value|
       if value.is_a?(Hash)
-        class_name = inflector.camelize(inflector.singularize(key))
+        class_name = Magento.inflector.camelize(Magento.inflector.singularize(key))
         result << map_hash(Object.const_get("Magento::#{class_name}"), value)
       else
         result << value
@@ -64,8 +64,4 @@ class ModelMapper
     end
     result
   end
-
-  def inflector
-    @inflector ||= Dry::Inflector.new
-  end
 end

data/lib/magento/query.rb

@@ -50,14 +50,22 @@ module Magento
       self
     end
 
-    def per(page_size)
-      self.page_size = page_size
+    def page_size(page_size)
+      @page_size = page_size
       self
     end
 
+    alias_method :per, :page_size
+
     def select(*fields)
       fields = fields.map { |field| parse_field(field) }
-      self.fields = "items[#{fields.join(',')}]"
+
+      if model == Magento::Category
+        self.fields = "children_data[#{fields.join(',')}]"
+      else
+        self.fields = "items[#{fields.join(',')}],search_criteria,total_count"
+      end
+
       self
     end
 
@@ -76,13 +84,14 @@ module Magento
     end
 
     def all
-      items = request.get("#{endpoint}?#{query_params}").parse['items']
-      items ? items.map { |i| ModelMapper.from_hash(i).to_model(model) } : []
+      result = request.get("#{endpoint}?#{query_params}").parse
+      field  = model == Magento::Category ? 'children_data' : 'items'
+      RecordCollection.from_magento_response(result, model: model, iterable_field: field)
     end
 
     private
 
-    attr_accessor :current_page, :filter_groups, :page_size, :request, :sort_orders, :model, :fields
+    attr_accessor :current_page, :filter_groups, :request, :sort_orders, :model, :fields
 
     def endpoint
       model.api_resource
@@ -100,7 +109,7 @@ module Magento
           filterGroups: filter_groups,
           currentPage: current_page,
           sortOrders: sort_orders,
-          pageSize: page_size
+          pageSize: @page_size
         }.compact,
         fields: fields
       }.compact

data/lib/magento/record_collection.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require 'forwardable'
+
+module Magento
+  class RecordCollection
+    attr_reader :items, :search_criteria, :total_count
+    extend Forwardable
+
+    def initialize(items:, total_count: nil, search_criteria: nil)
+      @items           = items || []
+      @total_count     = total_count || @items.size
+      @search_criteria = search_criteria || Magento::SearchCriterium.new
+    end
+
+    def_delegators :@search_criteria, :current_page, :filter_groups, :page_size
+
+    def_delegators :@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?
+
+    alias per page_size
+
+    class << self
+      def from_magento_response(response, model:, iterable_field: 'items')
+        items = response[iterable_field]&.map do |item|
+          ModelMapper.from_hash(item).to_model(model)
+        end
+
+        search_criteria = ModelMapper
+                          .from_hash(response['search_criteria'])
+                          .to_model(Magento::SearchCriterium)
+
+        Magento::RecordCollection.new(
+          items: items,
+          total_count: response['total_count'],
+          search_criteria: search_criteria
+        )
+      end
+    end
+  end
+end

data/lib/magento/shared/billing_address.rb

@@ -0,0 +1,4 @@
+module Magento
+  class BillingAddress
+  end
+end

data/lib/magento/shared/bundle_product_option.rb

@@ -0,0 +1,4 @@
+module Magento
+  class BundleProductOption
+  end
+end

data/lib/magento/shared/configurable_product_option.rb

@@ -0,0 +1,4 @@
+module Magento
+  class ConfigurableProductOption
+  end
+end

data/lib/magento/shared/filter.rb

@@ -0,0 +1,4 @@
+module Magento
+  class Filter
+  end
+end

data/lib/magento/shared/filter_group.rb

@@ -0,0 +1,4 @@
+module Magento
+  class FilterGroup
+  end
+end

data/lib/magento/shared/search_criterium.rb

@@ -0,0 +1,5 @@
+module Magento
+  class SearchCriterium
+    attr_accessor :current_page, :filter_groups, :page_size
+  end
+end

data/lib/magento/shared/sort_order.rb

@@ -0,0 +1,4 @@
+module Magento
+  class SortOrder
+  end
+end

data/lib/magento/shared/status_history.rb

@@ -0,0 +1,4 @@
+module Magento
+  class StatusHistory
+  end
+end

data/lib/magento/version.rb

@@ -1,3 +1,3 @@
-module Magento
-  VERSION = '0.3.7'
+module Magento
+  VERSION = '0.4.4'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: magento
 version: !ruby/object:Gem::Version
-  version: 0.3.7
+  version: 0.4.4
 platform: ruby
 authors:
 - Wallas Faria
@@ -58,12 +58,18 @@ files:
 - lib/magento/order.rb
 - lib/magento/product.rb
 - lib/magento/query.rb
+- lib/magento/record_collection.rb
 - lib/magento/request.rb
 - lib/magento/shared/address.rb
 - lib/magento/shared/available_regions.rb
+- lib/magento/shared/billing_address.rb
+- lib/magento/shared/bundle_product_option.rb
 - lib/magento/shared/category_link.rb
+- lib/magento/shared/configurable_product_option.rb
 - lib/magento/shared/custom_attribute.rb
 - lib/magento/shared/extension_attribute.rb
+- lib/magento/shared/filter.rb
+- lib/magento/shared/filter_group.rb
 - lib/magento/shared/item.rb
 - lib/magento/shared/media_gallery_entry.rb
 - lib/magento/shared/option.rb
@@ -71,8 +77,11 @@ files:
 - lib/magento/shared/payment_additional_info.rb
 - lib/magento/shared/product_link.rb
 - lib/magento/shared/region.rb
+- lib/magento/shared/search_criterium.rb
 - lib/magento/shared/shipping.rb
 - lib/magento/shared/shipping_assignment.rb
+- lib/magento/shared/sort_order.rb
+- lib/magento/shared/status_history.rb
 - lib/magento/shared/stock_item.rb
 - lib/magento/shared/tier_price.rb
 - lib/magento/shared/total.rb