paddle 2.2.1 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6224fc2a3ec9423990985241a118780185a090617407f95e97bb542120eb9323
-  data.tar.gz: 03403341d8dce73c881ed3fc2c722cf738b625803c6352dd2cca15e5d4cd65a7
+  metadata.gz: fd93d2c8220b972ffa99dc9134c9ae6a1dd4da4051d63d363f825f4130be5965
+  data.tar.gz: 4e6f0566db66650772cef15c976d229221cf3292b8a60f044ac22cfe91f81d70
 SHA512:
-  metadata.gz: 6453da01350a80adf7f8723817b7d45edfac636d5ae72ebeb92b281ad93d85d59866631eb60a17c3a8225f5a8f51780b857e1aeab940c0264daaa53446a70637
-  data.tar.gz: 716ef3061039df26a5cfc0dd0f8931cb1e9edcf964947047acf37ed8b95cc63a3cc36595288f6aaccc45ee2b1e3f8fe0b74ae39969123f2c99eeeeea9da41381
+  metadata.gz: 51904dcd27cdc1272ffffe94397ab53756a07cf0de48071d8e4b4830efd51533965296dd7f0b74667e6a0be0f9f6dd3ec2fbba6dda6f2b512983ab01be0e4096
+  data.tar.gz: aedd0b4538ed33115788157c00e18b06c83da69ac0491fa1f62f69ecf5c77cebc9e27c9f8e9aa51bfd23bf13a94f67a97f8657bd7a29d3b42bc4a2c9bb41d311

data/.rubocop.yml

@@ -6,3 +6,6 @@ inherit_gem: { rubocop-rails-omakase: rubocop.yml }
 # # Use `[a, [b, c]]` not `[ a, [ b, c ] ]`
 # Layout/SpaceInsideArrayLiteralBrackets:
 #   Enabled: false
+
+Rails/RefuteMethods:
+  Enabled: false

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    paddle (2.2.1)
+    paddle (2.3.0)
       faraday (~> 2.0)
 
 GEM
@@ -40,9 +40,9 @@ GEM
       ast (~> 2.4.1)
       racc
     racc (1.8.0)
-    rack (3.1.3)
+    rack (3.1.7)
     rainbow (3.1.1)
-    rake (13.0.6)
+    rake (13.2.1)
     regexp_parser (2.9.2)
     rexml (3.3.0)
       strscan

data/README.md

@@ -77,6 +77,14 @@ Paddle::Product.list(per_page: 10, after: "abc123")
 >
 > 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
 
 ```ruby
@@ -167,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/client.rb

@@ -1,66 +1,61 @@
+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
-        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
+
+      def default_headers
+        {
+          "User-Agent" => "paddle/v#{VERSION} (github.com/deanpcmad/paddle)",
+          "Paddle-Version" => Paddle.config.version.to_s
+        }
+      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
 
-        response
+      def raise_error(response)
+        error = Paddle::ErrorFactory.create(response.body, response.status)
+        raise error if error
       end
     end
   end

data/lib/paddle/error.rb

@@ -1,4 +1,127 @@
 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/object.rb

@@ -15,5 +15,26 @@ module Paddle
         obj
       end
     end
+
+    def update(**params)
+      method_missing :update unless klass.respond_to? :update
+
+      primary_attributes = klass.method(:update).parameters.select { |(type, name)| type == :keyreq }.map(&:last) # Identified by whatever is a required named parameter.
+
+      primary_attributes.each do |attrib|
+        # ? Should we need to handle blank strings here?
+        params[attrib] = self[attrib] || self["#{attrib}_id"] # Handling for customer (customer_id) and id.
+      end
+
+      klass.public_send(:update, **params).each_pair { |key, val| self[key] = val } # Updating self
+
+      self
+    end
+
+    private
+
+    def klass
+      self.class
+    end
   end
 end

data/lib/paddle/version.rb

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

data/lib/paddle.rb

@@ -9,6 +9,8 @@ module Paddle
   autoload :Client, "paddle/client"
   autoload :Collection, "paddle/collection"
   autoload :Error, "paddle/error"
+  autoload :ErrorFactory, "paddle/error"
+
   autoload :Object, "paddle/object"
 
   class << self

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: paddle
 version: !ruby/object:Gem::Version
-  version: 2.2.1
+  version: 2.3.0
 platform: ruby
 authors:
 - Dean Perry
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-06-28 00:00:00.000000000 Z
+date: 2024-07-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -110,7 +110,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.9
+rubygems_version: 3.5.15
 signing_key:
 specification_version: 4
 summary: Ruby library for the Paddle Billing & Classic APIs