lemonsqueezy 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6caa3dd3252a4d5e97ccffa65a6cbdc82afb275d58591904ed4ca575e5254cf7
-  data.tar.gz: 2e3881b8b63e63525dda7839b714740c70565282a3552e955b2e7c0295a74a17
+  metadata.gz: 212848d967c94034b1431c5f0969024c24e682f5f7ffc25b8318e3d0fd95de39
+  data.tar.gz: 20e52e92dc7182cb909ece3311392207ab8f6e25ec5c8b7e2d1b9aac71ff6a55
 SHA512:
-  metadata.gz: e6e61129aa111dea54a26a2ac0915fce6ea1217d3bfaed1afbd0e432297496081f1d046a4fef554515d1cb9e81a35571c792cf4d674ef97bc7aa44960275ab56
-  data.tar.gz: b86eaa0cb92691704d289ac7785003937e77b3dec5679a5c986f9fc889f94a267633924bcbbb2406f5fe0b94ea537ec80c1c3fb863ff950a9c654644922aae4a
+  metadata.gz: ada432d9f5a82a7de4be6f60d1909d5119915cb53cfbd083555cbe86690e3616acbcbe8cdac5ac680a7c690dd3cedd91284295b7b66ff94f4aeafae4f8924295
+  data.tar.gz: a4398fc57cc7a0a71b5d6912dadc2f6335869f2014177445f5ebf30a28cca063edb75d31deb97a48b0032c48b71fbba6a99b7ef6d0f3b42f5be62af6bbcb04c8

data/Gemfile.lock

@@ -1,17 +1,17 @@
 PATH
   remote: .
   specs:
-    lemonsqueezy (0.1.1)
+    lemonsqueezy (0.2.0)
       faraday (~> 2.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
     dotenv (2.7.6)
-    faraday (2.6.0)
+    faraday (2.7.4)
       faraday-net_http (>= 2.0, < 3.1)
       ruby2_keywords (>= 0.0.4)
-    faraday-net_http (3.0.1)
+    faraday-net_http (3.0.2)
     minitest (5.15.0)
     rake (13.0.6)
     ruby2_keywords (0.0.5)

data/README.md

@@ -1,5 +1,7 @@
 # LemonSqueezy
 
+**This Library is a work in progress**
+
 This is a Ruby library for interacting with the Lemon Squeezy API.
 
 ## Installation
@@ -14,8 +16,7 @@ gem "lemonsqueezy"
 
 ### Set Access Token
 
-Firstly you'll need to create an API Access Token on your
-[settings page](https://app.lemonsqueezy.com/settings/api)
+Firstly you'll need to create an API Access Token on your [settings page](https://app.lemonsqueezy.com/settings/api).
 
 ```ruby
 @client = LemonSqueezy::Client.new(access_token: "")
@@ -28,9 +29,182 @@ Firstly you'll need to create an API Access Token on your
 @client.stores.list
 
 # Retrieves a Store
-@client.stores.get(id: "123")
+@client.stores.get id: "123"
+```
+
+### Products
+
+```ruby
+# Retrieves a list of Products
+@client.products.list
+
+# Retrieves a list of Products for a specified Store
+@client.products.list store_id: 123
+
+# Retrieves a Product
+@client.products.get id: "123"
+```
+
+### Product Variants
+
+```ruby
+# Retrieves a list of Variants
+@client.variants.list
+
+# Retrieves a list of Variants for a Product
+@client.variants.list product_id: 123
+
+# Retrieves a Variant
+@client.variants.get id: "123"
+```
+
+### Orders
+
+```ruby
+# Retrieves a list of Orders
+@client.orders.list
+
+# Retrieves a list of Orders for a specified store
+@client.orders.list product_id: 123
+
+# Retrieves a list of Orders for an email address
+@client.orders.list email: "hello@test.com"
+
+# Retrieves an Order
+@client.orders.get id: "123"
+
+# Retrieves the items on an Order
+@client.orders.get order_items: "123"
+```
+
+### Subscriptions
+
+```ruby
+# Retrieves a list of Subscriptions
+@client.subscriptions.list
+
+# Retrieves a list of Subscriptions for a store
+@client.subscriptions.list store_id: 123
+
+# Retrieves a list of Subscriptions for an Order
+@client.subscriptions.list order_id: 123
+
+# Retrieves a list of Subscriptions for a product
+@client.subscriptions.list product_id: 123
+
+# Retrieves a Subscription
+@client.subscriptions.get 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
+
+# Un-Pause a Subscription
+@client.subscriptions.unpause id: 123
+
+# Cancel a Subscription
+@client.subscriptions.cancel id: 123
+
+# Un-Cancel a Subscription
+@client.subscriptions.uncancel id: 123
+
+# Change the Plan for a Subscription
+@client.subscriptions.change_plan id: 123, plan_id: 111, variant_id: 111
+```
+
+### Discounts
+
+```ruby
+# Retrieves a list of Discounts
+@client.discounts.list
+
+# Retrieves a list of Discounts for a store
+@client.discounts.list store_id: 123
+
+# Retrieves a Discount
+@client.discounts.get id: "123"
+```
+
+### License Keys
+
+```ruby
+# Retrieves a list of License Keys
+@client.license_keys.list
+
+# Retrieves a list of License Keys for a store
+@client.license_keys.list store_id: 123
+
+# Retrieves a list of License Keys for an order
+@client.license_keys.list order_id: 123
+
+# Retrieves a Discount
+@client.license_keys.get id: "123"
 ```
 
+### Files
+
+```ruby
+# Retrieves a list of Files
+@client.files.list
+
+# Retrieves a File
+@client.files.get id: "123"
+```
+
+### Customers
+
+```ruby
+# Retrieves a list of Customers
+@client.customers.list
+
+# Retrieves a list of Customers for a store
+@client.customers.list store_id: 123
+
+# Retrieves a list of Customers that contain the supplied email
+@client.customers.list email: "test@hello.com"
+
+# Retrieves a Customer
+@client.customers.get id: "123"
+```
+
+### License Key Instances
+
+```ruby
+# Retrieves a list of License Key Instances
+@client.license_key_instances.list
+
+# Retrieves a list of License Key Instances for a license key
+@client.license_key_instances.list license_key_id: 123
+
+# Retrieves a License Key Instance
+@client.license_key_instances.get id: "123"
+```
+
+### Checkouts
+
+```ruby
+# Retrieves a list of Checkouts
+@client.checkouts.list
+
+# Retrieves a list of Checkouts for a store
+@client.checkouts.list store_id: 123
+
+# Retrieves a list of Checkouts for a variant
+@client.checkouts.list variant_id: 123
+
+# Retrieves a Checkout
+@client.checkouts.get 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"}
+```
+
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/deanpcmad/lemonsqueezy.

data/lib/lemon_squeezy/client.rb

@@ -44,13 +44,29 @@ module LemonSqueezy
       FilesResource.new(self)
     end
 
+    def customers
+      CustomersResource.new(self)
+    end
+
+    def license_key_instances
+      LicenseKeyInstancesResource.new(self)
+    end
+
+    def checkouts
+      CheckoutsResource.new(self)
+    end
+
     def connection
       @connection ||= Faraday.new(BASE_URL) do |conn|
         conn.request :authorization, :Bearer, access_token
 
-        conn.request :json
+        conn.headers = {
+          "Accept" => "application/vnd.api+json",
+          "Content-Type" => "application/vnd.api+json"
+        } 
 
-        conn.response :json, content_type: "application/vnd.api+json"
+        conn.request :json
+        conn.response :json
 
         conn.adapter adapter, @stubs
       end

data/lib/lemon_squeezy/objects/checkout.rb

@@ -0,0 +1,12 @@
+module LemonSqueezy
+  class Checkout < Object
+
+    def initialize(options = {})
+      options.delete "relationships"
+      options.delete "links"
+
+      super options
+    end
+
+  end
+end

data/lib/lemon_squeezy/objects/customer.rb

@@ -0,0 +1,12 @@
+module LemonSqueezy
+  class Customer < Object
+
+    def initialize(options = {})
+      options.delete "relationships"
+      options.delete "links"
+
+      super options
+    end
+
+  end
+end

data/lib/lemon_squeezy/objects/license_key_instance.rb

@@ -0,0 +1,12 @@
+module LemonSqueezy
+  class LicenseKeyInstance < Object
+
+    def initialize(options = {})
+      options.delete "relationships"
+      options.delete "links"
+
+      super options
+    end
+
+  end
+end

data/lib/lemon_squeezy/objects/variant.rb

@@ -0,0 +1,12 @@
+module LemonSqueezy
+  class Variant < Object
+
+    def initialize(options = {})
+      options.delete "relationships"
+      options.delete "links"
+
+      super options
+    end
+
+  end
+end

data/lib/lemon_squeezy/resource.rb

@@ -31,7 +31,7 @@ module LemonSqueezy
     def handle_response(response)
       case response.status
       when 400
-        raise Error, "Error 400: Your request was malformed. '#{response.body["message"]}'"
+        raise Error, "Error 400: Your request was malformed. '#{response.body["errors"][0]["detail"]}'"
       when 401
         raise Error, "Error 401: You did not supply valid authentication credentials. '#{response.body["error"]}'"
       when 403

data/lib/lemon_squeezy/resources/checkouts.rb

@@ -0,0 +1,42 @@
+module LemonSqueezy
+  class CheckoutsResource < Resource
+
+    def list(**params)
+      response = get_request("checkouts", params: params)
+      Collection.from_response(response, type: Customer)
+    end
+
+    def get(id:)
+      response = get_request("checkouts/#{id}")
+      Customer.new(response.body["data"]) if response.success?
+    end
+
+    def create(store_id:, variant_id:, **attrs)
+      data = {}
+
+      data["type"] = "checkouts"
+
+      data["relationships"] = {
+        store: {
+          data: {
+            type: "stores",
+            id: store_id.to_s
+          }
+        },
+        variant: {
+          data: {
+            type: "variants",
+            id: variant_id.to_s
+          }
+        }
+      }
+
+      data["attributes"] = attrs
+
+      response = post_request("checkouts", body: {data: data}.to_json)
+
+      Checkout.new(response.body["data"]) if response.success?
+    end
+
+  end
+end

data/lib/lemon_squeezy/resources/customers.rb

@@ -0,0 +1,15 @@
+module LemonSqueezy
+  class CustomersResource < Resource
+
+    def list(**params)
+      response = get_request("customers", params: params)
+      Collection.from_response(response, type: Customer)
+    end
+
+    def get(id:)
+      response = get_request("customers/#{id}")
+      Customer.new(response.body["data"]) if response.success?
+    end
+
+  end
+end

data/lib/lemon_squeezy/resources/license_key_instances.rb

@@ -0,0 +1,15 @@
+module LemonSqueezy
+  class LicenseKeyInstancesResource < Resource
+
+    def list(**params)
+      response = get_request("license-key-instances", params: params)
+      Collection.from_response(response, type: LicenseKeyInstance)
+    end
+
+    def get(id:)
+      response = get_request("license-key-instances/#{id}")
+      LicenseKeyInstance.new(response.body["data"]) if response.success?
+    end
+
+  end
+end

data/lib/lemon_squeezy/resources/subscriptions.rb

@@ -11,5 +11,82 @@ module LemonSqueezy
       Subscription.new(response.body["data"]) if response.success?
     end
 
+    # Kind: void or free
+    def pause(id:, kind:, resumes_at: nil)
+      body = {
+        data: {
+          type: "subscriptions",
+          id: id.to_s,
+          attributes: {
+            pause: {mode: kind, resumes_at: resumes_at}
+          }
+        }
+      }
+
+      response = patch_request("subscriptions/#{id}", body: body.to_json)
+      Subscription.new(response.body["data"]) if response.success?
+    end
+
+    def unpause(id:)
+      body = {
+        data: {
+          type: "subscriptions",
+          id: id.to_s,
+          attributes: {
+            pause: nil
+          }
+        }
+      }
+
+      response = patch_request("subscriptions/#{id}", body: body.to_json)
+      Subscription.new(response.body["data"]) if response.success?
+    end
+
+    def cancel(id:)
+      body = {
+        data: {
+          type: "subscriptions",
+          id: id.to_s,
+          attributes: {
+            cancelled: true
+          }
+        }
+      }
+
+      response = patch_request("subscriptions/#{id}", body: body.to_json)
+      Subscription.new(response.body["data"]) if response.success?
+    end
+
+    def uncancel(id:)
+      body = {
+        data: {
+          type: "subscriptions",
+          id: id.to_s,
+          attributes: {
+            cancelled: false
+          }
+        }
+      }
+
+      response = patch_request("subscriptions/#{id}", body: body.to_json)
+      Subscription.new(response.body["data"]) if response.success?
+    end
+
+    def change_plan(id:, plan_id:, variant_id:)
+      body = {
+        data: {
+          type: "subscriptions",
+          id: id.to_s,
+          attributes: {
+            product_id: plan_id,
+            variant_id: variant_id
+          }
+        }
+      }
+
+      response = patch_request("subscriptions/#{id}", body: body.to_json)
+      Subscription.new(response.body["data"]) if response.success?
+    end
+
   end
 end

data/lib/lemon_squeezy/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module LemonSqueezy
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

data/lib/lemon_squeezy.rb

@@ -19,7 +19,10 @@ module LemonSqueezy
   autoload :SubscriptionsResource, "lemon_squeezy/resources/subscriptions"
   autoload :DiscountsResource, "lemon_squeezy/resources/discounts"
   autoload :LicenseKeysResource, "lemon_squeezy/resources/license_keys"
+  autoload :LicenseKeyInstancesResource, "lemon_squeezy/resources/license_key_instances"
   autoload :FilesResource, "lemon_squeezy/resources/files"
+  autoload :CustomersResource, "lemon_squeezy/resources/customers"
+  autoload :CheckoutsResource, "lemon_squeezy/resources/checkouts"
 
   autoload :Store, "lemon_squeezy/objects/store"
   autoload :Product, "lemon_squeezy/objects/product"
@@ -29,6 +32,9 @@ module LemonSqueezy
   autoload :Subscription, "lemon_squeezy/objects/subscription"
   autoload :Discount, "lemon_squeezy/objects/discount"
   autoload :LicenseKey, "lemon_squeezy/objects/license_key"
+  autoload :LicenseKeyInstance, "lemon_squeezy/objects/license_key_instance"
   autoload :File, "lemon_squeezy/objects/file"
+  autoload :Customer, "lemon_squeezy/objects/customer"
+  autoload :Checkout, "lemon_squeezy/objects/checkout"
   
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lemonsqueezy
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Dean Perry
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-10-11 00:00:00.000000000 Z
+date: 2023-01-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -44,17 +44,24 @@ files:
 - lib/lemon_squeezy/collection.rb
 - lib/lemon_squeezy/error.rb
 - lib/lemon_squeezy/object.rb
+- lib/lemon_squeezy/objects/checkout.rb
+- lib/lemon_squeezy/objects/customer.rb
 - lib/lemon_squeezy/objects/discount.rb
 - lib/lemon_squeezy/objects/file.rb
 - lib/lemon_squeezy/objects/license_key.rb
+- lib/lemon_squeezy/objects/license_key_instance.rb
 - lib/lemon_squeezy/objects/order.rb
 - lib/lemon_squeezy/objects/order_item.rb
 - lib/lemon_squeezy/objects/product.rb
 - lib/lemon_squeezy/objects/store.rb
 - lib/lemon_squeezy/objects/subscription.rb
+- lib/lemon_squeezy/objects/variant.rb
 - lib/lemon_squeezy/resource.rb
+- lib/lemon_squeezy/resources/checkouts.rb
+- lib/lemon_squeezy/resources/customers.rb
 - lib/lemon_squeezy/resources/discounts.rb
 - lib/lemon_squeezy/resources/files.rb
+- lib/lemon_squeezy/resources/license_key_instances.rb
 - lib/lemon_squeezy/resources/license_keys.rb
 - lib/lemon_squeezy/resources/orders.rb
 - lib/lemon_squeezy/resources/products.rb
@@ -83,7 +90,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.4.5
 signing_key: 
 specification_version: 4
 summary: Ruby library for interacting with the Lemon Squeezy API