magento 0.9.0 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 84ae0187402170a5d338e8fe19f7ffa07211be073592c36aff70a5edef16e008
-  data.tar.gz: 7eed987d9b42e2ec86f9394c088c363658cb27cfcb664a8d2192ada23c0ee5b8
+  metadata.gz: 2cac0ea3cb60d8b0a55431e9b404ba17108ae038642e57c7908700915a109818
+  data.tar.gz: '098eb32b5b64f50fd1228245ec1b2f431f3512c47ec1b23c8583fc1b4cb18022'
 SHA512:
-  metadata.gz: beef9d8552c025b306ad434b33701030e032b8a603545bfcfbc407be1b141f36625075ab4f873e8bac78b6369fd5334239af3da8cff0de04ebc445ed4f1fde3d
-  data.tar.gz: b8e897978815efe0416471903a3d398b5d4ed8593a59353852cda2d33b3843ae861929f168425072ab69caeb7dec0d360ba5c1345919a2ab81990f368134c744
+  metadata.gz: 1125477eea00eafac5824a696777dea28b88dfe3bf9c0ea1161c2c98c286cbfa2198052669d6fbdb1b2041dc3fa987d4120167b1f4708859e1283ed018585d8b
+  data.tar.gz: 7db7a194488212a7d5b050d2c0acc5ec5f7f573995d291435a6a5743d39cba78320ea464f1fa2493f7672f59c5775f061f1fb9899be5ddb188b3dc9868a1c80b

data/README.md

@@ -5,7 +5,7 @@
 Add in your Gemfile
 
 ```rb
-gem 'magento', '~> 0.9.0'
+gem 'magento', '~> 0.12.0'
 ```
 
 or run
@@ -32,6 +32,7 @@ Magento::Product
 Magento::Order
 Magento::Country
 Magento::Category
+Magento::Customer
 ```
 
 ## Get details
@@ -68,6 +69,7 @@ Magento::Product.select(:id, :sku, :name, extension_attributes: [:website_ids, {
 #### Filters:
 
 ```rb
+Magento::Product.where(visibility: 4).all
 Magento::Product.where(name_like: 'IPhone%').all
 Magento::Product.where(price_gt: 100).all
 
@@ -130,6 +132,20 @@ products = Magento::Product.select(:sku, :name)
                            .all
 ```
 
+## Get one
+
+```rb
+Magento::Order.where(increment_id: '000013457').first
+# or
+Magento::Order.find_by(increment_id: '000013457')
+```
+
+## Count
+```rb
+Magento::Order.count
+Magento::Order.where(status: :pending).count
+```
+
 \* _same pattern to all models_
 
 ### Response
@@ -255,6 +271,10 @@ product.save
 # or
 
 product.update(name: 'Updated name')
+
+# or
+
+Magento::Product.update('sku-teste', name: 'Updated name')
 ```
 
 ### Delete
@@ -464,14 +484,44 @@ order.cancel # or
 Magento::Order.cancel(order_id)
 ```
 
-___
+## Generate Sales Rules and Coupons
 
-##TODO:
+```rb
+rule = Magento::SalesRule.create(
+  name: 'Discount name',
+  website_ids: [1],
+  customer_group_ids: [0,1,2,3],
+  uses_per_customer: 1,
+  is_active: true,
+  stop_rules_processing: true,
+  is_advanced: false,
+  sort_order: 0,
+  discount_amount: 100,
+  discount_step: 1,
+  apply_to_shipping: true,
+  times_used: 0,
+  is_rss: true,
+  coupon_type: 'specific',
+  use_auto_generation: true,
+  uses_per_coupon: 1
+)
 
-### Search products
+rule.generate_coupon(quantity: 1, length: 10)
+```
+
+Renarate by class method
 ```rb
-Magento::Product.search('tshort')
+Magento::SalesRule.generate_coupon(
+  couponSpec: {
+    rule_id: 7,
+    quantity: 1,
+    length: 10
+  }
+)
 ```
+see all params in:
+- [Magento docs Coupon](https://magento.redoc.ly/2.3.5-admin/tag/couponsgenerate#operation/salesRuleCouponManagementV1GeneratePost)
+- [Magento docs SalesRules](https://magento.redoc.ly/2.3.5-admin/tag/salesRules#operation/salesRuleRuleRepositoryV1SavePost)
 
 ### First result
 ```rb
@@ -482,6 +532,23 @@ Magento::Product.where(name_like: 'some name%').first
 >> <Magento::Product @sku="some-sku" ...>
 ```
 
+### Count result
+```rb
+Magento::Product.count
+>> 7855
+Magento::Product.where(name_like: 'some name%').count
+>> 15
+```
+
+___
+
+##TODO:
+
+### Search products
+```rb
+Magento::Product.search('tshort')
+```
+
 ### Last result
 ```rb
 Magento::Product.last
@@ -491,12 +558,4 @@ Magento::Product.where(name_like: 'some name%').last
 >> <Magento::Product @sku="some-sku" ...>
 ```
 
-### Count result
-```rb
-Magento::Product.count
->> 7855
-Magento::Product.where(name_like: 'some name%').count
->> 15
-```
-
 ### Tests

data/lib/magento.rb

@@ -17,6 +17,7 @@ require_relative 'magento/customer'
 require_relative 'magento/order'
 require_relative 'magento/invoice'
 require_relative 'magento/guest_cart'
+require_relative 'magento/sales_rule'
 
 Dir[File.expand_path('magento/shared/*.rb', __dir__)].map { |f| require f }
 

data/lib/magento/customer.rb

@@ -1,17 +1,47 @@
 module Magento
   class Customer < Model
+    self.endpoint = 'customers/search'
+
     def fullname
       "#{@firstname} #{@lastname}"
     end
 
+    def update(attributes)
+      raise "id not present" if @id.nil?
+
+      attributes.each { |key, value| send("#{key}=", value) }
+      save
+    end
+
     class << self
       alias_method :find_by_id, :find
 
+      def update(id, attributes)
+        hash = request.put("customers/#{id}", { customer: attributes }).parse
+
+        block_given? ? yield(hash) : build(hash)
+      end
+
+      def create(attributes)
+        attributes.transform_keys!(&:to_sym)
+        password = attributes.delete :password
+        hash = request.post("customers", {
+          customer: attributes,
+          password: password
+        }).parse
+        build(hash)
+      end
+
       def find_by_token(token)
         user_request = Request.new(token: token)
         customer_hash = user_request.get('customers/me').parse
         build(customer_hash)
       end
+
+      def find(id)
+        hash = request.get("customers/#{id}").parse
+        build(hash)
+      end
     end
   end
 end

data/lib/magento/model.rb

@@ -7,14 +7,17 @@ module Magento
     include Magento::ModelParser
 
     def save
-      self.class.update(send(self.class.primary_key), to_h)
+      self.class.update(send(self.class.primary_key), to_h) do |hash|
+        update_attributes(hash)
+      end
     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
+      self.class.update(send(self.class.primary_key), attrs) do |hash|
+        update_attributes(hash)
+      end
     end
 
     def delete
@@ -25,10 +28,15 @@ module Magento
       @id || send(self.class.primary_key)
     end
 
+    protected def update_attributes(hash)
+      ModelMapper.map_hash(self, hash)
+    end
+
     class << self
       extend Forwardable
 
-      def_delegators :query, :all, :page, :per, :page_size, :order, :select, :where
+      def_delegators :query, :all, :page, :per, :page_size, :order, :select, 
+                     :where, :first, :find_by, :count
 
       def find(id)
         hash = request.get("#{api_resource}/#{id}").parse
@@ -48,7 +56,8 @@ module Magento
       def update(id, attributes)
         body = { entity_key => attributes }
         hash = request.put("#{api_resource}/#{id}", body).parse
-        build(hash)
+
+        block_given? ? yield(hash) : build(hash)
       end
 
       def api_resource

data/lib/magento/model_mapper.rb

@@ -17,9 +17,12 @@ module Magento
     end
 
     def self.map_hash(model, values)
-      object = model.new
+      object = model.is_a?(Class) ? model.new : model
       values.each do |key, value|
-        object.singleton_class.instance_eval { attr_accessor key }
+        unless object.respond_to?(key) && object.respond_to?("#{key}=")
+          object.singleton_class.instance_eval { attr_accessor key }
+        end
+
         if value.is_a?(Hash)
           class_name = Magento.inflector.camelize(Magento.inflector.singularize(key))
           value = map_hash(Object.const_get("Magento::#{class_name}"), value)

data/lib/magento/order.rb

@@ -12,8 +12,9 @@ module Magento
     def update(attrs)
       raise "'entity_id' not found" if @entity_id.nil?
 
-      attrs[:entity_id] = @entity_id
-      self.class.update(attrs)
+      self.class.update(@entity_id, attrs) do |hash|
+        update_attributes(hash)
+      end
     end
 
     def cancel
@@ -61,9 +62,10 @@ module Magento
     end
 
     class << self
-      def update(attributes)
+      def update(entity_id, attributes)
+        attributes[:entity_id] = entity_id
         hash = request.put('orders/create', { entity_key => attributes }).parse
-        build(hash)
+        block_given? ? yield(hash) : build(hash)
       end
 
       # @return {Boolean}

data/lib/magento/query.rb

@@ -89,6 +89,18 @@ module Magento
       RecordCollection.from_magento_response(result, model: model, iterable_field: field)
     end
 
+    def first
+      page_size(1).page(1).all.first
+    end
+
+    def find_by(attributes)
+      where(attributes).first
+    end
+
+    def count
+      select(:id).page_size(1).page(1).all.total_count
+    end
+
     private
 
     attr_accessor :current_page, :filter_groups, :request, :sort_orders, :model, :fields
@@ -119,10 +131,11 @@ module Magento
 
     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])
+      match = key.match(patter)
+
+      return match.to_a[1..2] if match && ACCEPTED_CONDITIONS.include?(match[2])
 
-      key.match(patter).to_a[1..2]
+      [key, 'eq']
     end
 
     def parse_value_filter(condition, value)

data/lib/magento/sales_rule.rb

@@ -0,0 +1,32 @@
+module Magento
+  class SalesRule < Model
+    self.primary_key = :rule_id
+    self.entity_key = :rule
+    self.endpoint = 'salesRules'
+
+    # Example
+    # rule = Magento::SalesRule.find(5)
+    # rule.generate_coupon(quantity: 1, length: 10)
+    #
+    # @return {String[]}
+    def generate_coupon(attributes)
+      body = { couponSpec: { rule_id: id }.merge(attributes) }
+      self.class.generate_coupon(body)
+    end
+
+    class << self
+      # Example
+      # Magento::SalesRule.generate_coupon(
+      #   couponSpec: {
+      #     rule_id: 5,
+      #     quantity: 1,
+      #     length: 10
+      #   }
+      # )
+      # @return {String[]}
+      def generate_coupon(attributes)
+        request.post('coupons/generate', attributes).parse
+      end
+    end
+  end
+end

data/lib/magento/shared/action_condition.rb

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

data/lib/magento/shared/condition.rb

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

data/lib/magento/version.rb

@@ -1,3 +1,3 @@
 module Magento
-  VERSION = '0.9.0'
+  VERSION = '0.12.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: magento
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.12.0
 platform: ruby
 authors:
 - Wallas Faria
@@ -63,12 +63,15 @@ files:
 - lib/magento/query.rb
 - lib/magento/record_collection.rb
 - lib/magento/request.rb
+- lib/magento/sales_rule.rb
+- lib/magento/shared/action_condition.rb
 - lib/magento/shared/address.rb
 - lib/magento/shared/available_regions.rb
 - lib/magento/shared/billing_address.rb
 - lib/magento/shared/bundle_product_option.rb
 - lib/magento/shared/category_link.rb
 - lib/magento/shared/comment.rb
+- lib/magento/shared/condition.rb
 - lib/magento/shared/configurable_product_option.rb
 - lib/magento/shared/currency.rb
 - lib/magento/shared/custom_attribute.rb