magentwo 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0855b02b9cf1761f2dff8aac04d3358904f7285eec5f94de93368825cba7681e'
-  data.tar.gz: 35cc8a01a17878c7a53e0c29d0d247462b10952779e837a84da2c9a6a8f81937
+  metadata.gz: a3a841b7d66c45e36a63b99466fd49e7bedfd056f9077e2cdf2e93dd0b7bf9d1
+  data.tar.gz: 46906bc86d4c0da2517334e916e61b0a647d181587324be4a8f5f5058ae3079e
 SHA512:
-  metadata.gz: e80b2f28e9327f855d38c43fff6666ac47fac9b3adef74548cf7fa26ff7c299c6cf93fd8e95df0db8ed53ecc2a78c596808233787d7317ab6a89e55c582564a6
-  data.tar.gz: ffa022044416feab9a526d6608681ea7142c59093d9a4f0b13a14f5b2d43c52016065847cb70362749413c3093f766813f2e82546366c76000a3f539b7048c75
+  metadata.gz: aa0c925bd64c60d046266bfed1a8f0c6c1c50ab9f69e2f2b5e5fb6700a5fef715db656a11c65c065f4fae273ba994422c9ec810c3903ffdb671d1d723a9242c0
+  data.tar.gz: 2a49d67d5c11fb054d23cc0d2ac24cb87d813c0704111dadeb75cf7a80626139f579f653ae86d7e61789debe02ef2c5951d178bfac0604b121ebfda4e77b236d

data/.gitignore

@@ -9,6 +9,8 @@
 /test/tmp/
 /test/version_tmp/
 /tmp/
+/magentwo.rb
+/publish.sh
 
 # Used by dotenv library to load environment variables.
 # .env

data/lib/adapter.rb

@@ -0,0 +1,52 @@
+module Magentwo
+  class Adapter < Magentwo::Connection
+    DateFields = %i(created_at dob  updated_at)
+    def call method, path, params
+      http_method, params = case method
+      when :put, :post, :delete then [method, params.to_json]
+      when :get, :get_with_meta_data then [:get, params]
+      else
+        raise ArgumentError, "unknown method type. Expected :get, :get_with_meta_data, :post, :put or :delete. #{method} #{path}"
+      end
+
+      response = self.send(http_method, path, params)
+
+      parsed_response = case method
+      when :get_with_meta_data, :put, :post, :delete then transform( parse( response))
+      when :get
+        parsed = parse(response)
+        if parsed[:items]
+          parsed[:items].map do |item|
+            transform item
+          end
+        else
+          transform parsed
+        end
+      else
+        raise ArgumentError, "unknown method type. Expected :get, :get_with_meta_data, :post, :put or :delete. #{method} #{path}"
+      end
+    end
+
+    private
+    def parse response
+      case response.code
+      when "200"
+        JSON.parse response.body, :symbolize_names => true
+      else
+        puts "request failed #{response.code} #{response.body}"
+      end
+    end
+
+    def transform item
+      date_transform item if item
+    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
+      item
+    end
+  end
+end

data/lib/connection.rb

@@ -17,7 +17,6 @@ module Magentwo
     end
 
     def request_token
-      p self
       Net::HTTP.start(self.host,self.port) do |http|
         req = Net::HTTP::Post.new("#{base_path}/integration/admin/token")
         req.body = {:username=> self.user, :password=> self.password}.to_json
@@ -27,47 +26,49 @@ module Magentwo
       end
     end
 
-    def call method, path, query:nil
-      url = "#{base_path}/#{path}?#{query}"
-      case method
-      when :get then self.get url
-      when :post then self.post url
-      when :delete then self.delete url
-      when :put then self.put url
-      else
-        raise "unknown http method, cannot call #{method}, expected :get, :post, :delete or :put"
-      end
-    end
-
-    def delete
+    def delete path, data
+      Magentwo.logger.info "DELETE #{path}"
+      Magentwo.logger.debug "DATA #{data}"
 
-    end
-
-    def put
+      Magentwo.logger.warn "not implemented"
 
     end
 
-    def post
-
+    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|
+        req = Net::HTTP::Put.new(url)
+        req["Authorization"] = "Bearer #{self.token}"
+        req['Content-Type'] = "application/json"
+        req.body = data
+        http.request(req)
+      end
     end
 
-    def get url
-      p "get: #{url}"
+    def post path, data
+      Magentwo.logger.info "POST #{host}/#{path}"
+      Magentwo.logger.debug "DATA #{data}"
+      url = "#{base_path}/#{path}"
       Net::HTTP.start(self.host,self.port) do |http|
-        req = Net::HTTP::Get.new(url)
+        req = Net::HTTP::Post.new(url)
         req["Authorization"] = "Bearer #{self.token}"
         req['Content-Type'] = "application/json"
-        resp = http.request(req)
-        handle_response resp
+        req.body = data
+        http.request(req)
       end
     end
 
-    private
-    def handle_response response
-      case response.code
-      when "200" then JSON.parse response.body, :symbolize_names => true
-      else
-        raise "request failed #{response.code} #{response.body}"
+
+    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|
+        req = Net::HTTP::Get.new(url)
+        req["Authorization"] = "Bearer #{self.token}"
+        req['Content-Type'] = "application/json"
+        http.request(req)
       end
     end
   end

data/lib/dataset.rb

@@ -7,9 +7,10 @@ module Magentwo
         :filters => [],
         :pagination => {
           :current_page => Filter::CurrentPage.new(1),
-          :page_size => Filter::PageSize.new(20)
+          :page_size => Filter::PageSize.new(Magentwo.default_page_size)
         },
-        :ordering => []
+        :ordering => [],
+        :fields => nil
       }
     end
 
@@ -39,7 +40,7 @@ module Magentwo
     end
 
     def select *fields
-      Dataset.new self.model, self.opts.merge(:filters => self.opts[:filters] + [Filter::Fields.new(fields)])
+      Dataset.new self.model, self.opts.merge(:fields => Filter::Fields.new(fields))
     end
 
     def like args
@@ -49,7 +50,7 @@ module Magentwo
     #################
     # Pagination
     ################
-    def page page, page_size=20
+    def page page, page_size=Magentwo.default_page_size
       Dataset.new self.model, self.opts.merge(:pagination => {:current_page => Filter::CurrentPage.new(page), :page_size => Filter::PageSize.new(page_size)})
     end
 
@@ -64,7 +65,7 @@ module Magentwo
     # Fetching
     ################
     def info
-      result = self.model.call :get, {:query => self.page(1, 1).to_query}
+      result = self.model.get self.page(1, 1).to_query, {:meta_data => true}
       {
         :fields => result[:items]&.first&.keys,
         :total_count => result[:total_count]
@@ -80,16 +81,11 @@ module Magentwo
     end
 
     def first
-      result = self.model.call :get, {:query => self.page(1, 1).to_query}
-      self.model.new result[:items].first
+      self.model.first self
     end
 
     def all
-      result = self.model.call :get, {:query => self.to_query}
-      return [] if result.nil?
-      (result[:items] || []).map do |item|
-        self.model.new item
-      end
+      self.model.all self
     end
 
     #################
@@ -110,6 +106,8 @@ module Magentwo
         self.opts[:ordering]
         .map { |opt, idx| opt.to_query(idx) }
         .join("&"),
+
+        self.opts[:fields]? self.opts[:fields].to_query() : ""
       ].reject(&:empty?)
       .join("&")
     end
@@ -119,12 +117,12 @@ module Magentwo
     ################
     def map(&block)
       raise ArgumentError, "no block given" unless block_given?
-      self.all.map(&block)
+      self.model.all.map(&block)
     end
 
     def each(&block)
       raise ArgumentError, "no block given" unless block_given?
-      self.all.each(&block)
+      self.model.all.each(&block)
     end
   end
 end

data/lib/filter.rb

@@ -98,7 +98,7 @@ module Magentwo
       end
       def to_query idx=nil
         #TODO api supports nested field selection e.g. items[address[street]]
-        "fields=items[#{URI::encode(self.fields.join(","))}]"
+        "fields=items[#{URI::encode(self.fields.map(&:to_s).join(","))}]"
       end
     end
   end

data/lib/magentwo.rb

@@ -1,17 +1,39 @@
 require 'uri'
 require 'net/http'
 require 'json'
+require 'logger'
 
 module Magentwo
-  Models = %w(base product customer order)
+  Models = %w(base product customer order coupon sales_rule)
   def self.connect host, user_name, password
-    Base.connection = Connection.new host, user_name, password
+    Base.adapter = Adapter.new host, user_name, password
   end
+
+  def self.logger= logger
+    @@logger = logger
+  end
+
+  def self.logger
+    @@logger ||= Logger.new STDOUT, {:level => Logger::DEBUG}
+  end
+
+  def self.default_page_size
+    @@default_page_size ||= 20
+  end
+
+  def self.default_page_size= page_size
+    @@default_page_size = page_size
+  end
+
+
 end
 
 require_relative 'connection.rb'
+require_relative 'adapter.rb'
 require_relative 'filter.rb'
 require_relative 'dataset.rb'
+require_relative 'util/validator.rb'
+
 Magentwo::Models.each do |file_name|
 	require_relative("model/#{file_name}.rb")
 end

data/lib/model/base.rb

@@ -1,6 +1,8 @@
 module Magentwo
   class Base
-    DatasetMethods = %i(all filter exclude select fields first count fields info page order_by like)
+    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|
@@ -9,23 +11,81 @@ module Magentwo
           instance_variable_set key_sym, value
         end
       end
-      if self.respond_to? :custom_attributes
+      if self.respond_to?(:custom_attributes) && args[:custom_attributes]
         self.custom_attributes = args[:custom_attributes].map do |attr|
           Hash[attr[:attribute_code].to_sym, attr[:value]]
         end.inject(&:merge)
       end
     end
 
-    def call method, path, query:nil
-      Magentwo::Base.call method, path, {:query => query}
+    def save
+      self.validate
+      response = Magentwo::Base.call :put, "#{self.class.base_path}/#{self.id}", self
+      self.class.new response
+    end
+
+    def delete
+      Magentwo.logger.warn "not implemented"
+    end
+
+    def validate
+      true
+    end
+
+    def check_presence *attributes
+      Magentwo::Validator.check_presence self, *attributes
     end
 
-    class << self; attr_accessor :connection end
+    def call method, path, params
+      self.class.call method, path, params
+    end
+
+    def to_h
+      self.instance_variables.map do |k|
+        key = k.to_s[1..-1] #symbol to string and remove @ in front
+        if key == "custom_attributes"
+          [
+            key,
+            self.send(key).map do |k, v|
+              {:attribute_code => k, :value => v}
+            end
+          ]
+        else
+          [key, self.send(key)]
+        end
+      end
+      .to_h
+    end
+
+    def to_json
+      Hash[self.class.lower_case_name, self.to_h].to_json
+    end
 
     class << self
-      #args may container searchCriteria, fields, ...
-      def call method, path="#{self.name.split("::").last.downcase}s", query:nil
-        Magentwo::Base.connection.call method, path, {:query => query}
+      attr_accessor :adapter
+
+      def lower_case_name
+        name = self.name.split(/::/).last
+        "#{name[0,1].downcase}#{name[1..-1]}"
+      end
+
+      def base_path
+        "#{lower_case_name}s"
+      end
+
+      def get_path
+        base_path
+      end
+
+      def all ds=self.dataset
+        self.get(ds.to_query)
+        .map do |item|
+          self.new item
+        end
+      end
+
+      def first ds=self.dataset
+        self.new self.get(ds.page(1, 1).to_query).first
       end
 
       def dataset
@@ -37,6 +97,20 @@ module Magentwo
           return dataset.send(name, *args)
         end
       end
+
+      def get query, path:self.get_path, meta_data:false
+        case meta_data
+        when true then self.call :get_with_meta_data, path, query
+        when false then self.call :get, path, query
+        else
+          raise ArgumentError "unknown meta_data param, expected bool value. got: #{meta_data}"
+        end
+      end
+
+      def call method, path=self.base_path, params
+          Magentwo::Base.adapter.call(method, path, params)
+      end
+
     end
   end
 end

data/lib/model/coupon.rb

@@ -0,0 +1,29 @@
+module Magentwo
+  class Coupon < Base
+    Attributes = %i(coupon_id rule_id code usage_per_customer times_used is_primary type)
+    Attributes.each do |attr| attr_accessor attr end
+
+    class << self
+      def get_path
+        "#{base_path}/search"
+      end
+
+      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",
+        {
+          :couponSpec => {
+           :rule_id => rule_id,
+           :quantity => quantity,
+           :length => length,
+           :format => format,
+           :delimiter => delimiter,
+           :delimiter_at_every => delimiter_at_every
+          }
+        }
+      end
+    end
+
+  end
+end

data/lib/model/customer.rb

@@ -1,18 +1,20 @@
 module Magentwo
   class Customer < Base
     Attributes = %i(id group_id default_billing default_shipping created_at updated_at created_in dob email firstname lastname gender store_id website_id addresses disable_auto_group_change extension_attributes)
+    Attributes.each do |attr| attr_accessor attr end
 
-    Attributes.each do |attr|
-      attr_accessor attr
+    def with_extension_attributes
+      self.class.new (self.class.get nil, path:"#{self.class.base_path}/#{self.id}")
     end
 
-    def with_extension_attributes
-      Magentwo::Customer.new( self.call :get, "customers/#{self.id}")
+    def validate
+      check_presence :email
+      super
     end
 
     class << self
-      def call method, path="customers/search", query:nil
-        Magentwo::Base.connection.call method, path, {:query => query}
+      def get_path
+        "#{base_path}/search"
       end
     end
   end

data/lib/model/product.rb

@@ -1,9 +1,6 @@
 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
+    Attributes.each do |attr| attr_accessor attr end
   end
 end

data/lib/model/sales_rule.rb

@@ -0,0 +1,13 @@
+module Magentwo
+  class SalesRule < Base
+    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
+
+    class << self
+      def get_path
+        "#{base_path}/search"
+      end
+    end
+
+  end
+end

data/lib/util/validator.rb

@@ -0,0 +1,24 @@
+module Magentwo
+  class Validator
+    class << self
+      def check_presence model, *attributes
+        case model
+        when Hash
+          attributes.each do |attribute|
+            raise ArgumentError, "#{attribute} must be set" unless model[attribute]
+          end
+        when Magentwo::Base
+          attributes.each do |attribute|
+            raise ArgumentError, "#{attribute} must be set" unless model.send(attribute)
+          end
+        else
+          raise ArgumentError, "unknown model type, expected Child of Magentwo::Base or Hash"
+        end
+      end
+
+      def one_of value, *valid_values
+        raise ArgumentError, "value #{value} invalid, expected one of #{valid_values}" unless valid_values.include?value
+      end
+    end
+  end
+end

data/magentwo.gemspec

@@ -1,12 +1,13 @@
 Gem::Specification.new do |s|
   s.name        = 'magentwo'
-  s.version     = '0.1.3'
+  s.version     = '0.1.4'
   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"
   s.authors     = ["André Mueß"]
   s.email       = 'andre.cux90@gmail.com'
   s.license     = 'MIT'
-  s.homepage    = "https://github.com/Arkad82x/magentwo"
+  s.homepage    = "https://rubygems.org/gems/magentwo"
+  s.metadata    = { "source_code_uri" => "https://github.com/Arkad82x/magentwo" }
   s.files       = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
 end

data/spec/dataset_spec.rb

@@ -0,0 +1,68 @@
+require_relative '../lib/magentwo.rb'
+
+describe Magentwo::Dataset do
+  let(:dataset) {Magentwo::Dataset.new Magentwo::Product}
+  context "Initial Dataset" do
+    let(:initial_query) {dataset.to_query}
+    it "has opts" do
+      expect(dataset).to respond_to :opts
+      expect(dataset.opts).to have_key :pagination
+      expect(dataset.opts).to have_key :ordering
+      expect(dataset.opts).to have_key :filters
+    end
+    it "has model" do
+      expect(dataset).to respond_to :model
+      expect(dataset.model).to eq Magentwo::Product
+    end
+    it "has default pagination" 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
+      expect(initial_query).to include "searchCriteria[current_page]=1"
+      expect(initial_query).to include "searchCriteria[page_size]=#{Magentwo::Dataset::DefaultPageSize}"
+    end
+  end
+
+  context "simple name filter" do
+    let(:name_filter_ds) {dataset.filter({:name => "foobar"})}
+    let(:name_filter_query) {name_filter_ds.to_query}
+    it "adds filter" do
+      expect(name_filter_ds.opts[:filters]).to include Magentwo::Filter::Eq
+    end
+    it "computes query" do
+      expect(name_filter_query).to include "searchCriteria[filter_groups][0][filters][0][field]=name"
+      expect(name_filter_query).to include "searchCriteria[filter_groups][0][filters][0][condition_type]=eq"
+      expect(name_filter_query).to include "searchCriteria[filter_groups][0][filters][0][value]=foobar"
+    end
+  end
+
+  context "select" do
+    let(:name_select_ds) {dataset.select(:name)}
+    let(:name_select_query) {name_select_ds.to_query}
+    let(:multi_field_select_ds) {dataset.select(:field1, :field2)}
+    let(:multi_field_select_query) {multi_field_select_ds.to_query}
+    it "adds filter" do
+      expect(name_select_ds.opts[:fields]).to be_an_instance_of Magentwo::Filter::Fields
+    end
+    it "computes name select query" do
+      expect(name_select_query).to include "fields=items[name]"
+    end
+    it "adds multiple fields" do
+      expect(multi_field_select_ds.opts).to have_key :fields
+      expect(multi_field_select_ds.opts[:fields]).to be_an_instance_of Magentwo::Filter::Fields
+      expect(multi_field_select_ds.opts[:fields].fields).to include :field1
+      expect(multi_field_select_ds.opts[:fields].fields).to include :field2
+    end
+    it "computes multi select query" do
+      expect(multi_field_select_query).to include "fields=items[field1,field2]"
+    end
+  end
+
+  context "URL encoding" do
+    let(:filter_query_with_spaces) {dataset.filter({:name => "Hello there, lets add some spaces here"}).to_query}
+    it "encodes spaces" do
+      expect(filter_query_with_spaces).to include "%20"
+    end
+  end
+end

data/spec/product_spec.rb

@@ -1,8 +1,4 @@
 require_relative '../lib/magentwo.rb'
 
-describe 'product' do
-  Magentwo::Base.connection = Magentwo::Connection.new('magento2.local',"admin","magentorocks1")
-  it 'returns an array when list is called' do
-    expect(Magentwo::Product.list.class).to eq Array
-  end
+describe Magentwo::Product do
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: magentwo
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - André Mueß
@@ -21,25 +21,28 @@ files:
 - Gemfile
 - LICENSE
 - README.md
+- lib/adapter.rb
 - lib/connection.rb
 - lib/dataset.rb
 - lib/filter.rb
 - lib/magentwo.rb
 - lib/model/base.rb
+- lib/model/coupon.rb
 - lib/model/customer.rb
 - lib/model/order.rb
 - lib/model/product.rb
+- lib/model/sales_rule.rb
+- lib/util/validator.rb
 - magentwo.gemspec
-- magentwo.rb
 - spec/base_model_spec.rb
 - spec/dataset_spec.rb
 - spec/product_spec.rb
-- spec/server_spec.rb
 - spec/spec_helper.rb
-homepage: https://github.com/Arkad82x/magentwo
+homepage: https://rubygems.org/gems/magentwo
 licenses:
 - MIT
-metadata: {}
+metadata:
+  source_code_uri: https://github.com/Arkad82x/magentwo
 post_install_message: 
 rdoc_options: []
 require_paths:

data/magentwo.rb

@@ -1,6 +0,0 @@
-require 'pry'
-require_relative 'lib/magentwo.rb'
-
-Magentwo.connect 'magento2.local',"admin","magentorocks1"
-
-binding.pry

data/spec/server_spec.rb

@@ -1,7 +0,0 @@
-require_relative '../lib/model/base.rb'
-
-describe 'setup' do
-  before do
-    Magentwo::Base.connection = Magentwo::Connection.new('magento2.local',"admin","magentorocks1")
-  end
-end