magentwo 0.1.6 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1f59f2c1b33cb0312fc53612b912df7a33e0497963daab678d4d9483e64cbd70
-  data.tar.gz: 4fdd910bc6d19c011eacc347a23102ba0a04a4a67179137f88a3a1d18ee32c73
+  metadata.gz: 76391fb49be2eacf141856ba17a36dda1edd5b08e0e7069be28ae7bedef35736
+  data.tar.gz: f6faa7a572b2a0c71007852272ad227032224786c8a42691cde861213a2591c5
 SHA512:
-  metadata.gz: 4ed9e751d283d7ceeee972b61edbfe19338e1c86fb8c2db312104f75346de47c6592c5ff885a3a3c593c4c2cbad6b7230efd60f533600875a290ef72b6b45872
-  data.tar.gz: 1f32e42bca87fda93e87f0bad9b42092b67a3c885679c42784321ebfc460eb27adb102de34fe85d1211a67c91cb8263a76cb8b8355b21ccc8f4cbf22db0a8ad7
+  metadata.gz: 8ca9a91c6c9e7cbd6df412e71fb418bf79adc68f40c10bb165ba8af3953f1717859f6562c01f5758c4669884cfd66fb14e657a6b00a6df43599624ee092e99f8
+  data.tar.gz: 985a28699825066decefabdbe438afcad4d4db0105ac12df34971c68c17a70c7cf7a427352a2101daa57d8d9f517f67ac5c133b06a0cfd693cff504d5dfc20ca

data/README.md

@@ -23,9 +23,21 @@ bundle
 
 
 # How to connect to your magento 2 shop
-Currently there is only one connection at a time possible
+When only using one connection simply type
 ```
-  Magentwo.connect http://example.com, username, password  
+  Magentwo.connect "http://example.com", "user_name", "password"  
+```
+When using multiple connections at once you can save the result of `Magentwo.connect` and use the `Magentwo.with` method
+```
+  connection1 = Magentwo.connect "http://example1.com", "user_name", "password"
+  connection2 = Magentwo.connect "http://example2.com", "user_name", "password"
+  
+  Magentwo.with (connection1) do
+    #do things in the context of connection1
+  end
+  Magentwo.with (connection2) do
+    #do things in the context of connection2
+  end
 ```
 
 # How to use
@@ -67,6 +79,26 @@ Look for all Products whose name includes the word "Computer"
 Magentwo::Product.like(:name => "%Computer%").all
 ```
 
+Compare using `gt`, `gteq`, `lt` or `lteq`. These methods do not seem to work with dates, please use `from` and `to` when e.g. trying to fetch all Products that changed within a certain period.
+```
+Magentwo::Product.lt(:price => 42).all
+Magentwo::Product.gt(:id => 1337).first
+```
+
+Compare using `from` and `to`, you may also use both to specify a range.
+```
+Magentwo::Product.from(:updated_at => Time.new(2019, 1, 1).all
+Magentwo::Product.to(:created_at => Time.new(2019, 2, 1).all
+```
+
+All of these filter-functions can be chained as needed
+
+# Select
+If you know which fields you are interested in you can speed up the fetching process by only requesting these fields
+```
+Magentwo::Product.filter(...).select(:id, :sku).all
+```
+
 # Pagination
 On default the pagesize is set to 20, you can change this with
 ```
@@ -85,6 +117,19 @@ Magentwo::Product.each_page(512) do |page|
   p page
 end
 ```
+You may also want to fetch all pages of products that match a certain criteria
+```
+Magentwo::Product.from(:updated_at => my_last_sync_value).each_page(512) do |page|
+  p page
+end
+```
+
+# Order
+By default the results are ordered as Magento2 "thinks" its best. At any place you may add the `order_by` to sepcify this to your liking. If you skip the `ASC/DESC` argument, `ASC` will be set.
+```
+Magentwo::Product.order_by(:id, "ASC").all
+Magentwo::Product.order_by(:id, "DESC").all
+```
 
 # Updates
 To update Models back to Magento 2 use the `save` method
@@ -96,4 +141,11 @@ customer.lastname = "Foo"
 customer.save
 ```
 
-to be continued
+# Delete
+To delete a Model use the `delete` method
+```
+product = Magentwo::Product.first
+product.delete
+```
+
+to be continued ...

data/lib/adapter.rb

@@ -10,9 +10,10 @@ module Magentwo
       end
 
       response = self.send(http_method, path, params)
-      Magentwo.logger.debug "Response body: #{response.body}"
+      Magentwo.logger.debug "Response body: #{response.body}" unless response.is_a? TrueClass
+
       parsed_response = case method
-      when :get_with_meta_data, :put, :post, :delete then transform( parse( response))
+      when :get_with_meta_data, :put, :post then transform( parse( response))
       when :get
         parsed = parse(response)
         if parsed.is_a?(Hash) && (parsed.has_key? :items)
@@ -22,6 +23,8 @@ module Magentwo
         else
           transform parsed
         end
+      when :delete
+        response
       else
         raise ArgumentError, "unknown method type. Expected :get, :get_with_meta_data, :post, :put or :delete. #{method} #{path}"
       end
@@ -47,7 +50,7 @@ module Magentwo
 
     def date_transform item
       DateFields.each do |date_field|
-        item[date_field] = Time.new item[date_field] if item[date_field]
+        item[date_field] = Time.parse item[date_field] if item[date_field]
       end
       item
     end

data/lib/connection.rb

@@ -26,11 +26,17 @@ module Magentwo
     end
 
     def delete path, data
-      Magentwo.logger.info "DELETE #{path}"
+      Magentwo.logger.info "DELETE #{host}/#{base_path}/#{path}"
       Magentwo.logger.debug "DATA #{data}"
 
-      Magentwo.logger.warn "not implemented"
-
+      url = "#{base_path}/#{path}"
+      Net::HTTP.start(self.host,self.port) do |http|
+        req = Net::HTTP::Delete.new(url)
+        req["Authorization"] = "Bearer #{self.token}"
+        req['Content-Type'] = "application/json"
+        req.body = data
+        http.request(req)
+      end
     end
 
     def put path, data

data/lib/dataset.rb

@@ -64,6 +64,14 @@ module Magentwo
       Dataset.new self.model, self.opts.merge(:filters => self.opts[:filters] + [Filter::Like.new(args.keys.first, args.values.first)])
     end
 
+    def from args
+      Dataset.new self.model, self.opts.merge(:filters => self.opts[:filters] + [Filter::From.new(args.keys.first, args.values.first)])
+    end
+
+    def to args
+      Dataset.new self.model, self.opts.merge(:filters => self.opts[:filters] + [Filter::To.new(args.keys.first, args.values.first)])
+    end
+
     #################
     # Pagination
     ################
@@ -108,23 +116,55 @@ module Magentwo
     #################
     # Transformation
     ################
+    def print_readable
+      ds = self
+
+      puts "*** Pagination ***"
+      puts ds.opts[:pagination][:current_page].to_s
+      puts ds.opts[:pagination][:page_size].to_s
+
+      puts "*** Filters ***"
+      ds.opts[:filters].each do |filter|
+        puts filter.to_s
+      end
+
+      puts "*** Ordering ***"
+      order_filters = ds.opts[:ordering]
+      if order_filters.size > 0
+        order_filters.each do |filter|
+          puts filter.to_s
+        end
+      else
+        puts "non specified"
+      end
+
+      puts "*** Fields ***"
+      if fields = ds.opts[:fields]&.fields
+        puts "Fetch only: #{fields}"
+      else
+        puts "Fetch everything"
+      end
+    end
+
     def to_query
+      self.validate
+      ds = self
       [
-        self.opts[:filters]
+        ds.opts[:filters]
         .each_with_index
         .map { |opt, idx| opt.to_query(idx) }
         .join("&"),
 
-        self.opts[:pagination]
+        ds.opts[:pagination]
         .map { |k, v| v.to_query}
         .join("&"),
 
 
-        self.opts[:ordering]
+        ds.opts[:ordering]
         .map { |opt, idx| opt.to_query(idx) }
         .join("&"),
 
-        self.opts[:fields]? self.opts[:fields].to_query() : ""
+        ds.opts[:fields]? ds.opts[:fields].to_query() : ""
       ].reject(&:empty?)
       .join("&")
     end
@@ -156,5 +196,12 @@ module Magentwo
         current_page += 1
       end
     end
+
+    #################
+    # Validation
+    ################
+    def validate
+      true
+    end
   end
 end

data/lib/filter.rb

@@ -14,6 +14,10 @@ module Magentwo
         "searchCriteria[filter_groups][#{idx}][filters][0][condition_type]=#{self.class.name.split("::").last.downcase}"]
         .join("&")
       end
+
+      def to_s
+        "#{self.field} #{self.class.name.split("::").last.downcase} #{self.value}"
+      end
     end
 
     class CompareArray < Compare
@@ -24,6 +28,10 @@ module Magentwo
         "searchCriteria[filter_groups][#{idx}][filters][0][condition_type]=#{self.class.name.split("::").last.downcase}"]
         .join("&")
       end
+
+      def to_s
+        "#{self.field} #{self.class.name.split("::").last.downcase} #{self.value}"
+      end
     end
 
     class Simple
@@ -36,6 +44,10 @@ module Magentwo
       def to_query idx=nil
         "searchCriteria[#{key}]=#{value}"
       end
+
+      def to_s
+        "#{self.key} == #{self.value}"
+      end
     end
 
     class Multi
@@ -49,6 +61,12 @@ module Magentwo
           "searchCriteria[#{kvp[:key]}]=#{kvp[:value]}"
         end.join("&")
       end
+
+      def to_s
+        self.kvps.map do |kvp|
+          "#{kvp[:key]} = #{kvp[:value]}"
+        end.join("\n")
+      end
     end
 
 
@@ -79,6 +97,12 @@ module Magentwo
     class Lteq < Magentwo::Filter::Compare
     end
 
+    class From < Magentwo::Filter::Compare
+    end
+
+    class To < Magentwo::Filter::Compare
+    end
+
     class PageSize < Magentwo::Filter::Simple
       def initialize value
         super(:page_size, value)

data/lib/magentwo.rb

@@ -1,10 +1,12 @@
 require 'uri'
 require 'net/http'
 require 'json'
+require 'time'
 require 'logger'
 
 module Magentwo
   Models = %w(base product customer order coupon sales_rule category cart)
+  @@mutex = Mutex.new
   def self.connect host=nil, user_name=nil, password=nil
     raise ArgumentError, "no host specified" unless host
     raise ArgumentError, "no user_name specified" unless user_name
@@ -12,12 +14,25 @@ module Magentwo
     Base.adapter = Adapter.new host, user_name, password
   end
 
+  def self.with connection
+    raise ArgumentError, "no connection specified" unless connection
+    @@mutex.synchronize do
+      old_connection = Magentwo::Base.adapter
+      begin
+        Magentwo::Base.adapter = connection
+        yield
+      ensure
+        Magentwo::Base.adapter = old_connection
+      end
+    end
+  end
+
   def self.logger= logger
     @@logger = logger
   end
 
   def self.logger
-    @@logger ||= Logger.new STDOUT, {:level => Logger::DEBUG}
+    @@logger ||= Logger.new STDOUT, {:level => Logger::INFO}
   end
 
   def self.default_page_size

data/lib/model/base.rb

@@ -1,6 +1,6 @@
 module Magentwo
   class Base
-    DatasetMethods = %i(filter exclude select fields count fields info page order_by like gt lt gteq lteq)
+    DatasetMethods = %i(filter exclude select fields count fields info page order_by like gt lt gteq lteq from to)
 
     def initialize args
       args.each do |key, value|
@@ -18,12 +18,12 @@ module Magentwo
 
     def save
       self.validate
-      response = Magentwo::Base.call :put, "#{self.class.base_path}/#{self.id}", self
+      response = Magentwo::Base.call :put, "#{self.class.base_path}/#{self.send(self.class.unique_identifier)}", self
       self.class.new response
     end
 
     def delete
-      Magentwo.logger.warn "not implemented"
+      Magentwo::Base.call :delete, "#{self.class.base_path}/#{self.send(self.class.unique_identifier)}", nil
     end
 
     def validate
@@ -62,8 +62,12 @@ module Magentwo
     class << self
       attr_accessor :adapter
 
-      def [] unique_identifier
-        self.new (Magentwo::Base.get nil, path:"#{base_path}/#{unique_identifier}")
+      def [] unique_identifier_value
+        self.new (Magentwo::Base.get nil, path:"#{base_path}/#{unique_identifier_value}")
+      end
+
+      def unique_identifier
+        :id
       end
 
       def lower_case_name

data/lib/model/category.rb

@@ -1,5 +1,6 @@
 module Magentwo
   class Category < Base
+    #TODO implement
     class << self
       def base_path
         "categories"

data/lib/model/coupon.rb

@@ -23,6 +23,10 @@ module Magentwo
           }
         }
       end
+
+      def unique_identifier
+        :coupon_id
+      end
     end
 
   end

data/lib/model/order.rb

@@ -19,6 +19,11 @@ module Magentwo
       def [] unique_identifier
         self.filter(:entity_id => unique_identifier).first
       end
+
+      def unique_identifier
+        Magentwo::Logger.error "orders do not container id on default requests, therefore they cannot be targeted on the API"
+        nil
+      end
     end
   end
 end

data/lib/model/product.rb

@@ -7,6 +7,10 @@ module Magentwo
       def types
         Magentwo::Base.get nil, path:"#{base_path}/types"
       end
+
+      def unique_identifier
+        :sku
+      end
     end
   end
 end

data/lib/model/sales_rule.rb

@@ -16,6 +16,10 @@ module Magentwo
       def get_path
         "#{base_path}/search"
       end
+
+      def unique_identifier
+        :rule_id
+      end
     end
 
   end

data/magentwo.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name        = 'magentwo'
-  s.version     = '0.1.6'
+  s.version     = '0.1.7'
   s.date        = '2019-01-17'
   s.summary     = "Magento 2 API Wrapper"
   s.description = "Provides a simple Ruby Interface to interact with the Magento 2 API"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: magentwo
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.1.7
 platform: ruby
 authors:
 - André Mueß