paddle 2.2.0 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b0c36c67374aa35e91a2497199311888ef26eb0265cd14dddf57f535e7dabb6e
-  data.tar.gz: 287d3e39a116eb4b19bba68baaa0772c67306e0f47249c81c815a29ab5a82f0f
+  metadata.gz: fd93d2c8220b972ffa99dc9134c9ae6a1dd4da4051d63d363f825f4130be5965
+  data.tar.gz: 4e6f0566db66650772cef15c976d229221cf3292b8a60f044ac22cfe91f81d70
 SHA512:
-  metadata.gz: 30ab0451e76ea879e948373553f707359e9847f92f9a06a1d962dad8f327e471d89858b505e27e7e030570db5413d161943b6aa29b7efe68dc26cdb9723bad7b
-  data.tar.gz: 10fd334a894063e6f14c69fb9e03d1931e9153877037b786cc127fec82d2ba4d0cf992ec1441ca4550ae469dcf444e8abf64404f4478573e28f834ab00d745e5
+  metadata.gz: 51904dcd27cdc1272ffffe94397ab53756a07cf0de48071d8e4b4830efd51533965296dd7f0b74667e6a0be0f9f6dd3ec2fbba6dda6f2b512983ab01be0e4096
+  data.tar.gz: aedd0b4538ed33115788157c00e18b06c83da69ac0491fa1f62f69ecf5c77cebc9e27c9f8e9aa51bfd23bf13a94f67a97f8657bd7a29d3b42bc4a2c9bb41d311

data/.rubocop.yml

@@ -0,0 +1,11 @@
+# Omakase Ruby styling for Rails
+inherit_gem: { rubocop-rails-omakase: rubocop.yml }
+
+# Overwrite or add rules to create your own house style
+#
+# # Use `[a, [b, c]]` not `[ a, [ b, c ] ]`
+# Layout/SpaceInsideArrayLiteralBrackets:
+#   Enabled: false
+
+Rails/RefuteMethods:
+  Enabled: false

data/Gemfile

@@ -9,5 +9,5 @@ gem "rake", "~> 13.0"
 
 gem "minitest", "~> 5.0"
 gem "dotenv"
-
 gem "vcr"
+gem "rubocop-rails-omakase", require: false

data/Gemfile.lock

@@ -1,22 +1,86 @@
 PATH
   remote: .
   specs:
-    paddle (2.2.0)
+    paddle (2.3.0)
       faraday (~> 2.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    activesupport (7.1.3.4)
+      base64
+      bigdecimal
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      connection_pool (>= 2.2.5)
+      drb
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      mutex_m
+      tzinfo (~> 2.0)
+    ast (2.4.2)
     base64 (0.1.1)
+    bigdecimal (3.1.8)
+    concurrent-ruby (1.3.3)
+    connection_pool (2.4.1)
     dotenv (2.7.6)
+    drb (2.2.1)
     faraday (2.7.11)
       base64
       faraday-net_http (>= 2.0, < 3.1)
       ruby2_keywords (>= 0.0.4)
     faraday-net_http (3.0.2)
+    i18n (1.14.5)
+      concurrent-ruby (~> 1.0)
+    json (2.7.2)
+    language_server-protocol (3.17.0.3)
     minitest (5.19.0)
-    rake (13.0.6)
+    mutex_m (0.2.0)
+    parallel (1.25.1)
+    parser (3.3.3.0)
+      ast (~> 2.4.1)
+      racc
+    racc (1.8.0)
+    rack (3.1.7)
+    rainbow (3.1.1)
+    rake (13.2.1)
+    regexp_parser (2.9.2)
+    rexml (3.3.0)
+      strscan
+    rubocop (1.64.1)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.3.0.2)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.31.3)
+      parser (>= 3.3.1.0)
+    rubocop-minitest (0.35.0)
+      rubocop (>= 1.61, < 2.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
+    rubocop-performance (1.21.0)
+      rubocop (>= 1.48.1, < 2.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
+    rubocop-rails (2.25.0)
+      activesupport (>= 4.2.0)
+      rack (>= 1.1)
+      rubocop (>= 1.33.0, < 2.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
+    rubocop-rails-omakase (1.0.0)
+      rubocop
+      rubocop-minitest
+      rubocop-performance
+      rubocop-rails
+    ruby-progressbar (1.13.0)
     ruby2_keywords (0.0.5)
+    strscan (3.1.0)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.5.0)
     vcr (6.2.0)
 
 PLATFORMS
@@ -27,6 +91,7 @@ DEPENDENCIES
   minitest (~> 5.0)
   paddle!
   rake (~> 13.0)
+  rubocop-rails-omakase
   vcr
 
 BUNDLED WITH

data/README.md

@@ -1,6 +1,6 @@
 # Paddle Ruby Library
 
-A Ruby library for the Paddle APIs, both Classic and Billing.
+The easiest and most complete Ruby library for the Paddle APIs, both Classic and Billing.
 
 ## Installation
 
@@ -33,10 +33,57 @@ Paddle.configure do |config|
 end
 ```
 
+### Resources
+
+The gem maps as closely as we can to the Paddle API so you can easily convert API examples to gem code.
+
+Responses are created as objects like `Paddle::Product`. Having types like `Paddle::Product` is handy for understanding what
+type of object you're working with. They're built using OpenStruct so you can easily access data in a Ruby-ish way.
+
+### Pagination
+
+Some of the endpoints return pages of results. The result object will have a `data` key to access the results.
+
+An example of using collections, including pagination:
+
+```ruby
+results = Paddle::Product.list(per_page: 10)
+#=> Paddle::Collection
+
+results.total
+#=> 10
+
+results.data
+#=> [#<Paddle::Product>, #<Paddle::Product>]
+
+results.each do |result|
+  puts result.id
+end
+
+results.first
+#=> #<Paddle::Product>
+
+results.last
+#=> #<Paddle::Product>
+
+# Retrieve the next page
+Paddle::Product.list(per_page: 10, after: "abc123")
+#=> Paddle::Collection
+```
+
 ### Caveats
 
-The Paddle API doesn't take `nil` values for optional parameters. If you want to
-remove a value, you'll need to pass `"null"` instead.
+>[!NOTE]
+>
+> The Paddle API doesn't take `nil` values for optional parameters. If you want to remove a value, you'll need to pass `"null"` instead.
+
+### Updating records
+
+For API endpoints that support it, you can use the `update` method to update a record, like so:
+
+```ruby
+Paddle::Product.retrieve(id: "pro_abc123").update(name: "My New Name")
+```
 
 ### Products
 
@@ -128,6 +175,7 @@ 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
 Paddle::Customer.create(email: "myemail@mydomain.com", name: "Customer Name")
 
 # Retrieve a customer

data/lib/paddle/classic/client.rb

@@ -1,7 +1,6 @@
 module Paddle
   module Classic
     class Client
-
       BASE_URL = "https://vendors.paddle.com/api"
       SANDBOX_BASE_URL = "https://sandbox-vendors.paddle.com/api"
 

data/lib/paddle/classic/resource.rb

@@ -14,7 +14,7 @@ module Paddle
       # end
 
       def post_request(url, body: {}, headers: {})
-        attrs = {vendor_id: client.vendor_id, vendor_auth_code: client.vendor_auth_code}
+        attrs = { vendor_id: client.vendor_id, vendor_auth_code: client.vendor_auth_code }
         handle_response client.connection.post(url, attrs.merge(body), headers)
       end
 

data/lib/paddle/classic/resources/charges.rb

@@ -1,13 +1,11 @@
 module Paddle
   module Classic
     class ChargesResource < Resource
-
       def create(subscription_id:, amount:, charge_name:)
-        attrs = {amount: amount, charge_name: charge_name}
+        attrs = { amount: amount, charge_name: charge_name }
         response = post_request("2.0/subscription/#{subscription_id}/charge", body: attrs)
         Charge.new(response.body["response"])
       end
-
     end
   end
 end

data/lib/paddle/classic/resources/coupons.rb

@@ -1,33 +1,31 @@
 module Paddle
   module Classic
     class CouponsResource < Resource
-
       def list(product_id:)
-        response = post_request("2.0/product/list_coupons", body: {product_id: product_id})
+        response = post_request("2.0/product/list_coupons", body: { product_id: product_id })
         Collection.from_response(response, type: Coupon)
       end
 
       def create(coupon_type:, discount_type:, discount_amount:, **params)
-        attrs = {coupon_type: coupon_type, discount_type: discount_type, discount_amount: discount_amount}
+        attrs = { coupon_type: coupon_type, discount_type: discount_type, discount_amount: discount_amount }
 
         response = post_request("2.1/product/create_coupon", body: attrs.merge(params))
 
         coupons =  response.body["response"]["coupon_codes"]
 
-        coupons.map {|c| Paddle::Coupon.new(code: c)}
+        coupons.map { |c| Paddle::Coupon.new(code: c) }
       end
 
       def delete(coupon_code:, product_id:)
-        attrs = {coupon_code: coupon_code, product_id: product_id}
+        attrs = { coupon_code: coupon_code, product_id: product_id }
         response = post_request("2.0/product/delete_coupon", body: attrs)
-        return true if response.success?
+        true if response.success?
       end
 
       def update(**params)
         response = post_request("2.1/product/update_coupon", body: params)
-        return true if response.success?
+        true if response.success?
       end
-
     end
   end
 end

data/lib/paddle/classic/resources/licenses.rb

@@ -1,15 +1,13 @@
 module Paddle
   module Classic
     class LicensesResource < Resource
-
       def generate(product_id:, allowed_uses:, **params)
-        attrs = {product_id: product_id, allowed_uses: allowed_uses}
+        attrs = { product_id: product_id, allowed_uses: allowed_uses }
 
         response = post_request("2.0/product/generate_license", body: attrs.merge(params))
 
         License.new(response.body["response"]) if response.success?
       end
-
     end
   end
 end

data/lib/paddle/classic/resources/modifiers.rb

@@ -1,26 +1,24 @@
 module Paddle
   module Classic
     class ModifiersResource < Resource
-
       def list(**params)
         response = post_request("2.0/subscription/modifiers", body: params)
         Collection.from_response(response, type: Modifier)
       end
 
       def create(subscription_id:, modifier_amount:, **params)
-        attrs = {subscription_id: subscription_id, modifier_amount: modifier_amount}
+        attrs = { subscription_id: subscription_id, modifier_amount: modifier_amount }
         create_response = post_request("2.0/subscription/modifiers/create", body: attrs.merge(params))
 
-        response = post_request("2.0/subscription/modifiers", body: {subscription_id: subscription_id} )
+        response = post_request("2.0/subscription/modifiers", body: { subscription_id: subscription_id })
         Collection.from_response(response, type: Modifier)
       end
 
       def delete(modifier_id:)
-        attrs = {modifier_id: modifier_id}
+        attrs = { modifier_id: modifier_id }
         response = post_request("2.0/subscription/modifiers/delete", body: attrs)
-        return true if response.success?
+        true if response.success?
       end
-
     end
   end
 end

data/lib/paddle/classic/resources/pay_links.rb

@@ -1,13 +1,11 @@
 module Paddle
   module Classic
     class PayLinksResource < Resource
-
       def generate(**params)
         response = post_request("2.0/product/generate_pay_link", body: params)
 
         PayLink.new(response.body["response"]) if response.success?
       end
-
     end
   end
 end

data/lib/paddle/classic/resources/payments.rb

@@ -1,24 +1,22 @@
 module Paddle
   module Classic
     class PaymentsResource < Resource
-
       def list(**params)
         response = post_request("2.0/subscription/payments", body: params)
         Collection.from_response(response, type: Payment)
       end
 
       def reschedule(payment_id:, date:)
-        attrs = {payment_id: payment_id, date: date}
+        attrs = { payment_id: payment_id, date: date }
         response = post_request("2.0/subscription/payments_reschedule", body: attrs)
-        return true if response.success?
+        true if response.success?
       end
 
       def refund(order_id:, **params)
-        attrs = {order_id: order_id}
+        attrs = { order_id: order_id }
         response = post_request("2.0/payment/refund", body: attrs.merge(params))
         PaymentRefund.new(response.body["response"])
       end
-
     end
   end
 end

data/lib/paddle/classic/resources/plans.rb

@@ -1,21 +1,19 @@
 module Paddle
   module Classic
     class PlansResource < Resource
-
       def list
         response = post_request("2.0/subscription/plans")
         Collection.from_response(response, type: Plan)
       end
 
       def create(name:, type:, **params)
-        attrs = {plan_name: name, plan_type: type}
+        attrs = { plan_name: name, plan_type: type }
         create_response = post_request("2.0/subscription/plans_create", body: attrs.merge(params))
 
         # After creating the Plan, because it doesn't return the whole record, grab it from the API and return that
-        response = post_request("2.0/subscription/plans", body: {plan: create_response.body["response"]["product_id"]} )
+        response = post_request("2.0/subscription/plans", body: { plan: create_response.body["response"]["product_id"] })
         Plan.new(response.body.dig("response")[0]) if response.success?
       end
-
     end
   end
 end

data/lib/paddle/classic/resources/products.rb

@@ -1,12 +1,10 @@
 module Paddle
   module Classic
     class ProductsResource < Resource
-
       def list
         response = post_request("2.0/product/get_products")
         Collection.from_response(response, type: Product, key: "products")
       end
-
     end
   end
 end

data/lib/paddle/classic/resources/transactions.rb

@@ -1,12 +1,10 @@
 module Paddle
   module Classic
     class TransactionsResource < Resource
-
       def list(entity:, id:)
         response = post_request("2.0/#{entity}/#{id}/transactions")
         Collection.from_response(response, type: Transaction)
       end
-
     end
   end
 end

data/lib/paddle/classic/resources/users.rb

@@ -1,42 +1,40 @@
 module Paddle
   module Classic
     class UsersResource < Resource
-
       def list(**params)
         response = post_request("2.0/subscription/users", body: params)
         Collection.from_response(response, type: User)
       end
 
       def update(subscription_id:, **params)
-        attrs = {subscription_id: subscription_id}
+        attrs = { subscription_id: subscription_id }
         response = post_request("2.0/subscription/users/update", body: attrs.merge(params))
         User.new(response.body["response"]) if response.success?
       end
 
       def pause(subscription_id:, **params)
-        attrs = {subscription_id: subscription_id, pause: true}
+        attrs = { subscription_id: subscription_id, pause: true }
         response = post_request("2.0/subscription/users/update", body: attrs.merge(params))
         User.new(response.body["response"]) if response.success?
       end
 
       def unpause(subscription_id:, **params)
-        attrs = {subscription_id: subscription_id, pause: false}
+        attrs = { subscription_id: subscription_id, pause: false }
         response = post_request("2.0/subscription/users/update", body: attrs.merge(params))
         User.new(response.body["response"]) if response.success?
       end
 
       def update_postcode(subscription_id:, postcode:)
-        attrs = {subscription_id: subscription_id, postcode: postcode}
+        attrs = { subscription_id: subscription_id, postcode: postcode }
         response = post_request("2.0/subscription/users/postcode", body: attrs)
-        return true if response.success?
+        true if response.success?
       end
 
       def cancel(subscription_id:)
-        attrs = {subscription_id: subscription_id}
+        attrs = { subscription_id: subscription_id }
         response = post_request("2.0/subscription/users_cancel", body: attrs)
-        return true if response.success?
+        true if response.success?
       end
-
     end
   end
 end

data/lib/paddle/classic/resources/webhooks.rb

@@ -1,12 +1,10 @@
 module Paddle
   module Classic
     class WebhooksResource < Resource
-
       def list(**params)
         response = post_request("2.0/alert/webhooks", body: params)
         Collection.from_response(response, type: Webhook, key: "data")
       end
-
     end
   end
 end

data/lib/paddle/client.rb

@@ -1,72 +1,62 @@
+require "faraday"
+
 module Paddle
   class Client
-
     class << self
-
       def connection
-        @connection ||= Faraday.new(Paddle.config.url) do |conn|
-          conn.request :authorization, :Bearer, Paddle.config.api_key
-
-          conn.headers = {
-            "User-Agent" => "paddle/v#{VERSION} (github.com/deanpcmad/paddle)",
-            "Paddle-Version" => Paddle.config.version.to_s
-          }
-
-          conn.request :json
-
-          conn.response :json, content_type: "application/json"
-        end
+        @connection ||= create_connection
       end
 
-
       def get_request(url, params: {}, headers: {})
-        handle_response connection.get(url, params, headers)
+        handle_response(connection.get(url, params, headers))
       end
 
       def post_request(url, body: {}, headers: {})
-        handle_response connection.post(url, body, headers)
+        handle_response(connection.post(url, body, headers))
       end
 
       def patch_request(url, body:, headers: {})
-        handle_response connection.patch(url, body, headers)
+        handle_response(connection.patch(url, body, headers))
       end
 
       def delete_request(url, headers: {})
-        handle_response connection.delete(url, headers)
+        handle_response(connection.delete(url, headers))
       end
 
-      def handle_response(response)
-        case response.status
-        when 400
-          raise Error, "Error 400: Your request was malformed. '#{response.body["error"]["code"]}'"
-        when 401
-          raise Error, "Error 401: You did not supply valid authentication credentials. '#{response.body["error"]}'"
-        when 403
-          raise Error, "Error 403: You are not allowed to perform that action. '#{response.body["error"]["code"]}'"
-        when 404
-          raise Error, "Error 404: No results were found for your request. '#{response.body["error"]["code"]}'"
-        when 409
-          raise Error, "Error 409: Your request was a conflict. '#{response.body["error"]["code"]}'"
-        when 429
-          raise Error, "Error 429: Your request exceeded the API rate limit. '#{response.body["error"]["code"]}'"
-        when 500
-          raise Error, "Error 500: We were unable to perform the request due to server-side problems. '#{response.body["error"]["code"]}'"
-        when 503
-          raise Error, "Error 503: You have been rate limited for sending more than 20 requests per second. '#{response.body["error"]["code"]}'"
-        when 501
-          raise Error, "Error 501: This resource has not been implemented. '#{response.body["error"]["code"]}'"
-        when 204
-          return true
-        end
+      private
 
-        if response.body && response.body["error"]
-          raise Error, "Error #{response.body["error"]["code"]} - #{response.body["errors"]["message"]}"
+      def create_connection
+        Faraday.new(Paddle.config.url) do |conn|
+          conn.request :authorization, :Bearer, Paddle.config.api_key
+          conn.headers = default_headers
+          conn.request :json
+          conn.response :json
         end
+      end
 
-        response
+      def default_headers
+        {
+          "User-Agent" => "paddle/v#{VERSION} (github.com/deanpcmad/paddle)",
+          "Paddle-Version" => Paddle.config.version.to_s
+        }
       end
 
-    end
+      def handle_response(response)
+        return true if response.status == 204
+        return response unless error?(response)
 
+        raise_error(response)
+      end
+
+      def error?(response)
+        [ 400, 401, 403, 404, 409, 429, 500, 501, 503 ].include?(response.status) ||
+          response.body&.key?("error")
+      end
+
+      def raise_error(response)
+        error = Paddle::ErrorFactory.create(response.body, response.status)
+        raise error if error
+      end
+    end
   end
 end

data/lib/paddle/collection.rb

@@ -23,5 +23,17 @@ module Paddle
       @data = data
       @total = total
     end
+
+    def each(&block)
+      data.each(&block)
+    end
+
+    def first
+      data.first
+    end
+
+    def last
+      data.last
+    end
   end
 end

data/lib/paddle/configuration.rb

@@ -2,7 +2,6 @@
 
 module Paddle
   class Configuration
-
     attr_reader :environment
 
     attr_accessor :version
@@ -15,7 +14,7 @@ module Paddle
 
     def environment=(env)
       env = env.nil? ? :production : env.to_sym
-      unless [:development, :sandbox, :production].include?(env)
+      unless [ :development, :sandbox, :production ].include?(env)
         raise ArgumentError, "#{env.inspect} is not a valid environment"
       end
       @environment = env
@@ -29,6 +28,5 @@ module Paddle
         "https://sandbox-api.paddle.com"
       end
     end
-
   end
 end