jpay 0.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d2ac5aa7a2da7f074f1c07f2867e68c530383bc7
+  data.tar.gz: 53e28aa9a257ed6e15a445161691b74f199cc693
+SHA512:
+  metadata.gz: 5c33aca71a43f2ac603692ecb8d22f51116578844dc201e137a9249bf1ec96f6d299fecc1c40a4ba281d65fbfbc9acf07e39616b6c20b55c2cdea73baa7f0a88
+  data.tar.gz: d875cf611b1a965ed348ee9553d1c3d863810dfc82be900361ddb5ae81a934d187d56cb05a3465eae75e1ce9057429eeebaa727338dbf49ee47c11fe083b49f8

data/.gitignore

@@ -0,0 +1,35 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 rezam90
+
+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/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Reza
+
+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,109 @@
+# Jpay
+
+### JahanPay payment gateway gem for rails
+
+the Jpay gem provides Ruby APIs for proccessing payments, transactions and verifications using JahanPay's Merchant APIs. For more information please visit [JahanPay](http://jahanpay.com) website
+
+##### NOTE: [Jpay](https://github.com/rezam90/jpay) is highly inspired by [Zarinpal](https://github.com/arashm/zarinpal) gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'jpay'
+```
+
+And then execute:
+
+```sh
+$ bundle
+```
+
+Or install it yourself as:
+
+```sh
+$ gem install jpay
+```
+
+## Configuration
+
+```sh
+rails g jpay:install
+```
+
+Configure 'config/initializers/jpay.rb':
+
+```ruby
+Jpay.configure do |config|
+
+  config.api = "xxxxx" # your jahanpay api
+  config.callback_url = "localhost:3000/verify"
+
+end
+```
+
+## Example
+
+Payment Request:
+
+```ruby
+class PurchaseController < ApplicationController
+  ...
+  def payment
+    ...
+    # payment request action
+    requeset = Jpay::PaymentRequest.new({
+      amount: 100, # must be in toman
+      order_id: 1, # your order id
+      text: 1, # any description for your order
+      # callback_url: 'localhost:3000/verifyProducts' #this is not needed as you already defined callback url in 'config/initializers/jpay.rb'
+      # but you can define it for every purchase if you want to have different callbacks for every purchase
+    })
+
+    response = request.pay
+    response.valid?
+    # if response is valid, it returns your jahanpay invoice number (response.invoice).
+    # you must redirect_to "http://jahanpay.com/pay_invoice/#{response.invoice}"
+    # or you can do as following:
+    redirect_to response.url if response.valid?
+    # this will redirect user to jahanpay.
+  end
+end
+```
+Payment Verification:
+
+```ruby
+class PurchaseController < ApplicationController
+  ...
+  # verify callback action
+  def verify
+    # jahanpay sends 'authority' code to your callback_url by GET method as 'au' param
+    authority_code = params[:au]
+
+    verification = Jpay::PaymentVerification.new({
+      amount: 100, # must be equal to request amount
+      authority: authority_code
+    })
+
+    response = verification.verify
+
+    response.status   # return 1 for successful transaction, error number for unsuccessful one
+    response.message  # returns status message
+    response.valid?   # returns 'true' for successful transaction
+  end
+
+end
+```
+
+## Contributing
+
+1. Fork it ( http://github.com/rezam90/jpay/fork )
+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
+
+
+##Copyright
+Copyright © 2015 Reza Morsali.

data/Rakefile

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

data/jpay.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'jpay/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "jpay"
+  spec.version       = Jpay::VERSION
+  spec.authors       = ["Reza Morsali"]
+  spec.email         = ["light.reza@gmail.com"]
+  spec.summary       = %q{JahanPay payment gem}
+  spec.description   = %q{JahanPay payment gem}
+  spec.homepage      = "https://github.com/rezam90/jpay"
+  spec.license       = "MIT"
+  spec.required_ruby_version = '~> 2.0.0'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "savon", "~> 2.11.1"
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/generators/jpay/install_generator.rb

@@ -0,0 +1,18 @@
+require 'rails/generators/base'
+
+module Jpay
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path("../../templates", __FILE__)
+      desc "Creates Jpay initializer for your application"
+
+      def copy_initializer
+        template "jpay_initializer.rb", "config/initializers/jpay.rb"
+        # puts "add your Jahanpay 'api' to config/initializers/jpay.rb"
+        # puts "add 'callback_url' to config/initializers/jpay.rb"
+        puts "Install complete!"
+
+      end
+    end
+  end
+end

data/lib/generators/templates/jpay_initializer.rb

@@ -0,0 +1,14 @@
+Jpay.configure do |config|
+
+  # your jahanpay api
+  config.api = "xxxxx"
+
+  # your callback_url: example:
+  # config.callback_url = verify_purchase_url
+  config.callback_url = "localhost:3000"
+  # you can send specific callback_url for every purchase if you want.
+  # this means every purchase can have it's own callback_url.
+  # you can do this by adding 'callback_url' arg to PaymentRequest.new() method
+  # along with other args (amount, callback_url, order_id, text)
+
+end

data/lib/jpay.rb

@@ -0,0 +1,35 @@
+require "jpay/version"
+require 'jpay/payment_request'
+require 'jpay/response'
+require 'jpay/payment_verification'
+require 'jpay/errors'
+
+module Jpay
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield configuration
+  end
+
+  # Configures the gem
+  #
+  # @example
+  #   Jpay.configure do |config|
+  #     config.merchant_id  = 'XXXXXXXX'
+  #     config.callback_url = 'http://example.com/call_back'
+  #     config.client       = 'http://www.jahanpay.com/webservice?wsdl'
+  #   end
+  class Configuration
+    attr_accessor :api, :callback_url, :client
+
+    def initialize
+      @api = 'randome-api-xyz'
+      @client = 'http://www.jahanpay.com/webservice?wsdl'
+      @callback_url = 'localhost:3000/verify'
+    end
+
+  end
+end

data/lib/jpay/errors.rb

@@ -0,0 +1,19 @@
+module Jpay
+  module Errors
+    IDS = {
+      '-32' => 'Amount does not match',
+      '-31' => 'Unsuccessful transaction',
+      '-30' => 'Invalid transaction',
+      '-29' => 'CallBack was not specified',
+      '-27' => 'your IP is blocked',
+      '-26' => 'Gateway is deactivated',
+      '-24' => 'Invalid amount',
+      '-23' => 'Too much amount',
+      '-22' => 'Amount should be greater than 100 Toman',
+      '-21' => 'Invalid IP for this Gateway',
+      '-20' => 'Invalid API',
+      '-6'  => 'Bank connection error',
+      '-9'  => 'System error',
+    }
+  end
+end

data/lib/jpay/payment_request.rb

@@ -0,0 +1,41 @@
+require "savon"
+
+module Jpay
+  class PaymentRequest
+
+    attr_accessor :amount, :order_id, :text
+    attr_reader   :response
+
+    # @note A hash of parametes should be send to this class
+    # @example
+    #   PaymentRequest.new(amount: 1000, callback_url: 'localhost:3000/verify', order_id: 12, text: 'sample text')
+    #
+    # @param args [Hash] hash of params to send requests
+    # @option args [Integer] :amount price in Toman
+    # @option args [String] :callback_url callback_url url for verification redirect
+    # @option args [Integer] :order_id your order id
+    # @option args [string] :text payment description
+
+    def initialize(args = {})
+      @amount   = args[:amount]
+      @callback_url = args[:callback_url] || Jpay.configuration.callback_url
+      @order_id = args[:order_id]
+      @text     = args[:text]
+      @client ||= Savon.client(wsdl: Jpay.configuration.client, pretty_print_xml: true)
+      @response = Response.new
+    end
+
+    def pay
+      response = @client.call :requestpayment, message: {
+        'api'      => Jpay.configuration.api,
+        'amount'   => @amount,
+        'callback' => @callback_url,
+        'orderid'  => @order_id,
+        'txt'      => @text
+      }
+
+      @response.validate(response.body)
+    end
+
+  end
+end

data/lib/jpay/payment_verification.rb

@@ -0,0 +1,34 @@
+require "savon"
+
+module Jpay
+  # Verifies transaction with jahanpay
+  class PaymentVerification
+    attr_reader :status
+
+    # @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 by verify url params
+    # @option args [Integer] :amount price of the request
+    def initialize(args = {})
+      @authority = args.fetch(:authority)
+      @amount    = args.fetch(:amount)
+      @client  ||= Savon.client(wsdl: Jpay.configuration.client, pretty_print_xml: true)
+      @response  = Response.new
+    end
+
+    # Send verification request to jahanpay
+    #
+    # @return [Jpay::Response]
+    def verify
+      response = @client.call :verification, message: {
+        'api' => Jpay.configuration.api,
+        'amount' => @amount,
+        'authority' => @authority,
+      }
+      @response.validate(response.body)
+    end
+  end
+end

data/lib/jpay/response.rb

@@ -0,0 +1,49 @@
+module Jpay
+  class Response
+    class ResponseError < RuntimeError; end
+    attr_reader :response, :invoice, :status, :url, :message
+
+    # 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[:requestpayment_response] || @response[:verification_response]
+      @status = body[:return].to_i
+      @message = Errors::IDS[body[:return]]
+
+      if body[:return].to_i < 0
+        @valid = false
+        # raise ResponseError, Errors::IDS[body[:return]]
+      elsif body[:return].to_i == 1
+        @valid = true
+        @message = "Successful transaction"
+      else
+        @valid = true
+        @invoice = body[:return]
+        @url = "http://www.jahanpay.com/pay_invoice/#{@invoice}"
+        @message = 'got invoice url'
+      end
+    end
+  end
+end

data/lib/jpay/version.rb

@@ -0,0 +1,3 @@
+module Jpay
+  VERSION = "0.0.3"
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: jpay
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+platform: ruby
+authors:
+- Reza Morsali
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-10-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: savon
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.11.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.11.1
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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'
+description: JahanPay payment gem
+email:
+- light.reza@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- jpay.gemspec
+- lib/generators/jpay/install_generator.rb
+- lib/generators/templates/jpay_initializer.rb
+- lib/jpay.rb
+- lib/jpay/errors.rb
+- lib/jpay/payment_request.rb
+- lib/jpay/payment_verification.rb
+- lib/jpay/response.rb
+- lib/jpay/version.rb
+homepage: https://github.com/rezam90/jpay
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: JahanPay payment gem
+test_files: []