payza_payments 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3a2eb8ce7c8f9c67f7d01d9b96a3dd840d3c636f
+  data.tar.gz: 4f8d0ed3b043c50c59a7541ce54c04f7dd0036d3
+SHA512:
+  metadata.gz: 05756a59ad447e1330d0abfc977407fce2e6f53cd08b8565ad3eeb2c75dcc11856dd4a8bf67f0f4de77cbdd3ac733775648579f688c7df243acf438c376e5407
+  data.tar.gz: f39a10e68a5684923f687260a2d9b2a94e787bae39ed212827f300a072dcc63d4112804e300b9f96166312066742311a12f547fd160b5fe18f2ea6425557b7a1

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.idea/
+.DS_Store

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 2.0.0
+before_script: cd ./test/dummy/ && bundle install
+script: cd ./test/dummy/ && bundle exec rake spec

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Patricio Cano
+
+MIT License
+
+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,135 @@
+# PayzaPayments
+[![Build Status](https://travis-ci.org/FreedomVPN/liberty_reserve_payments.png?branch=master)](https://travis-ci.org/FreedomVPN/liberty_reserve_payments)
+
+Configure buttons for Payza based on your requirements and validate IPN requests sent by Payza.
+With this gem the user of your shop can pay for a digital item (or any type of item) and you can validate the transaction
+after it was made.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'payza_payments'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install payza_payments
+
+## Usage
+
+After the installation, you still need two files for the gem to work. A Yaml config file and an initializer.
+
+### config/payza.yml
+```yaml
+development:
+  ipn_security_code: xhs123457
+  merchant_email: sample@example.com
+  sandbox: true
+
+production:
+  ipn_security_code: xhs123457
+  merchant_email: sample@example.com
+  sandbox: false
+
+test:
+  ipn_security_code: xhs123457
+  merchant_email: sample@example.com
+  sandbox: true
+```
+
+### config/initializers/payza.rb
+```ruby
+require 'payza_payments'
+
+PAYZA_CONFIG = YAML.load_file("#{Rails.root}/config/payza.yml")[Rails.env].symbolize_keys
+```
+
+After creating these files you still need to add the methods provided by this gem to your PaymentsController.
+To do this you can add the following template methods to you file:
+
+```ruby
+def pay_item_with_payza
+    # With this you will pass the ButtonGenerator instance to the view
+    # in order to be able to get the button in your view with the correct
+    # parameters.
+    @payza = PayzaPayments::ButtonGenerator.new PAYZA_CONFIG
+    @invoice = Invoice.new(params[:invoice])
+end
+```
+
+There are two methods for generating buttons. `.generate_simple_button` and
+`.generate_subscription_button`. Both take similar parameters:
+```ruby
+# action points to the current view
+# order_id can be any identifier you want. It should allow you to match
+# the IPN request to something in your application.
+.generate_simple_button(action, purchase_type, item_name, amount, currency,
+                        return_url, cancel_url, item_description, order_id)
+
+# time_unit: can be 'Day', 'Week', 'Month', 'Year'
+# period_length: gives how long the subscription will be, depending on time_unit
+# it can go from 1 to 90.
+.generate_subscription_button(action, purchase_type, item_name, amount, currency,
+                              return_url, cancel_url, item_description, order_id,
+                              time_unit, period_length)
+```
+The code in the view may look like this (Haml example)
+```haml
+= @payza.generate_simple_button(self, :item, 'Sample item', 5, 'EUR', 'http://exa.co/success',
+                                'http://exa.co/cancel', 'Sample Desc', @invoice.id)
+
+```
+You should also add a route for Payza to send the IPN notifications. This gem supports both v1 and v2
+of Payza. PayzaPayments will only validate the basic verification parameters. After a successful validation
+you should still manually go through the parameters in order to match the payment to a corresponding order.
+
+It can point to a method looking like this:
+
+```ruby
+def validate_ipn_v2
+    handler = PayzaPayments::IpnHandler.new PAYZA_CONFIG
+    response = handler.handle_ipn_v2(params[:token])
+    if response == 'INVALID REQUEST'
+        # Response is not valid, log it and review it later
+    else
+        # The transaction has been successfully verified
+        # use the response hash to validate it has the
+        # correct data. You should use response['apc_1'] to
+        # fetch the order id, or any other parameter you passed
+        # on the view to validate against your DB.
+        invoice = Invoice.find(response['apc_1'])
+        if (response['ap_merchant'] == handler.merchant_email and
+           response['ap_status'] == 'Success' and response['ap_amount'] == invoice.amount)
+           # Now we know that the transaction was successful, the amount matches and
+           # the payment was sent to us. For a list of all the IPN variables go to
+           # https://dev.payza.com/resources/references/ipn-variables
+        else
+           # Something devious has happened!
+        end
+    end
+end
+
+def validate_ipn
+    handler = ...
+    response = handler.handle_ipn(params)
+    if response == true
+        # params[:ap_securitycode] and params[:ap_merchant] have already been
+        # validated. You should still validate the rest.
+    else
+        # INVALID
+    end
+end
+
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/payza_payments.rb

@@ -0,0 +1,23 @@
+require 'attr_required'
+require 'attr_optional'
+require 'payza_payments/version'
+require 'payza_payments/base'
+require 'payza_payments/ipn_handler'
+require 'payza_payments/button_generator'
+
+module PayzaPayments
+
+  def self.sandbox!
+    self.sandbox = true
+  end
+
+  def self.sandbox=(boolean)
+    @@sandbox = boolean
+  end
+
+  def self.sandbox?
+    @@sandbox
+  end
+  self.sandbox = false
+
+end

data/lib/payza_payments/base.rb

@@ -0,0 +1,17 @@
+module PayzaPayments
+  class Base
+    include AttrRequired, AttrOptional
+
+    attr_required :ipn_security_code, :merchant_email, :sandbox
+
+    def initialize(attributes = {})
+      if attributes.is_a?(Hash)
+        (required_attributes + optional_attributes).each do |key|
+          value = attributes[key]
+          self.send "#{key}=", value
+        end
+      end
+      attr_missing!
+    end
+  end
+end

data/lib/payza_payments/button_generator.rb

@@ -0,0 +1,41 @@
+#require 'action_view'
+module PayzaPayments
+  class ButtonGenerator < Base
+    include ActionView::Helpers
+
+    def initialize(attributes = {})
+      super
+    end
+
+    def generate_simple_button(action, purchase_type, item_name, amount, currency, return_url, cancel_url, item_description, order_id)
+      action.content_tag(:form, method: :post, action: 'https://secure.payza.com/checkout') do
+        common_tags(purchase_type, item_name, amount, currency, return_url, cancel_url, item_description, order_id)
+      end
+    end
+
+    def generate_subscription_button(action, purchase_type, item_name, amount, currency, return_url, cancel_url,
+                                     item_description, order_id, time_unit, period_length)
+      action.content_tag :form, method: :post, action: 'https://secure.payza.com/checkout' do
+        common_tags(purchase_type, item_name, amount, currency, return_url, cancel_url, item_description, order_id) +
+        tag(:input, type: :hidden, name: 'ap_timeunit', value: time_unit) +
+        tag(:input, type: :hidden, name: 'ap_periodlength', value: period_length)
+      end
+    end
+
+    private
+
+    def common_tags(purchase_type, item_name, amount, currency, return_url, cancel_url, item_description, order_id)
+      tag(:input, type: :hidden, name: 'ap_purchasetype', value: purchase_type) +
+      tag(:input, type: :hidden, name: 'ap_merchant', value: self.merchant_email) +
+      tag(:input, type: :hidden, name: 'ap_itemname', value: item_name) +
+      tag(:input, type: :hidden, name: 'ap_currency', value: currency) +
+      tag(:input, type: :hidden, name: 'ap_amount', value: amount) +
+      tag(:input, type: :hidden, name: 'ap_description', value: item_description) +
+      tag(:input, type: :hidden, name: 'ap_returnurl', value: return_url) +
+      tag(:input, type: :hidden, name: 'ap_cancelurl', value: cancel_url) +
+      tag(:input, type: :hidden, name: 'apc_1', value: order_id) +
+      tag(:input, type: :image,  name: 'ap_image', src: 'https://www.payza.com/images/payza-buy-now.png')
+    end
+
+  end
+end

data/lib/payza_payments/ipn_handler.rb

@@ -0,0 +1,44 @@
+require 'httparty'
+module PayzaPayments
+  class IpnHandler < Base
+
+    SANDBOX_IPN = 'https://sandbox.payza.com/sandbox/ipn2.ashx'
+    PRODUCTION_IPN = 'https://secure.payza.com/ipn2.ashx'
+
+    def initialize(attributes = {})
+      super
+    end
+
+    def handle_ipn(params)
+      if params[:ap_securitycode] == self.ipn_security_code and params[:ap_merchant] == self.merchant_email
+        true
+      else
+        false
+      end
+    end
+
+    def handle_ipn_v2(token)
+      validate_ipn(token) ? @response.parsed_response : 'INVALID REQUEST'
+    end
+
+    private
+
+    def validate_ipn(token)
+      if self.sandbox?
+        send_ipn_validation(token, SANDBOX_IPN)
+      else
+        send_ipn_validation(token, PRODUCTION_IPN)
+      end
+    end
+
+    def send_ipn_validation(token_value, url)
+      token = { token: token_value }
+      @response = HTTParty.post(url, token)
+      if @response.parsed_response == 'INVALID TOKEN'
+        false
+      else
+        true
+      end
+    end
+  end
+end

data/lib/payza_payments/version.rb

@@ -0,0 +1,3 @@
+module PayzaPayments
+  VERSION = '0.1.0'
+end

data/payza_payments.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'payza_payments/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'payza_payments'
+  spec.version       = PayzaPayments::VERSION
+  spec.authors       = ['Patricio Cano']
+  spec.email         = %w(admin@insomniware.com)
+  spec.description   = %q{Validate Payza IPN payments and create payment buttons}
+  spec.summary       = %q{You can generate buy now and subscription buttons for your application, and then
+                          validate the IPN request sent.}
+  spec.homepage      = 'https://github.com/supernova32/payza_payments'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = %w(lib)
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rspec-rails'
+  spec.add_dependency 'attr_required', '>= 0.0.5'
+  spec.add_dependency 'httparty', '>=0.10.0'
+  spec.add_dependency 'rails', '>=3.2.14'
+end

data/spec/payza_payments/button_generator_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+require 'action_view'
+
+class ButtonTest < ActionView::TestCase
+
+end
+
+describe PayzaPayments::ButtonGenerator do
+  let :attributes do
+    {ipn_security_code: 'U123456', merchant_email: 'support@freedomvpn.info', sandbox: true}
+  end
+
+  let :instance do
+    PayzaPayments::ButtonGenerator.new attributes
+  end
+
+  describe '.generate_simple_button' do
+
+    it 'should render a valid button' do
+      instance.generate_simple_button(ButtonTest.new, :item, 'test', 5, 'EUR', 'https://freedomvpn.info',
+      'https://freedomvpn.info', 'test', 1).should == '<form action="https://secure.payza.com/checkout" method="post"><input name="ap_purchasetype" type="hidden" value="item" /><input name="ap_merchant" type="hidden" value="support@freedomvpn.info" /><input name="ap_itemname" type="hidden" value="test" /><input name="ap_currency" type="hidden" value="EUR" /><input name="ap_amount" type="hidden" value="5" /><input name="ap_description" type="hidden" value="test" /><input name="ap_returnurl" type="hidden" value="https://freedomvpn.info" /><input name="ap_cancelurl" type="hidden" value="https://freedomvpn.info" /><input name="apc_1" type="hidden" value="1" /><input name="ap_image" src="https://www.payza.com/images/payza-buy-now.png" type="image" /><input name="ap_timeunit" type="hidden" value="Month" /><input name="ap_periodlength" type="hidden" value="12" /></form>'
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require 'rspec'
+require 'payza_payments'
+#require 'action_view/test_helper'
+#RSpec.configure do |config|
+#  config.include ActionView::TestCase::Behavior
+#end

data/test/dummy/.gitignore

@@ -0,0 +1,16 @@
+# See http://help.github.com/ignore-files/ for more about ignoring files.
+#
+# If you find yourself ignoring temporary files generated by your text editor
+# or operating system, you probably want to add a global ignore instead:
+#   git config --global core.excludesfile '~/.gitignore_global'
+
+# Ignore bundler config.
+/.bundle
+
+# Ignore the default SQLite database.
+/db/*.sqlite3
+/db/*.sqlite3-journal
+
+# Ignore all logfiles and tempfiles.
+/log/*.log
+/tmp

data/test/dummy/Gemfile

@@ -0,0 +1,54 @@
+source 'https://rubygems.org'
+
+# Bundle edge Rails instead: gem 'rails', github: 'rails/rails'
+gem 'rails', '4.0.0'
+
+# Use sqlite3 as the database for Active Record
+gem 'sqlite3'
+
+# Use SCSS for stylesheets
+gem 'sass-rails', '~> 4.0.0'
+
+# Use Uglifier as compressor for JavaScript assets
+gem 'uglifier', '>= 1.3.0'
+
+# Use CoffeeScript for .js.coffee assets and views
+gem 'coffee-rails', '~> 4.0.0'
+
+# See https://github.com/sstephenson/execjs#readme for more supported runtimes
+# gem 'therubyracer', platforms: :ruby
+
+# Use jquery as the JavaScript library
+gem 'jquery-rails'
+gem 'better_errors'
+gem 'binding_of_caller'
+gem 'rspec-rails'
+gem 'simplecov'
+gem 'capybara'
+gem 'shoulda-matchers'
+
+# Turbolinks makes following links in your web application faster. Read more: https://github.com/rails/turbolinks
+gem 'turbolinks'
+
+gem 'payza_payments', git: 'git@github.com:supernova32/payza_payments.git'
+gem 'haml-rails'
+
+# Build JSON APIs with ease. Read more: https://github.com/rails/jbuilder
+gem 'jbuilder', '~> 1.2'
+
+group :doc do
+  # bundle exec rake doc:rails generates the API under doc/api.
+  gem 'sdoc', require: false
+end
+
+# Use ActiveModel has_secure_password
+# gem 'bcrypt-ruby', '~> 3.0.0'
+
+# Use unicorn as the app server
+# gem 'unicorn'
+
+# Use Capistrano for deployment
+# gem 'capistrano', group: :development
+
+# Use debugger
+# gem 'debugger', group: [:development, :test]