paypal_client 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2279ec026d46415c6c4ba27b11f14fba739eafa9
-  data.tar.gz: 556beeb56f57d81e19750c2e87478462e3d9a587
+  metadata.gz: a48ce325f1120721c1fa86079d4d31e7c4f1ed23
+  data.tar.gz: 48409e8f8c1f8e42f5997aa548d8d89124e0b29b
 SHA512:
-  metadata.gz: 1150eab9847c8eec968d55a99b94f048c59895d7c0d4947cbd914b889e8d6906449f6c074c81700813e191727727b4890964f1d2271b4c6ebff165ae4bc5508b
-  data.tar.gz: 397a04b94a5b17bf30428daeb1ebe1f34c37f01c1ae5b8d045db6fd929e915dd41a0d96220d53bcc5e1483f0f5a45a84b8cf6ba768038b5962280da48070ed35
+  metadata.gz: bf5f59ba813b4bb5e0e3808459f9f21700e36c9ea16fa25aef0a18769306be008a922f5415d5f91f2efbda88334788ce074804b1e49c98a82d5c46c76a681cec
+  data.tar.gz: bd16a3f58df0d48260184711a81cc25161cdf9bab415eb9ae2cd3426e824ec74da9727878e4e7df46e03099b114875b5890ace94b937808372db6134caf708a8

data/Gemfile

@@ -9,4 +9,5 @@ group :development, :test do
   gem 'pry'
   gem 'rubocop'
   gem 'simplecov'
+  gem 'yard'
 end

data/lib/paypal_client.rb

@@ -4,6 +4,12 @@ require 'paypal_client/version'
 require 'paypal_client/errors'
 require 'active_support/cache'
 
+#
+# Module PaypalClient provides an easy to use API client for the Paypal
+# REST API https://developer.paypal.com/docs/api/overview/
+#
+# @author Dennis van der Vliet <dennis.vandervliet@gmail.com>
+#
 module PaypalClient
   require 'faraday'
   require 'faraday_middleware'
@@ -18,6 +24,9 @@ module PaypalClient
     # so we have them expiry 3600 seconds before they actually expire
     TOKEN_EXPIRY_MARGIN = 60 * 60
 
+    # Build a new instance of PaypalClient based on defaults and environment
+    # variables
+    # @return [PaypalClient::Client] an instance of PaypalClient::Client
     def self.build
       @client ||= Client.new(
         client_id: ENV.fetch('PAYPAL_CLIENT_ID'),
@@ -28,6 +37,15 @@ module PaypalClient
       )
     end
 
+    # Creates a new instance of PaypalClient::Client
+    #
+    # @param [String] client_id: Paypal Client ID
+    # @param [String] client_secret: Paypal Client Secret
+    # @param [ActiveSupport::Cache::Store] cache: ActiveSupport::Cache::Store compaitable store to store auth token
+    # @param [Boolean] sandbox: true <description>
+    # @param [String] version: <description>
+    # @param [Logger] logger: nil <description>
+
     def initialize(client_id:, client_secret:, cache:, sandbox: true, version:, logger: nil)
       @client_id = client_id
       @client_secret = client_secret
@@ -37,25 +55,72 @@ module PaypalClient
       @logger = logger
     end
 
-    def connection
-      @conn ||= Faraday.new(url: base_url) do |faraday|
-        faraday.use PaypalClient::Errors::Middleware
+    # Send a GET request to the Paypal API
+    #
+    # @param [String] path Path to call on Paypal API (eg. /payments/payment)
+    # @param [Hash] data Hash to send as query parameters
+    # @param [Hash] headers Hash of custom request headers
+    #
+    # @return [Faraday::Response>] Faraday response. Call the `.body` method on it to access the response data.
 
-        faraday.headers = default_headers
-        faraday.response @logger if @logger
-        faraday.request  :json
-        faraday.response :json, content_type: /\bjson$/, parser_options: { symbolize_names: true }
+    def get(path, data = {}, headers = {})
+      connection.get(merged_path(path), data, merged_headers(headers))
+    end
 
-        faraday.adapter *adapter
-      end
+    # Send a POST request to the Paypal API
+    #
+    # @param [String] path Path to call on Paypal API (eg. /payments/payment)
+    # @param [Hash] data Hash to send as POST data. Will be turned into JSON.
+    # @param [Hash] headers Hash of custom request headers
+    #
+    # @return [Faraday::Response>] Faraday response. Call the `.body` method on it to access the response data.
+
+    def post(path, data = {}, headers = {})
+      connection.post(merged_path(path), data, merged_headers(headers))
     end
 
-    %i[get patch post put delete].each do |http_method|
-      define_method http_method do |path, data = {}, headers = {}|
-        connection.public_send(http_method, merged_path(path), data, merged_headers(headers))
-      end
+    # Send a PUT request to the Paypal API
+    #
+    # @param [String] path Path to call on Paypal API (eg. /payments/payment)
+    # @param [Hash] data Hash to send as POST data. Will be turned into JSON.
+    # @param [Hash] headers Hash of custom request headers
+    #
+    # @return [Faraday::Response>] Faraday response. Call the `.body` method on it to access the response data.
+
+    def put(path, data = {}, headers = {})
+      connection.put(merged_path(path), data, merged_headers(headers))
+    end
+
+    # Send a PATCH request to the Paypal API
+    #
+    # @param [String] path Path to call on Paypal API (eg. /payments/payment)
+    # @param [Hash] data Hash to send as POST data. Will be turned into JSON.
+    # @param [Hash] headers Hash of custom request headers
+    #
+    # @return [Faraday::Response>] Faraday response. Call the `.body` method on it to access the response data.
+
+    def patch(path, data = {}, headers = {})
+      connection.patch(merged_path(path), data, merged_headers(headers))
     end
 
+    # Send a DELETE request to the Paypal API
+    #
+    # @param [String] path Path to call on Paypal API (eg. /payments/payment)
+    # @param [Hash] data Hash to send as POST data. Will be turned into JSON.
+    # @param [Hash] headers Hash of custom request headers
+    #
+    # @return [Faraday::Response>] Faraday response. Call the `.body` method on it to access the response data.
+
+    def delete(path, data = {}, headers = {})
+      connection.delete(merged_path(path), data, merged_headers(headers))
+    end
+
+    # Request auth token from Paypal using the client_id and client_secret
+    #
+    # @param [<Boolean>] force: false Forces a refresh of the token even if cached
+    #
+    # @return [<String>] Valid auth token from Paypal
+    #
     def auth_token(force: false)
       return @cache.read(TOKEN_CACHE_KEY) if @cache.exist?(TOKEN_CACHE_KEY) && force == false
 
@@ -65,6 +130,21 @@ module PaypalClient
       end
     end
 
+    def connection
+      @conn ||= Faraday.new(url: base_url) do |faraday|
+        faraday.use PaypalClient::Errors::Middleware
+
+        faraday.headers = default_headers
+        faraday.response @logger if @logger
+        faraday.request  :json
+        faraday.response :json,
+                         content_type: /\bjson$/,
+                         parser_options: { symbolize_names: true }
+
+        faraday.adapter *adapter
+      end
+    end
+
     private
 
     def base_url
@@ -96,7 +176,8 @@ module PaypalClient
 
       response = connection.post(endpoint,
                                  'grant_type=client_credentials',
-                                 authorization: "Basic #{basic_auth}", "Content-Type": 'application/x-www-form-urlencoded')
+                                 authorization: "Basic #{basic_auth}",
+                                 "Content-Type": 'application/x-www-form-urlencoded')
       response.body
     end
 

data/lib/paypal_client/errors.rb

@@ -13,8 +13,8 @@ module PaypalClient
         @body = response.body
 
         if @body.class == Hash
-          @error = @body[:name] if @body.has_key?(:name)
-          @error_message = @body[:message] if @body.has_key?(:message)
+          @error = @body[:name] if @body.key?(:name)
+          @error_message = @body[:message] if @body.key?(:message)
         else
           @error = response.reason_phrase if @error.nil?
         end
@@ -22,7 +22,7 @@ module PaypalClient
       end
 
       def inspect
-        extra = ""
+        extra = ''
         extra << " status_code: #{status_code.inspect}" unless status_code.nil?
         extra << " body: #{body.inspect}"               unless body.nil?
         "#<#{self.class.name}: #{message}#{extra}>"
@@ -38,7 +38,7 @@ module PaypalClient
     class UnsupportedMediaType < Error; end
     class UnprocessableEntity < Error; end
     class RateLimitReached < Error; end
-    
+
     class InternalServerError < Error; end
     class ServiceUnavailable < Error; end
 

data/lib/paypal_client/version.rb

@@ -1,3 +1,3 @@
 module PaypalClient
-  VERSION = '0.2.0'.freeze
+  VERSION = '0.2.1'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: paypal_client
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Dennis van der Vliet
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-12-24 00:00:00.000000000 Z
+date: 2018-12-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport