koduc_express_paypal 1.0.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    YTU0OTkwZTZjZWVhMGIzN2JmMWMyNDllZjM5OWFhODAyNDY2NjM2Yw==
+  data.tar.gz: !binary |-
+    MWVjY2VhOTI1MDE1MzMzN2UzOGY4MjI3YTU2YWMxNjI3ZTg3ZGZlMA==
+SHA512:
+  metadata.gz: !binary |-
+    MDUzNWI4MzZiZjg4YTM0MWI2NjU4ZjZiNGFjOGZhM2FmMzFkN2Y3MzA2Nzkx
+    ZDJhNWEzYWIzYzdjMzc4OWVjYWI0ZWJkNzNlZjc4ZDIzYzFhMmRiOThjZjQ1
+    ZjNlMGQyZGQ0MWQ2MTNkZmRlOTI0ZGJiN2NjOGNlYTBjN2JhZDY=
+  data.tar.gz: !binary |-
+    M2QxZjM3ZGEwYjQ2YTRjZjU0MGUwZTY4MjVjM2Q3ZGI5NzE4ZTk1ZTA1NTBi
+    OWUxMTNiYTUyYTRhZTFmZWMxZTcyZjMyM2JjNGU4M2I1YTQyMDVkZjAxMDNh
+    YzljNmMxNzA4ODllZTAyZTA3MzUyODg1OGE3YTE0ZjAyNmM3OTE=

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 1.9.3
+before_install: gem install bundler -v 1.10.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in koduc_express_paypal.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Akanksha01
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,130 @@
+# KoducExpressPaypal
+
+KoducExpressPaypal is a simple gem used for fulfilling the requirement of one time Paypal Express Checkout integration using NVP(Name Value Pair). The chief principle of designing this library is the involvement of different internal Express Checkout Paypal APIs.
+
+It is developed for the usage in Ruby on Rails web applications and integrates as a Rails plugin.
+
+It is developed in November 2015 by [KSolves](http://ksolves.com/) team with the help of valuable contributors.
+
+## Installation
+
+### From Git
+
+Check out the latest source from git using:
+
+	git clone https://github.com/kartiksolves/koduc-paypal-express.git
+
+if you're using Bundler, just add the following to your Gemfile:
+
+```ruby
+gem 'koduc_express_paypal'
+```
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install koduc_express_paypal
+
+## Usage
+
+This simple example demonstrates how a purchase can be made using the KoducExpressPaypal gem.
+
+```ruby
+require 'koduc_express_paypal'	
+
+# Declare the following paypal credentials in the same format in the environment files present in the config folder. Use development.rb for sandbox credentials and production.rb for live credentials. Write everything is string.
+
+config.paypal_credentials = {
+            :USER => <userid>, 
+            :PWD => <password>, 
+            :SIGNATURE => <signature>
+         }
+
+# Set the environment in the format given below. 
+# Default it will be a sandbox mode.
+
+# For Sandbox mode use
+KsCheckEnvironment::ks_sandbox(true)
+
+# For Live mode use
+KsCheckEnvironment::ks_sandbox(false)
+
+# Form a hash of the required parameters in the format given below.
+# All the fields are mandatory
+# payment_amount   => payment amount (Integers and float values are allowed else it will throw error message )
+# payment_action   => type of transaction (Only alphabets are allowed.)
+# payment_currency => payment currency code (Only alphabets are allowed in capital letters.)
+# cancel_url       => redirect URL for use if the customer does not authorize payment
+# return_url       => redirect URL for use if the customer authorizes payment
+# Pass the parameters in string
+
+hash = {:payment_amount =><paymentAmount>,:payment_action=><paymentAction>,:payment_currency=><paymentCurrency>,:cancel_url=><cancelURL>,:return_url=><returnURL>}
+
+# Form an object using the above hash
+
+obj = KsExpressPaypal::KsRequest.new(hash)
+
+# Check if the passed parameters are valid using the object formed above
+
+validity = obj.valid?
+
+# The format of the response obtained is {success: true/false ,response:[Error Array]}
+# The value of success is true is the parameters are verified completely else it will be false.
+# The value of response will be an Array consisting of the error messages in case the validation of the parameters failed. In case the value of success is true the response will be an empty array.
+
+# If the success is true call the following method with the same object formed above
+
+set_checkout = obj.ks_set_express_checkout
+
+# The format of the response in case of success is {success: true ,response:[Response returned from Paypal]}
+# The format of the response in case of failure is {success: false ,response:[Error Message returned from Paypal]} 
+# If the above call is successful the response will contain the TOKEN. 
+# If the above call is a failure refer the paypal errors.
+
+# In case of success, using the token valued returned from above, redirect the customer to PayPal so they can approve the transaction:
+
+# For sandbox 
+https://www.sandbox.paypal.com/cgi-bin/webscr?cmd=_express-checkout&token=<tokenValue>
+
+# For LIVE redirect the customer to 
+https://www.paypal.com/cgi-bin/webscr?cmd=_express-checkout&token=<tokenValue>
+
+# The redirect presents the customer with a PayPal log-in page. After the customer logs in, PayPal displays the transaction details on the Payments Review page. The customer approves the payment on this page by clicking Continue.
+
+# If the customer approves the payment, PayPal directs the customer to the payment confirmation page (the return URL specified above in the parameters described above). If the customer doesn't authorize the payment, PayPal directs the customer to the cancel URL that you also specified in the parameters described above, and you can attempt to re-initiate the checkout.
+
+# If the customer approves the payment, find the checkout details using the following method by passing the TOKEN obtained above with the same object.
+# It is advisable to display the details on the payment confirmation page using the below method
+
+checkout_details = KsExpressPaypal::KsRequest.ks_checkout_details(<tokenValue>)
+
+# The format of the response in case of success is {success: true ,response:[Response returned from Paypal]}
+# The format of the response in case of failure is {success: false ,response:[Error Message returned from Paypal]} 
+# If the above call is successful the response will contain the TOKEN and the various other details with the PAYERID if the customer has verified the payment. Utilise the details obtained above accordingly.
+# If the above call is a failure refer the paypal errors.
+
+# In addition to the transaction details, your payment confirmation page should include a Confirm button. When the customer confirms the payment, call the below method to capture (collect) the payment. The following sample shows how to specify the PayerID and token value returned from the previous call. Provide the Payment Action with token and payerId:
+
+do_checkout = KsExpressPaypal::KsRequest.ks_do_checkout(<tokenValue>,<paymentAction>,<payerId>)
+
+# When PayPal processes the above call, it captures the payment by transferring the funds from the customer account to the appropriate merchant account and sends a confirmation e-mail to the customer.
+
+# The format of the response in case of success is {success: true ,response:[Response returned from Paypal]}
+# The format of the response in case of failure is {success: false ,response:[Error Message returned from Paypal]} 
+# Refer the paypal errors in case of failure.
+```
+## Queries and Issues 
+
+Your valuable queries and suggestions are welcomed. Please report the issues on GitHub at https://github.com/kartiksolves/koduc-paypal-express 
+
+## Contact 
+
+If you have any query, need support or advice just DROP us a line and we’ll be in touch very soon.
+
+Email: support@koduc.com
+
+You can also contact us at +91-120-4540178
+
+We’d love to hear from you! :) :)

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "koduc_express_paypal"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/koduc_express_paypal.gemspec

@@ -0,0 +1,38 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'koduc_express_paypal/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "koduc_express_paypal"
+  spec.version       = KoducExpressPaypal::VERSION
+  spec.authors       = ["Koduc"]
+  spec.email         = ["ratan@ksolves.com"]
+
+  spec.summary       = "Gem deals with express checkout one time Paypal Payment using NVP Gateway."
+  spec.description   = "Ks Express Paypal is a simple gem used for Paypal Payment Gateway integration. This gem is written by KSolves. The main aim of this project is to deal with the one time Paypal payment using express checkout method using NVP(Name Value Pair)."
+  spec.homepage      = "https://github.com/kartiksolves/koduc-paypal-express"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  # end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+
+  # Add run time dependency of the following gems 
+  # required for building the express checkout using NVP
+  spec.add_dependency 'activesupport', '>=3.2'
+  spec.add_dependency "rest-client", '~> 1.4'
+end

data/lib/koduc_exception_handling/koduc_api_errors.rb

@@ -0,0 +1,25 @@
+# Module is loaded so as to raise the Api Errors 
+# Inherit from the StandardError class
+# StandardError deals with application level errors
+# Avoiding the risk of catching errors that deals with the environment
+# Instantiate the KsAPIErrors class and initialize the object's constructor
+# Call ks_error_messages method to provide a format to the Error messages raised through API
+
+
+module KsExceptionHandling
+	class KsAPIErrors < StandardError
+		
+		attr_accessor :ks_response 
+
+		def initialize(ks_response)
+			@response_array = []
+			@ks_response = ks_response
+		end 
+
+		def ks_error_messages
+			@response_array << ks_response
+			response = {success: false ,response:@response_array}
+		end
+
+	end			
+end

data/lib/koduc_express_paypal/koduc_check_environment.rb

@@ -0,0 +1,41 @@
+module KsCheckEnvironment
+
+	# Declare the Endpoints according to the environment
+	# Endpoints are required to make a post call through Rest Client
+	# the constant ks_production holds the endpoint for making API call with live credentials
+	# the constant ks_sandbox holds the endpoint for making API call with sandbox credentials
+	KSENDPOINT = 
+		{ 
+			:ks_production=> 'https://api-3t.paypal.com/nvp',
+			:ks_sandbox=> 'https://api-3t.sandbox.paypal.com/nvp'
+		}
+
+	# @@ks_sandbox : A class variable that will decide the environment
+	# Set boolean value for this variable before making an API call
+	# Default is set for sandbox
+	# true for sandbox
+	# false for production
+	@@ks_sandbox = true
+
+	# Call this method to check the value of ks_sandbox variable after initialization
+	def self.ks_sandbox?
+		@@ks_sandbox
+	end
+
+	# Call this method to set the environment 
+	# pass ks_boolean_value as true for sandbox 
+	# And false for Live environemnt
+	def self.ks_sandbox(ks_boolean_value)
+		@@ks_sandbox = ks_boolean_value
+	end
+
+	# Invoke this method to set the endpoints according to the value of ks_sandbox variable
+	def self.ks_endpoint
+		if ks_sandbox?
+			KsCheckEnvironment::KSENDPOINT[:ks_sandbox]
+		else
+			KsCheckEnvironment::KSENDPOINT[:ks_production]	
+		end
+	end
+
+end	

data/lib/koduc_express_paypal/koduc_request.rb

@@ -0,0 +1,144 @@
+# Module is loaded for making requests
+# Initialize the object's constructor first
+# version 				:=> 	Version of the API used
+# params 				:=> 	To hold the parameters passed by the gem user
+# payment_amount		:=>		To hold the amount passed by the user 
+# payment_action 		:=>		To hold the action of the payment. default it is 'SALE'
+# payment_currency      :=>     Currency used ex: USD
+# cancel_url			:=>		URL to which the user is redirected when he/she cancels the payment
+# return_url			:=>     URL to which the user is redirected upon the successful completion of the payment
+
+module KsExpressPaypal
+	class KsRequest
+
+		attr_accessor :version, :params, :payment_amount, :payment_action, :payment_currency, :cancel_url, :return_url
+
+		def initialize(params)
+			@payment_amount = params[:payment_amount]
+			@payment_action = params[:payment_action]
+			@payment_currency = params[:payment_currency]
+			@cancel_url = params[:cancel_url]
+			@return_url = params[:return_url]
+		end
+
+		# Method to check the endpoint 
+		# The value is calculated according to the user's choice
+		def self.ks_endpoint
+			ks_env = KsCheckEnvironment.ks_endpoint
+		end
+		
+		# Method to dissociate the payment details passed by the user
+		# The parameters are dissociate so that they can be easily utilised in the further API call
+		def ks_payment_details
+	      	ks_payment_details = {
+	      		  :PAYMENTREQUEST_0_AMT => payment_amount,
+				  :PAYMENTREQUEST_0_PAYMENTACTION => payment_action,
+				  :PAYMENTREQUEST_0_CURRENCYCODE => payment_currency
+	      	}
+	      	return ks_payment_details
+		end
+
+		# Method to fetch the Redirect URLS
+		def ks_redirect_urls
+		    ks_redirect_urls = {
+		      		:cancelUrl=> cancel_url,
+		      		:returnUrl=> return_url
+		      	}
+		    return ks_redirect_urls
+		end
+
+		# Method to check the validity of the parameters before they are passed to the API call
+		# Initialize the KsValidation class object's constructor present in the KsAPIValidation module
+		# Initialize with the details send by the user through the app
+		# The method will return true if everything is properly validated
+		# Else it will return the response generated
+		# Format of the response "response = {success:true/false,response:[error message]}"
+		# Error message in case success is false
+		# For true value of success it is blank
+		# Will have to validate by the user
+		def valid?
+			validation_obj = KsAPIValidation::KsValidation.new(KsExpressPaypal.ks_merchants_details,ks_payment_details,ks_redirect_urls)
+			response = validation_obj.check_validity
+			return response		
+		end
+
+		# SetExpressCheckout method will set the express checkout method
+		# Parameters : Merchant details, payment details and the redirect urls
+		# Method will return a Token that will be utilised further on successful completion
+		# For any error message an error response will be generated
+		# Format of the error response "response = {success:false,response:[error message]}"
+		# Format of the success response "response = {success:true,response:[response generated by Paypal]}"
+		# Call ks_request method everytime for making a request to the API
+		def ks_set_express_checkout
+			ks_response = KsExpressPaypal::KsRequest.ks_request :SetExpressCheckout,KsExpressPaypal.ks_merchants_details.merge(ks_payment_details).merge(ks_redirect_urls)	
+		end
+
+		# The app must invoke this method after the user redirection to the paypal's site
+		# GetExpressCheckoutDetails method will return the details of the checkout 
+		# It will return the Payer id on successful invocation of the API utilised further
+		# For any error message an error response will be generated
+		# Format of the error response "response = {success:false,response:[error message]}"
+		# Format of the success response "response = {success:true,response:[response generated by Paypal]}"
+		def self.ks_checkout_details(ks_token)
+			ks_response = ks_request :GetExpressCheckoutDetails,KsExpressPaypal.ks_merchants_details.merge(:TOKEN=>ks_token)
+		end	
+
+		# Call this method for completing the checkout 
+		# Pass the token, payer_id and token as the parameters
+		# Returns the response in the format written same as the above API
+		# Firstly call GetExpressCheckoutDetails to find out the details of the checkout
+		# If the required details are found it will call DoExpressCheckoutPayment method to do the complete process else will return the error message.
+		def self.ks_do_checkout(ks_token,ks_payment_action,ks_payer_id)
+			ks_response = ks_request :GetExpressCheckoutDetails,KsExpressPaypal.ks_merchants_details.merge(:TOKEN=>ks_token)
+			if ks_response[:response][0].is_a? Hash
+				ks_do_checkout = ks_request :DoExpressCheckoutPayment,KsExpressPaypal.ks_merchants_details.merge({
+	      		  :PAYMENTREQUEST_0_AMT => ks_response[:response][0][:PAYMENTREQUEST_0_AMT],
+				  :PAYMENTREQUEST_0_PAYMENTACTION => ks_payment_action,
+				  :PAYMENTREQUEST_0_CURRENCYCODE => ks_response[:response][0][:PAYMENTREQUEST_0_CURRENCYCODE]
+	      		}).merge(:TOKEN=>ks_token,:PAYERID=>ks_payer_id)
+	      	else 
+				return ks_response	      				
+	      	end			
+		end
+
+		# method that will make all the API request
+		# Call ks_handle_response method to handle each request
+		# ks_post_request for every post request
+		def self.ks_request(ks_method,ks_params)
+			ks_handle_response do
+				ks_response = ks_post_request ks_method,ks_params
+			end
+		end
+
+		# Call this method for post request through Rest Client 
+		# Pass endpoint calculated above with the parameters with the requested method
+		def self.ks_post_request(ks_method,ks_parameters)
+			RestClient.post(ks_endpoint,ks_parameters.merge(:METHOD=>ks_method))
+		end
+
+		# call this method to handle each response return through the Paypal API
+		# collect the response and decode using CGI parsing and form key value pair
+		# If the ACK is Success or SuccessWithWarning call the custom response with the response message returned
+		# Else return the Error message
+		def self.ks_handle_response
+				ks_response = yield
+				ks_response = CGI.parse(ks_response).inject({}) do |ks_res, (ks_key, ks_value)|
+		          	ks_res.merge(ks_key.to_sym => ks_value.first)
+		        end
+		        case ks_response[:ACK]
+	        		when 'Success', 'SuccessWithWarning'
+	          			success =  KsResponse.new(ks_response)
+	          			success.ks_success_messages
+	        		else
+	        			error_messages = ks_response[:L_LONGMESSAGE0]
+	          			error =  KsExceptionHandling::KsAPIErrors.new(error_messages)
+	          			error.ks_error_messages
+	        		end	
+			rescue => exc
+        		if !exc.message.nil?
+					error =  KsExceptionHandling::KsAPIErrors.new(exc.message)
+					error.ks_error_messages
+				end
+		end
+	end	
+end	

data/lib/koduc_express_paypal/koduc_response.rb

@@ -0,0 +1,15 @@
+# Return the custom response generated by Paypal APIS
+# Inherit the StandardError not Exception 
+class KsResponse < StandardError
+	attr_accessor :ks_response 
+
+	def initialize(ks_response)
+		@response_array = []
+		@ks_response = ks_response
+	end 
+
+	def ks_success_messages
+		@response_array << ks_response
+		response = {success: true ,response:@response_array}
+	end
+end

data/lib/koduc_express_paypal/koduc_validation.rb

@@ -0,0 +1,195 @@
+# Methods of the module will validate the parameters passed by the user
+# Initialise the object's constructor of the class
+# ks_merchants_details 	=>		For holding the paypal credentials
+# ks_payment_details	=>		For holding the payment details
+# ks_redirect_urls		=>		For holding the redirect URLS
+# ks_error				=>		Array for holding the error messages
+
+module KsAPIValidation
+	class KsValidation
+
+		attr_accessor :ks_merchants_details, :ks_payment_details, :ks_redirect_urls, :ks_error
+
+		def initialize(ks_merchants_details,ks_payment_details,ks_redirect_urls)
+			@ks_merchants_details = ks_merchants_details
+			@ks_payment_details = ks_payment_details
+			@ks_redirect_urls = ks_redirect_urls
+			@ks_error = []
+		end
+
+
+		# It is the first method that is to be called to check the validity of the parameters
+		# The method invokes all the methods of validation and return true if the parameters are verified 
+		def check_validity
+			success = true
+			if !empty_values? 
+				success = false
+			else
+				success = false if !paypal_credentials? 
+				success = false if !mandatory_paypal_details? 
+				success = false if !mandatory_payment_details? 
+				success = false if !mandatory_url_details? 
+				success = false if !check_payment_amount? 
+				success = false if !payment_number? 
+				success = false if !payment_action? 
+				success = false if !currency_code? 
+			end
+			response = validate_response(success)
+			return response	
+		end
+
+		# It returns the response in both the cases (success or failure)
+		# The format of response is {success: true/false, error_messages: array of the error messages(blank if success is true)}
+		# Check the uniqueness of the array of the error messages with uniq keyword
+		def validate_response(success)
+			unique_errors = ks_error.uniq
+			response = {success:success,response:unique_errors}	
+			return response
+		end
+
+		# The method below checks if the parameters passed are completely empty or not
+		# Returns true and false accordingly
+		def empty_values?
+			if ks_merchants_details.empty? 
+				ks_error << 'Missing Parameters : Paypal credentials are missing.'
+				puts "Check for Empty values is failed."
+				success = false
+			else
+				puts "Check for Empty values is successful."
+				success = true
+			end
+			return success		
+		end
+
+		# The method checks the keys passed by the user in the paypal credentials are correct or not.
+		# These are necessary else the API will through error
+		# Returns true and false accordingly 
+		# If false the Error message will be stored in the ks_error 
+		def paypal_credentials?
+			if [:USER, :PWD, :SIGNATURE].all? { |s| ks_merchants_details.key? s  }
+				success = true
+				puts "Check for the keys of Paypal Credentials is successful."
+			else
+				ks_error << 'Keys Missing : Some of the keys in Paypal credentials are missing.'
+				success = false
+				puts "Check for the keys of Paypal Credentials is failed."
+			end
+			return success
+		end
+
+		# Check if all the mandatory keys in the Paypal credentials have values
+		# Returns true or false accordingly
+		# Error message if false
+		def mandatory_paypal_details?
+		 	if ks_merchants_details[:USER].blank? || ks_merchants_details[:PWD].blank? || ks_merchants_details[:SIGNATURE].blank? || ks_merchants_details[:VERSION].blank?
+		 		ks_error << 'Paypal Credentials : Mandatory fields cannot be blank.'
+				success = false
+				puts "Check for the mandatory paypal credentials is failed."
+			else
+		 		success = true
+		 		puts "Check for the mandatory paypal credentials is successful."
+		 	end
+		 	return success
+		end
+
+		# Check if all the mandatory keys in the Payment have values
+		# Returns true or false accordingly
+		# Error message if false
+		def mandatory_payment_details?
+			if ks_payment_details[:PAYMENTREQUEST_0_AMT].blank? || ks_payment_details[:PAYMENTREQUEST_0_PAYMENTACTION].blank? || ks_payment_details[:PAYMENTREQUEST_0_CURRENCYCODE].blank?
+				ks_error << 'Payment Details : Mandatory fields cannot be blank.'
+				success = false
+				puts "Check for mandatory payment details is failed."
+			else
+				success = true
+				puts "Check for mandatory payment details is successful."
+			end
+			return success
+		end
+
+		# Check if all the mandatory keys in the Redirect URLS have values
+		# Returns true or false accordingly
+		# Error message if false
+		def mandatory_url_details?
+			if ks_redirect_urls[:cancelUrl].blank? || ks_redirect_urls[:returnUrl].blank?
+				ks_error << ' Redirect URLS : Mandatory fields cannot be blank.'
+				success = false
+				puts "Check for mandatory redirect urls is failed."
+			else
+				success = true
+				puts "Check for mandatory redirect urls is successful."
+			end
+			return success
+		end
+
+		# Invoke the below method to check if the payment amount is smaller than or equals to zero
+		# Returns the value of success accordingly
+		def check_payment_amount?
+			if !ks_payment_details[:PAYMENTREQUEST_0_AMT].blank?
+				amount = ks_payment_details[:PAYMENTREQUEST_0_AMT].to_i
+				if !(amount <= 0)
+					success = true
+					puts "Check for payment amount is successful"
+				else	
+					ks_error << "Payment Amount is invalid."
+					success = false
+					puts "Check for payment Amount is failed."
+				end
+				return success
+			end	
+		end
+
+		# Check if the string passed consists of only numbers and the decimal values 
+		# Returns true and false accordingly
+		# Returns the error message if success is false
+		def payment_number?	
+			if !ks_payment_details[:PAYMENTREQUEST_0_AMT].blank?
+				if ks_payment_details[:PAYMENTREQUEST_0_AMT] =~ /\A[-+]?\d*\.?\d+\z/
+					success = true
+					puts "Check for payment amount is successful."
+				else	
+					ks_error << "Payment Amount is invalid."
+					success = false
+					puts "Check for payment amount is failed."
+				end
+				return success
+			end	
+		end
+
+		# Check if the string passed consists of only alphabets and the decimal values 
+		# Returns true and false accordingly
+		# Returns the error message if false
+		def payment_action?
+			if !ks_payment_details[:PAYMENTREQUEST_0_PAYMENTACTION].blank?
+				if ks_payment_details[:PAYMENTREQUEST_0_PAYMENTACTION].match(/^[a-zA-Z]+$/)
+					success = true
+					puts "Check for payment action is successful."
+				else
+					ks_error << 'Payment Action is invalid.'
+					success = false
+					puts "Check for payment action is failed."
+				end	
+				return success	
+			end
+		end
+
+		# Check if the currency code is invalid (contains capital letters)
+		# Returns true and false accordingly
+		# Returns the error message
+		def currency_code?
+			if !ks_payment_details[:PAYMENTREQUEST_0_CURRENCYCODE].blank?
+				if ks_payment_details[:PAYMENTREQUEST_0_CURRENCYCODE].match(/^[A-Z]+$/)
+					success = true
+					puts "Check for currency code is successful."
+				else
+					ks_error << 'Currency Code is invalid'
+					success = false
+					puts "Check for currency code is failed."
+				end
+				return success
+			end
+			
+		end
+
+	end	
+end	

data/lib/koduc_express_paypal/version.rb

@@ -0,0 +1,7 @@
+# Version of the gems are described here as a constant
+# Change the VERSION before submitting to rubygems.org
+# For initial phase keep it as it is 
+
+module KoducExpressPaypal
+  VERSION = "1.0.0"
+end

data/lib/koduc_express_paypal.rb

@@ -0,0 +1,37 @@
+# This is the first file to be loaded when this gem is firstly installed
+# Require each file here
+
+require "koduc_express_paypal/version"
+require "koduc_express_paypal/koduc_check_environment"
+require "koduc_express_paypal/koduc_request"
+require "koduc_express_paypal/koduc_validation"
+require "koduc_exception_handling/koduc_api_errors"
+require "koduc_express_paypal/koduc_response"
+require "active_support"
+require "active_support/core_ext"
+require "rest_client"
+
+# Declare a constant api_version
+# This is the release version of the developing API used in this gem
+# One of the parameters mandatory for each call
+# No need to pass it from the user's side
+# Keep it here and change it from here
+module KsExpressPaypal
+ 	mattr_accessor :api_version
+ 	self.api_version = '88.0'
+ 	
+ 	# Method to take the paypal credentials
+	# The credentials must be included in the app 
+	# Merge the VERSION declared in the KsExpressPaypal module 
+	# Value of the VERSION is declared as constant 
+ 	def self.ks_merchants_details
+ 		begin
+			ks_merchants_details = Rails.configuration.paypal_credentials.merge(VERSION: KsExpressPaypal.api_version)
+		rescue => exc
+			if !exc.message.nil?
+				error =  KsExceptionHandling::KsAPIErrors.new(exc.message)
+				error.ks_error_messages
+			end
+		end
+	end
+end

metadata

@@ -0,0 +1,135 @@
+--- !ruby/object:Gem::Specification
+name: koduc_express_paypal
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Koduc
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-12-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.4'
+description: Ks Express Paypal is a simple gem used for Paypal Payment Gateway integration.
+  This gem is written by KSolves. The main aim of this project is to deal with the
+  one time Paypal payment using express checkout method using NVP(Name Value Pair).
+email:
+- ratan@ksolves.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- koduc_express_paypal.gemspec
+- lib/koduc_exception_handling/koduc_api_errors.rb
+- lib/koduc_express_paypal.rb
+- lib/koduc_express_paypal/koduc_check_environment.rb
+- lib/koduc_express_paypal/koduc_request.rb
+- lib/koduc_express_paypal/koduc_response.rb
+- lib/koduc_express_paypal/koduc_validation.rb
+- lib/koduc_express_paypal/version.rb
+homepage: https://github.com/kartiksolves/koduc-paypal-express
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.3
+signing_key: 
+specification_version: 4
+summary: Gem deals with express checkout one time Paypal Payment using NVP Gateway.
+test_files: []
+has_rdoc: