magento 0.3.7 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4683ba34529189e0ae2a417065da3514b380463a51ea7b80a95d720e0db5a1e4
-  data.tar.gz: 5ac940a291de0ad07891cf34958d014c0b82e2a4249bf0b205d1622b066c6fff
+  metadata.gz: 10797b41b2292eb765414cf4757cca8e92d6eeaa604ae3c59da76763e11dce9e
+  data.tar.gz: 683f76e2c1b7215e279459bd5eca921caba0e58fe18d299a29c256a0a5e11b94
 SHA512:
-  metadata.gz: 57a3425ec1c2cc3a110b650569f8a11ff8957092a52095c47b17c3b4aa6efaea586ebf13543ed10968e7e87047058a894a6d64d136764359cd749b37c286237f
-  data.tar.gz: 966333d6449626d8a929ac6cb6dab27b1e14d18e9d342d599888372d3bd1a2812d2bb4e364f40f38cfdad1e579b38d8f46bfe848c53002fcdeb2c5d63594575e
+  metadata.gz: c8c44416f426c6c57bd402cd2d794027ce811bdd1d2e001502d19ffc785e3cb16b26d01fa983c1a3e1582a2d2a6b18f33a3a6f472230069abb33d75263676060
+  data.tar.gz: 5175d8d609601f3b207e29f92cfa38fff076c7ec51a225c274cbdfbd5d6a81edc99e3f8069ebeed100b838899add3c875c70054afa2de70601d69148270ad521

data/README.md

@@ -5,7 +5,7 @@
 Add in your Gemfile
 
 ```rb
-gem 'magento', '~> 0.3.7'
+gem 'magento', '~> 0.4.0'
 ```
 
 or run
@@ -109,20 +109,55 @@ Magento::Product.order(status: :desc, name: :asc).all
 
 ```rb
 # Set page and quantity per page
-Magento::Product.page(1).per(25) # Default per is 50
+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
-Magento::Product.select(:sku, :name, :price)
-                .where(name_like: 'Tshort%')
-                .order(price: :desc)
-                .per(10)
-                .all
+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

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

@@ -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,13 @@ 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
+      RecordCollection.from_magento_response(result, model: model)
     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 +108,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,66 @@
+# frozen_string_literal: true
+
+require 'forwardable'
+
+module Magento
+  class RecordCollection
+    attr_accessor :items, :search_criteria, :total_count
+    extend Forwardable
+
+    def initialize
+      @items = []
+      @search_criteria = Magento::SearchCriterium
+    end
+
+    def_delegators :@search_criteria, :current_page, :filter_groups, :page_size
+
+    def_delegators :@items, :last, :each_index, :sample, :sort, :count, :[],
+                   :find_index, :select, :filter, :reject, :collect, :map,
+                   :first, :all?, :any?, :none?, :one?, :reverse_each, :take,
+                   :take_while, :drop, :drop_while, :cycle, :index, :sort_by,
+                   :empty?, :reverse, :length, :size, :each, :find
+
+    alias_method :per, :page_size
+
+    class << self
+      def from_magento_response(response, model:)
+        if model == Magento::Category
+          handle_category_response(response, model)
+        else
+          handle_response(response, model)
+        end
+      end
+
+      private
+
+      def handle_category_response(response, model)
+        collection = Magento::RecordCollection.new
+
+        collection.items = response['children_data']&.map do |item|
+          ModelMapper.from_hash(item).to_model(model)
+        end || []
+
+        collection.total_count = response['children_data']&.size || 0
+        collection
+      end
+
+      def handle_response(response, model)
+        collection = Magento::RecordCollection.new
+
+        collection.items = response['items']&.map do |item|
+          ModelMapper.from_hash(item).to_model(model)
+        end || []
+
+        collection.total_count = response['total_count'] if response['total_count']
+
+        if response['search_criteria']
+          collection.search_criteria = ModelMapper
+            .from_hash(response['search_criteria'])
+            .to_model(Magento::SearchCriterium)
+        end
+
+        collection
+      end
+    end
+  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/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: magento
 version: !ruby/object:Gem::Version
-  version: 0.3.7
+  version: 0.4.0
 platform: ruby
 authors:
 - Wallas Faria
@@ -58,12 +58,17 @@ 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/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,6 +76,7 @@ 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/stock_item.rb