payline.rb 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d6a93ff4570ea3a7de895a1bfdca21ca6dbd380b
+  data.tar.gz: 884f9aa6074c03d1bc7daabbc8671ba47fa8b1d0
+SHA512:
+  metadata.gz: 7eb44586b3884401ae5af19c28187fe729ea6cce3a0110a7ab619ffb44df0b3011aea2a31843b6d0f0e58eec74846e8389ecf8d26476e7f3f8303b12d4438112
+  data.tar.gz: bcf9e593562d33fb373a6e7f9f28f98ecaa59b5b2564144c8185cd356856917ea7b522882fa928b6e89ce1a5644c07a3fabc710fea5480a6ddd7b4386a65c81d

data/.gitignore

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

data/.rspec

@@ -0,0 +1 @@
+--color

data/.travis.yml

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

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,43 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+# directories %w(app lib config test spec features) \
+#  .select{|d| Dir.exists?(d) ? d : UI.warning("Directory #{d} does not exist")}
+
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), then you will want to move
+## the Guardfile to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+
+# Note: The cmd option is now required due to the increasing number of ways
+#       rspec may be run, below are examples of the most common uses.
+#  * bundler: 'bundle exec rspec'
+#  * bundler binstubs: 'bin/rspec'
+#  * spring: 'bin/rspec' (This will use spring if running and you have
+#                          installed the spring binstubs per the docs)
+#  * zeus: 'zeus rspec' (requires the server to be started separately)
+#  * 'just' rspec: 'rspec'
+
+guard :rspec, cmd: "bundle exec rspec" do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # Feel free to open issues for suggestions and improvements
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+  watch(%r{^lib/payline/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Arvin Jenabi
+
+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,128 @@
+# Payline
+
+Payline is an API client for handling payments with Payline.ir. You can easily integrate this gem to your ruby app - whether it's based on Rails or other frameworks - and make and verify your IRR payments.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'payline.rb'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install payline.rb
+
+## Usage
+
+### Configuration
+
+You must configure the gem as below before using it, with a valid API token:
+```ruby
+Payline.configure |config|
+  config.api_token = 'XXXXX-XXXXX-XXXXXXXX-XXXXXXXXX-XXXXXXXXXXXXXXXXXXXXX'
+end
+```
+You can get a valid api_token by signing up on Payline.ir.
+There are other options to configure if you need, see `lib/payline/configuration.rb` for more information.
+
+### Request to make a payment
+
+Initialize a payment request with a valid amount (must be bigger than 1000 IRR) and redirect_uri and then make the request by calling `request` on the object:
+
+```ruby
+payment = Payline::Charge.new(amount: 250000, redirect_uri: 'http://localhost:3000/payment')
+
+# Connects to the server to get an id_get.
+# Returns a Payline::Response if everything goes well or rises respective error for the situation.
+# See Errors Section for more information.
+response = payment.request
+
+# If the transaction was successful, you can get the address for the generated gateway:
+gateway = response.gateway
+
+# You can always check if the response is valid or not:
+response.valid?
+# => true
+```
+
+### Get the Confirmation for a payment
+
+You can request for a confirmation of a payment like below:
+
+```ruby
+confirmation = Payline::Confirmation.new(id_get: 34687545, trans_id: 5463466)
+
+# Connects to the server to validate a transaction.
+# Returns a Payline::Response if everything goes well or rises respective error for the situation.
+# See Errors Section for more information.
+response = confirmation.request
+
+# You can always check if the response is valid or not:
+response.valid?
+# => true
+```
+
+### Client Errors
+
+When a request fails, it raises a particular exception with a description.
+There are several exceptions that may show up:
+
+| Exception | Description |
+| --------- | ----------- |
+| PaylineError | Represents all Payline errors, catch this to catch all following exceptions . |
+| BadAPIToken | If the provided token was wrong or no api_token was provided |
+| BadAmount | If the requested amount was invalid or was not provided |
+| BadRedirectURI | If redirect_uri was not provided |
+| BadTransId | If provided trans_id was invalid |
+| BadIdGet | If provided id_get was wrong |
+| FailedTransaction |  If the transaction has failed |
+| InvalidResponse | If somehow it receives a bad/invalid response |
+| NotFoundError | If the requested gateway was not found |
+
+All errors inherit from ```Payline::PaylineError```, if you wish to catch all kinds of exceptions - and you should! - , try catching ```Payline::PaylineError``` and you'll be fine!
+
+#### Handling Errors
+
+The following piece of code should give you an idea of how to handle errors:
+
+```ruby
+begin
+  confirmation = Payline::Confirmation.new(id_get: 34687545, trans_id: 5463466)
+  response = confirmation.request
+rescue Payline::BadIdGet
+  # Invalid id_get was supplied to Payline's API
+  puts "Invalid id_get"
+rescue Payline::BadTransId
+  # Invalid trans_id was supplied to Payline's API
+  puts "Invalid trans_id"
+rescue Payline::FailedTransaction
+  # User failed to pay
+  puts "You've failed to pay the bill!"
+rescue Payline::PaylineError => e
+  # Handles all other kinds of errors
+  puts "System: #{e}"
+end
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/Arvinje/payline.
+
+Always write tests and make sure they're all green and remember:
+> In TDD we trust!
+
+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
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

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,7 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "payline"
+require "pry"
+
+Pry.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/lib/payline.rb

@@ -0,0 +1,17 @@
+require "payline/version"
+require "faraday"
+require "payline/configuration"
+require "payline/charge"
+require "payline/confirmation"
+require "payline/response"
+require "payline/errors"
+
+module Payline
+
+  # Payline.rb , version: 0.1
+  # Easily handle transactions with Payline.ir
+  # Author: Arvin Jenabi  (https://github.com/Arvinje)
+  # Homepage: https://github.com/Arvinje/payline.rb
+  # This is an unofficial gem and the author is not related to Payline.ir at all!
+  
+end

data/lib/payline/charge.rb

@@ -0,0 +1,41 @@
+module Payline
+
+  # Initialize a payment request:
+  # Payline::Charge.new(amount: AMOUNT, redirect_uri: 'REDIRECT_URI')
+  #
+  # Make the request by calling 'request' on the object:
+  # response = charge_instance.request
+  #
+  # If the request was successful, it returns an instance of Payline::Response with a true value for 'valid?'.
+  # Beware that in case of an error in payment, it'll rise a respective error based on the received response.
+  #
+  # You can generate the requested payment gateway address by calling 'gateway' on the object:
+  # response.gateway
+  #
+  # @example
+  #   payment = Payline::Charge.new(amount: 250000, redirect_uri: 'http://localhost:3000/payment')
+  #   response = payment.request
+  #   response.valid?
+  # => true
+  #   response.gateway
+  # => 'http://payline.ir/payment/gateway-79968'
+  #
+
+  class Charge
+    attr_accessor :amount, :redirect_uri
+
+    def initialize(options = {})
+      @connection = Payline.configuration.connection
+      @amount = options[:amount]
+      @redirect_uri = options[:redirect_uri]
+      @response = Response.new
+    end
+
+    def request
+      response = @connection.post Payline.configuration.charge_uri, { api: Payline.configuration.api_token, amount: @amount, redirect: @redirect_uri }
+      @response.body = response.body
+      @response.validate_request
+    end
+
+  end
+end

data/lib/payline/configuration.rb

@@ -0,0 +1,43 @@
+module Payline
+
+  # Start by setting the basic configurations
+  # You should get a valid api_token by signing up on Payline.ir
+  # There are other options to configure if you need, see below for more information.
+  #
+  # @example
+  #   Payline.configure do |config|
+  #     config.api_token = 'adxcv-zzadq-polkjsad-opp13opoz-1sdf455aadzmck1244567'
+  #   end
+
+  class Configuration
+    attr_accessor :main_uri, :charge_uri, :confirmation_uri, :api_token, :base_gateway
+    attr_reader :connection
+
+    def initialize
+      @main_uri = 'http://payline.ir'
+      @charge_uri = '/payment/gateway-send'
+      @confirmation_uri = '/payment/gateway-result-second'
+      @base_gateway = 'http://payline.ir/payment/gateway-'
+      @connection = initialize_faraday
+    end
+
+    private
+    def initialize_faraday
+      connection = Faraday.new(:url => @main_uri) do |config|
+        config.request  :url_encoded             # form-encode POST params
+        config.adapter  Faraday.default_adapter  # make requests with Net::HTTP
+      end
+      connection
+    end
+  end
+
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configure      # Accepts a block for configurations
+    self.configuration = Configuration.new
+    yield configuration
+  end
+
+end

data/lib/payline/confirmation.rb

@@ -0,0 +1,36 @@
+module Payline
+
+  # Initialize a confirmation request:
+  # Payline::Confirmation.new(id_get: ID_GET, trans_id: TRANS_ID)
+  #
+  # Make the request by calling 'request' on the object:
+  # confirmation_instance.request
+  #
+  # If the request was successful, it returns an instance of Payline::Response with a true value for 'valid?'.
+  # Beware that in case of an error in payment, it'll rise a respective error based on the received response.
+  #
+  # @example
+  #   confirmation = Payline::Confirmation.new(id_get: 34687545, trans_id: 5463466)
+  #   response = confirmation.request
+  #   response.valid?
+  # => true
+  #
+
+  class Confirmation
+    attr_accessor :id_get, :trans_id
+
+    def initialize(options = {})
+      @connection = Payline.configuration.connection
+      @id_get = options[:id_get]
+      @trans_id = options[:trans_id]
+      @response = Response.new
+    end
+
+    def request
+      response = @connection.post Payline.configuration.confirmation_uri, { api: Payline.configuration.api_token, id_get: @id_get, trans_id: @trans_id }
+      @response.body = response.body
+      @response.validate_confirmation
+    end
+
+  end
+end

data/lib/payline/errors.rb

@@ -0,0 +1,29 @@
+module Payline
+  # All Payline errors, catch this to catch all following exceptions
+  class PaylineError < StandardError; end
+
+  # If the provided token was wrong or no api_token was provided
+  class BadAPIToken < PaylineError; end
+
+  # If the requested amount was invalid or was not provided
+  class BadAmount < PaylineError; end
+
+  # If redirect_uri was not provided
+  class BadRedirectURI < PaylineError; end
+
+  # If provided trans_id was invalid
+  class BadTransId < PaylineError; end
+
+  # If provided id_get was wrong
+  class BadIdGet < PaylineError; end
+
+  # If the transaction has failed
+  class FailedTransaction < PaylineError; end
+
+  # If somehow it receives a bad/invalid response
+  class InvalidResponse < PaylineError; end
+
+  # If the requested gateway was not found
+  class NotFoundError < PaylineError; end
+
+end

data/lib/payline/response.rb

@@ -0,0 +1,65 @@
+module Payline
+  class Response
+    attr_accessor :body
+    attr_reader :valid, :gateway, :id_get
+
+    def initialize
+      @valid = false
+    end
+
+    def validate_request      # Respective to Payline::Charge
+      case @body
+      when '-1'
+        raise BadAPIToken, 'The API token is invalid'
+      when '-2'
+        raise BadAmount, 'The requested amount is invalid'
+      when '-3'
+        raise BadRedirectURI, 'Redirect URI is invalid (probably nil)'
+      when '-4'
+        raise NotFoundError, 'The requested gateway was not found'
+      else
+        raise InvalidResponse, 'Response is not valid' unless is_integer? @body   # If the response was a float
+        if @body.to_i > 0
+          @id_get = @body.to_i
+          generate_gateway
+          @valid = true
+        else
+          raise InvalidResponse, 'Response is not valid'
+        end
+      end
+      self
+    end
+
+    def validate_confirmation     # Respective to Payline::Confirmation
+      case @body
+      when '-1'
+        raise BadAPIToken, 'The API token is invalid'
+      when '-2'
+        raise BadTransId, 'The trans_id is invalid'
+      when '-3'
+        raise BadIdGet, 'The id_get is invalid'
+      when '-4'
+        raise FailedTransaction, 'The transaction has failed'
+      when '1'
+        @valid = true
+      else
+        raise InvalidResponse, 'Response is not valid'
+      end
+      self
+    end
+
+    def valid?    # To see if the request is valid or not
+      @valid
+    end
+
+    private
+    def generate_gateway  # To generate a gateway based on a valid id_get
+      @gateway = Payline.configuration.base_gateway + @id_get.to_s
+    end
+
+    def is_integer? string
+      true if Integer(string) rescue false
+    end
+
+  end
+end

data/lib/payline/version.rb

@@ -0,0 +1,3 @@
+module Payline
+  VERSION = "0.1.0"
+end

data/payline.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'payline/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "payline.rb"
+  spec.version       = Payline::VERSION
+  spec.authors       = ["Arvin Jenabi"]
+  spec.email         = ["Arvinje@gmail.com"]
+
+  spec.summary       = %q{An API client to make payments with Payline.ir}
+  spec.description   = %q{Easily integrate Payline.ir service to your app and accept IRR payments.}
+  spec.homepage      = "https://github.com/Arvinje/payline.rb"
+  spec.license       = "MIT"
+
+  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_dependency "faraday", '~> 0.9.1'
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.3.0"
+  spec.add_development_dependency "guard-rspec", "~> 4.6.4"
+  spec.add_development_dependency "terminal-notifier-guard", "~> 1.6.4"
+end

metadata

@@ -0,0 +1,146 @@
+--- !ruby/object:Gem::Specification
+name: payline.rb
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Arvin Jenabi
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-08-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+- !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: 3.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.6.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.6.4
+- !ruby/object:Gem::Dependency
+  name: terminal-notifier-guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.4
+description: Easily integrate Payline.ir service to your app and accept IRR payments.
+email:
+- Arvinje@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/payline.rb
+- lib/payline/charge.rb
+- lib/payline/configuration.rb
+- lib/payline/confirmation.rb
+- lib/payline/errors.rb
+- lib/payline/response.rb
+- lib/payline/version.rb
+- payline.gemspec
+homepage: https://github.com/Arvinje/payline.rb
+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.5.1
+signing_key: 
+specification_version: 4
+summary: An API client to make payments with Payline.ir
+test_files: []