magento 0.2.0 → 0.3.7

data/lib/magento/customer.rb

@@ -1,18 +1,13 @@
-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
-
-      def find_by_token(token)
-        user_request = Request.new(token: token)
-        customer_hash = user_request.get('customers/me').parse
-        map_hash Customer, customer_hash
-      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,47 +1,79 @@
-# frozen_string_literal: true
-
-require 'dry/inflector'
-
-module Magento
-  class Model
-    class << self
-      protected
-
-      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
-      end
-
-      def inflector
-        @inflector ||= Dry::Inflector.new
-      end
-
-      def request
-        @request ||= Request.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
+
+    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}").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 || 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,9 @@
-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
-    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

@@ -0,0 +1,150 @@
+# 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)
+        value = parse_value_filter(condition, value)
+        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_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
+
+      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/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