magentwo 0.1.4 → 0.1.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a3a841b7d66c45e36a63b99466fd49e7bedfd056f9077e2cdf2e93dd0b7bf9d1
-  data.tar.gz: 46906bc86d4c0da2517334e916e61b0a647d181587324be4a8f5f5058ae3079e
+  metadata.gz: 20edcef61f1dd6dcb2d941e61c8c2ec307b3b34f5a8cc20a6bd4b7e5ac13fb78
+  data.tar.gz: 69d77fdbd17a9379a6f17427a3e2095b30aa8f4d36e8f4dc0cba6400767439e0
 SHA512:
-  metadata.gz: aa0c925bd64c60d046266bfed1a8f0c6c1c50ab9f69e2f2b5e5fb6700a5fef715db656a11c65c065f4fae273ba994422c9ec810c3903ffdb671d1d723a9242c0
-  data.tar.gz: 2a49d67d5c11fb054d23cc0d2ac24cb87d813c0704111dadeb75cf7a80626139f579f653ae86d7e61789debe02ef2c5951d178bfac0604b121ebfda4e77b236d
+  metadata.gz: e0e08d0b6d433b7e3c8a67a0c1e31a1e15784facf810c3f959cf4c078feb38f3dfde82bc84d55cb3f8ee1fb815b2c87fcfb8273b2ec6bad2598a8f8683c6c2c3
+  data.tar.gz: 6068da51a75fa3cf357354341d9c8a8b27976321454ae44dc0a6e7294db97b57e737cc5f4dedb05f81691f587f33630cabe71265ae3c794e98687147a12839e0

data/.gitignore

@@ -50,3 +50,5 @@ build-iPhoneSimulator/
 
 # unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
 .rvmrc
+
+/cplus

data/README.md

@@ -1,4 +1,188 @@
-# magentwo
-Simple Ruby-Wrapper for the Magento 2 REST API
+This gem is under developement and nowhere near finished but feel free to play around with it.
+I am grateful for any ideas and suggestions
 
-under developement
+# Magentwo
+
+Ruby-Wrapper for the Magento 2 REST API
+
+# How to install
+
+To install the Gem directly use
+
+```
+gem install magentwo
+```
+
+or add the following line to your Gemfile
+
+```
+gem 'magentwo'
+```
+
+and call bundler
+
+```
+bundle
+```
+
+# How to connect to your magento 2 shop
+
+When only using one connection simply type
+
+```
+  Magentwo.connect "http://example.com", "user_name", "password"
+```
+
+or
+
+```
+  Magentwo.connect_with_token "http://example.com", "my_secret_token"
+```
+
+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_with_token "http://example2.com", "my_secret_token"
+
+  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
+
+In Magentwo you interact with the API using Models. These are named according the the REST-API specifications of Magento 2
+The basic functionality is the same for all Models. For products some simple requests would look like this
+
+```
+Magentwo::Product.all #fetches all Products
+Magentwo::Product.first #fetches the first product
+Magentwo::Product.count #returns the number of available products
+Magentwo::Product.fields #returns an array of productfields
+```
+
+# Filtering
+
+You can filter requests to search for specific elements
+Here are some examples
+
+Look for all customers whose firstname is Foobar
+
+```
+Magentwo::Customer.filter(:firstname => "Foobar").all
+```
+
+Look for all customers whose id is not 42
+
+```
+Magentwo::Customer.exclude(:id => 42).all
+```
+
+You can also combine these
+
+```
+Magentwo::Customer.filter(:firstname => "Foobar").exclude(:id => 42).all
+```
+
+The `filter` and `exclude` methods can also be used to filter for a set. To Request all Customers whose firstname is either Foo or Bar you could write
+
+```
+Magentwo::Customer.filter(:firstname => ["Foo", "bar"]).all
+```
+
+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
+
+```
+Magentwo.default_page_size=42
+```
+
+The pagesize can also be set on the fly
+To request page 2 with a pagesize of 100 simply write the following. The second paramter is optional
+
+```
+Magentwo::Product.exclude(:name => "foobar").page(2, 100).all
+```
+
+To iterate threw all the pages use `each_page`. Again the pagesize parameter is optional
+
+```
+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
+This switches the first and last name of the Customer Foo Bar
+
+```
+customer = Magentwo::Customer.filter(:first_name => "Foo", :last_name => "Bar").first
+customer.firstname = "Bar"
+customer.lastname = "Foo"
+customer.save
+```
+
+# Delete
+
+To delete a Model use the `delete` method
+
+```
+product = Magentwo::Product.first
+product.delete
+```
+
+to be continued ...

data/lib/adapter.rb

@@ -1,6 +1,7 @@
 module Magentwo
   class Adapter < Magentwo::Connection
-    DateFields = %i(created_at dob  updated_at)
+    DateTimeFields = %i(created_at updated_at change_status_at)
+    DateFields = %i(dob)
     def call method, path, params
       http_method, params = case method
       when :put, :post, :delete then [method, params.to_json]
@@ -10,18 +11,21 @@ module Magentwo
       end
 
       response = self.send(http_method, path, params)
+      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[:items]
-          parsed[:items].map do |item|
+        if parsed.is_a?(Hash) && (parsed.has_key? :items)
+          (parsed[:items] || []).map do |item|
             transform item
           end
         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
@@ -33,18 +37,25 @@ module Magentwo
       when "200"
         JSON.parse response.body, :symbolize_names => true
       else
-        puts "request failed #{response.code} #{response.body}"
+        puts "error #{response.code}: #{JSON.parse(response.body)}"
+        return nil
       end
     end
 
     def transform item
-      date_transform item if item
+      if(item && item.is_a?(Hash))
+        date_transform item
+      else
+        item
+      end
     end
 
     def date_transform item
-      p "datetransform: #{item}"
       DateFields.each do |date_field|
-        item[date_field] = Time.new item[date_field] if item[date_field]
+        item[date_field] = Date.parse item[date_field] if item[date_field]
+      end
+      DateTimeFields.each do |datetime_field|
+        item[datetime_field] = (Time.parse "#{item[datetime_field]} UTC").getlocal if item[datetime_field]
       end
       item
     end

data/lib/connection.rb

@@ -1,44 +1,58 @@
 module Magentwo
   class Connection
-    attr_accessor :host, :port, :user, :password, :token, :base_path
+    attr_accessor :host, :port, :user, :password, :token, :base_path, :scheme
 
-    def initialize host, user, password, base_path:nil
-      if host.include? ":"
-        @host = host.split(":").first
-        @port = host.split(":").last.to_i
+    def initialize uri:, user:nil, password:nil, base_path:nil, token:nil
+      uri = URI(uri)
+      @host = uri.host
+      @port = uri.port
+      @scheme = uri.scheme
+      @base_path = base_path || "/rest/V1"
+
+      if (user && password)
+        @user = user
+        @password = password
+        request_token
+      elsif (token)
+       @token = token
       else
-        @host = host
-        @port = 80
+        raise ArgumentError, "expected user/password or token"
       end
-      @user = user
-      @password = password
-      @base_path = base_path || "/rest/default/V1"
-      request_token
+
     end
 
     def request_token
-      Net::HTTP.start(self.host,self.port) do |http|
-        req = Net::HTTP::Post.new("#{base_path}/integration/admin/token")
+      Net::HTTP.start(self.host,self.port, :use_ssl => self.scheme == 'https') do |http|
+        url = "#{base_path}/integration/admin/token"
+        Magentwo.logger.info "POST #{url}"
+        req = Net::HTTP::Post.new(url)
         req.body = {:username=> self.user, :password=> self.password}.to_json
         req['Content-Type'] = "application/json"
         req['Content-Length'] = req.body.length
-        @token = JSON.parse http.request(req).body
+        response = http.request(req).body
+        @token = JSON.parse response
       end
     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, :use_ssl => self.scheme == 'https') 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
       Magentwo.logger.info "PUT #{host}/#{base_path}/#{path}"
       Magentwo.logger.debug "DATA #{data}"
       url = "#{base_path}/#{path}"
-      Net::HTTP.start(self.host,self.port) do |http|
+      Net::HTTP.start(self.host,self.port, :use_ssl => self.scheme == 'https') do |http|
         req = Net::HTTP::Put.new(url)
         req["Authorization"] = "Bearer #{self.token}"
         req['Content-Type'] = "application/json"
@@ -51,7 +65,7 @@ module Magentwo
       Magentwo.logger.info "POST #{host}/#{path}"
       Magentwo.logger.debug "DATA #{data}"
       url = "#{base_path}/#{path}"
-      Net::HTTP.start(self.host,self.port) do |http|
+      Net::HTTP.start(self.host,self.port, :use_ssl => self.scheme == 'https') do |http|
         req = Net::HTTP::Post.new(url)
         req["Authorization"] = "Bearer #{self.token}"
         req['Content-Type'] = "application/json"
@@ -64,7 +78,7 @@ module Magentwo
     def get path, query
       Magentwo.logger.info "GET #{host}#{base_path}/#{path}?#{query}"
       url = "#{base_path}/#{path}?#{query}"
-      Net::HTTP.start(self.host,self.port) do |http|
+      Net::HTTP.start(self.host,self.port, :use_ssl => self.scheme == 'https') do |http|
         req = Net::HTTP::Get.new(url)
         req["Authorization"] = "Bearer #{self.token}"
         req['Content-Type'] = "application/json"

data/lib/dataset.rb

@@ -7,7 +7,7 @@ module Magentwo
         :filters => [],
         :pagination => {
           :current_page => Filter::CurrentPage.new(1),
-          :page_size => Filter::PageSize.new(Magentwo.default_page_size)
+          :page_size => Filter::PageSize.new(0)
         },
         :ordering => [],
         :fields => nil
@@ -18,27 +18,44 @@ module Magentwo
     # Filters
     ################
     def filter hash_or_other, invert:false
-      filter = case hash_or_other
+      filters = case hash_or_other
       when Hash
         raise ArgumentError, "empty hash supplied" if hash_or_other.empty?
-        key, value = hash_or_other.first
-        klass = case value
-        when Array
-          invert ? Filter::Nin : Filter::In
-        else
-          invert ? Filter::Neq : Filter::Eq
+        hash_or_other.map do |key, value|
+          klass = case value
+          when Array
+            invert ? Filter::Nin : Filter::In
+          else
+            invert ? Filter::Neq : Filter::Eq
+          end
+          klass.new(key, value)
         end
-        klass.new(key, value)
       else
         raise ArgumentError, "filter function expects Hash as input"
       end
-      Dataset.new self.model, self.opts.merge(:filters => self.opts[:filters] + [filter])
+      Dataset.new self.model, self.opts.merge(:filters => self.opts[:filters] + filters)
     end
 
     def exclude args
       filter args, invert:true
     end
 
+    def gt args
+      Dataset.new self.model, self.opts.merge(:filters => self.opts[:filters] + [Filter::Gt.new(args.keys.first, args.values.first)])
+    end
+
+    def lt args
+      Dataset.new self.model, self.opts.merge(:filters => self.opts[:filters] + [Filter::Lt.new(args.keys.first, args.values.first)])
+    end
+
+    def gteq args
+      Dataset.new self.model, self.opts.merge(:filters => self.opts[:filters] + [Filter::Gteq.new(args.keys.first, args.values.first)])
+    end
+
+    def lteq args
+      Dataset.new self.model, self.opts.merge(:filters => self.opts[:filters] + [Filter::Lteq.new(args.keys.first, args.values.first)])
+    end
+
     def select *fields
       Dataset.new self.model, self.opts.merge(:fields => Filter::Fields.new(fields))
     end
@@ -47,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
     ################
@@ -84,30 +109,62 @@ module Magentwo
       self.model.first self
     end
 
-    def all
-      self.model.all self
+    def all meta_data:false
+      self.model.all self, :meta_data => meta_data
     end
 
     #################
     # 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
@@ -124,5 +181,26 @@ module Magentwo
       raise ArgumentError, "no block given" unless block_given?
       self.model.all.each(&block)
     end
+
+    def each_page page_size=Magentwo.default_page_size, &block
+      raise ArgumentError, "no block given" unless block_given?
+
+      received_element_count = page_size
+      current_page = 1
+      total_count = nil
+      until(total_count && current_page*page_size > (total_count + page_size)) do
+        page = self.page(current_page, page_size).all meta_data:true
+        total_count = page[:total_count] unless total_count
+        block.call(page[:items])
+        current_page += 1
+      end
+    end
+
+    #################
+    # Validation
+    ################
+    def validate
+      true
+    end
   end
 end

data/lib/filter.rb

@@ -7,23 +7,31 @@ module Magentwo
         @value = value
       end
 
-      def to_query idx
+      def to_query idx, field:self.field, value:self.value
         [
         "searchCriteria[filter_groups][#{idx}][filters][0][field]=#{self.field}",
-        "searchCriteria[filter_groups][#{idx}][filters][0][value]=#{URI::encode(self.value)}",
+        "searchCriteria[filter_groups][#{idx}][filters][0][value]=#{URI::encode(self.value.to_s)}",
         "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
       def to_query idx
         [
         "searchCriteria[filter_groups][#{idx}][filters][0][field]=#{self.field}",
-        "searchCriteria[filter_groups][#{idx}][filters][0][value]=#{URI::encode(self.value.join(","))}",
+        "searchCriteria[filter_groups][#{idx}][filters][0][value]=#{URI::encode(self.value.map(&:to_s).join(","))}",
         "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
 
 
@@ -67,6 +85,31 @@ module Magentwo
     class Like < Magentwo::Filter::Compare
     end
 
+    class Gt < Magentwo::Filter::Compare
+    end
+
+    class Lt < Magentwo::Filter::Compare
+    end
+
+    class Gteq < Magentwo::Filter::Compare
+    end
+
+    class Lteq < Magentwo::Filter::Compare
+    end
+
+    class From < Magentwo::Filter::Compare
+      def to_query idx
+        value = case self.value
+        when Time then self.value.utc
+        else self.value
+        end
+        super idx, value:value
+      end
+    end
+
+    class To < Magentwo::Filter::Compare
+    end
+
     class PageSize < Magentwo::Filter::Simple
       def initialize value
         super(:page_size, value)

data/lib/magentwo.rb

@@ -1,12 +1,36 @@
 require 'uri'
 require 'net/http'
 require 'json'
+require 'time'
 require 'logger'
 
 module Magentwo
-  Models = %w(base product customer order coupon sales_rule)
-  def self.connect host, user_name, password
-    Base.adapter = Adapter.new host, user_name, password
+  Models = %w(base product customer order coupon sales_rule category cart stock_item)
+  @@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
+    raise ArgumentError, "no password specified" unless password
+    Base.adapter = Adapter.new ({uri: host, user: user_name, password: password})
+  end
+
+  def self.connect_with_token host=nil, token=nil
+    raise ArgumentError, "no host specified" unless host
+    raise ArgumentError, "no token specified" unless token
+    Base.adapter = Adapter.new ({token: token, uri: host})
+  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
@@ -14,7 +38,20 @@ module Magentwo
   end
 
   def self.logger
-    @@logger ||= Logger.new STDOUT, {:level => Logger::DEBUG}
+    @@logger ||= Logger.new STDOUT, {:level => Logger::INFO}
+  end
+
+  def self.log_level= level
+    new_log_level = case level
+    when :debug then Logger::DEBUG
+    when :info  then Logger::INFO
+    when :warn then Logger::WARN
+    when :error then Logger::ERROR
+    when :fatal then Logger::FATAL
+    else
+      raise ArgumentError, "invalid log_level"
+    end
+    self.logger= Logger.new STDOUT, {:level => new_log_level}
   end
 
   def self.default_page_size
@@ -25,7 +62,14 @@ module Magentwo
     @@default_page_size = page_size
   end
 
-
+  def self.models
+    Models.map do |model_file_name|
+      model_file_name
+      .split('_')
+      .map(&:capitalize)
+      .join
+    end
+  end
 end
 
 require_relative 'connection.rb'
@@ -35,5 +79,5 @@ require_relative 'dataset.rb'
 require_relative 'util/validator.rb'
 
 Magentwo::Models.each do |file_name|
-	require_relative("model/#{file_name}.rb")
+  require_relative("model/#{file_name}.rb")
 end

data/lib/model/base.rb

@@ -1,8 +1,6 @@
 module Magentwo
   class Base
-    DatasetMethods = %i(filter exclude select fields count fields info page order_by like)
-
-    attr_accessor :base_path
+    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|
@@ -20,12 +18,14 @@ module Magentwo
 
     def save
       self.validate
-      response = Magentwo::Base.call :put, "#{self.class.base_path}/#{self.id}", self
+      self.check_presence self.class.unique_identifier
+      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"
+      self.check_presence self.class.unique_identifier
+      Magentwo::Base.call :delete, "#{self.class.base_path}/#{self.send(self.class.unique_identifier)}", nil
     end
 
     def validate
@@ -64,6 +64,15 @@ module Magentwo
     class << self
       attr_accessor :adapter
 
+      def [] unique_identifier_value
+        result = Magentwo::Base.get nil, path:"#{base_path}/#{unique_identifier_value}"
+        self.new result if result
+      end
+
+      def unique_identifier
+        :id
+      end
+
       def lower_case_name
         name = self.name.split(/::/).last
         "#{name[0,1].downcase}#{name[1..-1]}"
@@ -77,15 +86,36 @@ module Magentwo
         base_path
       end
 
-      def all ds=self.dataset
-        self.get(ds.to_query)
+      def all ds=self.dataset, meta_data:false
+        response = self.get(ds.to_query, :meta_data => meta_data)
+        return [] if response.nil?
+        items = (meta_data ? response[:items] : response)
         .map do |item|
           self.new item
         end
+        if meta_data
+          response[:items] = items
+          response
+        else
+          items
+        end
       end
 
       def first ds=self.dataset
-        self.new self.get(ds.page(1, 1).to_query).first
+        response = self.get(ds.page(1, 1).to_query).first
+        self.new response if response
+      end
+
+      def each_page page_size=Magentwo.default_page_size, &block
+        self.dataset.each_page page_size, &block
+      end
+
+      def each &block
+        self.dataset.each &block
+      end
+
+      def map &block
+        self.dataset.map &block
       end
 
       def dataset
@@ -108,7 +138,7 @@ module Magentwo
       end
 
       def call method, path=self.base_path, params
-          Magentwo::Base.adapter.call(method, path, params)
+        Magentwo::Base.adapter.call(method, path, params)
       end
 
     end

data/lib/model/cart.rb

@@ -0,0 +1,12 @@
+module Magentwo
+  class Cart < Base
+    Attributes = %i(id created_at updated_at is_active is_virtual items_count items_qty customer billing_address reserved_order_id orig_order_id currency customer_is_guest customer_note_notify customer_tax_class_id store_id)
+    Attributes.each do |attr| attr_accessor attr end
+
+    class << self
+      def get_path
+        "#{self.base_path}/search"
+      end
+    end
+  end
+end

data/lib/model/category.rb

@@ -0,0 +1,10 @@
+module Magentwo
+  class Category < Base
+    #TODO implement
+    class << self
+      def base_path
+        "categories"
+      end
+    end
+  end
+end

data/lib/model/coupon.rb

@@ -11,7 +11,7 @@ module Magentwo
       def generate rule_id, quantity:1, length:16, format:(:alpha), delimiter:"-", delimiter_at_every:4
         format = format.to_sym
         Magentwo::Validator.one_of format, :num, :alpha, :alphanum
-        self.call :post, "coupons/generate",
+        self.call :post, "#{base_path}/generate",
         {
           :couponSpec => {
            :rule_id => rule_id,
@@ -23,6 +23,10 @@ module Magentwo
           }
         }
       end
+
+      def unique_identifier
+        :coupon_id
+      end
     end
 
   end

data/lib/model/order.rb

@@ -1,5 +1,30 @@
 module Magentwo
   class Order < Base
+    Attributes = %i(base_currency_code base_discount_amount base_discount_invoiced base_grand_total base_discount_tax_compensation_amount base_discount_tax_compensation_invoiced base_shipping_amount base_shipping_discount_amount base_shipping_discount_tax_compensation_amnt base_shipping_incl_tax base_shipping_invoiced base_shipping_tax_amount base_subtotal base_subtotal_incl_tax base_subtotal_invoiced base_tax_amount base_tax_invoiced base_total_due base_total_invoiced base_total_invoiced_cost base_total_paid base_to_global_rate base_to_order_rate billing_address_id created_at customer_dob customer_email customer_firstname customer_gender customer_group_id customer_id customer_is_guest customer_lastname customer_note_notify discount_amount discount_invoiced entity_id global_currency_code grand_total discount_tax_compensation_amount discount_tax_compensation_invoiced increment_id is_virtual order_currency_code protect_code quote_id shipping_amount shipping_description shipping_discount_amount shipping_discount_tax_compensation_amount shipping_incl_tax shipping_invoiced shipping_tax_amount state status store_currency_code store_id store_name store_to_base_rate store_to_order_rate subtotal subtotal_incl_tax subtotal_invoiced tax_amount tax_invoiced total_due total_invoiced total_item_count total_paid total_qty_ordered updated_at weight items billing_address payment status_histories extension_attributes amount_refunded base_amount_refunded base_discount_amount base_discount_invoiced base_discount_tax_compensation_amount base_discount_tax_compensation_invoiced base_original_price base_price base_price_incl_tax base_row_invoiced base_row_total base_row_total_incl_tax base_tax_amount base_tax_invoiced created_at discount_amount discount_invoiced discount_percent free_shipping discount_tax_compensation_amount discount_tax_compensation_invoiced is_qty_decimal item_id name no_discount order_id original_price price price_incl_tax product_id product_type qty_canceled qty_invoiced qty_ordered qty_refunded qty_shipped row_invoiced row_total row_total_incl_tax row_weight sku store_id tax_amount tax_invoiced tax_percent updated_at weight)
+    Attributes.each do |attr| attr_accessor attr end
 
+    def products
+      product_skus = self.items.map do |item|
+        item[:sku]
+      end
+      Magentwo::Product.filter(:sku => product_skus).all
+    end
+
+    def customer
+      self.check_presence :customer_id
+      Magentwo::Customer[self.customer_id]
+    end
+
+    class << self
+      #this is necessary as the return type of magento2 is not consistent
+      def [] unique_identifier
+        self.filter(:entity_id => unique_identifier).first
+      end
+
+      def unique_identifier
+        Magentwo::Logger.error "orders do not contain id on default requests, therefore they cannot be targeted on the API"
+        nil
+      end
+    end
   end
 end

data/lib/model/product.rb

@@ -2,5 +2,19 @@ module Magentwo
   class Product < Base
     Attributes = %i(id sku name attribute_set_id price status visibility type_id created_at updated_at extension_attributes product_links options media_gallery_entries tier_prices custom_attributes)
     Attributes.each do |attr| attr_accessor attr end
+
+    def stocks
+      Magentwo::StockItem[self.sku]
+    end
+
+    class << self
+      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

@@ -3,10 +3,28 @@ module Magentwo
     Attributes = %i(rule_id name store_labels description website_ids customer_group_ids uses_per_customer is_active condition action_condition stop_rules_processing is_advanced sort_order simple_action discount_amount discount_step apply_to_shipping times_used is_rss coupon_type use_auto_generation uses_per_coupon simple_free_shipping)
     Attributes.each do |attr| attr_accessor attr end
 
+    def generate quantity:1, length:16, format:(:alpha), delimiter:"-", delimiter_at_every:4
+      self.check_presence :rule_id
+      Magentwo::Coupon.generate self.rule_id, quantity:quantity, length:length, format:format, delimiter:delimiter, delimiter_at_every:delimiter_at_every
+    end
+
+    def coupons
+      self.check_presence :rule_id
+      Magentwo::Coupon.filter(:rule_id => self.rule_id).all
+    end
+
+    def to_json
+      Hash["rule", self.to_h].to_json
+    end
+
     class << self
       def get_path
         "#{base_path}/search"
       end
+
+      def unique_identifier
+        :rule_id
+      end
     end
 
   end

data/lib/model/stock_item.rb

@@ -0,0 +1,12 @@
+# Usage: 
+# Magentwo::StockItems['sku']
+
+module Magentwo
+  class StockItem < Base
+    Attributes = %i(item_id product_id stock_id qty is_in_stock is_qty_decimal show_default_notification_message use_config_min_qty min_qty use_config_min_sale_qty min_sale_qty use_config_max_sale_qty max_sale_qty use_config_backorders backorders use_config_notify_stock_qty notify_stock_qty use_config_qty_increments qty_increments use_config_enable_qty_inc enable_qty_increments use_config_manage_stock manage_stock low_stock_date is_decimal_divided stock_status_changed_auto)
+    Attributes.each do |attr| attr_accessor attr end
+
+    class << self
+    end
+  end
+end

data/magentwo.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name        = 'magentwo'
-  s.version     = '0.1.4'
+  s.version     = '0.1.9'
   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"

data/spec/dataset_spec.rb

@@ -18,9 +18,9 @@ describe Magentwo::Dataset do
       expect(dataset.opts[:pagination]).to have_key :current_page
       expect(dataset.opts[:pagination]).to have_key :page_size
     end
-    it "requests #{Magentwo::Dataset::DefaultPageSize} items on default" do
+    it "requests all items on default" do
       expect(initial_query).to include "searchCriteria[current_page]=1"
-      expect(initial_query).to include "searchCriteria[page_size]=#{Magentwo::Dataset::DefaultPageSize}"
+      expect(initial_query).to include "searchCriteria[page_size]=0"
     end
   end
 
@@ -37,6 +37,31 @@ describe Magentwo::Dataset do
     end
   end
 
+  context "multi filter" do
+    let(:multi_filter_ds) {dataset.filter(:name => "foobar").filter(:id => 42)}
+    let(:multi_filter_query) {multi_filter_ds.to_query}
+    let(:multi_filter_in_one_ds) {dataset.filter(:name => "foobar", :id => 42)}
+    let(:multi_filter_in_one_query) {multi_filter_in_one_ds.to_query}
+    it "contains filter with type Filter::Eq" do
+      expect(multi_filter_ds.opts[:filters]).to include Magentwo::Filter::Eq
+    end
+    it "contains two filters" do
+      expect(multi_filter_ds.opts[:filters].count).to eq 2
+    end
+    it "compute query" do
+      expect(multi_filter_query).to include "searchCriteria[filter_groups][0][filters][0][field]=name"
+      expect(multi_filter_query).to include "searchCriteria[filter_groups][0][filters][0][condition_type]=eq"
+      expect(multi_filter_query).to include "searchCriteria[filter_groups][0][filters][0][value]=foobar"
+      expect(multi_filter_query).to include "searchCriteria[filter_groups][1][filters][0][field]=id"
+      expect(multi_filter_query).to include "searchCriteria[filter_groups][1][filters][0][condition_type]=eq"
+      expect(multi_filter_query).to include "searchCriteria[filter_groups][1][filters][0][value]=42"
+    end
+    it "is the same for multiple keys in one filter" do
+      expect(multi_filter_ds.opts.count).to eq multi_filter_in_one_ds.opts.count
+      expect(multi_filter_query).to eq multi_filter_in_one_query
+    end
+  end
+
   context "select" do
     let(:name_select_ds) {dataset.select(:name)}
     let(:name_select_query) {name_select_ds.to_query}

data/spec/product_spec.rb

@@ -1,4 +1,83 @@
 require_relative '../lib/magentwo.rb'
 
 describe Magentwo::Product do
+  before(:all) do
+    Magentwo.logger = Logger.new STDOUT, {:level => Logger::ERROR}
+    @original_count = Magentwo::Product.count
+  end
+
+  context "#dataset" do
+    let(:dataset) {Magentwo::Product.dataset}
+    it "returns dataset" do
+      expect(dataset).to be_a Magentwo::Dataset
+    end
+  end
+
+  context "#count" do
+    let(:count) {Magentwo::Product.count}
+    it "responds to :count" do
+      expect(Magentwo::Product).to respond_to :count
+    end
+    it "correct count" do
+      expect(count).to eq @original_count
+    end
+    it "count is integer" do
+      expect(count).to be_a Integer
+    end
+  end
+
+  context "#all" do
+    let(:products) {Magentwo::Product.all}
+    let(:ds) {Magentwo::Product.dataset}
+
+    it "responds to all" do
+      expect(Magentwo::Product).to respond_to :all
+    end
+    it "returns an array" do
+      expect(products).to be_a Array
+    end
+    it "requested all" do
+      expect(products.count).to eq @original_count
+    end
+  end
+
+  context "#fields" do
+    let(:fields) {Magentwo::Product.fields}
+
+    it "returns array of symbols" do
+      expect(fields).to be_a Array
+      fields.each do |field|
+        expect(field).to be_a Symbol
+      end
+    end
+  end
+
+  context "#first" do
+    let(:product) {Magentwo::Product.first}
+
+    it "returns a product" do
+      expect(product).to be_a Magentwo::Product
+    end
+  end
+
+  context "#types" do
+    let(:types) {Magentwo::Product.types}
+
+    it "returns array" do
+      expect(types).to be_a Array
+    end
+  end
+
+  context "#[]" do
+    let(:first_product) {Magentwo::Product.first}
+    let(:by_sku_product) {Magentwo::Product[first_product.sku]}
+
+    it "returns a product" do
+      expect(by_sku_product).to be_a Magentwo::Product
+    end
+
+    it "returns product by :sku" do
+      expect(first_product.sku).to eq by_sku_product.sku
+    end
+  end
 end

metadata

@@ -1,11 +1,11 @@
 --- !ruby/object:Gem::Specification
 name: magentwo
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.9
 platform: ruby
 authors:
 - André Mueß
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
 date: 2019-01-17 00:00:00.000000000 Z
@@ -27,11 +27,14 @@ files:
 - lib/filter.rb
 - lib/magentwo.rb
 - lib/model/base.rb
+- lib/model/cart.rb
+- lib/model/category.rb
 - lib/model/coupon.rb
 - lib/model/customer.rb
 - lib/model/order.rb
 - lib/model/product.rb
 - lib/model/sales_rule.rb
+- lib/model/stock_item.rb
 - lib/util/validator.rb
 - magentwo.gemspec
 - spec/base_model_spec.rb
@@ -43,7 +46,7 @@ licenses:
 - MIT
 metadata:
   source_code_uri: https://github.com/Arkad82x/magentwo
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -58,8 +61,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.2
-signing_key: 
+rubygems_version: 3.2.15
+signing_key:
 specification_version: 4
 summary: Magento 2 API Wrapper
 test_files: []