spackle-ruby 0.0.18 → 0.0.19

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7a5b9861dc2d74dffa6bc745b4bcc0bc7469b0ecd8e96fb593a2d5d3f590e090
-  data.tar.gz: 221a36058f512b719cfa413df10a4352baa94534ceeec737eea70d1fbbbebd54
+  metadata.gz: 3a068195f85f43b672e48420f8020bfc91f02122894cad7f4fc1f04f511c5b91
+  data.tar.gz: 1bb74da02b2774c447c6dacb77d379bb9c4335fde6c67253d49ee6a959e879a3
 SHA512:
-  metadata.gz: ca4c8170d6e4b076f62202ab5e17a47d75aadc8467380c41312d5d2ce59a97a9ab67bbb66edf7aa310c9d92e9744d31b77645473b2fc5f5182f534655d05ca36
-  data.tar.gz: 5460ac9cbcabdd41531d1165b33bde4979944a6afbda2ae44aa21df133e2da02ac3719f0ec636514acf037797263601526585a2f9a6e533fa4a94d23f84e26d6
+  metadata.gz: 77aa643922bdcb3f22c07bb9e8521a7ca0d81802f789185a98ef460950a409bd9278654ab92dc8f4d0603b576887032bc6eb321daa4b5821847a5ba6a86f1c51
+  data.tar.gz: 3d31d216ee9473293ca70ae4bd4497d0a9170fb2f6d555e1402dc31366b364d588df6cc3c6a7b7ae3ce4fd5f8545efbcc502cbfe43354871988c8223f57455d9

data/README.md

@@ -43,7 +43,48 @@ Spackle.bootstrap()
 
 ## Usage
 
-### Fetch a customer
+### Pricing tables
+
+#### Fetch a pricing table
+
+```ruby
+pricing_table = Spackle::PricingTable.retrieve("abcde123")
+```
+
+#### Pricing table object
+```ts
+{
+  id: string
+  name: string
+  intervals: string[]
+  products: {
+    id: string
+    features: {
+      id: string
+      name: string
+      key: string
+      type: number
+      value_flag: boolean
+      value_limit: number | null
+    }[]
+    name: string
+    prices: {
+      month?: {
+        unit_amount: number
+        currency: string
+      }
+      year?: {
+        unit_amount: number
+        currency: string
+      }
+    }
+  }[]
+}
+```
+
+### Entitlements
+
+#### Fetch a customer
 
 Spackle uses stripe ids as references to customer features.
 
@@ -51,19 +92,19 @@ Spackle uses stripe ids as references to customer features.
 customer = Spackle::Customer.retrieve("cus_00000000")
 ```
 
-### Verify feature access
+#### Verify feature access
 
 ```ruby
 customer.enabled("feature_key")
 ```
 
-### Fetch a feature limit
+#### Fetch a feature limit
 
 ```ruby
 customer.limit("feature_key")
 ```
 
-### Examine a customer's subscriptions
+#### Examine a customer's subscriptions
 
 A customer's current subscriptions are available on the `subscriptions` property. These are valid `Stripe::Subscription` objects as defined in the [Stripe Ruby library](https://stripe.com/docs/api/subscriptions/object?lang=ruby).
 
@@ -71,7 +112,7 @@ A customer's current subscriptions are available on the `subscriptions` property
 customer.subscriptions
 ```
 
-## Waiters
+#### Waiters
 
 There is a brief delay between when an action takes place in Stripe and when it is reflected in Spackle. To account for this, Spackle provides a `Waiters` module that can be used to wait for a Stripe object to be updated and replicated.
 
@@ -90,22 +131,7 @@ There is a brief delay between when an action takes place in Stripe and when it
 
 These will block until Spackle is updated with the latest information from Stripe or until a timeout occurs.
 
-## Logging
-The Spackle Ruby library emits logs as it performs various internal tasks. You can control the verbosity of Spackle's logging a few different ways:
-
-1. Set the environment variable SPACKLE_LOG to the value `debug`, `info`, `warn` or `error`
-
-   ```sh
-   $ export SPACKLE_LOG=debug
-   ```
-
-2. Set Spackle.log_level:
-
-   ```ruby
-   Spackle.log_level = 'debug'
-   ```
-
-## Usage in development environments
+#### Usage in development environments
 In production, Spackle requires a valid Stripe customer. However, that is not development environments where state needs to be controlled. As an alternative, you can use a file store to test your application with seed data.
 
 ```json
@@ -172,3 +198,18 @@ Spackle.store.set_customer_data("cus_000000000", {
 ```
 
 **Note:** The in-memory store is not thread-safe and state will reset on each application restart.
+
+## Logging
+The Spackle Ruby library emits logs as it performs various internal tasks. You can control the verbosity of Spackle's logging a few different ways:
+
+1. Set the environment variable SPACKLE_LOG to the value `debug`, `info`, `warn` or `error`
+
+   ```sh
+   $ export SPACKLE_LOG=debug
+   ```
+
+2. Set Spackle.log_level:
+
+   ```ruby
+   Spackle.log_level = 'debug'
+   ```

data/lib/spackle/pricing_table.rb

@@ -0,0 +1,22 @@
+module Spackle
+  class PricingTable
+    def self.retrieve(id)
+      @api = Faraday.new(
+        url: Spackle.api_base,
+        headers: {
+          'Authorization' => "Bearer #{Spackle.api_key}",
+        }
+      ) do |faraday|
+        faraday.adapter :net_http_persistent
+      end
+
+      response = @api.get(Spackle.api_base + "/pricing_tables/#{id}")
+
+      if response.status != 200
+        raise SpackleError.new "Pricing table #{id} not found"
+      end
+
+      return JSON.parse(response.body)
+    end
+  end
+end

data/lib/spackle.rb

@@ -2,6 +2,7 @@ require 'logger'
 require 'forwardable'
 
 require 'spackle/customer'
+require 'spackle/pricing_table'
 require 'spackle/spackle_configuration'
 require 'spackle/util'
 require 'spackle/waiters'

data/spackle.gemspec

@@ -2,7 +2,7 @@ $LOAD_PATH.unshift(::File.join(::File.dirname(__FILE__), "lib"))
 
 Gem::Specification.new do |s|
   s.name          = "spackle-ruby"
-  s.version       = "0.0.18"
+  s.version       = "0.0.19"
   s.summary       = "Spackle Ruby gem"
   s.description   = "Spackle is the easiest way to integrate your Ruby app with Stripe Billing. " \
                     "See https://www.spackle.so for details."

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: spackle-ruby
 version: !ruby/object:Gem::Version
-  version: 0.0.18
+  version: 0.0.19
 platform: ruby
 authors:
 - Spackle
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-07-24 00:00:00.000000000 Z
+date: 2023-09-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -123,6 +123,7 @@ files:
 - bin/spackle-console
 - lib/spackle.rb
 - lib/spackle/customer.rb
+- lib/spackle/pricing_table.rb
 - lib/spackle/spackle_configuration.rb
 - lib/spackle/stores/base.rb
 - lib/spackle/stores/edge.rb