magentwo 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a3a841b7d66c45e36a63b99466fd49e7bedfd056f9077e2cdf2e93dd0b7bf9d1
-  data.tar.gz: 46906bc86d4c0da2517334e916e61b0a647d181587324be4a8f5f5058ae3079e
+  metadata.gz: 692e463d7482eb7a4badc478f415deccc4085bb5b19a7d3d84bcc0a671108a8e
+  data.tar.gz: 9d4615302038000aa1c322190484d139e34e1fc6a122ef6c68ceae9e7296f617
 SHA512:
-  metadata.gz: aa0c925bd64c60d046266bfed1a8f0c6c1c50ab9f69e2f2b5e5fb6700a5fef715db656a11c65c065f4fae273ba994422c9ec810c3903ffdb671d1d723a9242c0
-  data.tar.gz: 2a49d67d5c11fb054d23cc0d2ac24cb87d813c0704111dadeb75cf7a80626139f579f653ae86d7e61789debe02ef2c5951d178bfac0604b121ebfda4e77b236d
+  metadata.gz: c2cbcd9f5ee6814e5fba49f3422c9df1d18f9fb86fef3608945201c307c28e3e53c479ed8361373a1ff20b52ab61d961ee34e69dce33618df8be588c946c5d4f
+  data.tar.gz: 5add378c0c94715979a40d9d53c6d9d0c704e11f9daa2891627d7cb82b44fb59dea62af33aafb532cb4fcd28b303b640ac30790528be861cd1da65211dd8e34c

data/README.md

@@ -1,4 +1,99 @@
-# magentwo
-Simple Ruby-Wrapper for the Magento 2 REST API
 
-under developement
+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
+
+# 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
+Currently there is only one connection at a time possible
+```
+  Magentwo.connect http://example.com, username, password  
+```
+
+# 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
+```
+
+# 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
+```
+
+# 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").filter(:last_name => "Bar").first
+customer.firstname = "Bar"
+customer.lastname = "Foo"
+customer.save
+```
+
+to be continued

data/lib/adapter.rb

@@ -10,12 +10,13 @@ module Magentwo
       end
 
       response = self.send(http_method, path, params)
+      Magentwo.logger.debug response.body
 
       parsed_response = case method
       when :get_with_meta_data, :put, :post, :delete then transform( parse( response))
       when :get
         parsed = parse(response)
-        if parsed[:items]
+        if parsed.is_a?(Hash) && parsed[:items]
           parsed[:items].map do |item|
             transform item
           end
@@ -38,11 +39,14 @@ module Magentwo
     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]
       end

data/lib/connection.rb

@@ -2,27 +2,26 @@ module Magentwo
   class Connection
     attr_accessor :host, :port, :user, :password, :token, :base_path
 
-    def initialize host, user, password, base_path:nil
-      if host.include? ":"
-        @host = host.split(":").first
-        @port = host.split(":").last.to_i
-      else
-        @host = host
-        @port = 80
-      end
+    def initialize uri, user, password, base_path:nil
+      uri = URI(uri)
+      @host = uri.host
+      @port = uri.port
       @user = user
       @password = password
-      @base_path = base_path || "/rest/default/V1"
+      @base_path = base_path || "/rest/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")
+        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
 

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,21 +18,22 @@ 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
@@ -124,5 +125,20 @@ 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
+      while(received_element_count == page_size) do
+        page = self.page(current_page, page_size).all
+
+        block.call(page)
+
+        received_element_count = page.count
+        current_page += 1
+      end
+    end
   end
 end

data/lib/filter.rb

@@ -10,7 +10,7 @@ module Magentwo
       def to_query idx
         [
         "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
@@ -20,7 +20,7 @@ module Magentwo
       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.join(",").map(&:to_s))}",
         "searchCriteria[filter_groups][#{idx}][filters][0][condition_type]=#{self.class.name.split("::").last.downcase}"]
         .join("&")
       end

data/lib/magentwo.rb

@@ -4,8 +4,11 @@ require 'json'
 require 'logger'
 
 module Magentwo
-  Models = %w(base product customer order coupon sales_rule)
-  def self.connect host, user_name, password
+  Models = %w(base product customer order coupon sales_rule category)
+  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 host, user_name, password
   end
 
@@ -14,7 +17,7 @@ module Magentwo
   end
 
   def self.logger
-    @@logger ||= Logger.new STDOUT, {:level => Logger::DEBUG}
+    @@logger ||= Logger.new STDOUT, {:level => Logger::INFO}
   end
 
   def self.default_page_size
@@ -25,7 +28,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'

data/lib/model/base.rb

@@ -2,8 +2,6 @@ module Magentwo
   class Base
     DatasetMethods = %i(filter exclude select fields count fields info page order_by like)
 
-    attr_accessor :base_path
-
     def initialize args
       args.each do |key, value|
         key_sym = :"@#{key}"
@@ -64,6 +62,10 @@ module Magentwo
     class << self
       attr_accessor :adapter
 
+      def [] unique_identifier
+        self.new (Magentwo::Base.get nil, path:"#{base_path}/#{unique_identifier}")
+      end
+
       def lower_case_name
         name = self.name.split(/::/).last
         "#{name[0,1].downcase}#{name[1..-1]}"
@@ -88,6 +90,18 @@ module Magentwo
         self.new self.get(ds.page(1, 1).to_query).first
       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
         Magentwo::Dataset.new(self)
       end
@@ -108,7 +122,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/category.rb

@@ -0,0 +1,9 @@
+module Magentwo
+  class Category < Base
+    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,

data/lib/model/product.rb

@@ -2,5 +2,11 @@ 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
+
+    class << self
+      def types
+        Magentwo::Base.get nil, path:"#{base_path}/types"
+      end
+    end
   end
 end

data/lib/model/sales_rule.rb

@@ -3,6 +3,15 @@ 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
+      Magentwo::Coupon.generate self.rule_id, quantity:quantity, length:length, format:format, delimiter:delimiter, delimiter_at_every:delimiter_at_every
+    end
+
+    def coupons
+      Magentwo::Coupon.filter(:rule_id => self.rule_id).all
+    end
+
+
     class << self
       def get_path
         "#{base_path}/search"

data/magentwo.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name        = 'magentwo'
-  s.version     = '0.1.4'
+  s.version     = '0.1.5'
   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,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: magentwo
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - André Mueß
@@ -27,6 +27,7 @@ files:
 - lib/filter.rb
 - lib/magentwo.rb
 - lib/model/base.rb
+- lib/model/category.rb
 - lib/model/coupon.rb
 - lib/model/customer.rb
 - lib/model/order.rb