Ruby client for ReCharge Payments' recurring payments API for Shopify
Switch branches/tags
Nothing to show
Clone or download
Latest commit 3eaf772 May 16, 2018
Permalink
Failed to load latest commit information.
lib Doc updates [ci skip] May 16, 2018
spec More tests for Subscription Dec 5, 2017
.gitignore Initial commit Nov 28, 2017
.travis.yml Initial commit Nov 28, 2017
Gemfile Initial commit Nov 28, 2017
LICENSE.txt Initial commit Nov 28, 2017
README.md Doc updates [ci skip] May 16, 2018
Rakefile Initial commit Nov 28, 2017
recharge-api.gemspec More tests, some fixes Dec 5, 2017

README.md

ReCharge API Client

Build Status

Ruby client for ReCharge Payments' recurring payments API for Shopify.

Installation

Ruby gems:

gem install recharge-api

Bundler:

gem "recharge-api", :require => "recharge"

Usage

require "recharge"

ReCharge.api_key = "YOUR_KEY"  # Can also use Recharge
data = {
  :address_id => 123234321,
  :customer_id => 565728,
  # ... more stuff
  :next_charge_scheduled_at => Time.new,
  :properties => {
    :name => "size",
    :value => "medium"
  }
}

subscription = ReCharge::Subscription.create(data)
subscription.address_id = 454343
subscription.save

# Or
ReCharge::Subscription.update(id, data)

subscription = ReCharge::Subscription.new(data)
subscription.save

order1 = ReCharge::Order.get(123123)
order1.line_items.each do |li|
  p li.title
  p li.quantity
end

order2 = ReCharge::Order.get(453321)
p "Different" if order1 != order2

JSON.dump(order2.to_h)

customers = ReCharge::Customer.list(:page => 10, :limit => 50)
customers.each do |customer|
  addresses = ReCharge::Customer.addresses(customer.id)
  # ...
end

For complete documentation refer to the API docs: http://rdoc.info/gems/recharge-api

Rake Tasks for Webhook Management

Add the following to your Rakefile:

require "recharge/tasks"

This will add the following tasks:

  • recharge:hook:create - create webhook HOOK to be sent to CALLBACK
  • recharge:hooks:delete - delete the webhook(s) given by ID
  • recharge:hooks:delete_all - delete all webhooks
  • recharge:hooks:list - list webhooks

All tasks require RECHARGE_API_KEY be set.

For example, to create a hook run the following:

rake recharge:hooks:create RECHARGE_API_KEY=YOURKEY HOOK=subscription/created CALLBACK=https://example.com/callback

License

Released under the MIT License: www.opensource.org/licenses/MIT


Made by ScreenStaring