increase 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c94e77f42a4d8c725f5518af02301564c6cbff71f90015063313e983aeac5124
-  data.tar.gz: 1d5ec565ec368dd713b47f18a41d5eb1363e624ef6792c05b87952f9fe368695
+  metadata.gz: 5dab8c774d39cce112627bc75d36a10947419d640db56e45dfc4f2cd75330656
+  data.tar.gz: a93d12bf1e5a64938dcf41b339a1de33c36c82ad8b5430169156cb868e0cf87a
 SHA512:
-  metadata.gz: 4dd0a71c6eac5742ca4f63237eb8bbccffc8eefe625ce63e345b97cb4431b3cba04744e9acd426665757ab0d1240637a4fb02311cda84cbe7dc8fa1f2657c7bf
-  data.tar.gz: cba66503cbbeaf4fd7bdc6541899d033126a2efbc20a7ce70cb8b14f42a78a30628b3ea40b3da1b7b176e4d8219291d800846061f3004c70c2d0e96f4b548a64
+  metadata.gz: f74f1fd78799702a1dfed5180e93155ca7595a4f8d758545e483f3aee5db6cac853ff044fe043bcc33918eb85dd17c4544ea359654adfa1b52448240e1a38d42
+  data.tar.gz: ce8aacf00abb9d1660cff928a80ecc5f74900f6ea998cb47a512dedb080cfd252740e4c7f15d982580dae0f026c172948d3948fcbd9438a0348e6b8dd2ee28f6

data/README.md

@@ -98,7 +98,7 @@ rescue Increase::ApiError => e
   puts e.detail # "No resource of type transaction was found with ID transaction_1234abcd."
   puts e.status # 404
 
-  puts e.response # This contains the full response from the API, including headers! (its a Faraday::Env object)
+  puts e.response # This contains the full response from the API, including headers! (its a Faraday::Response object)
 
   puts e.class # Increase::ObjectNotFoundError (it's a subclass of Increase::ApiError!)
 end
@@ -129,15 +129,58 @@ Increase.api_key = 'terabytes_of_cash' # Default: nil (you'll need one tho!)
 Increase.base_url = :production # Default: :production
 Increase.raise_api_errors = true # Default: true
 
-# Or, you can use a block
+# Or, you can pass in a hash
+Increase.configure(api_key: 'just_my_two_cents')
+
+# Or, you can use a block!
 Increase.configure do |config|
   config.api_key = 'digital_dough'
-  config.base_url = :sandbox
-  config.raise_api_errors = false
+  config.base_url = :sandbox # Default: :production
+  config.raise_api_errors = false # Default: true
 end
+```
 
-# Or, you can pass in a hash
-Increase.configure(api_key: 'just_my_two_cents')
+If you are using Rails, the recommended way is to set your configurations as a block in an initializer.
+
+```ruby
+# config/initializers/increase.rb
+
+Increase.configure do |config|
+  config.api_key = 'money_cant_buy_happiness'
+  config.base_url = :production
+end
+```
+
+### Webhooks
+
+**Increase**'s webhooks include a `Increase-Webhook-Signature` header for securing your webhook endpoint. Although not
+required, it's strongly recommended that you verify the signature to ensure the request is coming from **Increase**.
+
+Here is an example for Rails.
+
+```ruby
+
+class IncreaseController < ApplicationController
+  protect_from_forgery except: :webhook # Ignore CSRF checks
+
+  def webhook
+    payload = request.body.read
+    sig_header = request.headers['Increase-Webhook-Signature']
+    secret = Rails.application.credentials.dig(:increase, :webhook_secret)
+
+    Increase::Webhook::Signature.verify?(
+      payload: payload,
+      signature_header: sig_header,
+      secret: secret
+    )
+
+    # It's a valid webhook! Do something with it...
+
+    render json: {success: true}
+  rescue Increase::WebhookSignatureVerificationError => e
+    render json: {error: 'Webhook signature verification failed'}, status: :bad_request
+  end
+end
 ```
 
 ### Idempotency

data/lib/increase/resources/check_transfers.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require "increase/resource"
+
+module Increase
+  class CheckTransfers < Resource
+    create
+    list
+    retrieve
+    endpoint :approve, :post, with: :id
+    endpoint :cancel, :post, with: :id
+    endpoint :stop_payment, :post, with: :id
+  end
+end

data/lib/increase/resources/limits.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "increase/resource"
+
+module Increase
+  class Limits < Resource
+    create
+    list
+    update
+    retrieve
+  end
+end

data/lib/increase/resources/routing_numbers.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require "increase/resource"
+
+module Increase
+  class RoutingNumbers < Resource
+    list
+  end
+end

data/lib/increase/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Increase
-  VERSION = "0.1.2"
+  VERSION = "0.1.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: increase
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Gary Tou
@@ -133,8 +133,11 @@ files:
 - lib/increase/resources/accounts.rb
 - lib/increase/resources/ach_transfers.rb
 - lib/increase/resources/cards.rb
+- lib/increase/resources/check_transfers.rb
 - lib/increase/resources/events.rb
+- lib/increase/resources/limits.rb
 - lib/increase/resources/pending_transactions.rb
+- lib/increase/resources/routing_numbers.rb
 - lib/increase/resources/transactions.rb
 - lib/increase/response_hash.rb
 - lib/increase/util.rb