RubyGems - zarinpal - Versions diffs - 0.0.1 - Mend

zarinpal 0.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (57) hide show

checksums.yaml +7 -0
data/.gitignore +16 -0
data/.rspec +2 -0
data/Gemfile +4 -0
data/Guardfile +24 -0
data/LICENSE.txt +22 -0
data/README.md +29 -0
data/Rakefile +1 -0
data/doc/Zarinpal.html +338 -0
data/doc/Zarinpal/Configuration.html +445 -0
data/doc/Zarinpal/Errors.html +149 -0
data/doc/Zarinpal/PaymentRequest.html +805 -0
data/doc/Zarinpal/PaymentVerification.html +540 -0
data/doc/Zarinpal/Response.html +669 -0
data/doc/Zarinpal/Response/ResponseError.html +123 -0
data/doc/_index.html +184 -0
data/doc/class_list.html +54 -0
data/doc/css/common.css +1 -0
data/doc/css/full_list.css +57 -0
data/doc/css/style.css +338 -0
data/doc/doc/_index.html +88 -0
data/doc/doc/class_list.html +54 -0
data/doc/doc/css/common.css +1 -0
data/doc/doc/css/full_list.css +57 -0
data/doc/doc/css/style.css +338 -0
data/doc/doc/file_list.html +53 -0
data/doc/doc/frames.html +26 -0
data/doc/doc/index.html +88 -0
data/doc/doc/js/app.js +214 -0
data/doc/doc/js/full_list.js +178 -0
data/doc/doc/js/jquery.js +4 -0
data/doc/doc/method_list.html +53 -0
data/doc/doc/top-level-namespace.html +102 -0
data/doc/file.README.html +105 -0
data/doc/file_list.html +56 -0
data/doc/frames.html +26 -0
data/doc/index.html +105 -0
data/doc/js/app.js +214 -0
data/doc/js/full_list.js +178 -0
data/doc/js/jquery.js +4 -0
data/doc/method_list.html +191 -0
data/doc/top-level-namespace.html +112 -0
data/lib/zarinpal.rb +37 -0
data/lib/zarinpal/errors.rb +17 -0
data/lib/zarinpal/payment_request.rb +44 -0
data/lib/zarinpal/payment_verification.rb +34 -0
data/lib/zarinpal/response.rb +50 -0
data/lib/zarinpal/version.rb +3 -0
data/spec/lib/configuration_spec.rb +18 -0
data/spec/lib/errors_spec.rb +7 -0
data/spec/lib/payment_request_spec.rb +40 -0
data/spec/lib/payment_verification_spec.rb +41 -0
data/spec/lib/response_spec.rb +46 -0
data/spec/lib/version_spec.rb +7 -0
data/spec/spec_helper.rb +20 -0
data/zarinpal.gemspec +29 -0
metadata +206 -0

data/doc/top-level-namespace.html ADDED

@@ -0,0 +1,112 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<title>
+  Top Level Namespace
+    &mdash; Documentation by YARD 0.8.7.2
+</title>
+  <link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
+  <link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
+<script type="text/javascript" charset="utf-8">
+  hasFrames = window.top.frames.main ? true : false;
+  relpath = '';
+  framesUrl = "frames.html#!" + escape(window.location.href);
+</script>
+  <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
+  <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
+  </head>
+  <body>
+    <div id="header">
+      <div id="menu">
+    <a href="_index.html">Index</a> &raquo;
+    <span class="title">Top Level Namespace</span>
+  <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
+</div>
+      <div id="search">
+    <a class="full_list_link" id="class_list_link"
+        href="class_list.html">
+      Class List
+    </a>
+    <a class="full_list_link" id="method_list_link"
+        href="method_list.html">
+      Method List
+    </a>
+    <a class="full_list_link" id="file_list_link"
+        href="file_list.html">
+      File List
+    </a>
+</div>
+      <div class="clear"></div>
+    </div>
+    <iframe id="search_frame"></iframe>
+    <div id="content"><h1>Top Level Namespace
+</h1>
+<dl class="box">
+</dl>
+<div class="clear"></div>
+<h2>Defined Under Namespace</h2>
+<p class="children">
+      <strong class="modules">Modules:</strong> <span class='object_link'><a href="Zarinpal.html" title="Zarinpal (module)">Zarinpal</a></span>
+</p>
+</div>
+    <div id="footer">
+  Generated on Sat Mar  1 21:03:58 2014 by
+  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.8.7.2 (ruby-2.1.0).
+</div>
+  </body>
+</html>

data/lib/zarinpal.rb ADDED

@@ -0,0 +1,37 @@
+require 'zarinpal/version'
+require 'zarinpal/payment_request'
+require 'zarinpal/response'
+require 'zarinpal/payment_verification'
+require 'zarinpal/errors'
+# A library to send and verify transactions with Zaripal
+#
+# @see http://zarinpal.com/
+# @author {http://github.com/arashm Arash Mousavi}
+module Zarinpal
+  class << self
+    attr_accessor :configuration
+  end
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield configuration
+  end
+  # Configures the gem
+  #
+  # @example
+  #   Zarinpal.configure do |config|
+  #     config.merchant_id  = 'XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX'
+  #     config.callback_url = 'http://example.com/call_back'
+  #     config.client       = 'https://de.zarinpal.com/pg/services/WebGate/wsdl'
+  #   end
+  class Configuration
+    attr_accessor :merchant_id, :callback_url, :client
+    def initialize
+      @client = 'https://de.zarinpal.com/pg/services/WebGate/wsdl'
+    end
+  end
+end

data/lib/zarinpal/errors.rb ADDED

@@ -0,0 +1,17 @@
+module Zarinpal
+  # List of status code errors and description
+  module Errors
+    # List of status code errors and description
+    IDS = {
+      '-1'  => 'Insufficient information',
+      '-2'  => 'IP or Merchant Code is not correct',
+      '-3'  => 'Amount should be greater than 1000',
+      '-4'  => 'Insufficient',
+      '-11' => 'Requested response didn\'t find',
+      '-21' => 'No financial action found for this transaction',
+      '-22' => 'Unsuccessful transaction',
+      '-33' => 'Transaction price is not equal to payed amount',
+      '-54' => 'The request had archived'
+    }
+  end
+end

data/lib/zarinpal/payment_request.rb ADDED

@@ -0,0 +1,44 @@
+require "savon"
+module Zarinpal
+  # Sends a payment request to zarinpal
+  # @return [Zarinpal::Response]
+  class PaymentRequest
+    attr_accessor :amount, :description, :email, :mobile
+    attr_reader   :response
+    # @note A hash of parameters should be send to this class
+    # @example
+    #   PaymentRequest.new(amount: 10000, description: 'sth...', email: 'example@example.com')
+    #
+    # @param args [Hash] hash of params to send requests
+    # @option args [Integer] :amount price of the request
+    # @option args [Integer] :description description of transaction
+    # @option args [String] :email ('') email of buyer
+    # @option args [String] :mobile ('') mobile number of buyer
+    def initialize(args = {})
+      @amount      = args.fetch(:amount)
+      @description = args.fetch(:description)
+      @email       = args.fetch(:email, '')
+      @mobile      = args.fetch(:mobile, '')
+      @client      = Savon.client(wsdl: Zarinpal.configuration.client, pretty_print_xml: true)
+      @response    = Response.new
+    end
+    # Sends the payment request to Zarinpal
+    #
+    # @return [Zarinpal::Response]
+    def call
+      response = @client.call :payment_request, message: {
+        'MerchantID' => Zarinpal.configuration.merchant_id,
+        'Amount' => @amount,
+        'Description' => @description,
+        'Email' => @email,
+        'Mobile' => @mobile,
+        'CallbackURL' => Zarinpal.configuration.callback_url
+      }
+      @response.validate(response.body)
+    end
+  end
+end

data/lib/zarinpal/payment_verification.rb ADDED

@@ -0,0 +1,34 @@
+require "savon"
+module Zarinpal
+  # Verifyes transaction with Zarinpal
+  class PaymentVerification
+    attr_reader   :status, :refid
+    # @note A hash of parameters should be send to this class
+    # @example
+    #   PaymentVerification.new(authority: 'xxx-xxx', amount: 10000)
+    #
+    # @param args [Hash] hash of params to verify transaction
+    # @option args [String] :authority Authority code returned from PaymentRequest
+    # @option args [Integer] :amount price of the request
+    def initialize(args = {})
+      @authority = args.fetch(:authority)
+      @amount    = args.fetch(:amount)
+      @client    = Savon.client(wsdl: Zarinpal.configuration.client, pretty_print_xml: true)
+      @response  = Response.new
+    end
+    # Send verification request to Zarinpal
+    #
+    # @return [Zarinpal::Response]
+    def verify
+      response = @client.call :payment_verification, message: {
+        'MerchantID' => Zarinpal.configuration.merchant_id,
+        'Authority' => @authority,
+        'Amount' => @amount
+      }
+      @response.validate(response.body)
+    end
+  end
+end

data/lib/zarinpal/response.rb ADDED

@@ -0,0 +1,50 @@
+module Zarinpal
+  # This classs manages the returned response from PaymentVerification and
+  # PaymentRequest. If the response is not valid (the status is not code is 100 or 101)
+  # it will raise an error with the corresponding description.
+  class Response
+    class ResponseError < RuntimeError; end
+    attr_reader :response, :authority, :status, :refid
+    # Checks if the transaction response returned from PaymentRequest
+    # or PaymentVerification is valid
+    #
+    # @param [#response Hash]
+    # @raise [ArgumentError] if response is nil
+    # @raise [ResponseError] if response is not valid
+    # @return [Response]
+    def validate(response = nil)
+      @response = response
+      perform_validation
+      return self
+    end
+    # Returns the validation status of response
+    #
+    # @return [boolean]
+    def valid?
+      @valid
+    end
+    private
+    def perform_validation
+      raise ArgumentError, 'not a valid response' if @response.nil?
+      body       = @response[:payment_request_response] || @response[:payment_verification_response]
+      @authority = body[:authority]
+      @status    = body[:status].to_i
+      @refid     = body[:ref_id]
+      if not ['100', '101'].include?(body[:status])
+        @valid = false
+        raise ResponseError, Errors::IDS[body[:status]]
+      else
+        @valid = true
+      end
+    end
+  end
+end

data/lib/zarinpal/version.rb ADDED

@@ -0,0 +1,3 @@
+module Zarinpal
+  VERSION = "0.0.1"
+end

data/spec/lib/configuration_spec.rb ADDED

@@ -0,0 +1,18 @@
+require 'spec_helper'
+describe Zarinpal do
+  before do
+    Zarinpal.configure do |config|
+      config.merchant_id = '52fbc7f4-3ca4-4b40-88ee-287f5ee8a9d4'
+      config.callback_url = 'http://www.m0b.ir/verify.php'
+    end
+  end
+  it 'responses to merchant_id' do
+    expect(Zarinpal.configuration.merchant_id).to eq('52fbc7f4-3ca4-4b40-88ee-287f5ee8a9d4')
+  end
+  it 'responses to client with default value' do
+    expect(Zarinpal.configuration.client).to eq('https://de.zarinpal.com/pg/services/WebGate/wsdl')
+  end
+end

data/spec/lib/errors_spec.rb ADDED

@@ -0,0 +1,7 @@
+require 'spec_helper'
+describe Zarinpal::Errors do
+  it { respond_to(:IDS) }
+end

data/spec/lib/payment_request_spec.rb ADDED

@@ -0,0 +1,40 @@
+require 'spec_helper'
+describe Zarinpal::PaymentRequest do
+  include Savon::SpecHelper
+  let(:zarin) {
+    Zarinpal::PaymentRequest.new(
+    {
+      amount: 10000,
+      description: 'sth for test'
+    })
+  }
+  let(:uri) { 'https://de.zarinpal.com/pg/services/WebGate/wsdl' }
+  before(:all) do
+    savon.mock!
+    Zarinpal.configure do |config|
+      config.merchant_id = '52fbc7f4-3ca4-4b40-88ee-287f5ee8a9d4'
+      config.callback_url = 'http://example.com/callback_url'
+    end
+  end
+  after(:all) { savon.unmock! }
+  it 'responses to call' do
+    expect(zarin).to respond_to(:call)
+  end
+  it 'successfully calls the server' do
+    message = {"MerchantID"=>"52fbc7f4-3ca4-4b40-88ee-287f5ee8a9d4", "Amount"=>10000, "Description"=>"sth for test", "Email"=>"", "Mobile"=>"", "CallbackURL"=>"http://example.com/callback_url"}
+    savon.expects(:payment_request).with(message: message ).returns('<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="http://zarinpal.com/"><SOAP-ENV:Body><ns1:PaymentRequestResponse><ns1:Status>101</ns1:Status><ns1:Authority>"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"</ns1:Authority></ns1:PaymentRequestResponse></SOAP-ENV:Body></SOAP-ENV:Envelope>')
+    response = zarin.call
+    expect(response).to be_valid
+  end
+end

data/spec/lib/payment_verification_spec.rb ADDED

@@ -0,0 +1,41 @@
+require 'spec_helper'
+describe Zarinpal::PaymentVerification, focus: true do
+  include Savon::SpecHelper
+  let(:pv) {
+    Zarinpal::PaymentVerification.new(
+    {
+      authority: 'XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX',
+      amount: 10000
+    })
+  }
+  before(:all) do
+    savon.mock!
+    Zarinpal.configure do |config|
+      config.merchant_id = '52fbc7f4-3ca4-4b40-88ee-287f5ee8a9d4'
+    end
+  end
+  after(:all) { savon.unmock! }
+  it 'successfully verify the request' do
+    message = {"MerchantID"=>"52fbc7f4-3ca4-4b40-88ee-287f5ee8a9d4", "Authority"=>'XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX', "Amount"=>10000}
+    savon.expects(:payment_verification).with(message: message ).returns('<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="http://zarinpal.com/">
+      <SOAP-ENV:Body>
+        <ns1:PaymentVerificationResponse>
+          <ns1:Status>100</ns1:Status>
+          <ns1:RefID>22xxff33</ns1:RefID>
+        </ns1:PaymentVerificationResponse>
+      </SOAP-ENV:Body>
+    </SOAP-ENV:Envelope>')
+    response = pv.verify
+    expect(response).to be_valid
+    expect(response.refid).to eq('22xxff33')
+    expect(response.status).to eq(100)
+  end
+end

data/spec/lib/response_spec.rb ADDED

@@ -0,0 +1,46 @@
+require 'spec_helper'
+describe Zarinpal::Response do
+  let(:response) { Zarinpal::Response.new }
+  before(:all) do
+    Zarinpal.configure do |config|
+      config.merchant_id = '52fbc7f4-3ca4-4b40-88ee-287f5ee8a9d4'
+      config.callback_url = 'http://example.com/callback_url'
+    end
+  end
+  it 'responses to authority and status' do
+    expect(response).to respond_to :authority
+    expect(response).to respond_to :status
+  end
+  context 'Validation' do
+    it 'fails validation if response is nil' do
+      zarin = Zarinpal::Response.new
+      expect{ zarin.validate }.to raise_error(ArgumentError, 'not a valid response')
+    end
+    it 'fails if status is less than 0' do
+      response = { payment_request_response: {status: "-2" } }
+      zarin = Zarinpal::Response.new
+      expect { zarin.validate(response) }.to raise_error(Zarinpal::Response::ResponseError, 'IP or Merchant Code is not correct')
+      expect(zarin).to_not be_valid
+    end
+    it 'fails if authority is less than 36 character' do
+      response = { payment_request_response: {authority: "this-is-wrong"} }
+      zarin = Zarinpal::Response.new.validate response
+      expect(zarin).to_not be_valid
+    end
+    it 'is successful' do
+      response = { payment_request_response: {authority: "x" * 36, status: 100 } }
+      zarin = Zarinpal::Response.new.validate response
+      expect(zarin).to be_valid
+      expect(zarin.authority).to eq("x" * 36)
+    end
+  end
+end