magentwo 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 57c5ce2bff9ba6b24431270fec36de370ae8a1637c0b336cf8f5bd7a741d4cdb
+  data.tar.gz: 2dfe12316718b6e2882db03b7b057ba128c7f6e41df1a23717a21bbb2e59aa11
+SHA512:
+  metadata.gz: 57390590bb9ccb28a3fefce2ea23417768a1e01c7dacb1ab388bcd7e6d5ecb3abf6103a9059ec9d21e95137137ce1a4025c30993a5ea3f58638722d0435ed0ec
+  data.tar.gz: d57e227ce4ec86df09fbdf12ac14f915180e9fe53bcdc08c7c15a02834425491d3547dfc84884abc202e5a639aaebe5331741e9e05fefe1a3adfce26fc8d2f86

data/.gitignore

@@ -0,0 +1,50 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Arkad82x
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,4 @@
+# magentwo
+Simple Ruby-Wrapper for the Magento 2 REST API
+
+under developement

data/lib/connection.rb

@@ -0,0 +1,74 @@
+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
+      @user = user
+      @password = password
+      @base_path = base_path || "/rest/default/V1"
+      request_token
+    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
+        req['Content-Type'] = "application/json"
+        req['Content-Length'] = req.body.length
+        @token = JSON.parse http.request(req).body
+      end
+    end
+
+    def call method, path, query
+      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
+
+    end
+
+    def put
+
+    end
+
+    def post
+
+    end
+
+    def get url
+      p "get: #{url}"
+      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"
+        resp = http.request(req)
+        handle_response resp
+      end
+    end
+
+    private
+    def handle_response response
+      case response.code
+      when "200" then JSON.parse response.body
+      else
+        raise "request failed #{response.code} #{response.body}"
+      end
+    end
+  end
+end

data/lib/dataset.rb

@@ -0,0 +1,130 @@
+module Magentwo
+  class Dataset
+    attr_accessor :model, :opts
+    def initialize model, opts=nil
+      self.model = model
+      self.opts = opts || {
+        :filters => [],
+        :pagination => {
+          :current_page => Filter::CurrentPage.new(1),
+          :page_size => Filter::PageSize.new(20)
+        },
+        :ordering => []
+      }
+    end
+
+    #################
+    # Filters
+    ################
+    def filter hash_or_other, invert:false
+      filter = 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
+        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])
+    end
+
+    def exclude args
+      filter args, invert:true
+    end
+
+    def select *fields
+      Dataset.new self.model, self.opts.merge(:filters => self.opts[:filters] + [Filter::Fields.new(fields)])
+    end
+
+    def like args
+      Dataset.new self.model, self.opts.merge(:filters => self.opts[:filters] + [Filter::Like.new(args.keys.first, args.values.first)])
+    end
+
+    #################
+    # Pagination
+    ################
+    def page page, page_size=20
+      Dataset.new self.model, self.opts.merge(:pagination => {:current_page => Filter::CurrentPage.new(page), :page_size => Filter::PageSize.new(page_size)})
+    end
+
+    #################
+    # Ordering
+    ################
+    def order_by field, direction="ASC"
+      Dataset.new self.model, self.opts.merge(:ordering => self.opts[:ordering] + [Filter::OrderBy.new(field, direction)])
+    end
+
+    #################
+    # Fetching
+    ################
+    def info
+      result = self.model.call :get, self.page(1, 1).to_query
+      {
+        :fields => result["items"]&.first&.keys,
+        :total_count => result["total_count"]
+      }
+    end
+
+    def count
+      self.info[:total_count]
+    end
+
+    def fields
+      self.info[:fields]
+    end
+
+    def first
+      result = self.model.call :get, self.page(1, 1).to_query
+      self.model.new result["items"].first
+    end
+
+    def all
+      result = self.model.call :get, self.to_query
+      return [] if result.nil?
+      (result["items"] || []).map do |item|
+        self.model.new item
+      end
+    end
+
+    #################
+    # Transformation
+    ################
+    def to_query
+      [
+        self.opts[:filters]
+        .each_with_index
+        .map { |opt, idx| opt.to_query(idx) }
+        .join("&"),
+
+        self.opts[:pagination]
+        .map { |k, v| v.to_query}
+        .join("&"),
+
+
+        self.opts[:ordering]
+        .map { |opt, idx| opt.to_query(idx) }
+        .join("&"),
+      ].reject(&:empty?)
+      .join("&")
+    end
+
+    #################
+    # Functors
+    ################
+    def map(&block)
+      raise ArgumentError, "no block given" unless block_given?
+      self.all.map(&block)
+    end
+
+    def each &block
+      raise ArgumentError, "no block given" unless block_given?
+      self.all.each(&block)
+    end
+  end
+end

data/lib/filter.rb

@@ -0,0 +1,105 @@
+module Magentwo
+  module Filter
+    class Compare
+      attr_accessor :field, :value
+      def initialize field, value
+        @field = field
+        @value = value
+      end
+
+      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][condition_type]=#{self.class.name.split("::").last.downcase}"]
+        .join("&")
+      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][condition_type]=#{self.class.name.split("::").last.downcase}"]
+        .join("&")
+      end
+    end
+
+    class Simple
+      attr_accessor :key, :value
+      def initialize key, value
+        @key = key
+        @value = value
+      end
+
+      def to_query idx=nil
+        "searchCriteria[#{key}]=#{value}"
+      end
+    end
+
+    class Multi
+      attr_accessor :kvps
+      def initialize kvps
+        @kvps = kvps
+      end
+
+      def to_query idx=nil
+        kvps.map do |kvp|
+          "searchCriteria[#{kvp[:key]}]=#{kvp[:value]}"
+        end.join("&")
+      end
+    end
+
+
+    class Eq < Magentwo::Filter::Compare
+    end
+
+    class Neq < Magentwo::Filter::Compare
+    end
+
+    class In < Magentwo::Filter::CompareArray
+    end
+
+    class Nin < Magentwo::Filter::CompareArray
+    end
+
+    class Like < Magentwo::Filter::Compare
+    end
+
+    class PageSize < Magentwo::Filter::Simple
+      def initialize value
+        super(:page_size, value)
+      end
+    end
+
+    class CurrentPage < Magentwo::Filter::Simple
+      def initialize value
+        super(:current_page, value)
+      end
+    end
+
+    class OrderBy < Magentwo::Filter::Multi
+      def initialize field, direction
+        super([{:key => :field, :value => field}, {:key => :direction, :value => direction}])
+      end
+
+      def to_query idx=nil
+        self.kvps.map do |kvp|
+        "searchCriteria[sortOrders][0][#{kvp[:key]}]=#{kvp[:value]}"
+        end.join("&")
+      end
+    end
+
+    class Fields
+      attr_accessor :fields
+      def initialize fields
+        @fields = fields
+      end
+      def to_query idx=nil
+        #TODO api supports nested field selection e.g. items[address[street]]
+        "fields=items[#{URI::encode(self.fields.join(","))}]"
+      end
+    end
+  end
+end

data/lib/magentwo.rb

@@ -0,0 +1,17 @@
+require 'uri'
+require 'net/http'
+require 'json'
+
+module Magentwo
+  Models = %w(base product customer order)
+  def self.connect host, user_name, password
+    Base.connection = Connection.new host, user_name, password
+  end
+end
+
+require_relative 'connection.rb'
+require_relative 'filter.rb'
+require_relative 'dataset.rb'
+Magentwo::Models.each do |file_name|
+	require_relative("model/#{file_name}.rb")
+end

data/lib/model/base.rb

@@ -0,0 +1,35 @@
+module Magentwo
+  class Base
+    DatasetMethods = %i(all filter exclude select fields first count fields info page order_by like)
+
+    def initialize args
+      args.each do |key, value|
+        key_sym = :"@#{key}"
+        if self.respond_to? :"#{key}="
+          instance_variable_set key_sym, value
+        end
+      end
+    end
+
+    class << self; attr_accessor :connection end
+
+    class << self
+      #args may container searchCriteria, fields, ...
+      def call method, query
+        model_name = "#{self.name.split("::").last.downcase}s"
+        Magentwo::Base.connection.call method, model_name, query
+      end
+
+      def dataset
+        Magentwo::Dataset.new(self)
+      end
+
+      DatasetMethods.each do |name|
+        define_method name do |*args|
+          return dataset.send(name, *args)
+        end
+      end
+
+    end
+  end
+end

data/lib/model/customer.rb

@@ -0,0 +1,16 @@
+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)
+
+    Attributes.each do |attr|
+      attr_accessor attr
+    end
+
+    class << self
+      def call method, query
+        model_name = "customers/search"
+        Magentwo::Base.connection.call method, model_name, query
+      end
+    end
+  end
+end

data/lib/model/order.rb

@@ -0,0 +1,5 @@
+module Magentwo
+  class Order < Base
+
+  end
+end

data/lib/model/product.rb

@@ -0,0 +1,9 @@
+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
+  end
+end

data/magentwo.gemspec

@@ -0,0 +1,12 @@
+Gem::Specification.new do |s|
+  s.name        = 'magentwo'
+  s.version     = '0.1.0'
+  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.files       = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
+end

data/magentwo.rb

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

data/spec/base_model_spec.rb

@@ -0,0 +1,4 @@
+require_relative '../lib/model/base.rb'
+
+describe 'BaseModel' do
+end

data/spec/product_spec.rb

@@ -0,0 +1,8 @@
+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
+end

data/spec/server_spec.rb

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

data/spec/spec_helper.rb

@@ -0,0 +1,100 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # This option will default to `:apply_to_host_groups` in RSpec 4 (and will
+  # have no way to turn it off -- the option exists only for backwards
+  # compatibility in RSpec 3). It causes shared context metadata to be
+  # inherited by the metadata hash of host groups and examples, rather than
+  # triggering implicit auto-inclusion in groups with matching metadata.
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # This allows you to limit a spec run to individual examples or groups
+  # you care about by tagging them with `:focus` metadata. When nothing
+  # is tagged with `:focus`, all examples get run. RSpec also provides
+  # aliases for `it`, `describe`, and `context` that include `:focus`
+  # metadata: `fit`, `fdescribe` and `fcontext`, respectively.
+  config.filter_run_when_matching :focus
+
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  config.example_status_persistence_file_path = "spec/examples.txt"
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
+  #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = "doc"
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification
+name: magentwo
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- André Mueß
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-01-17 00:00:00.000000000 Z
+dependencies: []
+description: Provides a simple Ruby Interface to interact with the Magento 2 API
+email: andre.cux90@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE
+- README.md
+- lib/connection.rb
+- lib/dataset.rb
+- lib/filter.rb
+- lib/magentwo.rb
+- lib/model/base.rb
+- lib/model/customer.rb
+- lib/model/order.rb
+- lib/model/product.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
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.2
+signing_key: 
+specification_version: 4
+summary: Magento 2 API Wrapper
+test_files: []