Project

MagentoTwo

0.0
The project is in a healthy, maintained state
An API wrapper to handle orders, shipments, customers and products.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies
 Project Readme

WIP - MagentoTwo

Ruby Gem as Magento 2 API Wrapper, Because other gems are lacking some features. Current Available Features:

- All Orders
- Pending Orders
- Processing Orders
- Complete Orders
- Update Order Shipment (which changes the status to Complete)

Installation

TODO: Replace UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.

Install the gem and add to the application's Gemfile by executing:

$ bundle add UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG

If bundler is not being used to manage dependencies, install the gem by executing:

$ gem install UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG

Usage

    MagentoTwo.configure do |config|
      config.host = "http://host_url/rest/V1/"
      config.token = "your_oauth_token"
    end

    # Get All Orders
    MagentoTwo::Order.new.all

    # Get Pending Orders
    MagentoTwo::Order.new.pending

    # Get Processing Orders
    MagentoTwo::Order.new.processing

    # Get Complete Orders
    MagentoTwo::Order.new.complete

    # Update Shipment
    MagentoTwo::Order.new.ship(order_id: 1, carrier_code: 'DHL', title: 'Tracking Number', track_number: '9876543210')

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake test to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and the created tag, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/Kaakati/magento-two. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the MagentoTwo project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.