lemonsqueezy 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0900634c79d4767c4035474bf0c842e8a08f4ae6a967d8111e2c20b0da65321d'
-  data.tar.gz: 65fe9091c594652c165f771c72dd763b0496163eac3d2bc6d5fb6b26a2ed2d85
+  metadata.gz: dd14c80c85077df0e50fb727cbdb98f0fb23da8905dda8f579404f76b78054d8
+  data.tar.gz: d962818e7851b0c67e51cb4b0cbae31f33012ed593110d4e456b704d05482283
 SHA512:
-  metadata.gz: 876df20f2d4528f04e0c1dbbde80043879c17dd45a209b4ad7f1ac8a099f50e77df5e4b16b198b3ab14247208df2b8e3eb64794d18f364c96ff6c399610b9223
-  data.tar.gz: 78175a9305d0453b2bf755a516a2fbd8a308ca6f2976c946863f6d84d2bd8ebb9d2a36d5c3fb9130ac2551a290d32618def69365e53437635da51fe50d4a1c55
+  metadata.gz: 0fe5de09cc0a63fe09322f35d4c77d0117dbb4288fcffb6a385f9abc12142a20af501585cee66c7c526984e48992db3714bbe059a12824f521a862558c93a90c
+  data.tar.gz: f7af44ccce6cb505180d573c2513a5973dc6eb9fa4dd91e637f103f7210fcb04d098f83e9ea6b4b7215796fac6be1001b1c688386849a44ff9fe4e34af563c2e

data/Gemfile

@@ -10,3 +10,7 @@ gem "rake", "~> 13.0"
 gem "minitest", "~> 5.0"
 gem "dotenv"
 gem "vcr"
+
+# Ruby 3.4
+gem "mutex_m"
+gem "base64"

data/Gemfile.lock

@@ -1,31 +1,39 @@
 PATH
   remote: .
   specs:
-    lemonsqueezy (1.0.0)
+    lemonsqueezy (1.1.0)
       faraday (~> 2.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    base64 (0.2.0)
     dotenv (2.8.1)
-    faraday (2.9.0)
-      faraday-net_http (>= 2.0, < 3.2)
-    faraday-net_http (3.1.0)
-      net-http
+    faraday (2.12.2)
+      faraday-net_http (>= 2.0, < 3.5)
+      json
+      logger
+    faraday-net_http (3.4.0)
+      net-http (>= 0.5.0)
+    json (2.10.2)
+    logger (1.6.6)
     minitest (5.20.0)
-    net-http (0.4.1)
+    mutex_m (0.3.0)
+    net-http (0.6.0)
       uri
     rake (13.1.0)
-    uri (0.13.0)
+    uri (1.0.3)
     vcr (6.2.0)
 
 PLATFORMS
   x86_64-linux
 
 DEPENDENCIES
+  base64
   dotenv
   lemonsqueezy!
   minitest (~> 5.0)
+  mutex_m
   rake (~> 13.0)
   vcr
 

data/README.md

@@ -19,6 +19,7 @@ Firstly you'll need to create an API Key on your [settings page](https://app.lem
 ```ruby
 LemonSqueezy.configure do |config|
   config.api_key = ENV["LEMON_SQUEEZY_API_KEY"]
+  config.default_page_size = 10 # Optional: Set default page size for paginated requests
 end
 ```
 
@@ -159,7 +160,8 @@ LemonSqueezy::Subscription.cancel id: 123
 LemonSqueezy::Subscription.uncancel id: 123
 
 # Change the Plan for a Subscription
-LemonSqueezy::Subscription.change_plan id: 123, plan_id: 111, variant_id: 111
+# invoice_immediately and disable_prorations are optional and false by default.
+LemonSqueezy::Subscription.change_plan id: 123, plan_id: 111, variant_id: 111, invoice_immediately: false, disable_prorations: false
 ```
 
 ### Subscription Invoices
@@ -300,16 +302,16 @@ LemonSqueezy::File.retrieve id: 123
 
 ```ruby
 # Retrieves a list of Checkouts
-LemonSqeezy::Checkout.list
+LemonSqueezy::Checkout.list
 
 # Retrieves a list of Checkouts for a store
-LemonSqeezy::Checkout.list store_id: 123
+LemonSqueezy::Checkout.list store_id: 123
 
 # Retrieves a list of Checkouts for a variant
-LemonSqeezy::Checkout.list variant_id: 123
+LemonSqueezy::Checkout.list variant_id: 123
 
 # Retrieves a Checkout
-LemonSqeezy::Checkout.retrieve id: 123
+LemonSqueezy::Checkout.retrieve id: 123
 
 # Creates a Checkout
 # View docs for more info: https://docs.lemonsqueezy.com/api/checkouts#create-a-checkout
@@ -342,6 +344,25 @@ LemonSqueezy::Webhook.update id: 123, events: ["order_created", "subscription_cr
 LemonSqueezy::Webhook.delete id: 123
 ```
 
+### Pagination
+
+All list methods support pagination. You can control pagination in two ways:
+
+1. Using the default page size in configuration:
+```ruby
+LemonSqueezy.configure do |config|
+  config.default_page_size = 10 # This will be used for all list requests
+end
+```
+
+2. Using pagination parameters in individual requests:
+```ruby
+# Get first page with 20 items
+customers = LemonSqueezy::Customer.list(page: { size: 20, number: 1 })
+
+# Get next page
+next_page_customers = LemonSqueezy::Customer.list(page: { size: 20, number: 2 })
+```
 
 ## Contributing
 

data/lib/lemon_squeezy/client.rb

@@ -1,8 +1,7 @@
 module LemonSqueezy
   class Client
-
     class << self
-
+      
       def connection
         @connection ||= Faraday.new("https://api.lemonsqueezy.com/v1") do |conn|
           conn.request :authorization, :Bearer, LemonSqueezy.config.api_key
@@ -18,7 +17,7 @@ module LemonSqueezy
           conn.response :json
         end
       end
-
+      
       def get_request(url, params: {}, headers: {})
         handle_response connection.get(url, params, headers)
       end
@@ -34,7 +33,7 @@ module LemonSqueezy
       def delete_request(url, headers: {})
         handle_response connection.delete(url, headers)
       end
-
+      
       def handle_response(response)
         case response.status
         when 400
@@ -68,7 +67,18 @@ module LemonSqueezy
         response
       end
 
-    end
+      def build_list_request_params(params)
+        filter_params = params.reject { |k, _| k == :page }
+        pagination_params = params[:page] || {}
+        pagination_params[:size] = LemonSqueezy.config.default_page_size if pagination_params[:size].nil?
 
+        request_params = {}
+        request_params[:filter] = filter_params unless filter_params.empty?
+        request_params[:page] = pagination_params unless pagination_params.empty?
+        request_params
+      end
+      
+    end
+    
   end
 end

data/lib/lemon_squeezy/collection.rb

@@ -1,6 +1,6 @@
 module LemonSqueezy
   class Collection
-    attr_reader :data, :total
+    attr_reader :data, :meta, :total
 
     def self.from_response(response, type:, key: nil)
       body = response.body
@@ -13,14 +13,29 @@ module LemonSqueezy
         total = body["data"].count
       end
 
+      # Extract pagination metadata if available
+      meta = body["meta"]
+      pagination = meta&.dig("page")
+      
       new(
         data: data,
+        meta: {
+          page: {
+            total: pagination&.dig("total"),
+            current_page: pagination&.dig("currentPage"),
+            from: pagination&.dig("from"),
+            to: pagination&.dig("to"),
+            last_page: pagination&.dig("lastPage"),
+            per_page: pagination&.dig("perPage")
+          }
+        },
         total: total
       )
     end
 
-    def initialize(data:, total:)
+    def initialize(data:, meta:, total:)
       @data = data
+      @meta = meta
       @total = total
     end
   end

data/lib/lemon_squeezy/configuration.rb

@@ -3,9 +3,10 @@
 module LemonSqueezy
   class Configuration
 
-    attr_accessor :api_key
+    attr_accessor :api_key, :default_page_size
 
     def initialize
+      @default_page_size = 10
     end
 
   end

data/lib/lemon_squeezy/models/checkout.rb

@@ -4,7 +4,7 @@ module LemonSqueezy
     class << self
 
       def list(**params)
-        response = Client.get_request("checkouts", params: {filter: params})
+        response = Client.get_request("checkouts", params: Client.build_list_request_params(params))
         Collection.from_response(response, type: Checkout)
       end
 

data/lib/lemon_squeezy/models/customer.rb

@@ -4,7 +4,7 @@ module LemonSqueezy
     class << self
 
       def list(**params)
-        response = Client.get_request("customers", params: {filter: params})
+        response = Client.get_request("customers", params: Client.build_list_request_params(params))
         Collection.from_response(response, type: Customer)
       end
 

data/lib/lemon_squeezy/models/discount.rb

@@ -4,7 +4,7 @@ module LemonSqueezy
     class << self
 
       def list(**params)
-        response = Client.get_request("discounts", params: {filter: params})
+        response = Client.get_request("discounts", params: Client.build_list_request_params(params))
         Collection.from_response(response, type: Discount)
       end
 

data/lib/lemon_squeezy/models/discount_redemption.rb

@@ -4,7 +4,7 @@ module LemonSqueezy
     class << self
 
       def list(**params)
-        response = Client.get_request("discount-redemptions", params: {filter: params})
+        response = Client.get_request("discount-redemptions", params: Client.build_list_request_params(params))
         Collection.from_response(response, type: DiscountRedemption)
       end
 

data/lib/lemon_squeezy/models/file.rb

@@ -4,7 +4,7 @@ module LemonSqueezy
     class << self
 
       def list(**params)
-        response = Client.get_request("files", params: {filter: params})
+        response = Client.get_request("files", params: Client.build_list_request_params(params))
         Collection.from_response(response, type: File)
       end
 

data/lib/lemon_squeezy/models/license_key.rb

@@ -4,7 +4,7 @@ module LemonSqueezy
     class << self
 
       def list(**params)
-        response = Client.get_request("license-keys", params: {filter: params})
+        response = Client.get_request("license-keys", params: Client.build_list_request_params(params))
         Collection.from_response(response, type: LicenseKey)
       end
 

data/lib/lemon_squeezy/models/license_key_instance.rb

@@ -4,7 +4,7 @@ module LemonSqueezy
     class << self
 
       def list(**params)
-        response = Client.get_request("license-key-instances", params: {filter: params})
+        response = Client.get_request("license-key-instances", params: Client.build_list_request_params(params))
         Collection.from_response(response, type: LicenseKeyInstance)
       end
 

data/lib/lemon_squeezy/models/order.rb

@@ -4,7 +4,7 @@ module LemonSqueezy
     class << self
 
       def list(**params)
-        response = Client.get_request("orders", params: {filter: params})
+        response = Client.get_request("orders", params: Client.build_list_request_params(params))
         Collection.from_response(response, type: Order)
       end
 

data/lib/lemon_squeezy/models/price.rb

@@ -4,7 +4,7 @@ module LemonSqueezy
     class << self
 
       def list(**params)
-        response = Client.get_request("prices", params: {filter: params})
+        response = Client.get_request("prices", params: Client.build_list_request_params(params))
         Collection.from_response(response, type: Price)
       end
 

data/lib/lemon_squeezy/models/product.rb

@@ -4,7 +4,7 @@ module LemonSqueezy
     class << self
 
       def list(**params)
-        response = Client.get_request("products", params: {filter: params})
+        response = Client.get_request("products", params: Client.build_list_request_params(params))
         Collection.from_response(response, type: Product)
       end
 

data/lib/lemon_squeezy/models/store.rb

@@ -3,8 +3,8 @@ module LemonSqueezy
 
     class << self
 
-      def list
-        response = Client.get_request("stores")
+      def list(**params)
+        response = Client.get_request("stores", params: Client.build_list_request_params(params))
         Collection.from_response(response, type: Store)
       end
 

data/lib/lemon_squeezy/models/subscription.rb

@@ -4,7 +4,7 @@ module LemonSqueezy
     class << self
 
       def list(**params)
-        response = Client.get_request("subscriptions", params: {filter: params})
+        response = Client.get_request("subscriptions", params: Client.build_list_request_params(params))
         Collection.from_response(response, type: Subscription)
       end
 
@@ -77,14 +77,16 @@ module LemonSqueezy
         Subscription.new(response.body["data"]) if response.success?
       end
 
-      def change_plan(id:, plan_id:, variant_id:)
+      def change_plan(id:, plan_id:, variant_id:, invoice_immediately: false, disable_prorations: false)
         body = {
           data: {
             type: "subscriptions",
             id: id.to_s,
             attributes: {
               product_id: plan_id,
-              variant_id: variant_id
+              variant_id: variant_id,
+              invoice_immediately: invoice_immediately,
+              disable_prorations: disable_prorations
             }
           }
         }

data/lib/lemon_squeezy/models/subscription_invoice.rb

@@ -4,7 +4,7 @@ module LemonSqueezy
     class << self
 
       def list(**params)
-        response = Client.get_request("subscription-invoices", params: {filter: params})
+        response = Client.get_request("subscription-invoices", params: Client.build_list_request_params(params))
         Collection.from_response(response, type: SubscriptionInvoice)
       end
 

data/lib/lemon_squeezy/models/subscription_item.rb

@@ -4,7 +4,7 @@ module LemonSqueezy
     class << self
 
       def list(**params)
-        response = Client.get_request("subscription-items", params: {filter: params})
+        response = Client.get_request("subscription-items", params: Client.build_list_request_params(params))
         Collection.from_response(response, type: SubscriptionItem)
       end
 

data/lib/lemon_squeezy/models/variant.rb

@@ -4,7 +4,7 @@ module LemonSqueezy
     class << self
 
       def list(**params)
-        response = Client.get_request("variants", params: {filter: params})
+        response = Client.get_request("variants", params: Client.build_list_request_params(params))
         Collection.from_response(response, type: Variant)
       end
 

data/lib/lemon_squeezy/models/webhook.rb

@@ -4,7 +4,7 @@ module LemonSqueezy
     class << self
 
       def list(**params)
-        response = Client.get_request("webhooks", params: {filter: params})
+        response = Client.get_request("webhooks", params: Client.build_list_request_params(params))
         Collection.from_response(response, type: Webhook)
       end
 

data/lib/lemon_squeezy/version.rb

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

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: lemonsqueezy
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Dean Perry
-autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-01-14 00:00:00.000000000 Z
+date: 2025-03-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -24,7 +23,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
-description: 
 email:
 - dean@deanpcmad.com
 executables: []
@@ -71,7 +69,6 @@ licenses: []
 metadata:
   homepage_uri: https://github.com/deanpcmad/lemonsqueezy
   source_code_uri: https://github.com/deanpcmad/lemonsqueezy
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -86,8 +83,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.22
-signing_key: 
+rubygems_version: 3.6.2
 specification_version: 4
 summary: Ruby library for interacting with the Lemon Squeezy API
 test_files: []