magento 0.4.4 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: af61beeba0846cab8e23f29034500fe562898978552a23da76e0024fd7a93fa1
-  data.tar.gz: cdcffc887ee8a9b420b9d8262744b248d8b31330a938a64704a95a392e7f7bc1
+  metadata.gz: 5a31c9d80a9b75142710a4eaca0c87e47ac32c9fc0589ce967cebd450350a4e2
+  data.tar.gz: 16e930d0a17ccab6e520e75e4a87da495caee97977c6ed61b59b5ed046c82485
 SHA512:
-  metadata.gz: b1643ee9ac6bf85537296ea21b2968c9926d896b59c571fc18807736d98eaa9e4f8fe1578754a34012d56b11304c32d5c8a9f38d8a32ea4ae3d750011f3a1e01
-  data.tar.gz: 44cceb73112da8dcebff5233ffec93a34dac3bc56126871b768a8ab8306044e42395bfd7b5c2fa8a77cfb911403253f60e84c84981ef17398387f4ff89d9a4a8
+  metadata.gz: ed64d3a633a8d5e4cfd6eac464ff4d3bfc85c5105c5a2f83a4dc8d739710d584fa9ca35a17f49ea49eeadd01e3aadc6d1c6c48e3f46fbe085544b3ada8e518b4
+  data.tar.gz: 9ad6ce4e8e29c15eea332371f3c73b9d0c342d97b540a764ae7e8f6f03244e087e44fd72e8f1bd5e50cb5fc5b22327f9b2ee55369261ea9efa1208fc13527209

data/README.md

@@ -5,7 +5,7 @@
 Add in your Gemfile
 
 ```rb
-gem 'magento', '~> 0.4.4'
+gem 'magento', '~> 0.5.0'
 ```
 
 or run
@@ -257,6 +257,25 @@ product.delete
 Magento::Product.delete('sku-teste')
 ```
 
+## GuestCart
+
+Set payment information to finish the order
+```rb
+cart = Magento::GuestCart.find('gXsepZcgJbY8RCJXgGioKOO9iBCR20r7')
+
+# or use "build" to not request information from the magento API
+cart = Magento::GuestCart.build(
+  cart_id: 'aj8oUtY1Qi44Fror6UWVN7ftX1idbBKN'
+)
+
+cart.payment_information(
+  email: 'customer@gmail.com',
+  payment: { method: 'cashondelivery' }
+)
+
+>> "234575" # return the order id
+```
+
 ___
 
 ##TODO:

data/lib/magento.rb

@@ -1,43 +1,44 @@
-# 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
+# frozen_string_literal: true
+
+require 'time'
+require 'dry/inflector'
+
+require_relative 'magento/errors'
+require_relative 'magento/request'
+require_relative 'magento/model_mapper'
+require_relative 'magento/model'
+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'
+require_relative 'magento/guest_cart'
+
+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/customer.rb

@@ -1,13 +1,17 @@
-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
+    def fullname
+      "#{@firstname} #{@lastname}"
+    end
+
+    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
+        build(customer_hash)
+      end
+    end
+  end
+end

data/lib/magento/guest_cart.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module Magento
+  class GuestCart < Model
+    self.endpoint = 'guest-carts'
+    self.primary_key = :cart_id
+
+    def add_item(item_attributes)
+      attributes = { cartItem: item_attributes.merge(quote_id: cart_id) }
+      item = self.class.add_item(cart_id, attributes)
+      @items = @items.reject {|i| i.item_id == item.item_id} << item if @items
+      item
+    end
+
+    #
+    # Set payment information to finish the order
+    # 
+    # Example:
+    # cart = Magento::GuestCart.find('gXsepZcgJbY8RCJXgGioKOO9iBCR20r7')
+    #
+    # # or use "build" to not request information from the magento API
+    # cart = Magento::GuestCart.build({ 'cart_id' => 'aj8oUtY1Qi44Fror6UWVN7ftX1idbBKN' })
+    #
+    # cart.payment_information(
+    #   email: 'customer@gmail.com',
+    #   payment: { method: 'cashondelivery' }
+    # )
+    #
+    # @return String: return the order id
+    def payment_information(email:, payment:)
+      attributes = { cartId: cart_id, paymentMethod: payment, email: email }
+      self.class.payment_information(attributes)
+    end
+
+    class << self
+      def create(load_cart_info: false)
+        cart = build(cart_id: request.post(api_resource).parse)
+        find cart.id if load_cart_info
+      end
+
+      def find(id)
+        cart = build request.get("#{api_resource}/#{id}").parse.merge(cart_id: id)
+      end
+
+      #
+      # Set payment information to finish the order using class method
+      #
+      # Example:
+      # Magento::GuestCart.payment_information(
+      #   cartId: 'aj8oUtY1Qi44Fror6UWVN7ftX1idbBKN',
+      #   paymentMethod: { method: 'cashondelivery' },
+      #   email: email
+      # )
+      #
+      # @return String: return the order id
+      def payment_information(attributes)
+        attributes.transform_keys(&:to_sym)
+        url = "#{api_resource}/#{attributes[:cartId]}/payment-information"
+        request.post(url, attributes).parse
+      end
+
+      def add_item(id, attributes)
+        url  = "#{api_resource}/#{id}/items"
+        hash = request.post(url, attributes).parse
+        Magento::ModelMapper.map_hash(Magento::Item, hash)
+      end
+    end
+  end
+end

data/lib/magento/model.rb

@@ -1,79 +1,84 @@
-# 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
+# frozen_string_literal: true
+
+require 'forwardable'
+
+module Magento
+  class Model
+    include Magento::ModelParser
+
+    def save
+      self.class.update(send(self.class.primary_key), to_h)
+    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
+        build(hash)
+      end
+
+      def create(attributes)
+        body = { entity_name => attributes }
+        hash = request.post(api_resource, body).parse
+        build(hash)
+      end
+
+      def delete(id)
+        request.delete("#{api_resource}/#{id}").status.success?
+      end
+
+      def update(id, attributes)
+        body = { entity_key => attributes }
+        hash = request.put("#{api_resource}/#{id}", body).parse
+        build(hash)
+      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, :entity_key
+
+      def entity_key
+        @entity_key || entity_name
+      end
+
+      def query
+        Query.new(self)
+      end
+
+      def request
+        @request ||= Request.new
+      end
+    end
+  end
+end

data/lib/magento/model_mapper.rb

@@ -1,67 +1,63 @@
-class ModelMapper
-  def initialize(from)
-    @from = from
-  end
-
-  def to_model(model)
-    map_hash(model, @from) if @from
-  end
-
-  def to_hash
-    self.class.to_hash(@from) if @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
+module Magento
+  module ModelMapper
+    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[key] = value
+      hash
     end
-    hash
-  end
 
-  private
+    def self.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 = 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)
+        end
+        object.send("#{key}=", value)
+      end
+      object
+    end
 
-  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 = 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)
+    def self.map_array(key, values)
+      result = []
+      values.each do |value|
+        if value.is_a?(Hash)
+          class_name = Magento.inflector.camelize(Magento.inflector.singularize(key))
+          result << map_hash(Object.const_get("Magento::#{class_name}"), value)
+        else
+          result << value
+        end
       end
-      object.send("#{key}=", value)
+      result
     end
-    object
   end
 
-  def map_array(key, values)
-    result = []
-    values.each do |value|
-      if value.is_a?(Hash)
-        class_name = Magento.inflector.camelize(Magento.inflector.singularize(key))
-        result << map_hash(Object.const_get("Magento::#{class_name}"), value)
-      else
-        result << value
+  module ModelParser
+    module ClassMethods
+      def build(attributes)
+        ModelMapper.map_hash(self, attributes)
       end
     end
-    result
+
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    def to_h
+      ModelMapper.to_hash(self)
+    end
   end
 end

data/lib/magento/order.rb

@@ -1,5 +1,6 @@
 module Magento
   class Order < Model
     self.primary_key = :entity_id
+    self.entity_key = :entity
   end
 end

data/lib/magento/record_collection.rb

@@ -1,44 +1,36 @@
-# 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
+# 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')
+        Magento::RecordCollection.new(
+          items: response[iterable_field]&.map { |item| model.build(item) },
+          total_count: response['total_count'],
+          search_criteria: Magento::SearchCriterium.build(response['search_criteria'])
+        )
+      end
+    end
+  end
+end

data/lib/magento/request.rb

@@ -1,108 +1,79 @@
-# 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
+# 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 handle_error(resp)
+      return resp if resp.status.success?
+
+      begin
+        msg = resp.parse['message']
+        errors = resp.parse['errors']
+        if resp.parse['parameters'].is_a? Hash
+          resp.parse['parameters'].each { |k, v| msg.sub! "%#{k}", v }
+        end
+      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

data/lib/magento/shared/currency.rb

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

data/lib/magento/shared/search_criterium.rb

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

data/lib/magento/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: magento
 version: !ruby/object:Gem::Version
-  version: 0.4.4
+  version: 0.5.0
 platform: ruby
 authors:
 - Wallas Faria
@@ -53,6 +53,7 @@ files:
 - lib/magento/country.rb
 - lib/magento/customer.rb
 - lib/magento/errors.rb
+- lib/magento/guest_cart.rb
 - lib/magento/model.rb
 - lib/magento/model_mapper.rb
 - lib/magento/order.rb
@@ -66,6 +67,7 @@ files:
 - lib/magento/shared/bundle_product_option.rb
 - lib/magento/shared/category_link.rb
 - lib/magento/shared/configurable_product_option.rb
+- lib/magento/shared/currency.rb
 - lib/magento/shared/custom_attribute.rb
 - lib/magento/shared/extension_attribute.rb
 - lib/magento/shared/filter.rb