magento 0.3.0 → 0.4.0

data/lib/magento.rb

@@ -1,35 +1,43 @@
-# 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
+# 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/record_collection'
+require_relative 'magento/query'
+require_relative 'magento/category'
+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
+
+    def inflector
+      @inflector ||= Dry::Inflector.new do |inflections|
+        inflections.singular 'children_data', 'category'
+      end
+    end
+  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/country.rb

@@ -1,5 +1,5 @@
-module Magento
-  class Country < Model
-    self.endpoint = 'directory/countries'
-  end
-end
+module Magento
+  class Country < Model
+    self.endpoint = 'directory/countries'
+  end
+end

data/lib/magento/customer.rb

@@ -1,13 +1,13 @@
-module Magento
-  class Customer < Model
-    class << self
-      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
-        ModelMapper.from_hash(customer_hash).to_model(Customer)
-      end
-    end
-  end
-end
+module Magento
+  class Customer < Model
+    class << self
+      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
+        ModelMapper.from_hash(customer_hash).to_model(Customer)
+      end
+    end
+  end
+end

data/lib/magento/model.rb

@@ -1,79 +1,79 @@
-# frozen_string_literal: true
-
-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
-      extend Forwardable
-      
-      def_delegators :query, :all, :page, :per, :order, :select
-
-      def find(id)
-        hash = request.get("#{api_resource}/#{id}").parse
-        ModelMapper.from_hash(hash).to_model(self)
-      end
-
-      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
+# frozen_string_literal: true
+
+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
+
+    def id
+      @id || send(self.class.primary_key)
+    end
+
+    class << self
+      extend Forwardable
+      
+      def_delegators :query, :all, :page, :per, :page_size, :order, :select, :where
+
+      def find(id)
+        hash = request.get("#{api_resource}/#{id}").parse
+        ModelMapper.from_hash(hash).to_model(self)
+      end
+
+      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}").status.success?
+      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 || Magento.inflector.pluralize(entity_name)
+      end
+
+      def entity_name
+        Magento.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
+    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/product.rb

@@ -1,7 +1,9 @@
-module Magento
-  class Product < Model
-    class << self
-      alias_method :find_by_sku, :find
-    end
-  end
-end
+module Magento
+  class Product < Model
+    self.primary_key = :sku
+
+    class << self
+      alias_method :find_by_sku, :find
+    end
+  end
+end

data/lib/magento/query.rb

@@ -38,6 +38,7 @@ module Magento
       filters = []
       attributes.each do |key, value|
         field, condition = parse_filter(key)
+        value = parse_value_filter(condition, value)
         filters << { field: field, conditionType: condition, value: value }
       end
       filter_groups << { filters: filters }
@@ -49,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
 
@@ -75,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
@@ -99,7 +108,7 @@ module Magento
           filterGroups: filter_groups,
           currentPage: current_page,
           sortOrders: sort_orders,
-          pageSize: page_size
+          pageSize: @page_size
         }.compact,
         fields: fields
       }.compact
@@ -115,6 +124,14 @@ module Magento
       key.match(patter).to_a[1..2]
     end
 
+    def parse_value_filter(condition, value)
+      if ['in', 'nin'].include?(condition) && value.is_a?(Array)
+        value = value.join(',')
+      end
+
+      value
+    end
+
     def parse_field(value)
       return verify_id(value) unless value.is_a? Hash
 

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