recharge-api 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 38da2ffc86ba27bea660a00c153e74ffe72fc054
+  data.tar.gz: eed4ac714a4c95f27791c196fbe8c74a2e458b63
+SHA512:
+  metadata.gz: 3b0e967d97687f1df95f7c981bae8846fd62736e246ff186087c40fb005f4711321652450475ccaff461b7ff915c3e7d4479c74e8021fe5794b67c7b1902a171
+  data.tar.gz: fab06c67606cd8052deb664ebaea1d1adc1b7615cd6777080c737ccfb05ea53bf0fc56e4ab02a4cab480c3c05c333b5297410d5fbb2702f1c27c3e6c3d44ec3a

data/.gitignore

@@ -0,0 +1,122 @@
+
+# Created by https://www.gitignore.io/api/emacs,ruby
+
+### Emacs ###
+# -*- mode: gitignore; -*-
+*~
+\#*\#
+/.emacs.desktop
+/.emacs.desktop.lock
+*.elc
+auto-save-list
+tramp
+.\#*
+
+# Org-mode
+.org-id-locations
+*_archive
+
+# flymake-mode
+*_flymake.*
+
+# eshell files
+/eshell/history
+/eshell/lastdir
+
+# elpa packages
+/elpa/
+
+# reftex files
+*.rel
+
+# AUCTeX auto folder
+/auto/
+
+# cask packages
+.cask/
+dist/
+
+# Flycheck
+flycheck_*.el
+
+# server auth directory
+/server/
+
+# projectiles files
+.projectile
+projectile-bookmarks.eld
+
+# directory configuration
+.dir-locals.el
+
+# saveplace
+places
+
+# url cache
+url/cache/
+
+# cedet
+ede-projects.el
+
+# smex
+smex-items
+
+# company-statistics
+company-statistics-cache.el
+
+# anaconda-mode
+anaconda-mode/
+
+### Ruby ###
+*.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
+
+# End of https://www.gitignore.io/api/emacs,ruby

data/.travis.yml

@@ -0,0 +1,12 @@
+language: ruby
+sudo: false
+rvm:
+  - 2.1
+  - 2.2
+  - 2.3
+  - 2.4
+
+before_install: gem update bundler
+
+notifications:
+  email: false

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in recharge-api.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 ScreenStaring
+
+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,83 @@
+# ReCharge API Client
+
+[![Build Status](https://travis-ci.org/ScreenStaring/recharge-api.svg?branch=master)](https://travis-ci.org/ScreenStaring/recharge-api)
+
+Ruby client for [ReCharge Payments'](https://rechargepayments.com/developers)
+recurring payments API for Shopify.
+
+## Installation
+
+Ruby gems:
+
+    gem install recharge-api
+
+Bundler:
+
+    gem "recharge-api", :require => "recharge"
+
+## Usage
+
+```rb
+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
+
+Requiring `recharge/tasks` will include several Rake tasks for webhook management.
+All tasks require `RECHARGE_API_KEY` be set.
+
+The hooks are:
+
+  * `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
+
+## License
+
+Released under the MIT License: www.opensource.org/licenses/MIT
+
+---
+
+Made by [ScreenStaring](http://screenstaring.com)

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/recharge-api.rb

@@ -0,0 +1 @@
+require "recharge"

data/lib/recharge.rb

@@ -0,0 +1,36 @@
+require "recharge/classes"
+require "recharge/version"
+
+module Recharge
+  ENDPOINT = "api.rechargeapps.com".freeze
+  PORT = 443
+  TOKEN_HEADER = "X-Recharge-Access-Token".freeze
+  USER_AGENT = "ReCharge API Client v#{VERSION} (Ruby v#{RUBY_VERSION})"
+
+  Error = Class.new(StandardError)
+  ConnectionError = Class.new(Error)
+
+  #
+  # Raised when a non-2XX HTTP response is returned
+  #
+  class RequestError < Error
+    attr_accessor :errors
+    attr_accessor :status
+    attr_accessor :meta
+
+    def initialize(message, status, meta = nil, errors = nil)
+      super message
+      @status = status
+      @meta = meta || {}
+      @errors = errors || {}
+    end
+  end
+
+  class << self
+    attr_accessor :api_key
+    # If +true+ output HTTP request/response to stderr. Can also be an +IO+ instance to output to.
+    attr_accessor :debug
+  end
+end
+
+ReCharge = Recharge

data/lib/recharge/classes.rb

@@ -0,0 +1,462 @@
+require "json"
+require "class2"
+require "recharge/http_request"
+
+class2 "Recharge", JSON.parse(<<-END) do
+{
+  "subscription":
+     {
+        "id":10101,
+        "address_id":178918,
+        "customer_id":1438,
+        "created_at":"2017-02-28T20:31:29",
+        "updated_at":"2017-02-28 20:31:29",
+        "next_charge_scheduled_at":"2017-04-01T00:00:00",
+        "cancelled_at":null,
+        "product_title":"Sumatra Coffee",
+        "price":12,
+        "quantity":1,
+        "status":"ACTIVE",
+        "shopify_product_id":1255183683,
+        "shopify_variant_id":3844924611,
+        "sku":null,
+        "order_interval_unit":"day",
+        "order_interval_frequency":"30",
+        "charge_interval_frequency":"30",
+        "order_day_of_month":null,
+        "order_day_of_week":null,
+        "properties": []
+     },
+  "charge":
+    {
+      "address_id":178918,
+      "billing_address":{
+         "address1":"3030 Nebraska Avenue",
+         "address2":"",
+         "city":"Los Angeles",
+         "company":"",
+         "country":"United States",
+         "first_name":"Mike",
+         "last_name":"Flynn",
+         "phone":"",
+         "province":"California",
+         "zip":"90404"
+      },
+      "client_details": {
+        "browser_ip": null,
+        "user_agent": null
+      },
+      "created_at":"2017-03-01T19:52:11",
+      "customer_hash":null,
+      "customer_id":10101,
+      "first_name":"Mike",
+      "id":1843,
+      "last_name":"Flynn",
+      "line_items":[
+         {
+            "grams":0,
+            "price":100.0,
+            "properties":[],
+            "quantity":1,
+            "shopify_product_id": "1255183683",
+            "shopify_variant_id":"3844924611",
+            "sku":"",
+            "title": "Milk  10% Off Auto renew",
+            "variant_title": "a / b",
+            "vendor": "Example Storeeeeeee",
+            "subscription_id":14562
+         }
+      ],
+      "processed_at":"2014-11-20T00:00:00",
+      "scheduled_at":"2014-11-20T00:00:01",
+      "shipments_count":null,
+      "shipping_address":{
+         "address1":"3030 Nebraska Avenue",
+         "address2":"",
+         "city":"Los Angeles",
+         "company":"",
+         "country":"United States",
+         "first_name":"Mike",
+         "last_name":"Flynn",
+         "phone":"3103843698",
+         "province":"California",
+         "zip":"90404"
+      },
+      "shopify_order_id":"281223307",
+      "status":"SUCCESS",
+      "total_price":446.00,
+      "updated_at":"2016-09-05T09:19:29"
+    },
+  "customer":
+     {
+        "id": 1438,
+        "hash": "143806234a9ff87a8d9e",
+        "shopify_customer_id": null,
+        "email": "mike@gmail.com",
+        "created_at": "2018-01-10T11:00:00",
+        "updated_at": "2017-01-11T13:16:19",
+        "first_name": "Mike",
+        "last_name": "Flynn",
+        "billing_first_name": "Mike",
+        "billing_last_name": "Flynn",
+        "billing_company": null,
+        "billing_address1": "3030 Nebraska Avenue",
+        "billing_address2": null,
+        "billing_zip": "90404",
+        "billing_city": "Los Angeles",
+        "billing_province": "California",
+        "billing_country": "United States",
+        "billing_phone": "3103843698",
+        "processor_type": null,
+        "status": "FOO"
+    },
+  "order": {
+     "id":7271806,
+     "customer_id":10101,
+     "address_id":178918,
+     "charge_id":9519316,
+     "transaction_id":"ch_19sdP2J2zqHvZRd1hqkeGANO",
+     "shopify_order_id":"5180645510",
+     "shopify_order_number":5913,
+     "created_at":"2017-03-01T14:46:26",
+     "updated_at":"2017-03-01T14:46:26",
+     "scheduled_at":"2017-03-01T00:00:00",
+     "processed_at":"2017-03-01T14:46:26",
+     "status":"SUCCESS",
+     "charge_status":"SUCCESS",
+     "type":"CHECKOUT",
+     "first_name":"Mike",
+     "last_name":"Flynn",
+     "email":"mike@gmail.com",
+     "payment_processor":"stripe",
+     "address_is_active":1,
+     "is_prepaid":0,
+     "line_items":[
+        {
+           "subscription_id":10101,
+           "shopify_product_id":"1255183683",
+           "shopify_variant_id":"3844924611",
+           "variant_title":"Sumatra",
+           "title":"Sumatra Latte",
+           "quantity":1,
+           "properties":[]
+        }
+     ],
+     "total_price":18.00,
+     "shipping_address":{
+        "address1":"1933 Manning",
+        "address2":"204",
+        "city":"los angeles",
+        "province":"California",
+        "first_name":"mike",
+        "last_name":"flynn",
+        "zip":"90025",
+        "company":"bootstrap",
+        "phone":"3103103101",
+        "country":"United States"
+     },
+     "billing_address":{
+        "address1":"1933 Manning",
+        "address2":"204",
+        "city":"los angeles",
+        "province":"California",
+        "first_name":"mike",
+        "last_name":"flynn",
+        "zip":"90025",
+        "company":"bootstrap",
+        "phone":"3103103101",
+        "country":"United States"
+     }
+  },
+  "webhook":
+    {
+        "id":6,
+        "address":"https://request.in/foo",
+        "topic":"order/create"
+  },
+  "address":{
+    "id":3411137,
+    "address1":"1933 Manning",
+    "address2":"204",
+    "city":"los angeles",
+    "province":"California",
+    "first_name":"mike",
+    "last_name":"flynn",
+    "zip":"90025",
+    "company":"bootstrap",
+    "phone":"3103103101",
+    "country":"United States"
+  }
+}
+END
+  def meta=(meta)
+    @meta = meta
+  end
+
+  def meta
+    @meta ||= {}
+  end
+
+  private
+
+  def self.instance(response)
+    args = response[self::SINGLE]
+    args["meta"] = response["meta"]
+    new(args)
+  end
+end
+
+module Recharge
+  module Persistable  # :nodoc:
+    def save
+      data = to_h
+      data.delete("id")
+
+      if id
+        self.class.update(id, data)
+      else
+        self.id = self.class.create(data).id
+      end
+    end
+  end
+
+  class Address
+    PATH = "/addresses".freeze
+    SINGLE = "address".freeze
+    COLLECTION = "addresses".freeze
+
+    extend HTTPRequest::Get
+    extend HTTPRequest::Update
+
+    #
+    # Persist the updated address
+    #
+    # === Errors
+    #
+    # Recharge::ConnectionError, Recharge::RequestError
+    #
+    def save
+      data = to_h
+      data.delete("id")
+      self.class.update(id, data)
+    end
+
+    # Validate an address
+    #
+    # === Arguments
+    #
+    # [data (Hash)] Address to validate, see: https://developer.rechargepayments.com/?shell#validate-address
+    #
+    # === Returns
+    #
+    # [Hash] Validated and sometimes updated address
+    #
+    # === Errors
+    #
+    # Recharge::ConnectionError, Recharge::RequestError
+    #
+    # If the address is invalid a Recharge::RequestError is raised. The validation
+    # errors can be retrieved via Recharge::RequestError#errors
+    #
+    def self.validate(data)
+      POST(join("validate"), data)
+    end
+  end
+
+  class Customer
+    PATH = "/customers".freeze
+    SINGLE = "customer".freeze
+    COLLECTION = "customers".freeze
+
+    extend HTTPRequest::Create
+    extend HTTPRequest::Get
+    extend HTTPRequest::Update
+    extend HTTPRequest::List
+    extend HTTPRequest::Count
+
+    include Persistable
+
+    # Retrieve all of a customer's addresses
+    #
+    # === Arguments
+    #
+    # [id (Fixnum)] Customer ID
+    #
+    # === Errors
+    #
+    # ConnectionError, RequestError
+    #
+    # === Returns
+    #
+    # [Array[Recharge::Address]] The customer's addresses
+    #
+    def self.addresses(id)
+      id_required!(id)
+      data = GET(join(id, Address::COLLECTION))
+      (data[Address::COLLECTION] || []).map do |d|
+        address = Address.new(d)
+        address.meta = data["meta"]
+        address
+      end
+    end
+
+    # Create a new address
+    #
+    # === Arguments
+    #
+    # [id (Fixnum)] Customer ID
+    # [address (Hash)] Address attributes, see: https://developer.rechargepayments.com/?shell#create-address
+    #
+    # === Returns
+    #
+    # [Recharge::Address] The created address
+    #
+    # === Errors
+    #
+    # Recharge::ConnectionError, Recharge::RequestError
+    #
+    def self.create_address(id, address)
+      id_required!(id)
+      data = POST(join(id, Address::COLLECTION), address)
+      address = Address.new(data[Address::SINGLE])
+      address.meta = data["meta"]
+      address
+    end
+  end
+
+  class Charge
+    PATH = "/charges".freeze
+    SINGLE = "charge".freeze
+    COLLECTION = "charges".freeze
+
+    extend HTTPRequest::Count
+    extend HTTPRequest::Get
+    extend HTTPRequest::List
+
+    def self.list(options = nil)
+      super(convert_date_params(options, :date_min, :date_max))
+    end
+
+    def self.change_next_charge_date(id, date)
+      path = join(id, "change_next_charge_date")
+      instance(POST(path, :next_charge_date => date_param(date)))
+    end
+
+    def self.skip(id, subscription_id)
+      path = join(id, "skip")
+      instance(POST(path, :subscription_id => subscription_id))
+    end
+  end
+
+  class Order
+    PATH = "/orders".freeze
+    SINGLE = "order".freeze
+    COLLECTION = "orders".freeze
+
+    extend HTTPRequest::Count
+    extend HTTPRequest::Get
+    extend HTTPRequest::List
+
+    def self.count(options = nil)
+      super(convert_date_params(options, :created_at_max, :created_at_min, :date_min, :date_max))
+    end
+
+    def self.change_date(id, date)
+      id_required!(id)
+      instance(POST(join(id, "change_date"), :shipping_date => date_param(date)))
+    end
+
+    def self.update_shopify_variant(id, old_variant_id, new_varient_id)
+      id_required!(id)
+      path = join(id, "update_shopify_variant", old_variant_id)
+      instance(POST(path, :new_shopify_variant_id => new_varient_id))
+    end
+  end
+
+  class Subscription
+    PATH = "/subscriptions".freeze
+    SINGLE = "subscription".freeze
+    COLLECTION = "subscriptions".freeze
+
+    extend HTTPRequest::Create
+    extend HTTPRequest::Get
+    extend HTTPRequest::Update
+    extend HTTPRequest::List
+
+    include Persistable
+
+    #
+    # Activate a subscription
+    #
+    # === Arguments
+    #
+    # [id (Integer)] ID of subscription to cancel
+    #
+    # === Returns
+    #
+    # [Recharge::Subscription] The activated subscription
+    #
+    # === Errors
+    #
+    # Recharge::ConnectionError, Recharge::RequestError
+    #
+    # If the subscription was already activated a Recharge::RequestError will be raised
+    #
+    def self.activate(id)
+      id_required!(id)
+      instance(POST(join(id, "activate"), :status => "active"))
+    end
+
+    #
+    # Cancel a subscription
+    #
+    # === Arguments
+    #
+    # [id (Integer)] ID of subscription to cancel
+    # [reason (String)] Reason for the cancellation
+    #
+    # === Returns
+    #
+    # [Recharge::Subscription] The canceled subscription
+    #
+    # === Errors
+    #
+    # Recharge::ConnectionError, Recharge::RequestError
+    #
+    # If the subscription was already canceled a Recharge::RequestError will be raised
+    #
+    def self.cancel(id, reason)
+      id_required!(id)
+      instance(POST(join(id, "cancel"), :cancellation_reason => reason))
+    end
+
+    def self.set_next_charge_date(id, date)
+      id_required!(id)
+      instance(POST(join(id, "set_next_charge_date"), :date => date_param(date)))
+    end
+
+    def self.list(options = nil)
+      #options[:status] = options[:status].upcase if options[:status]
+      super(convert_date_params(options, :created_at, :created_at_max, :updated_at, :updated_at_max))
+    end
+  end
+
+  class Webhook
+    PATH = "/webhooks".freeze
+    COLLECTION = "webhooks".freeze
+    SINGLE = "webhook".freeze
+
+    extend HTTPRequest::Create
+    extend HTTPRequest::Delete
+    extend HTTPRequest::Get
+    extend HTTPRequest::List
+    extend HTTPRequest::Update
+
+    include Persistable
+
+    def delete
+      self.class.delete(id)
+      true
+    end
+  end
+end

data/lib/recharge/http_request.rb

@@ -0,0 +1,223 @@
+require "net/http"
+require "uri"
+require "json"
+
+# For iso8601
+require "date"
+require "time"
+
+module Recharge
+  module HTTPRequest # :nodoc:
+
+    protected
+
+    def DELETE(path, data = {})
+      request(Net::HTTP::Delete.new(path), data)
+    end
+
+    def GET(path, data = {})
+      path += sprintf("?%s", URI.encode_www_form(data)) if data && data.any?
+      request(Net::HTTP::Get.new(path))
+    end
+
+    def POST(path, data = {})
+      request(Net::HTTP::Post.new(path), data)
+    end
+
+    def PUT(path, data = {})
+      request(Net::HTTP::Put.new(path), data)
+    end
+
+    def id_required!(id)
+      raise ArgumentError, "id required" if id.nil? || id.to_s.strip.empty?
+    end
+
+    def join(*parts)
+      parts.unshift(self::PATH).join("/")
+    end
+
+    def convert_date_params(options, *keys)
+      return unless options
+
+      options = options.dup
+      keys.each do |key|
+        options[key] = date_param(options[key]) if options.include?(key)
+      end
+
+      options
+    end
+
+    def date_param(date)
+      # ReCharge doesn't accept 8601, 500s on zone specifier
+      # date.respond_to?(:iso8601) ? date.iso8601 : date
+      date.respond_to?(:strftime) ? date.strftime("%Y-%m-%dT%H:%M:%S") : date
+    end
+
+    private
+
+    def request(req, data = {})
+      req[TOKEN_HEADER] = ReCharge.api_key || ""
+      req["User-Agent"] = USER_AGENT
+
+      if req.request_body_permitted? && data && data.any?
+        req.body = data.to_json
+        req["Content-Type"] = "application/json"
+      end
+
+      connection.start do |http|
+        res = http.request(req)
+        data = res["Content-Type"] == "application/json" ? parse_json(res.body) : {}
+        data["meta"] = { "id" => res["X-Request-Id"], "limit" => res["X-Recharge-Limit"] }
+
+        return data if res.code[0] == "2" && !data["warning"] && !data["error"]
+
+        message = data["warning"] || data["error"] || "#{res.code} - #{res.message}"
+        raise RequestError.new(message, res.code, data["meta"], data["errors"])
+      end
+    rescue Net::ReadTimeout, IOError, SocketError, SystemCallError => e
+      raise ConnectionError, "connection failure: #{e}"
+    end
+
+    def connection
+      unless defined? @request
+        @request = Net::HTTP.new(ENDPOINT, PORT)
+        @request.use_ssl = true
+      end
+
+      if !Recharge.debug
+        @request.set_debug_output(nil)
+      else
+        @request.set_debug_output(
+          Recharge.debug.is_a?(IO) ? Recharge.debug : $stderr
+        )
+      end
+
+      @request
+    end
+
+    def parse_json(s)
+      JSON.parse(s)
+    rescue JSON::ParserError => e
+      raise Error, "failed to parse JSON response: #{e}"
+    end
+
+    #
+    # Make a count request to the included/extended class' endpoint
+    #
+    # === Arguments
+    #
+    # [options (Hash)] Optional arguments to filter the count on.
+    #
+    # See the appropriate count call in {ReCharge's documentation}[https://developer.rechargepayments.com/] for valid options.
+    #
+    # === Returns
+    #
+    # +Fixnum+ of the resulting count
+    #
+    # === Errors
+    #
+    # Recharge::ConnectionError, Recharge::RequestError
+    #
+    module Count
+      include HTTPRequest
+
+      def count(options = nil)
+        GET(join("count"), options)["count"]
+      end
+    end
+
+    #
+    # Create an new record for the included/extended entity
+    #
+    # === Arguments
+    #
+    # [data (Hash)] New record's attributes
+    #
+    # See the appropriate create call in {ReCharge's documentation}[https://developer.rechargepayments.com/] for valid attributes
+    #
+    # === Returns
+    #
+    # An instance of the created entity
+    #
+    # === Errors
+    #
+    # Recharge::ConnectionError, Recharge::RequestError
+    #
+    module Create
+      include HTTPRequest
+
+      def create(data)
+        new(POST(self::PATH, data)[self::SINGLE])
+      end
+    end
+
+    #
+    # Delete a record for included/extended entity
+    #
+    # === Arguments
+    #
+    # [id (Fixnum)] ID of the record to delete
+    #
+    # === Returns
+    #
+    # An instance of the deleted entity
+    #
+    # === Errors
+    #
+    # Recharge::ConnectionError, Recharge::RequestError
+    #
+    module Delete
+      include HTTPRequest
+
+      def delete(id)
+        id_required!(id)
+        DELETE(join(id))
+      end
+    end
+
+    module Get
+      include HTTPRequest
+
+      def get(id)
+        id_required!(id)
+        new(GET(join(id))[self::SINGLE])
+      end
+    end
+
+    #
+    # Retrieve a page of records for the included/extended class'
+    #
+    # === Arguments
+    #
+    # [options (Hash)] Optional arguments to filter the result set on.
+    #
+    # In most cases +:page+ and +:limit+ are accepted but see
+    # the appropriate call in {ReCharge's documentation}[https://developer.rechargepayments.com/] for valid options.
+    #
+    # === Returns
+    #
+    # +Array+ of record instances
+    #
+    # === Errors
+    #
+    # Recharge::ConnectionError, Recharge::RequestError
+    #
+    module List
+      include HTTPRequest
+
+      def list(options = nil)
+        data = GET(self::PATH, options)
+        (data[self::COLLECTION] || []).map { |d| new(d.merge("meta" => data["meta"])) }
+      end
+    end
+
+    module Update
+      include HTTPRequest
+
+      def update(id, data)
+        id_required!(id)
+        new(PUT(join(id), data)[self::SINGLE])
+      end
+    end
+  end
+end

data/lib/recharge/tasks.rb

@@ -0,0 +1,65 @@
+require "rake"
+require "recharge"
+
+namespace :recharge do
+  namespace :hooks do
+    task :_setup_recharge do
+      abort "RECHARGE_API_KEY required" unless ENV["RECHARGE_API_KEY"]
+      ReCharge.api_key = ENV["RECHARGE_API_KEY"]
+    end
+
+    desc "List webhooks for RECHARGE_API_KEY"
+    task :list => :_setup_recharge do
+      format = "%-5s %-25s %-80s\n"
+      printf format, "ID", "Hook", "URL"
+
+      Recharge::Webhook.list.each do |hook|
+        printf format, hook.id, hook.topic, hook.address
+      end
+    end
+
+    desc "Delete webhooks for RECHARGE_API_KEY"
+    task :delete_all => :_setup_recharge do
+      Recharge::Webhook.list.each { |hook| hook.class.delete(hook.id) }
+    end
+
+    desc "Delete the webhooks given by the ID(s) in ID for RECHARGE_API_KEY"
+    task :delete => :_setup_recharge do
+      ids = ENV["ID"].to_s.strip.split(",")
+      abort "ID required" unless ids.any?
+
+      ids.each do |id|
+        puts "Deleting webhook #{id}"
+        Recharge::Webhook.delete(id)
+      end
+    end
+
+    desc "Create webhook HOOK to be sent to CALLBACK for RECHARGE_API_KEY"
+    task :create => :_setup_recharge do
+      known_hooks = %w[
+        subscription/created
+        subscription/updated
+        subscription/activated
+        subscription/cancelled
+        customer/created
+        customer/updated
+        order/created
+        charge/created
+        charge/paid
+      ]
+
+      abort "CALLBACK required" unless ENV["CALLBACK"]
+      abort "HOOK required" unless ENV["HOOK"]
+      abort "unknown hook #{ENV["HOOK"]}" unless known_hooks.include?(ENV["HOOK"])
+
+      puts "Creating webhook #{ENV["HOOK"]} for #{ENV["CALLBACK"]}"
+
+      hook = Recharge::Webhook.create(
+        :topic   => ENV["HOOK"],
+        :address => ENV["CALLBACK"]
+      )
+
+      puts "Created hook ##{hook.id}"
+    end
+  end
+end

data/lib/recharge/version.rb

@@ -0,0 +1,3 @@
+module Recharge
+  VERSION = "0.0.1".freeze
+end

data/recharge-api.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "recharge/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "recharge-api"
+  spec.version       = Recharge::VERSION
+  spec.authors       = ["Skye Shaw"]
+  spec.email         = ["skye.shaw@gmail.com"]
+
+  spec.summary       = %q{Client for ReCharge Payments API}
+  spec.description   = %q{Client for ReCharge Payments recurring payments API for Shopify}
+  spec.homepage      = "https://github.com/ScreenStaring/recharge-api"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "class2", "~> 0.3.0"
+  spec.add_development_dependency "webmock", "~> 3.0"
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification
+name: recharge-api
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Skye Shaw
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-12-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: class2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Client for ReCharge Payments recurring payments API for Shopify
+email:
+- skye.shaw@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/recharge-api.rb
+- lib/recharge.rb
+- lib/recharge/classes.rb
+- lib/recharge/http_request.rb
+- lib/recharge/tasks.rb
+- lib/recharge/version.rb
+- recharge-api.gemspec
+homepage: https://github.com/ScreenStaring/recharge-api
+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: []
+rubyforge_project: 
+rubygems_version: 2.6.14
+signing_key: 
+specification_version: 4
+summary: Client for ReCharge Payments API
+test_files: []