paddle 2.3.0 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fd93d2c8220b972ffa99dc9134c9ae6a1dd4da4051d63d363f825f4130be5965
-  data.tar.gz: 4e6f0566db66650772cef15c976d229221cf3292b8a60f044ac22cfe91f81d70
+  metadata.gz: 8f5aba3cef837ddde090eb1759279427dcf213115c5950b18c167cbea59f4de3
+  data.tar.gz: 8bd53cd25b7d29113a5f5e942bac4457afd976cca2995ba232ce888051dc5367
 SHA512:
-  metadata.gz: 51904dcd27cdc1272ffffe94397ab53756a07cf0de48071d8e4b4830efd51533965296dd7f0b74667e6a0be0f9f6dd3ec2fbba6dda6f2b512983ab01be0e4096
-  data.tar.gz: aedd0b4538ed33115788157c00e18b06c83da69ac0491fa1f62f69ecf5c77cebc9e27c9f8e9aa51bfd23bf13a94f67a97f8657bd7a29d3b42bc4a2c9bb41d311
+  metadata.gz: e844d8f2c15d7c7d0ad0de2d6dadc566fee298b5a1e1930529b709f9532cf673efc7258e02fe9b636338ed9e7730f90a1a293e71faa7d71293e1c1996c479ac5
+  data.tar.gz: 895d3532f3a0ddf935427e186d5a06e28fd7e5af610594d88540b009887023683c0ae0ad4cf06bacbef7c7c7ab9f09e29d3931e65f898b779ccd0ee888623a1c

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    paddle (2.3.0)
+    paddle (2.4.0)
       faraday (~> 2.0)
 
 GEM

data/README.md

@@ -7,7 +7,7 @@ The easiest and most complete Ruby library for the Paddle APIs, both Classic and
 Add this line to your application's Gemfile:
 
 ```ruby
-gem "paddle", "~> 2.2"
+gem "paddle", "~> 2.3"
 ```
 
 ## Billing API
@@ -101,10 +101,12 @@ Paddle::Product.create(name: "My SAAS Plan", tax_category: "saas")
 Paddle::Product.create(name: "My Standard Product", tax_category: "standard")
 
 # Retrieve a product
-Paddle::Product.retrieve(id: "pro_abc123")
+product = Paddle::Product.retrieve(id: "pro_abc123")
 
 # Update a product
 # https://developer.paddle.com/api-reference/products/update-product
+product.update(description: "This is a plan")
+# or
 Paddle::Product.update(id: "pro_abc123", description: "This is a plan")
 ```
 
@@ -124,10 +126,12 @@ Paddle::Price.list(product_id: "pro_abc123")
 Paddle::Price.create(product_id: "pro_abc123", description: "A one off price", amount: "1000", currency: "GBP")
 
 # Retrieve a price
-Paddle::Price.retrieve(id: "pri_123abc")
+price = Paddle::Price.retrieve(id: "pri_123abc")
 
 # Update a price
 # https://developer.paddle.com/api-reference/prices/update-price
+price.update(description: "An updated description")
+# or
 Paddle::Price.update(id: "pri_123abc", description: "An updated description")
 ```
 
@@ -157,10 +161,12 @@ Paddle::Discount.create(description: "$5 off", type: "flat", amount: "500", curr
 Paddle::Discount.create(description: "10% Off", type: "percentage", amount: "10", code: "10OFF")
 
 # Retrieve a discount
-Paddle::Discount.retrieve(id: "dsc_abc123")
+discount = Paddle::Discount.retrieve(id: "dsc_abc123")
 
 # Update a discount
 # https://developer.paddle.com/api-reference/discounts/update-discount
+discount.update(description: "An updated description")
+# or
 Paddle::Discount.update(id: "dsc_abc123", description: "An updated description")
 ```
 
@@ -175,14 +181,16 @@ Paddle::Customer.list(email: "me@mydomain.com")
 
 # Create a customer
 # https://developer.paddle.com/api-reference/customers/create-customer
-# Returns a Paddle::ConflictError if the email is already used on Paddle
+# Returns a Paddle::Errors::ConflictError if the email is already used on Paddle
 Paddle::Customer.create(email: "myemail@mydomain.com", name: "Customer Name")
 
 # Retrieve a customer
-Paddle::Customer.retrieve(id: "ctm_abc123")
+customer = Paddle::Customer.retrieve(id: "ctm_abc123")
 
 # Update a customer
 # https://developer.paddle.com/api-reference/customers/update-customer
+customer.update(status: "archived")
+# or
 Paddle::Customer.update(id: "ctm_abc123", status: "archived")
 
 # Retrieve credit balance for a customer
@@ -202,10 +210,12 @@ Paddle::Address.list(customer: "ctm_abc123")
 Paddle::Address.create(customer: "ctm_abc123", country_code: "GB", postal_code: "SW1A 2AA")
 
 # Retrieve an address
-Paddle::Address.retrieve(customer: "ctm_abc123", id: "add_abc123")
+address = Paddle::Address.retrieve(customer: "ctm_abc123", id: "add_abc123")
 
 # Update an address
 # https://developer.paddle.com/api-reference/addresses/update-address
+address.update(status: "archived")
+# or
 Paddle::Address.update(customer: "ctm_abc123", id: "add_abc123", status: "archived")
 ```
 
@@ -221,10 +231,12 @@ Paddle::Business.list(customer: "ctm_abc123")
 Paddle::Business.create(customer: "ctm_abc123", name: "My Ltd Company")
 
 # Retrieve a business
-Paddle::Business.retrieve(customer: "ctm_abc123", id: "biz_abc123")
+business = Paddle::Business.retrieve(customer: "ctm_abc123", id: "biz_abc123")
 
 # Update a business
 # https://developer.paddle.com/api-reference/businesses/update-business
+business.update(status: "archived")
+# or
 Paddle::Business.update(customer: "ctm_abc123", id: "biz_abc123", status: "archived")
 ```
 
@@ -246,10 +258,12 @@ Paddle::Transaction.retrieve(id: "txn_abc123")
 
 # Retrieve a transaction with extra information
 # extra can be either "address", "adjustment", "adjustments_totals", "business", "customer", "discount"
-Paddle::Transaction.retrieve(id: "txn_abc123", extra: "customer")
+transaction = Paddle::Transaction.retrieve(id: "txn_abc123", extra: "customer")
 
 # Update a transaction
 # https://developer.paddle.com/api-reference/transaction/update-transaction
+transaction.update(items: [ { price_id: "pri_abc123", quantity: 2 } ])
+# or
 Paddle::Transaction.update(id: "txn_abc123", items: [ { price_id: "pri_abc123", quantity: 2 } ])
 
 # Preview a transaction
@@ -280,7 +294,7 @@ Paddle::Subscription.retrieve(id: "sub_abc123")
 
 # Retrieve a subscription with extra information
 # extra can be either "next_transaction" or "recurring_transaction_details"
-Paddle::Subscription.retrieve(id: "sub_abc123", extra: "next_transaction")
+subscription = Paddle::Subscription.retrieve(id: "sub_abc123", extra: "next_transaction")
 
 # Preview an update to a subscription
 # https://developer.paddle.com/api-reference/subscriptions/preview-subscription
@@ -288,6 +302,8 @@ Paddle::Subscription.preview(id: "sub_abc123", items: [ { price_id: "pri_123abc"
 
 # Update a subscription
 # https://developer.paddle.com/api-reference/subscriptions/update-subscription
+subscription.update(billing_details: {purchase_order_number: "PO-1234"})
+# or
 Paddle::Subscription.update(id: "sub_abc123", billing_details: {purchase_order_number: "PO-1234"})
 
 # Get a transaction to update payment method
@@ -367,7 +383,7 @@ Used for creating webhook and email notifications
 Paddle::NotificationSetting.list
 
 # Retrieve a notification setting
-Paddle::NotificationSetting.retrieve(id: "ntfset_abc123")
+setting = Paddle::NotificationSetting.retrieve(id: "ntfset_abc123")
 
 # Create a notification setting
 # https://developer.paddle.com/api-reference/notification-settings/create-notification-setting
@@ -383,6 +399,8 @@ Paddle::NotificationSetting.create(
 
 # Update a notification setting
 # https://developer.paddle.com/api-reference/notification-settings/update-notification-setting
+setting.update(subscribed_events: %w[subscription.activated transaction.completed transaction.billed])
+# or
 Paddle::NotificationSetting.update(id: "ntfset_abc123",
   subscribed_events: [
     "subscription.activated",

data/lib/paddle/classic/error.rb

@@ -0,0 +1,6 @@
+module Paddle
+  module Classic
+    class Error < StandardError
+    end
+  end
+end

data/lib/paddle/error.rb

@@ -1,127 +1,4 @@
 module Paddle
   class Error < StandardError
-    attr_reader :http_status_code
-    attr_reader :paddle_error_code
-    attr_reader :paddle_error_message
-
-    def initialize(response_body, http_status_code)
-      @response_body = response_body
-      @http_status_code = http_status_code
-      set_paddle_error_values
-      super(build_message)
-    end
-
-    private
-
-    def set_paddle_error_values
-      @paddle_error_code = @response_body.dig("error", "code")
-      @paddle_error_message = @response_body.dig("error", "detail")
-    end
-
-    def error_message
-      @paddle_error_message || @response_body.dig("error", "code")
-    rescue NoMethodError
-      "An unknown error occurred."
-    end
-
-    def build_message
-      if paddle_error_code.nil?
-        return "Error #{@http_status_code}: #{error_message}"
-      end
-      "Error #{@http_status_code}: #{error_message} '#{paddle_error_code}'"
-    end
-  end
-
-  class BadRequestError < Error
-    private
-
-    def error_message
-      "Your request was malformed."
-    end
-  end
-
-  class AuthenticationMissingError < Error
-    private
-
-    def error_message
-      "You did not supply valid authentication credentials."
-    end
-  end
-
-  class ForbiddenError < Error
-    private
-
-    def error_message
-      "You are not allowed to perform that action."
-    end
-  end
-
-  class EntityNotFoundError < Error
-    private
-
-    def error_message
-      "No results were found for your request."
-    end
-  end
-
-  class ConflictError < Error
-    private
-
-    def error_message
-      "Your request was a conflict."
-    end
-  end
-
-  class TooManyRequestsError < Error
-    private
-
-    def error_message
-      "Your request exceeded the API rate limit."
-    end
-  end
-
-  class InternalError < Error
-    private
-
-    def error_message
-      "We were unable to perform the request due to server-side problems."
-    end
-  end
-
-  class ServiceUnavailableError < Error
-    private
-
-    def error_message
-      "You have been rate limited for sending more than 20 requests per second."
-    end
-  end
-
-  class NotImplementedError < Error
-    private
-
-    def error_message
-      "This resource has not been implemented."
-    end
-  end
-
-
-  class ErrorFactory
-    HTTP_ERROR_MAP = {
-      400 => BadRequestError,
-      401 => AuthenticationMissingError,
-      403 => ForbiddenError,
-      404 => EntityNotFoundError,
-      409 => ConflictError,
-      429 => TooManyRequestsError,
-      500 => InternalError,
-      503 => ServiceUnavailableError,
-      501 => NotImplementedError
-    }.freeze
-
-    def self.create(response_body, http_status_code)
-      status = http_status_code
-      error_class = HTTP_ERROR_MAP[status] || Error
-      error_class.new(response_body, http_status_code) if error_class
-    end
   end
 end

data/lib/paddle/error_generator.rb

@@ -0,0 +1,128 @@
+module Paddle
+  class ErrorGenerator < StandardError
+    attr_reader :http_status_code
+    attr_reader :paddle_error_code
+    attr_reader :paddle_error_message
+
+    def initialize(response_body, http_status_code)
+      @response_body = response_body
+      @http_status_code = http_status_code
+      set_paddle_error_values
+      super(build_message)
+    end
+
+    private
+
+    def set_paddle_error_values
+      @paddle_error_code = @response_body.dig("error", "code")
+      @paddle_error_message = @response_body.dig("error", "detail")
+    end
+
+    def error_message
+      @paddle_error_message || @response_body.dig("error", "code")
+    rescue NoMethodError
+      "An unknown error occurred."
+    end
+
+    def build_message
+      if paddle_error_code.nil?
+        return "Error #{@http_status_code}: #{error_message}"
+      end
+      "Error #{@http_status_code}: #{error_message} '#{paddle_error_code}'"
+    end
+  end
+
+  module Errors
+    class BadRequestError < ErrorGenerator
+      private
+
+      def error_message
+        "Your request was malformed."
+      end
+    end
+
+    class AuthenticationMissingError < ErrorGenerator
+      private
+
+      def error_message
+        "You did not supply valid authentication credentials."
+      end
+    end
+
+    class ForbiddenError < ErrorGenerator
+      private
+
+      def error_message
+        "You are not allowed to perform that action."
+      end
+    end
+
+    class EntityNotFoundError < ErrorGenerator
+      private
+
+      def error_message
+        "No results were found for your request."
+      end
+    end
+
+    class ConflictError < ErrorGenerator
+      private
+
+      def error_message
+        "Your request was a conflict."
+      end
+    end
+
+    class TooManyRequestsError < ErrorGenerator
+      private
+
+      def error_message
+        "Your request exceeded the API rate limit."
+      end
+    end
+
+    class InternalError < ErrorGenerator
+      private
+
+      def error_message
+        "We were unable to perform the request due to server-side problems."
+      end
+    end
+
+    class ServiceUnavailableError < ErrorGenerator
+      private
+
+      def error_message
+        "You have been rate limited for sending more than 20 requests per second."
+      end
+    end
+
+    class NotImplementedError < ErrorGenerator
+      private
+
+      def error_message
+        "This resource has not been implemented."
+      end
+    end
+  end
+
+  class ErrorFactory
+    HTTP_ERROR_MAP = {
+      400 => Errors::BadRequestError,
+      401 => Errors::AuthenticationMissingError,
+      403 => Errors::ForbiddenError,
+      404 => Errors::EntityNotFoundError,
+      409 => Errors::ConflictError,
+      429 => Errors::TooManyRequestsError,
+      500 => Errors::InternalError,
+      503 => Errors::ServiceUnavailableError,
+      501 => Errors::NotImplementedError
+    }.freeze
+
+    def self.create(response_body, http_status_code)
+      status = http_status_code
+      error_class = HTTP_ERROR_MAP[status] || ErrorGenerator
+      error_class.new(response_body, http_status_code) if error_class
+    end
+  end
+end

data/lib/paddle/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Paddle
-  VERSION = "2.3.0"
+  VERSION = "2.4.0"
 end

data/lib/paddle.rb

@@ -9,7 +9,8 @@ module Paddle
   autoload :Client, "paddle/client"
   autoload :Collection, "paddle/collection"
   autoload :Error, "paddle/error"
-  autoload :ErrorFactory, "paddle/error"
+  autoload :ErrorGenerator, "paddle/error_generator"
+  autoload :ErrorFactory, "paddle/error_generator"
 
   autoload :Object, "paddle/object"
 
@@ -50,6 +51,7 @@ module Paddle
     autoload :Client, "paddle/classic/client"
     autoload :Collection, "paddle/classic/collection"
     autoload :Resource, "paddle/classic/resource"
+    autoload :Error, "paddle/classic/error"
 
     autoload :PlansResource, "paddle/classic/resources/plans"
     autoload :CouponsResource, "paddle/classic/resources/coupons"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: paddle
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 2.4.0
 platform: ruby
 authors:
 - Dean Perry
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-07-16 00:00:00.000000000 Z
+date: 2024-08-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -42,6 +42,7 @@ files:
 - lib/paddle.rb
 - lib/paddle/classic/client.rb
 - lib/paddle/classic/collection.rb
+- lib/paddle/classic/error.rb
 - lib/paddle/classic/objects/charge.rb
 - lib/paddle/classic/objects/coupon.rb
 - lib/paddle/classic/objects/license.rb
@@ -70,6 +71,7 @@ files:
 - lib/paddle/collection.rb
 - lib/paddle/configuration.rb
 - lib/paddle/error.rb
+- lib/paddle/error_generator.rb
 - lib/paddle/models/address.rb
 - lib/paddle/models/adjustment.rb
 - lib/paddle/models/business.rb
@@ -110,7 +112,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.15
+rubygems_version: 3.5.11
 signing_key:
 specification_version: 4
 summary: Ruby library for the Paddle Billing & Classic APIs