Project

desertcart

0.0
No release in over a year
desertcartdesertcart/desertcart-rubyHomepageDocumentationSource CodeBug TrackerWiki
Client library to talk to Desertcart API. Get products details, proceed with checkout and retrieve informations about your orders.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Popularity
Downloads
11,266
Stars
0
Forks
2
Watchers
2
 Releases
Current version
1.2.0
Total releases
8
First release
2021-09-01
Latest release
2021-12-27
 Pull Requests
Open Pull Requests
1
Closed Pull Requests
0
Merged Pull Requests
2
Pull Request Acceptance Rate
66%
 Development
Primary Language
Ruby
Licenses
MIT
Average date of last 50 commits
2022-07-30
Reverse Dependencies
0

 Dependencies

Development

dotenv
>= 0
rubocop
>= 0

Runtime

ledger_sync
~> 2.3.1
 Project Readme

Desertcart

This gem allows you to talk with Desertcart and its Marketplace API. It is build on top of ledger_sync.

Installation

Add this line to your application's Gemfile:

gem 'desertcart'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install desertcart

Usage

Authentication and Authorization

Get tokens from API by signing in.

require 'desertcart'

client = Desertcart::Client.new

resource = Desertcart::Session.new(login: 'EMAIL', password: 'password')

operation = Desertcart::Session::Operations::Create.new(client: client, resource: resource)
operation.perform

Setting['DESERTCART_USER_TOKEN'] = operation.result.resource.token
Setting['DESERTCART_USER_ID'] = operation.result.resource.user.ledger_id

Once you have tokens, go ahead and get tokens for your store (id: 1)

client = Desertcart::Client.new(user_id: Setting['DESERTCART_USER_ID'], user_token: Setting['DESERTCART_USER_TOKEN'], store_id: nil, store_token: nil)

store = Desertcart::Marketplace::Store.new(ledger_id: '1')

resource = Desertcart::Marketplace::Authorization.new(store: store)

operation = Desertcart::Marketplace::Authorization::Operations::Create.new(client: client, resource: resource)
operation.perform

Setting['DESERTCART_AMAZON_US_TOKEN'] = operation.result.resource.token
Setting['DESERTCART_AMAZON_US_ID'] = operation.result.resource.store.ledger_id

Verification

Verify its all good.

require 'desertcart'

client = Desertcart::Client.new(user_id: Setting['DESERTCART_USER_ID'], user_token: Setting['DESERTCART_USER_TOKEN'], store_id: Setting['DESERTCART_AMAZON_US_ID'], store_token: Setting['DESERTCART_AMAZON_US_TOKEN'])

resource = Desertcart::Marketplace::Store.new(ledger_id: 'current')

operation = Desertcart::Marketplace::Store::Operations::Find.new(client: client, resource: resource)
operation.perform

operation.result.resource.ledger_id

Search

To get list of items/search, you need to use Searcher class.

require 'desertcart'

client = Desertcart::Client.new(user_id: Setting['DESERTCART_USER_ID'], user_token: Setting['DESERTCART_USER_TOKEN'], store_id: Setting['DESERTCART_AMAZON_US_ID'], store_token: Setting['DESERTCART_AMAZON_US_TOKEN'])

search = Desertcart::Marketplace::OrderItem::Searcher.new(client: client, query: {})
search.resources

Pending order items search with hash param.

require 'desertcart'

client = Desertcart::Client.new(user_id: Setting['DESERTCART_USER_ID'], user_token: Setting['DESERTCART_USER_TOKEN'], store_id: Setting['DESERTCART_AMAZON_US_ID'], store_token: Setting['DESERTCART_AMAZON_US_TOKEN'])

search = Desertcart::Marketplace::PendingOrderItem::Searcher.new(client: client, query: {updated_at_eq: Time.zone.now})
search.resources

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec 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/[USERNAME]/desertcart.

License

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