magento 0.3.2 → 0.4.2

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, :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}")
-      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

@@ -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/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

@@ -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/request.rb

@@ -1,103 +1,108 @@
-# frozen_string_literal: true
-
-require 'uri'
-require 'http'
-
-module Magento
-  class Request
-    attr_reader :token, :store
-
-    def initialize(token: Magento.token, store: Magento.store)
-      @token = token
-      @store = store
-    end
-
-    def get(resource, token: nil)
-      save_request(:get, url(resource))
-      handle_error http_auth.get(url(resource))
-    end
-
-    def put(resource, body)
-      save_request(:put, url(resource), body)
-      handle_error http_auth.put(url(resource), json: body)
-    end
-
-    def post(resource, body = nil, url_completa = false)
-      url = url_completa ? resource : url(resource)
-      save_request(:post, url, body)
-      handle_error http_auth.post(url, json: body)
-    end
-
-    private
-
-    def http_auth
-      HTTP.auth("Bearer #{token}")
-    end
-
-    def base_url
-      url = Magento.url.to_s.sub(%r{/$}, '')
-      "#{url}/rest/#{store}/V1"
-    end
-
-    def url(resource)
-      "#{base_url}/#{resource}"
-    end
-
-    def search_params(field:, value:, conditionType: :eq)
-      create_params(
-        filter_groups: {
-          '0': {
-            filters: {
-              '0': {
-                field: field,
-                conditionType: conditionType,
-                value: value
-              }
-            }
-          }
-        }
-      )
-    end
-
-    def field_params(fields:)
-      create_params(fields: fields)
-    end
-
-    def create_params(filter_groups: nil, fields: nil, current_page: 1)
-      CGI.unescape(
-        {
-          searchCriteria: {
-            currentPage: current_page,
-            filterGroups: filter_groups
-          }.compact,
-          fields: fields
-        }.compact.to_query
-      )
-    end
-
-    def handle_error(resp)
-      return resp if resp.status.success?
-
-      begin
-        msg = resp.parse['message']
-        errors = resp.parse['errors']
-      rescue StandardError
-        msg = 'Failed access to the magento server'
-        errors = []
-      end
-
-      raise Magento::NotFound.new(msg, resp.status.code, errors, @request) if resp.status.not_found?
-
-      raise Magento::MagentoError.new(msg, resp.status.code, errors, @request)
-    end
-
-    def save_request(method, url, body = nil)
-      begin
-        body = body[:product].reject { |e| e == :media_gallery_entries }
-      rescue StandardError
-      end
-
-      @request = { method: method, url: url, body: body }
-    end
-  end
-end
+# frozen_string_literal: true
+
+require 'uri'
+require 'http'
+
+module Magento
+  class Request
+    attr_reader :token, :store
+
+    def initialize(token: Magento.token, store: Magento.store)
+      @token = token
+      @store = store
+    end
+
+    def get(resource)
+      save_request(:get, url(resource))
+      handle_error http_auth.get(url(resource))
+    end
+
+    def put(resource, body)
+      save_request(:put, url(resource), body)
+      handle_error http_auth.put(url(resource), json: body)
+    end
+
+    def post(resource, body = nil, url_completa = false)
+      url = url_completa ? resource : url(resource)
+      save_request(:post, url, body)
+      handle_error http_auth.post(url, json: body)
+    end
+
+    def delete(resource)
+      save_request(:delete, url(resource))
+      handle_error http_auth.delete(url(resource))
+    end
+
+    private
+
+    def http_auth
+      HTTP.auth("Bearer #{token}")
+    end
+
+    def base_url
+      url = Magento.url.to_s.sub(%r{/$}, '')
+      "#{url}/rest/#{store}/V1"
+    end
+
+    def url(resource)
+      "#{base_url}/#{resource}"
+    end
+
+    def search_params(field:, value:, conditionType: :eq)
+      create_params(
+        filter_groups: {
+          '0': {
+            filters: {
+              '0': {
+                field: field,
+                conditionType: conditionType,
+                value: value
+              }
+            }
+          }
+        }
+      )
+    end
+
+    def field_params(fields:)
+      create_params(fields: fields)
+    end
+
+    def create_params(filter_groups: nil, fields: nil, current_page: 1)
+      CGI.unescape(
+        {
+          searchCriteria: {
+            currentPage: current_page,
+            filterGroups: filter_groups
+          }.compact,
+          fields: fields
+        }.compact.to_query
+      )
+    end
+
+    def handle_error(resp)
+      return resp if resp.status.success?
+
+      begin
+        msg = resp.parse['message']
+        errors = resp.parse['errors']
+      rescue StandardError
+        msg = 'Failed access to the magento server'
+        errors = []
+      end
+
+      raise Magento::NotFound.new(msg, resp.status.code, errors, @request) if resp.status.not_found?
+
+      raise Magento::MagentoError.new(msg, resp.status.code, errors, @request)
+    end
+
+    def save_request(method, url, body = nil)
+      begin
+        body = body[:product].reject { |e| e == :media_gallery_entries }
+      rescue StandardError
+      end
+
+      @request = { method: method, url: url, body: body }
+    end
+  end
+end