Merge pull request #9 from stoffus/refactoring-with-docs-updates

Refactoring with docs updates

Author: stoffus

README.md

@@ -1,14 +1,14 @@
 # Payson API
 
-A simple utility to handle requests against the Payson payment gateway API.
+A zero dependency, pure Ruby utility to handle requests against the Payson payment gateway API.
 
 ## Supported Ruby versions
 
 * 2.6
 * 2.7
 * 3.0
 
-## Install
+## Installation
 
 Put this line in your Gemfile:
 
@@ -58,6 +58,10 @@ request.order.items << PaysonAPI::V2::Requests::OrderItem.new.tap do |item|
   item.quantity = 3
   item.reference = 'product-1'
 end
+
+checkout = PaysonAPI::V2::Client.create_checkout(request)
+
+# Continue by rendering the HTML from checkout.snippet.
 ```
 
 ### Updating a checkout
@@ -116,8 +120,6 @@ payment.return_url = 'http://localhost/payson/success'
 payment.cancel_url = 'http://localhost/payson/cancel'
 payment.ipn_url = 'http://localhost/payson/ipn'
 payment.memo = 'Sample order description'
-payment.sender = sender
-
 payment.sender = PaysonAPI::V1::Sender.new.tap do |s|
   s.email = '[email protected]'
   s.first_name = 'My'
@@ -197,10 +199,10 @@ class Payson < ApplicationController
     # Create a new IPN request object containing the raw response from above
     ipn_request = PaysonAPI::V1::Requests::IPN.new(ipn_response.raw)
 
-    validate = PaysonAPI::V1::Client.validate_ipn(ipn_request)
+    validation = PaysonAPI::V1::Client.validate_ipn(ipn_request)
 
-    unless validate.verified?
-      raise "Something went terribly wrong."
+    unless validation.verified?
+      raise "Something went terribly wrong"
     end
 
     # Do business transactions, e.g. update the corresponding order:
@@ -213,15 +215,15 @@ end
 
 ## Todo
 
-Document the code for the Payson Checkout v2 processes.
+Nothing at the moment.
 
-## Build Status
+## Project Status
 
-[![Build Status](https://travis-ci.org/stoffus/payson_api.svg?branch=master)](https://travis-ci.org/stoffus/payson_api)
+[![Build Status](https://travis-ci.org/stoffus/payson_api.svg?branch=master)](https://travis-ci.org/stoffus/payson_api) [![Gem Version](https://badge.fury.io/rb/payson_api.svg)](https://badge.fury.io/rb/payson_api)
 
 ## Questions, Feedback
 
-Feel free to message me on Github (stoffus).
+Feel free to message me on [GitHub](https://github.com/stoffus).
 
 ## Copyright
 

lib/payson_api/v2/client.rb

@@ -18,13 +18,13 @@ def self.get_checkout(id)
 
       def self.create_checkout(request)
         response = payson_request(Net::HTTP::Post, PAYSON_API_RESOURCES[:checkouts][:create], request)
-        handle_validation_error(response)
+        intercept_validation_errors(response)
         PaysonAPI::V2::Models::Checkout.from_hash(JSON.parse(response.body))
       end
 
       def self.update_checkout(request)
         response = payson_request(Net::HTTP::Put, PAYSON_API_RESOURCES[:checkouts][:update] % request.id, request)
-        handle_validation_error(response)
+        intercept_validation_errors(response)
         PaysonAPI::V2::Models::Checkout.from_hash(JSON.parse(response.body))
       end
 
@@ -38,7 +38,7 @@ def self.list_checkouts(request)
         end
       end
 
-      def self.handle_validation_error(response)
+      def self.intercept_validation_errors(response)
         if response.code == '400' || response.code == '500' # rubocop:disable Style/GuardClause
           raise PaysonAPI::V2::Errors::ValidationError, errors: JSON.parse(response.body)['errors']
         end
@@ -62,6 +62,8 @@ def self.payson_request(method, resource, request = nil)
 
         response
       end
+
+      private_class_method :intercept_validation_errors, :hash_to_params, :payson_request
     end
   end
 end

lib/payson_api/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module PaysonAPI
-  VERSION = '1.0.0'
+  VERSION = '1.0.2'
 end