paddle_pay 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d4b576ab1993da2a68d2157288909b5a32263c0e64fba65c8f590ade235e34e4
-  data.tar.gz: 055e96a399e3b98a508ff638506bb44383fc05020258202447d314ffc7d1a402
+  metadata.gz: d2c11cc7eda43495df42fa84b9806cca833202178676463725f2b94c9c08f245
+  data.tar.gz: 61061e1fcc1db7c7515bf9a8efd66bd564767843ee82b7ce75568e4d9802269d
 SHA512:
-  metadata.gz: 4d4abed1bfa549c2fc8c50522c462d65ed0a82a92b046e9b72663556e90d5f16f07a17d61f8dc127b9a6b963a03bcc098a12c233f488372d16b4666b40ae120f
-  data.tar.gz: 5f82a368c69a8231840ecf002702ab0e44ec9e8e38f3ff8cf25135dd4e1a6da8bb41ba1215bf8147799afc442f85f63f83455116edfd7cad6e6bc88348beeeee
+  metadata.gz: fc6e6db5f4c96a9731f324c85c5c088013dccd213ccc115eb6ce165d8d9719b929cfd9059dd1222e8b085497091464154c815a13905adc320a114ca94ab7c2c4
+  data.tar.gz: 789a614eeb26dc9ae04420316a9e75e6c396de296aed42b2841f4487d908cea3f72eec5f3c3fc4e5d5fcc2aacc0480be22b47ff1456b6608b253d96fa7275210

data/README.md

@@ -1,5 +1,8 @@
 # PaddlePay
 
+![Tests](https://github.com/devmindo/paddle_pay/workflows/Tests/badge.svg?branch=master)
+[![Gem Version](https://img.shields.io/gem/v/paddle_pay.svg?style=flat)](https://rubygems.org/gems/paddle_pay)
+
 A Ruby wrapper for the paddle.com API.
 
 ## Installation
@@ -18,12 +21,24 @@ And then execute:
 
 Configure the gem with the credentials obtained from the Paddle Dashboard
 
+### Development
 ```ruby
 PaddlePay.configure do |config|
-  config.vendor_id = 'YOUR VENDOR ID'
-  config.vendor_auth_code = 'YOUR VENDOR AUTH CODE'
+  config.environment = :development # or :sandbox
+  config.vendor_id = 'YOUR SANDBOX VENDOR ID'
+  config.vendor_auth_code = 'YOUR SANDBOX VENDOR AUTH CODE'
 end
 ```
+
+### Production
+```ruby
+PaddlePay.configure do |config|
+  config.environment = :production
+  config.vendor_id = 'YOUR PRODUCTION VENDOR ID'
+  config.vendor_auth_code = 'YOUR PRODUCTION VENDOR AUTH CODE'
+end
+```
+
 ## Usage
 
 ### Product
@@ -198,6 +213,10 @@ id = '123456'
 PaddlePay::Transaction::User.list(id, options = {})
 ```
 
+## Webhooks
+
+With this gem it is possible to communicate with the Paddle API, but no webhooks are handled. If you want to handle Paddle webhooks in a Ruby on Rails application, please have a look at the [pay gem](https://github.com/pay-rails/pay) where this gem is integrated.
+
 ## Development
 
 Check out the repository and run `bin/setup` to install dependencies. For configuration run `mv .env.template .env` and set your credentials in the required fields. After that, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt.

data/lib/paddle_pay.rb

@@ -1,29 +1,29 @@
 # frozen_string_literal: true
 
-require 'faraday'
-require 'json'
+require "faraday"
+require "json"
 
-require_relative 'paddle_pay/configuration'
-require_relative 'paddle_pay/connection'
-require_relative 'paddle_pay/util'
-require_relative 'paddle_pay/version'
-require_relative 'paddle_pay/errors/paddle_pay_error'
-require_relative 'paddle_pay/models/alert/webhook'
-require_relative 'paddle_pay/models/product/coupon'
-require_relative 'paddle_pay/models/product/license'
-require_relative 'paddle_pay/models/product/pay_link'
-require_relative 'paddle_pay/models/product/payment'
-require_relative 'paddle_pay/models/product/product'
-require_relative 'paddle_pay/models/subscription/charge'
-require_relative 'paddle_pay/models/subscription/modifier'
-require_relative 'paddle_pay/models/subscription/payment'
-require_relative 'paddle_pay/models/subscription/plan'
-require_relative 'paddle_pay/models/subscription/user'
-require_relative 'paddle_pay/models/transaction/checkout'
-require_relative 'paddle_pay/models/transaction/order'
-require_relative 'paddle_pay/models/transaction/product'
-require_relative 'paddle_pay/models/transaction/subscription'
-require_relative 'paddle_pay/models/transaction/user'
+require_relative "paddle_pay/configuration"
+require_relative "paddle_pay/connection"
+require_relative "paddle_pay/util"
+require_relative "paddle_pay/version"
+require_relative "paddle_pay/errors/paddle_pay_error"
+require_relative "paddle_pay/models/alert/webhook"
+require_relative "paddle_pay/models/product/coupon"
+require_relative "paddle_pay/models/product/license"
+require_relative "paddle_pay/models/product/pay_link"
+require_relative "paddle_pay/models/product/payment"
+require_relative "paddle_pay/models/product/product"
+require_relative "paddle_pay/models/subscription/charge"
+require_relative "paddle_pay/models/subscription/modifier"
+require_relative "paddle_pay/models/subscription/payment"
+require_relative "paddle_pay/models/subscription/plan"
+require_relative "paddle_pay/models/subscription/user"
+require_relative "paddle_pay/models/transaction/checkout"
+require_relative "paddle_pay/models/transaction/order"
+require_relative "paddle_pay/models/transaction/product"
+require_relative "paddle_pay/models/transaction/subscription"
+require_relative "paddle_pay/models/transaction/user"
 
 module PaddlePay
   class << self

data/lib/paddle_pay/configuration.rb

@@ -2,16 +2,29 @@
 
 module PaddlePay
   class Configuration
-    attr_reader :vendors_url
-    attr_reader :vendor_auth_code
-    attr_reader :vendor_id
+    attr_reader :environment
+    attr_accessor :vendor_auth_code
+    attr_accessor :vendor_id
 
     def initialize
-      @vendors_url = 'https://vendors.paddle.com/api'
+      @environment ||= :production
     end
 
-    attr_writer :vendor_auth_code
+    def environment=(env)
+      env = env.to_sym
+      unless [:development, :sandbox, :production].include?(env)
+        raise ArgumentError, "#{env.inspect} is not a valid environment"
+      end
+      @environment = env
+    end
 
-    attr_writer :vendor_id
+    def vendors_url
+      case @environment
+      when :production
+        "https://vendors.paddle.com/api"
+      when :development, :sandbox
+        "https://sandbox-vendors.paddle.com/api"
+      end
+    end
   end
 end

data/lib/paddle_pay/connection.rb

@@ -9,23 +9,23 @@ module PaddlePay
         headers = options.delete(:headers) || {}
         body = options.delete(:body) || {}
 
-        conn = Faraday.new(url: request_url) do |faraday|
+        conn = Faraday.new(url: request_url) { |faraday|
           faraday.request :url_encoded
           faraday.response :raise_error
           faraday.adapter :net_http
-        end
+        }
 
         begin
-          response = conn.post(url, config.merge(body)) do |req|
+          response = conn.post(url, config.merge(body)) { |req|
             req.params.merge!(params)
             req.headers.merge!(headers)
-          end
+          }
           result = parse(response)
-          unless result['success']
-            raise PaddlePayError.new(result['error']['message'], result['error']['code'])
+          unless result["success"]
+            raise PaddlePayError.new(result["error"]["message"], result["error"]["code"])
           end
 
-          PaddlePay::Util.convert_hash_keys(result['response'])
+          PaddlePay::Util.convert_hash_keys(result["response"])
         rescue Faraday::BadRequestError => e
           raise BadRequestError.new(e.response[:body], e.response[:status])
         rescue Faraday::UnauthorizedError => e
@@ -40,10 +40,10 @@ module PaddlePay
           raise ConflictError.new(e.response[:body], e.response[:status])
         rescue Faraday::UnprocessableEntityError => e
           raise UnprocessableEntityError.new(e.response[:body], e.response[:status])
-        rescue Faraday::TimeoutError => e
-          raise TimeoutError, 'The connection has timed out'
-        rescue Faraday::ConnectionFailed => e
-          raise ConnectionError, 'The connection failed'
+        rescue Faraday::TimeoutError
+          raise TimeoutError, "The connection has timed out"
+        rescue Faraday::ConnectionFailed
+          raise ConnectionError, "The connection failed"
         rescue Faraday::ServerError => e
           raise ServerError.new(e.response[:body], e.response[:status])
         end

data/lib/paddle_pay/errors/paddle_pay_error.rb

@@ -7,7 +7,7 @@ module PaddlePay
     attr_reader :message
 
     def initialize(message, code = nil)
-      super("#{message} #{'(Code ' + code.to_s + ')' if code}")
+      super("#{message} #{"(Code " + code.to_s + ")" if code}")
       @code = code
       @message = message
     end
@@ -37,6 +37,9 @@ module PaddlePay
   class UnprocessableEntityError < ClientError
   end
 
+  class ArgumentError < ClientError
+  end
+
   class ServerError < PaddlePayError
   end
 

data/lib/paddle_pay/models/alert/webhook.rb

@@ -5,8 +5,8 @@ module PaddlePay
     module Webhook
       class << self
         def history(filters = {}, options = {})
-          options.merge!({ body: filters }) if filters.is_a?(::Hash)
-          Connection.request('2.0/alert/webhooks', options)
+          options[:body] = filters if filters.is_a?(::Hash)
+          Connection.request("2.0/alert/webhooks", options)
         end
       end
     end

data/lib/paddle_pay/models/product/coupon.rb

@@ -5,30 +5,30 @@ module PaddlePay
     module Coupon
       class << self
         def list(product_id, options = {})
-          options.merge!({ body: { product_id: product_id } })
-          Connection.request('2.0/product/list_coupons', options)
+          options[:body] = {product_id: product_id}
+          Connection.request("2.0/product/list_coupons", options)
         end
 
         def create(attributes, options = {})
-          options.merge!({ body: attributes }) if attributes.is_a?(::Hash)
-          Connection.request('2.1/product/create_coupon', options)
+          options[:body] = attributes if attributes.is_a?(::Hash)
+          Connection.request("2.1/product/create_coupon", options)
         end
 
         def delete(coupon_code, product_id, options = {})
-          options.merge!({ body: { coupon_code: coupon_code, product_id: product_id } })
-          Connection.request('2.0/product/delete_coupon', options)
+          options[:body] = {coupon_code: coupon_code, product_id: product_id}
+          Connection.request("2.0/product/delete_coupon", options)
         end
 
         def update_code(coupon_code, attributes = {}, options = {})
-          attributes.merge!(coupon_code: coupon_code)
-          options.merge!({ body: attributes })
-          Connection.request('2.1/product/update_coupon', options)
+          attributes[:coupon_code] = coupon_code
+          options[:body] = attributes
+          Connection.request("2.1/product/update_coupon", options)
         end
 
         def update_group(group, attributes = {}, options = {})
-          attributes.merge!(group: group)
-          options.merge!({ body: attributes })
-          Connection.request('2.1/product/update_coupon', options)
+          attributes[:group] = group
+          options[:body] = attributes
+          Connection.request("2.1/product/update_coupon", options)
         end
       end
     end

data/lib/paddle_pay/models/product/license.rb

@@ -5,8 +5,8 @@ module PaddlePay
     module License
       class << self
         def generate(attributes, options = {})
-          options.merge!({ body: attributes }) if attributes.is_a?(::Hash)
-          Connection.request('2.0/product/generate_license', options)
+          options[:body] = attributes if attributes.is_a?(::Hash)
+          Connection.request("2.0/product/generate_license", options)
         end
       end
     end

data/lib/paddle_pay/models/product/pay_link.rb

@@ -5,8 +5,8 @@ module PaddlePay
     module PayLink
       class << self
         def generate(attributes, options = {})
-          options.merge!({ body: attributes }) if attributes.is_a?(::Hash)
-          Connection.request('2.0/product/generate_pay_link', options)
+          options[:body] = attributes if attributes.is_a?(::Hash)
+          Connection.request("2.0/product/generate_pay_link", options)
         end
       end
     end

data/lib/paddle_pay/models/product/payment.rb

@@ -5,11 +5,11 @@ module PaddlePay
     module Payment
       class << self
         def refund(order_id, attributes = {}, options = {})
-          attributes.merge!(order_id: order_id)
-          options.merge!({ body: attributes })
-          Connection.request('2.0/payment/refund', options)
+          attributes[:order_id] = order_id
+          options[:body] = attributes
+          Connection.request("2.0/payment/refund", options)
         end
       end
     end
   end
-end
+end

data/lib/paddle_pay/models/product/product.rb

@@ -4,8 +4,8 @@ module PaddlePay
   module Product
     class << self
       def list(filters = {}, options = {})
-        options.merge!({ body: filters }) if filters.is_a?(::Hash)
-        Connection.request('2.0/product/get_products', options)
+        options[:body] = filters if filters.is_a?(::Hash)
+        Connection.request("2.0/product/get_products", options)
       end
     end
   end

data/lib/paddle_pay/models/subscription/charge.rb

@@ -5,7 +5,7 @@ module PaddlePay
     module Charge
       class << self
         def create(subscription_id, amount, charge_name, options = {})
-          options.merge!({ body: { amount: amount, charge_name: charge_name } })
+          options[:body] = {amount: amount, charge_name: charge_name}
           Connection.request("2.0/subscription/#{subscription_id}/charge", options)
         end
       end

data/lib/paddle_pay/models/subscription/modifier.rb

@@ -5,18 +5,18 @@ module PaddlePay
     module Modifier
       class << self
         def list(filters = {}, options = {})
-          options.merge!({ body: filters }) if filters.is_a?(::Hash)
-          Connection.request('2.0/subscription/modifiers', options)
+          options[:body] = filters if filters.is_a?(::Hash)
+          Connection.request("2.0/subscription/modifiers", options)
         end
 
         def create(attributes, options = {})
-          options.merge!({ body: attributes }) if attributes.is_a?(::Hash)
-          Connection.request('2.0/subscription/modifiers/create', options)
+          options[:body] = attributes if attributes.is_a?(::Hash)
+          Connection.request("2.0/subscription/modifiers/create", options)
         end
 
         def delete(modifier_id, options = {})
-          options.merge!({ body: { modifier_id: modifier_id } })
-          Connection.request('2.0/subscription/modifiers/delete', options)
+          options[:body] = {modifier_id: modifier_id}
+          Connection.request("2.0/subscription/modifiers/delete", options)
         end
       end
     end

data/lib/paddle_pay/models/subscription/payment.rb

@@ -5,19 +5,19 @@ module PaddlePay
     module Payment
       class << self
         def list(filters = {}, options = {})
-          options.merge!({ body: filters }) if filters.is_a?(::Hash)
-          Connection.request('2.0/subscription/payments', options)
+          options[:body] = filters if filters.is_a?(::Hash)
+          Connection.request("2.0/subscription/payments", options)
         end
 
         def reschedule(payment_id, date, options = {})
-          options.merge!({ body: { payment_id: payment_id, date: date } })
-          Connection.request('2.0/subscription/payments_reschedule', options)
+          options[:body] = {payment_id: payment_id, date: date}
+          Connection.request("2.0/subscription/payments_reschedule", options)
         end
 
         def refund(order_id, attributes = {}, options = {})
-          attributes.merge!(order_id: order_id)
-          options.merge!({ body: attributes })
-          Connection.request('2.0/payment/refund', options)
+          attributes[:order_id] = order_id
+          options[:body] = attributes
+          Connection.request("2.0/payment/refund", options)
         end
       end
     end

data/lib/paddle_pay/models/subscription/plan.rb

@@ -5,13 +5,13 @@ module PaddlePay
     module Plan
       class << self
         def list(filters = {}, options = {})
-          options.merge!({ body: filters }) if filters.is_a?(::Hash)
-          Connection.request('2.0/subscription/plans', options)
+          options[:body] = filters if filters.is_a?(::Hash)
+          Connection.request("2.0/subscription/plans", options)
         end
 
         def create(attributes, options = {})
-          options.merge!({ body: attributes }) if attributes.is_a?(::Hash)
-          Connection.request('2.0/subscription/plans_create', options)
+          options[:body] = attributes if attributes.is_a?(::Hash)
+          Connection.request("2.0/subscription/plans_create", options)
         end
       end
     end

data/lib/paddle_pay/models/subscription/user.rb

@@ -5,25 +5,25 @@ module PaddlePay
     module User
       class << self
         def list(filters = {}, options = {})
-          options.merge!({ body: filters }) if filters.is_a?(::Hash)
-          Connection.request('2.0/subscription/users', options)
+          options[:body] = filters if filters.is_a?(::Hash)
+          Connection.request("2.0/subscription/users", options)
         end
 
         def cancel(subscription_id, options = {})
-          options.merge!({ body: { subscription_id: subscription_id } })
-          Connection.request('2.0/subscription/users_cancel', options)
+          options[:body] = {subscription_id: subscription_id}
+          Connection.request("2.0/subscription/users_cancel", options)
         end
 
         def update(subscription_id, attributes = {}, options = {})
-          attributes.merge!(subscription_id: subscription_id)
-          options.merge!({ body: attributes })
-          Connection.request('2.0/subscription/users_update', options)
+          attributes[:subscription_id] = subscription_id
+          options[:body] = attributes
+          Connection.request("2.0/subscription/users_update", options)
         end
 
         def preview_update(subscription_id, attributes = {}, options = {})
-          attributes.merge!(subscription_id: subscription_id)
-          options.merge!({ body: attributes })
-          Connection.request('2.0/subscription/preview_update', options)
+          attributes[:subscription_id] = subscription_id
+          options[:body] = attributes
+          Connection.request("2.0/subscription/preview_update", options)
         end
       end
     end

data/lib/paddle_pay/util.rb

@@ -15,7 +15,7 @@ module PaddlePay
       end
 
       def convert_class_to_path(class_name)
-        class_name.split('::').map { |v| to_snake_case(v) }.join('/')
+        class_name.split("::").map { |v| to_snake_case(v) }.join("/")
       end
 
       private
@@ -25,11 +25,11 @@ module PaddlePay
       end
 
       def to_snake_case(string)
-        string.gsub(/::/, '/')
-              .gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
-              .gsub(/([a-z\d])([A-Z])/, '\1_\2')
-              .tr('-', '_')
-              .downcase
+        string.gsub(/::/, "/")
+          .gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
+          .gsub(/([a-z\d])([A-Z])/, '\1_\2')
+          .tr("-", "_")
+          .downcase
       end
     end
   end