magentwo 0.1.82 → 0.1.90

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 762b1ff6602d28d8c0016f48853837c9d04f550eedfbdf473f76fa49b9aeac4d
-  data.tar.gz: eec1223e6e50059395b536df7b5dd130cba61fcced963dbed9fd581cf1d7b67c
+  metadata.gz: 44f33adbf5ffc5496b64a1f441adc196278dbbad3a8aadc318ca19b676aa6858
+  data.tar.gz: 20b45d22c24da87f886cb8b09033b6148adc8fe3ea6004ce48423480cf64c965
 SHA512:
-  metadata.gz: b2aac1f5d4db03d4ab60edbf8520b632ed3b87279ca4ccf4769d4db75ff5955877e9a5ca289967c6c5fb395e7cc734f279f4909bb24aa59a793c4c573270da97
-  data.tar.gz: 293e42cc723f68a9a34ac295c6d93105a3f3f72c3818c8430b1eafa001e99f85833f146e37f63bbdb6b0fe526587f95ccc4d08fc7efa5dddc3714683e5ceb423
+  metadata.gz: 2fcce9091f7e9ef49383278c230d8c61b7eb0248ba97c4fc002c8385494fe5fc803bcda137e8b1bc6732f320299a6309d8d9c1789ffa01b29d6944b451791411
+  data.tar.gz: 32f13b1fdcf0c182bd6151566bba566a0d6ebfec22220805e03deb6205b0cd7815dc7d274606c7213fa37e41b75573a2d0881f17605ab789aab0e41241518297

data/README.md

@@ -1,37 +1,50 @@
-
 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
 
+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"  
+  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 "http://example2.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
@@ -41,6 +54,7 @@ When using multiple connections at once you can save the result of `Magentwo.con
 ```
 
 # 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
 
@@ -52,40 +66,49 @@ 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
@@ -94,30 +117,38 @@ 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
@@ -125,15 +156,19 @@ 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"
@@ -142,7 +177,9 @@ customer.save
 ```
 
 # Delete
+
 To delete a Model use the `delete` method
+
 ```
 product = Magentwo::Product.first
 product.delete

data/lib/adapter.rb

@@ -37,7 +37,8 @@ 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
 

data/lib/connection.rb

@@ -1,19 +1,28 @@
 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 uri, user, password, base_path:nil
+    def initialize uri:, user:nil, password:nil, base_path:nil, token:nil
       uri = URI(uri)
       @host = uri.host
       @port = uri.port
-      @user = user
-      @password = password
+      @scheme = uri.scheme
       @base_path = base_path || "/rest/V1"
-      request_token
+
+      if (user && password)
+        @user = user
+        @password = password
+        request_token
+      elsif (token)
+       @token = token
+      else
+        raise ArgumentError, "expected user/password or token"
+      end
+
     end
 
     def request_token
-      Net::HTTP.start(self.host,self.port) do |http|
+      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)
@@ -30,7 +39,7 @@ module Magentwo
       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::Delete.new(url)
         req["Authorization"] = "Bearer #{self.token}"
         req['Content-Type'] = "application/json"
@@ -43,7 +52,7 @@ module Magentwo
       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"
@@ -56,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"
@@ -69,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/filter.rb

@@ -7,7 +7,7 @@ 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.to_s)}",
@@ -98,6 +98,13 @@ module Magentwo
     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

data/lib/magentwo.rb

@@ -5,13 +5,19 @@ require 'time'
 require 'logger'
 
 module Magentwo
-  Models = %w(base product customer order coupon sales_rule category cart)
+  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 host, user_name, 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

data/lib/model/base.rb

@@ -65,7 +65,8 @@ module Magentwo
       attr_accessor :adapter
 
       def [] unique_identifier_value
-        self.new (Magentwo::Base.get nil, path:"#{base_path}/#{unique_identifier_value}")
+        result = Magentwo::Base.get nil, path:"#{base_path}/#{unique_identifier_value}"
+        self.new result if result
       end
 
       def unique_identifier
@@ -87,6 +88,7 @@ module Magentwo
 
       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
@@ -100,7 +102,8 @@ module Magentwo
       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

data/lib/model/product.rb

@@ -3,6 +3,10 @@ module Magentwo
     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"

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.82'
+  s.version     = '0.1.90'
   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,11 +1,11 @@
 --- !ruby/object:Gem::Specification
 name: magentwo
 version: !ruby/object:Gem::Version
-  version: 0.1.82
+  version: 0.1.90
 platform: ruby
 authors:
 - André Mueß
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
 date: 2019-01-17 00:00:00.000000000 Z
@@ -34,6 +34,7 @@ files:
 - 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
@@ -45,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
@@ -60,8 +61,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.2.15
+signing_key:
 specification_version: 4
 summary: Magento 2 API Wrapper
 test_files: []