spackle-ruby 0.0.17 → 0.0.19.beta

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 32480a021112248d161f422541c003cbe176944ac291b40eb3bfd108bd2b8a64
-  data.tar.gz: a95dc99b789dd3640ba204b1ec789ed51e94507594cfa92f929fa87003fb46cf
+  metadata.gz: cba8dd3558c9f2fd420c6012270d7a64b75a47abbeb7e78def87a708a7da9f8e
+  data.tar.gz: f0e6d00f8074fd77d142a27c041dbda74423b75146d66ed2037e90a2dc9f8461
 SHA512:
-  metadata.gz: c32a949157acd858345046696e28754414b55716bcdefd057ed72023049a87697a8fa375d002745f3e4fedec7ff15c9db2fa6b7bf0768253150039bc0dad1f76
-  data.tar.gz: 18c1f836c78568b3a05ee87f03a60adfc254ee6516129320246ceac812947b4c7c5fe6beb29a3deabfa98caa0ecfbf2222c79d9caa228a0a1a461c630a8c6868
+  metadata.gz: 63867ff2ce77badd85923ab5b1cc73445b13e4bd7805256fc6ca4304ae824f725cfcbae90c8cdcc07e25a5a00a552899c0f07291e65d6dbc2f9051a4c8f5ecb3
+  data.tar.gz: 934bb37bc4be6ac675663a499ecb2885d68c7f59ea536c83f538f71625d4ee0894b1f2e3366f319307479f050a6f721323d731327087620a6684c8ec7ebbe992

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.17"
+  s.version       = "0.0.19.beta"
   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."
@@ -19,6 +19,7 @@ Gem::Specification.new do |s|
   }
 
   s.add_dependency "faraday", "~> 2.7"
+  s.add_dependency "faraday-net_http_persistent", '~> 2.0'
   s.add_dependency "nokogiri", "~> 1.13"
   s.add_dependency "stripe", "~> 8.3"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: spackle-ruby
 version: !ruby/object:Gem::Version
-  version: 0.0.17
+  version: 0.0.19.beta
 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
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.7'
+- !ruby/object:Gem::Dependency
+  name: faraday-net_http_persistent
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
@@ -109,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
@@ -137,9 +152,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubygems_version: 3.4.10
 signing_key: