lemonsqueezy 0.2.2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5d3696e1ba538e89d4ea65a77f90a20c024f79790700981191437e09c22bf183
-  data.tar.gz: 11186062f312505a6dbe326c9ff27a8c940573475f788b5d44cabbb3e27c95ac
+  metadata.gz: '0900634c79d4767c4035474bf0c842e8a08f4ae6a967d8111e2c20b0da65321d'
+  data.tar.gz: 65fe9091c594652c165f771c72dd763b0496163eac3d2bc6d5fb6b26a2ed2d85
 SHA512:
-  metadata.gz: 47b685c7e6d41eaf056789dbdfbe58b2e080626cc20fe2fc997d78cc16d95545547d25efd1b54fbc51fc7c296cc6bd532b95a6193b94a43d97e2c4749bf44057
-  data.tar.gz: 1894f19062e99ea38437dd0fc9c2691e90148c2974d8ca7390f1daf8a96de1291d455551a97f29b64cbf6f7dc955b6bc444bd4863b77a422f8e74281b826b9c3
+  metadata.gz: 876df20f2d4528f04e0c1dbbde80043879c17dd45a209b4ad7f1ac8a099f50e77df5e4b16b198b3ab14247208df2b8e3eb64794d18f364c96ff6c399610b9223
+  data.tar.gz: 78175a9305d0453b2bf755a516a2fbd8a308ca6f2976c946863f6d84d2bd8ebb9d2a36d5c3fb9130ac2551a290d32618def69365e53437635da51fe50d4a1c55

data/.env.example

@@ -1 +1,2 @@
-ACCESS_TOKEN=
+LEMON_SQUEEZY_API_KEY=""
+LEMON_SQUEEZY_API_KEY_TEST=""

data/Gemfile

@@ -8,4 +8,5 @@ gemspec
 gem "rake", "~> 13.0"
 
 gem "minitest", "~> 5.0"
-gem "dotenv"
+gem "dotenv"
+gem "vcr"

data/Gemfile.lock

@@ -1,20 +1,23 @@
 PATH
   remote: .
   specs:
-    lemonsqueezy (0.2.1)
+    lemonsqueezy (1.0.0)
       faraday (~> 2.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    dotenv (2.7.6)
-    faraday (2.7.4)
-      faraday-net_http (>= 2.0, < 3.1)
-      ruby2_keywords (>= 0.0.4)
-    faraday-net_http (3.0.2)
-    minitest (5.15.0)
-    rake (13.0.6)
-    ruby2_keywords (0.0.5)
+    dotenv (2.8.1)
+    faraday (2.9.0)
+      faraday-net_http (>= 2.0, < 3.2)
+    faraday-net_http (3.1.0)
+      net-http
+    minitest (5.20.0)
+    net-http (0.4.1)
+      uri
+    rake (13.1.0)
+    uri (0.13.0)
+    vcr (6.2.0)
 
 PLATFORMS
   x86_64-linux
@@ -24,6 +27,7 @@ DEPENDENCIES
   lemonsqueezy!
   minitest (~> 5.0)
   rake (~> 13.0)
+  vcr
 
 BUNDLED WITH
    2.3.22

data/README.md

@@ -1,220 +1,345 @@
-# LemonSqueezy
+# LemonSqueezy Ruby Library
 
-**This Library is a work in progress**
-
-This is a Ruby library for interacting with the Lemon Squeezy API.
+A Ruby library for the Lemon Squeezy API.
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem "lemonsqueezy"
+gem "lemonsqueezy", "~> 1.0"
 ```
 
 ## Usage
 
-### Set Access Token
+### Set API Key
+
+Firstly you'll need to create an API Key on your [settings page](https://app.lemonsqueezy.com/settings/api).
+
+```ruby
+LemonSqueezy.configure do |config|
+  config.api_key = ENV["LEMON_SQUEEZY_API_KEY"]
+end
+```
 
-Firstly you'll need to create an API Access Token on your [settings page](https://app.lemonsqueezy.com/settings/api).
+### User
 
 ```ruby
-@client = LemonSqueezy::Client.new(access_token: "")
+# Retrieve the authenticated user
+LemonSqueezy::User.me
 ```
 
 ### Stores
 
 ```ruby
 # Retrieves a list of Stores
-@client.stores.list
+LemonSqueezy::Store.list
 
 # Retrieves a Store
-@client.stores.get id: "123"
+LemonSqueezy::Store.retrieve id: 123
+```
+
+### Customers
+
+```ruby
+# Retrieves a list of Customers
+LemonSqueezy::Customer.list
+
+# Retrieves a list of Customers for a store
+LemonSqueezy::Customer.list store_id: 123
+
+# Retrieves a list of Customers that contain the supplied email
+LemonSqueezy::Customer.list email: "test@hello.com"
+
+# Retrieves a Customer
+LemonSqueezy::Customer.retrieve id: 123
+
+# Create a customer
+# https://docs.lemonsqueezy.com/api/customers#create-a-customer
+LemonSqueezy::Customer.create store_id: 123, name: "Customer name", email: "test@hello.com"
+
+# Update a customer
+# https://docs.lemonsqueezy.com/api/customers#update-a-customer
+LemonSqueezy::Customer.update id: 123, name: "Customer name", status: "archived"
 ```
 
 ### Products
 
 ```ruby
 # Retrieves a list of Products
-@client.products.list
+LemonSqueezy::Product.list
 
 # Retrieves a list of Products for a specified Store
-@client.products.list store_id: 123
+LemonSqueezy::Product.list store_id: 123
 
 # Retrieves a Product
-@client.products.get id: "123"
+LemonSqueezy::Product.retrieve id: 123
 ```
 
 ### Product Variants
 
 ```ruby
 # Retrieves a list of Variants
-@client.variants.list
+LemonSqueezy::Variant.list
 
 # Retrieves a list of Variants for a Product
-@client.variants.list product_id: 123
+LemonSqueezy::Variant.list product_id: 123
 
 # Retrieves a Variant
-@client.variants.get id: "123"
+LemonSqueezy::Variant.retrieve id: 123
+```
+
+### Prices
+
+```ruby
+# Retrieves a list of Prices
+LemonSqueezy::Price.list
+
+# Retrieves a list of Prices for a Variant
+LemonSqueezy::Price.list variant_id: 123
+
+# Retrieves a Price
+LemonSqueezy::Price.retrieve id: 123
 ```
 
 ### Orders
 
 ```ruby
 # Retrieves a list of Orders
-@client.orders.list
+LemonSqueezy::Order.list
 
 # Retrieves a list of Orders for a specified store
-@client.orders.list product_id: 123
+LemonSqueezy::Order.list product_id: 123
 
 # Retrieves a list of Orders for an email address
-@client.orders.list email: "hello@test.com"
+LemonSqueezy::Order.list email: "hello@test.com"
 
 # Retrieves an Order
-@client.orders.get id: "123"
+LemonSqueezy::Order.retrieve id: 123
 
 # Retrieves the items on an Order
-@client.orders.get order_items: "123"
+LemonSqueezy::Order.retrieve order_items: 123
 ```
 
 ### Subscriptions
 
 ```ruby
 # Retrieves a list of Subscriptions
-@client.subscriptions.list
+LemonSqueezy::Subscription.list
 
 # Retrieves a list of Subscriptions for a store
-@client.subscriptions.list store_id: 123
+LemonSqueezy::Subscription.list store_id: 123
 
 # Retrieves a list of Subscriptions for an Order
-@client.subscriptions.list order_id: 123
+LemonSqueezy::Subscription.list order_id: 123
 
 # Retrieves a list of Subscriptions for a product
-@client.subscriptions.list product_id: 123
+LemonSqueezy::Subscription.list product_id: 123
 
 # Retrieves a Subscription
-@client.subscriptions.get id: 123
+LemonSqueezy::Subscription.retrieve id: 123
+
+# Updates a Subscription
+# https://docs.lemonsqueezy.com/api/subscriptions#update-a-subscription
+LemonSqueezy::Subscription.update id: 123, variant_id: 123
 
 # Pauses a Subscription
 # Kind should be void or free
 # resumes_at can be nil or an ISO-8601 formatted date-time string indicating
 # when the subscription will continue collecting payments.
-@client.subscriptions.pause id: 123, kind: "void", resumes_at: nil
+LemonSqueezy::Subscription.pause id: 123, kind: "void", resumes_at: nil
 
 # Un-Pause a Subscription
-@client.subscriptions.unpause id: 123
+LemonSqueezy::Subscription.unpause id: 123
 
 # Cancel a Subscription
-@client.subscriptions.cancel id: 123
+LemonSqueezy::Subscription.cancel id: 123
 
 # Un-Cancel a Subscription
-@client.subscriptions.uncancel id: 123
+LemonSqueezy::Subscription.uncancel id: 123
 
 # Change the Plan for a Subscription
-@client.subscriptions.change_plan id: 123, plan_id: 111, variant_id: 111
+LemonSqueezy::Subscription.change_plan id: 123, plan_id: 111, variant_id: 111
 ```
 
 ### Subscription Invoices
 
 ```ruby
 # Retrieves a list of Subscription Invoices
-@client.subscription_invoices.list
+LemonSqueezy::SubscriptionInvoice.list
 
 # Retrieves a list of Subscription Invoices for a specified Store
-@client.subscription_invoices.list store_id: 123
+LemonSqueezy::SubscriptionInvoice.list store_id: 123
+
+# Retrieves a list of Subscription Invoices for a specified Subscription
+LemonSqueezy::SubscriptionInvoice.list subscription_id: 123
 
 # Retrieves a Subscription Invoice
-@client.subscription_invoices.get id: "123"
+LemonSqueezy::SubscriptionInvoice.retrieve id: 123
+```
+
+### Subscription Items
+
+```ruby
+# Retrieves a list of Subscription Items
+LemonSqueezy::SubscriptionItem.list
+
+# Retrieves a list of Subscription Items for a specified Subscription
+LemonSqueezy::SubscriptionItem.list subscription_id: 123
+
+# Retrieves a Subscription Item
+LemonSqueezy::SubscriptionItem.retrieve id: 123
+
+# Updates a Subscription Item
+# https://docs.lemonsqueezy.com/api/subscription-items#update-a-subscription-item
+LemonSqueezy::SubscriptionItem.update id: 123, quantity: 2
+
+# Retrieve subscription item's current usage
+# Returns 404 if the product/variant does not have usage based billing enabled
+# https://docs.lemonsqueezy.com/api/subscription-items#retrieve-a-subscription-item-s-current-usage
+LemonSqueezy::SubscriptionItem.current_usage id: 123
 ```
 
 ### Discounts
 
 ```ruby
 # Retrieves a list of Discounts
-@client.discounts.list
+LemonSqueezy::Discount.list
 
 # Retrieves a list of Discounts for a store
-@client.discounts.list store_id: 123
+LemonSqueezy::Discount.list store_id: 123
 
 # Retrieves a Discount
-@client.discounts.get id: "123"
+LemonSqueezy::Discount.retrieve id: 123
+
+# Create a Discount
+# https://docs.lemonsqueezy.com/api/discounts#create-a-discount
+LemonSqueezy::Discount.create store_id: 123, name: "20 Off", code: "20OFF", amount: 20, amount_type: "percent"
+
+# Delete a Discount
+LemonSqueezy::Discount.delete id: 123
 ```
 
-### License Keys
+### Discount Redemptions
 
 ```ruby
-# Retrieves a list of License Keys
-@client.license_keys.list
+# Retrieves a list of Discount Redemptions
+LemonSqueezy::DiscountRedemption.list
 
-# Retrieves a list of License Keys for a store
-@client.license_keys.list store_id: 123
+# Retrieves a list of Discount Redemptions for a Discount
+LemonSqueezy::DiscountRedemption.list discount_id: 123
 
-# Retrieves a list of License Keys for an order
-@client.license_keys.list order_id: 123
+# Retrieves a list of Discount Redemptions for a Order
+LemonSqueezy::DiscountRedemption.list order_id: 123
 
-# Retrieves a Discount
-@client.license_keys.get id: "123"
+# Retrieves a Discount Redemption
+LemonSqueezy::DiscountRedemption.retrieve id: 123
 ```
 
-### Files
+### Licenses
+
+This API is used to manage licenses generated by Lemon Squeezy. [Docs](https://docs.lemonsqueezy.com/help/licensing/license-api)
 
 ```ruby
-# Retrieves a list of Files
-@client.files.list
+# Validate a license key
+LemonSqueezy::License.validate key: "abc123-abc123-abc123"
 
-# Retrieves a File
-@client.files.get id: "123"
+# Activate a license key
+# Instance is a label to identify this activation
+LemonSqueezy::License.activate key: "abc123-abc123-abc123", instance: "Activation 1"
+
+# Deactivate a license key
+# Instance is the License Key Instance ID
+LemonSqueezy::License.deactivate key: "abc123-abc123-abc123", instance: "abc123"
 ```
 
-### Customers
+### License Keys
 
 ```ruby
-# Retrieves a list of Customers
-@client.customers.list
+# Retrieves a list of License Keys
+LemonSqueezy::LicenseKey.list
 
-# Retrieves a list of Customers for a store
-@client.customers.list store_id: 123
+# Retrieves a list of License Keys for a store
+LemonSqueezy::LicenseKey.list store_id: 123
 
-# Retrieves a list of Customers that contain the supplied email
-@client.customers.list email: "test@hello.com"
+# Retrieves a list of License Keys for an order
+LemonSqueezy::LicenseKey.list order_id: 123
 
-# Retrieves a Customer
-@client.customers.get id: "123"
+# Retrieves a License Key
+LemonSqueezy::LicenseKey.retrieve id: 123
+
+# Updates a License Key
+# https://docs.lemonsqueezy.com/api/license-keys#update-a-license-key
+LemonSqueezy::LicenseKey.update id: 123, activation_limit: 10, disabled: false
 ```
 
 ### License Key Instances
 
 ```ruby
 # Retrieves a list of License Key Instances
-@client.license_key_instances.list
+LemonSqueezy::LicenseKeyInstances.list
 
 # Retrieves a list of License Key Instances for a license key
-@client.license_key_instances.list license_key_id: 123
+LemonSqueezy::LicenseKeyInstances.list license_key_id: 123
 
 # Retrieves a License Key Instance
-@client.license_key_instances.get id: "123"
+LemonSqueezy::LicenseKeyInstances.retrieve id: 123
+```
+
+### Files
+
+```ruby
+# Retrieves a list of Files
+LemonSqueezy::File.list
+
+# Retrieves a File
+LemonSqueezy::File.retrieve id: 123
 ```
 
 ### Checkouts
 
 ```ruby
 # Retrieves a list of Checkouts
-@client.checkouts.list
+LemonSqeezy::Checkout.list
 
 # Retrieves a list of Checkouts for a store
-@client.checkouts.list store_id: 123
+LemonSqeezy::Checkout.list store_id: 123
 
 # Retrieves a list of Checkouts for a variant
-@client.checkouts.list variant_id: 123
+LemonSqeezy::Checkout.list variant_id: 123
 
 # Retrieves a Checkout
-@client.checkouts.get id: "123"
+LemonSqeezy::Checkout.retrieve id: 123
 
 # Creates a Checkout
 # View docs for more info: https://docs.lemonsqueezy.com/api/checkouts#create-a-checkout
 # store_id and variant_id are required
 # Any other parameters are send as "attributes" to the API
-@client.checkouts.create store_id: 123, variant_id: 321, custom_price: 500, product_options: {name: "a test name"}
+LemonSqueezy::Checkout.create store_id: 123, variant_id: 321, custom_price: 500, product_options: {name: "a test name"}
+```
+
+### Webhooks
+
+```ruby
+# List all Webhooks
+LemonSqueezy::Webhook.list
+
+# List all Webhooks for a Store
+LemonSqueezy::Webhook.list store_id: 123
+
+# Retrieve a Webhook
+LemonSqueezy::Webhook.retrieve id: 123
+
+# Create a Webhook
+# https://docs.lemonsqueezy.com/api/webhooks#create-a-webhook
+LemonSqueezy::Webhook.create store_id: 123, url: "", secret: "abc", events: ["order_created"]
+
+# Update a Webhook
+# https://docs.lemonsqueezy.com/api/webhooks#update-a-webhook
+LemonSqueezy::Webhook.update id: 123, events: ["order_created", "subscription_created"]
+
+# Delete a Webhook
+LemonSqueezy::Webhook.delete id: 123
 ```
 
 

data/bin/console

@@ -14,7 +14,9 @@ require 'dotenv/load'
 # require "pry"
 # Pry.start
 
-@client = LemonSqueezy::Client.new(access_token: ENV["ACCESS_TOKEN"])
+LemonSqueezy.configure do |config|
+  config.api_key = ENV["LEMON_SQUEEZY_API_KEY"]
+end
 
 require "irb"
 IRB.start(__FILE__)

data/lib/lemon_squeezy/client.rb

@@ -1,80 +1,74 @@
 module LemonSqueezy
   class Client
-    BASE_URL = "https://api.lemonsqueezy.com/v1"
 
-    attr_reader :access_token, :adapter
+    class << self
 
-    def initialize(access_token:, adapter: Faraday.default_adapter, stubs: nil)
-      @access_token = access_token
-      @adapter = adapter
+      def connection
+        @connection ||= Faraday.new("https://api.lemonsqueezy.com/v1") do |conn|
+          conn.request :authorization, :Bearer, LemonSqueezy.config.api_key
 
-      # Test stubs for requests
-      @stubs = stubs
-    end
-
-    def stores
-      StoresResource.new(self)
-    end
-
-    def products
-      ProductsResource.new(self)
-    end
-
-    def variants
-      VariantsResource.new(self)
-    end
+          conn.headers = {
+            "User-Agent" => "lemonsqueezy/v#{VERSION} (github.com/deanpcmad/lemonsqueezy)",
+            "Accept" => "application/vnd.api+json",
+            "Content-Type" => "application/vnd.api+json"
+          }
 
-    def orders
-      OrdersResource.new(self)
-    end
-
-    def subscriptions
-      SubscriptionsResource.new(self)
-    end
+          conn.request :json
 
-    def subscription_invoices
-      SubscriptionInvoicesResource.new(self)
-    end
+          conn.response :json
+        end
+      end
 
-    def discounts
-      DiscountsResource.new(self)
-    end
+      def get_request(url, params: {}, headers: {})
+        handle_response connection.get(url, params, headers)
+      end
 
-    def license_keys
-      LicenseKeysResource.new(self)
-    end
+      def post_request(url, body: {}, headers: {})
+        handle_response connection.post(url, body, headers)
+      end
 
-    def files
-      FilesResource.new(self)
-    end
+      def patch_request(url, body:, headers: {})
+        handle_response connection.patch(url, body, headers)
+      end
 
-    def customers
-      CustomersResource.new(self)
-    end
+      def delete_request(url, headers: {})
+        handle_response connection.delete(url, headers)
+      end
 
-    def license_key_instances
-      LicenseKeyInstancesResource.new(self)
-    end
+      def handle_response(response)
+        case response.status
+        when 400
+          raise Error, "Error 400: Your request was malformed. '#{response.body["errors"]}'"
+        when 401
+          raise Error, "Error 401: You did not supply valid authentication credentials. '#{response.body["errors"]}'"
+        when 403
+          raise Error, "Error 403: You are not allowed to perform that action. '#{response.body["errors"]}'"
+        when 404
+          raise Error, "Error 404: No results were found for your request. '#{response.body["errors"]}'"
+        when 409
+          raise Error, "Error 409: Your request was a conflict. '#{response.body["errors"]}'"
+        when 429
+          raise Error, "Error 429: Your request exceeded the API rate limit. '#{response.body["errors"]}'"
+        when 422
+          raise Error, "Error 422: Unprocessable Entity. '#{response.body["errors"]}'"
+        when 500
+          raise Error, "Error 500: We were unable to perform the request due to server-side problems. '#{response.body["errors"]}'"
+        when 503
+          raise Error, "Error 503: You have been rate limited for sending more than 20 requests per second. '#{response.body["errors"]}'"
+        when 501
+          raise Error, "Error 501: This resource has not been implemented. '#{response.body["errors"]}'"
+        when 204
+          return true
+        end
+
+        if response.body && response.body["error"]
+          raise Error, "Error #{response.body["error"]["code"]} - #{response.body["errors"]["message"]}"
+        end
+
+        response
+      end
 
-    def checkouts
-      CheckoutsResource.new(self)
     end
 
-    def connection
-      @connection ||= Faraday.new(BASE_URL) do |conn|
-        conn.request :authorization, :Bearer, access_token
-
-        conn.headers = {
-          "User-Agent" => "lemonsqueezy/v#{VERSION} (github.com/deanpcmad/lemonsqueezy)",
-          "Accept" => "application/vnd.api+json",
-          "Content-Type" => "application/vnd.api+json",
-        } 
-
-        conn.request :json
-        conn.response :json
-
-        conn.adapter adapter, @stubs
-      end
-    end
   end
 end

data/lib/lemon_squeezy/configuration.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module LemonSqueezy
+  class Configuration
+
+    attr_accessor :api_key
+
+    def initialize
+    end
+
+  end
+end