paddle 2.2.0 → 2.3.0

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/models/address.rb

@@ -1,15 +1,13 @@
 module Paddle
   class Address < Object
-
     class << self
-
       def list(customer:, **params)
         response = Client.get_request("customers/#{customer}/addresses", params: params)
         Collection.from_response(response, type: Address)
       end
 
       def create(customer:, country_code:, postal_code:, **params)
-        attrs = {country_code: country_code, postal_code: postal_code}
+        attrs = { country_code: country_code, postal_code: postal_code }
         response = Client.post_request("customers/#{customer}/addresses", body: attrs.merge(params))
         Address.new(response.body["data"])
       end
@@ -23,8 +21,6 @@ module Paddle
         response = Client.patch_request("customers/#{customer}/addresses/#{id}", body: params)
         Address.new(response.body["data"])
       end
-
     end
-
   end
 end

data/lib/paddle/models/adjustment.rb

@@ -1,20 +1,16 @@
 module Paddle
   class Adjustment < Object
-
     class << self
-
       def list(**params)
         response = Client.get_request("adjustments", params: params)
         Collection.from_response(response, type: Adjustment)
       end
 
       def create(transaction_id:, action:, reason:, items:, **params)
-        attrs = {transaction_id: transaction_id, action: action, reason: reason, items: items}
+        attrs = { transaction_id: transaction_id, action: action, reason: reason, items: items }
         response = Client.post_request("adjustments", body: attrs.merge(params))
         Adjustment.new(response.body["data"])
       end
-
     end
-
   end
 end

data/lib/paddle/models/business.rb

@@ -1,15 +1,13 @@
 module Paddle
   class Business < Object
-
     class << self
-
       def list(customer:, **params)
         response = Client.get_request("customers/#{customer}/businesses", params: params)
         Collection.from_response(response, type: Business)
       end
 
       def create(customer:, name:, **params)
-        attrs = {name: name}
+        attrs = { name: name }
         response = Client.post_request("customers/#{customer}/businesses", body: attrs.merge(params))
         Business.new(response.body["data"])
       end
@@ -23,8 +21,6 @@ module Paddle
         response = Client.patch_request("customers/#{customer}/businesses/#{id}", body: params)
         Business.new(response.body["data"])
       end
-
     end
-
   end
 end

data/lib/paddle/models/customer.rb

@@ -1,15 +1,13 @@
 module Paddle
   class Customer < Object
-
     class << self
-
       def list(**params)
         response = Client.get_request("customers", params: params)
         Collection.from_response(response, type: Customer)
       end
 
       def create(email:, **params)
-        attrs = {email: email.gsub(/\s+/, "")}
+        attrs = { email: email.gsub(/\s+/, "") }
         response = Client.post_request("customers", body: attrs.merge(params))
         Customer.new(response.body["data"])
       end
@@ -28,8 +26,6 @@ module Paddle
         response = Client.get_request("customers/#{id}/credit-balances")
         CreditBalance.new(response.body["data"][0])
       end
-
     end
-
   end
 end

data/lib/paddle/models/discount.rb

@@ -1,15 +1,13 @@
 module Paddle
   class Discount < Object
-
     class << self
-
       def list(**params)
         response = Client.get_request("discounts", params: params)
         Collection.from_response(response, type: Discount)
       end
 
       def create(amount:, description:, type:, **params)
-        attrs = {amount: amount, description: description, type: type}
+        attrs = { amount: amount, description: description, type: type }
         response = Client.post_request("discounts", body: attrs.merge(params))
         Discount.new(response.body["data"])
       end
@@ -23,8 +21,6 @@ module Paddle
         response = Client.patch_request("discounts/#{id}", body: params)
         Discount.new(response.body["data"])
       end
-
     end
-
   end
 end

data/lib/paddle/models/event.rb

@@ -1,14 +1,10 @@
 module Paddle
   class Event < Object
-
     class << self
-
       def list(**params)
         response = Client.get_request("events", params: params)
         Collection.from_response(response, type: Event)
       end
-
     end
-
   end
 end

data/lib/paddle/models/event_type.rb

@@ -1,14 +1,10 @@
 module Paddle
   class EventType < Object
-
     class << self
-
       def list
         response = Client.get_request("event-types")
         Collection.from_response(response, type: EventType)
       end
-
     end
-
   end
 end

data/lib/paddle/models/notification.rb

@@ -1,8 +1,6 @@
 module Paddle
   class Notification < Object
-
     class << self
-
       def list(**params)
         response = Client.get_request("notifications", params: params)
         Collection.from_response(response, type: Notification)
@@ -23,8 +21,6 @@ module Paddle
         response = Client.get_request("notifications/#{id}/logs", params: params)
         Collection.from_response(response, type: NotificationLog)
       end
-
     end
-
   end
 end

data/lib/paddle/models/notification_setting.rb

@@ -1,15 +1,13 @@
 module Paddle
   class NotificationSetting < Object
-
     class << self
-
       def list(**params)
         response = Client.get_request("notification-settings", params: params)
         Collection.from_response(response, type: NotificationSetting)
       end
 
       def create(description:, destination:, type:, subscribed_events:, **params)
-        attrs = {description: description, destination: destination, type: type, subscribed_events: subscribed_events}
+        attrs = { description: description, destination: destination, type: type, subscribed_events: subscribed_events }
         response = Client.post_request("notification-settings", body: attrs.merge(params))
         NotificationSetting.new(response.body["data"])
       end
@@ -27,8 +25,6 @@ module Paddle
       def delete(id:)
         Client.delete_request("notification-settings/#{id}")
       end
-
     end
-
   end
 end

data/lib/paddle/models/price.rb

@@ -1,15 +1,13 @@
 module Paddle
   class Price < Object
-
     class << self
-
       def list(**params)
         response = Client.get_request("prices", params: params)
         Collection.from_response(response, type: Price)
       end
 
       def create(product_id:, description:, amount:, currency:, **params)
-        attrs = {product_id: product_id, description: description, unit_price: {amount: amount, currency_code: currency}}
+        attrs = { product_id: product_id, description: description, unit_price: { amount: amount, currency_code: currency } }
         response = Client.post_request("prices", body: attrs.merge(params))
         Price.new(response.body["data"])
       end
@@ -23,8 +21,6 @@ module Paddle
         response = Client.patch_request("prices/#{id}", body: params)
         Price.new(response.body["data"])
       end
-
     end
-
   end
 end

data/lib/paddle/models/pricing_preview.rb

@@ -1,15 +1,11 @@
 module Paddle
   class PricingPreview < Object
-
     class << self
-
       def generate(items:, **params)
-        attrs = {items: items}
+        attrs = { items: items }
         response = Client.post_request("pricing-preview", body: attrs.merge(params))
         PricingPreview.new(response.body["data"])
       end
-
     end
-
   end
 end

data/lib/paddle/models/product.rb

@@ -1,15 +1,13 @@
 module Paddle
   class Product < Object
-
     class << self
-
       def list(**params)
         response = Client.get_request("products", params: params)
         Collection.from_response(response, type: Product)
       end
 
       def create(name:, tax_category:, **params)
-        attrs = {name: name, tax_category: tax_category}
+        attrs = { name: name, tax_category: tax_category }
         response = Client.post_request("products", body: attrs.merge(params))
         Product.new(response.body["data"])
       end
@@ -23,8 +21,6 @@ module Paddle
         response = Client.patch_request("products/#{id}", body: params)
         Product.new(response.body["data"])
       end
-
     end
-
   end
 end

data/lib/paddle/models/report.rb

@@ -1,15 +1,13 @@
 module Paddle
   class Report < Object
-
     class << self
-
       def list(**params)
         response = Client.get_request("reports", params: params)
         Collection.from_response(response, type: Report)
       end
 
       def create(type:, filters:, **params)
-        attrs = {type: type, filters: filters}
+        attrs = { type: type, filters: filters }
         response = Client.post_request("reports", body: attrs.merge(params))
         Report.new(response.body["data"])
       end
@@ -22,11 +20,9 @@ module Paddle
       def csv(id:)
         response = Client.get_request("reports/#{id}/download-url")
         if response.success?
-          return response.body["data"]["url"]
+          response.body["data"]["url"]
         end
       end
-
     end
-
   end
 end

data/lib/paddle/models/subscription.rb

@@ -1,15 +1,13 @@
 module Paddle
   class Subscription < Object
-
     class << self
-
       def list(**params)
         response = Client.get_request("subscriptions", params: params)
         Collection.from_response(response, type: Subscription)
       end
 
       def retrieve(id:, extra: nil)
-        params = extra ? {include: extra} : {}
+        params = extra ? { include: extra } : {}
         response = Client.get_request("subscriptions/#{id}", params: params)
         Subscription.new(response.body["data"])
       end
@@ -30,7 +28,7 @@ module Paddle
       end
 
       def charge(id:, items:, effective_from:, **params)
-        attrs = {items: items, effective_from: effective_from}
+        attrs = { items: items, effective_from: effective_from }
         response = Client.post_request("subscriptions/#{id}/charge", body: attrs.merge(params))
         Subscription.new(response.body["data"])
       end
@@ -41,7 +39,7 @@ module Paddle
       end
 
       def resume(id:, effective_from:, **params)
-        attrs = {effective_from: effective_from}
+        attrs = { effective_from: effective_from }
         response = Client.post_request("subscriptions/#{id}/resume", body: attrs.merge(params))
         Subscription.new(response.body["data"])
       end
@@ -55,8 +53,6 @@ module Paddle
         response = Client.post_request("subscriptions/#{id}/activate")
         Subscription.new(response.body["data"])
       end
-
     end
-
   end
 end

data/lib/paddle/models/transaction.rb

@@ -1,21 +1,19 @@
 module Paddle
   class Transaction < Object
-
     class << self
-
       def list(**params)
         response = Client.get_request("transactions", params: params)
         Collection.from_response(response, type: Transaction)
       end
 
       def create(items:, **params)
-        attrs = {items: items}
+        attrs = { items: items }
         response = Client.post_request("transactions", body: attrs.merge(params))
         Transaction.new(response.body["data"])
       end
 
       def retrieve(id:, extra: nil)
-        params = extra ? {include: extra} : {}
+        params = extra ? { include: extra } : {}
         response = Client.get_request("transactions/#{id}", params: params)
         Transaction.new(response.body["data"])
       end
@@ -28,17 +26,15 @@ module Paddle
       def invoice(id:)
         response = Client.get_request("transactions/#{id}/invoice")
         if response.success?
-          return response.body["data"]["url"]
+          response.body["data"]["url"]
         end
       end
 
       def preview(items:, **params)
-        attrs = {items: items}
+        attrs = { items: items }
         response = Client.post_request("transactions/preview", body: attrs.merge(params))
         Transaction.new(response.body["data"])
       end
-
     end
-
   end
 end

data/lib/paddle/object.rb

@@ -8,12 +8,33 @@ module Paddle
 
     def to_ostruct(obj)
       if obj.is_a?(Hash)
-        OpenStruct.new(obj.map { |key, val| [key, to_ostruct(val)] }.to_h)
+        OpenStruct.new(obj.map { |key, val| [ key, to_ostruct(val) ] }.to_h)
       elsif obj.is_a?(Array)
         obj.map { |o| to_ostruct(o) }
       else # Assumed to be a primitive value
         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.0"
+  VERSION = "2.3.0"
 end

data/lib/paddle.rb

@@ -5,11 +5,12 @@ require "faraday"
 require_relative "paddle/version"
 
 module Paddle
-
   autoload :Configuration, "paddle/configuration"
   autoload :Client, "paddle/client"
   autoload :Collection, "paddle/collection"
   autoload :Error, "paddle/error"
+  autoload :ErrorFactory, "paddle/error"
+
   autoload :Object, "paddle/object"
 
   class << self
@@ -75,5 +76,4 @@ module Paddle
     autoload :Modifier, "paddle/classic/objects/modifier"
     autoload :Charge, "paddle/classic/objects/charge"
   end
-
 end

data/paddle.gemspec

@@ -5,8 +5,8 @@ require_relative "lib/paddle/version"
 Gem::Specification.new do |spec|
   spec.name          = "paddle"
   spec.version       = Paddle::VERSION
-  spec.authors       = ["Dean Perry"]
-  spec.email         = ["dean@deanpcmad.com"]
+  spec.authors       = [ "Dean Perry" ]
+  spec.email         = [ "dean@deanpcmad.com" ]
 
   spec.summary       = "Ruby library for the Paddle Billing & Classic APIs"
   spec.homepage      = "https://github.com/deanpcmad/paddle"
@@ -24,7 +24,7 @@ Gem::Specification.new do |spec|
   end
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = [ "lib" ]
 
   spec.add_dependency "faraday", "~> 2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: paddle
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.3.0
 platform: ruby
 authors:
 - Dean Perry
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-04-24 00:00:00.000000000 Z
+date: 2024-07-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -24,7 +24,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
-description: 
+description:
 email:
 - dean@deanpcmad.com
 executables: []
@@ -32,6 +32,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".env.example"
+- ".rubocop.yml"
 - Gemfile
 - Gemfile.lock
 - README.md
@@ -94,7 +95,7 @@ licenses: []
 metadata:
   homepage_uri: https://github.com/deanpcmad/paddle
   source_code_uri: https://github.com/deanpcmad/paddle
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -109,8 +110,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.9
-signing_key: 
+rubygems_version: 3.5.15
+signing_key:
 specification_version: 4
 summary: Ruby library for the Paddle Billing & Classic APIs
 test_files: []