vtweb_json 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ed044ee130377f58a8ca9e87ef8ea5474ba53132
+  data.tar.gz: c6d1203f233954872e81cafd3ccbbd75860838ee
+SHA512:
+  metadata.gz: d408d2fbc48ed25fdd5387920203e5dad6b8f5c42a77d8f57184ab4a290e004537b5a75bc61acced5ac056fb00ca4b83ea1fc9806a2ee55fbeae363f81494e8c
+  data.tar.gz: 5be42f911e4f7591fde9f0fd4daa2359d1efd273cad37d7548abaf5698432f54c696860764e150eacf41148779f09df5a02900adedc75d4385d849624c799709

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Panggi Libersa Jasri Akadol
+
+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,139 @@
+# Veritrans VT-Web Ruby wrapper using JSON request
+
+Ruby Wrapper for Veritrans VT-Web. Visit https://www.veritrans.co.id for more information about the product and see documentation at http://docs.veritrans.co.id/vtweb/index.html for more technical details.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'vtweb_json'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install vtweb_json
+
+## Usage
+
+In your Rails app, create 'vtweb.yml' at config directory (config/vtweb.yml) with this code:
+
+    development:
+      merchant_id: "T100000000000001XXXXXX"
+      merchant_hash_key: "yourmerchanthashkey"
+      unfinish_payment_return_url: "http://localhost:3000/cancel_pay"
+      finish_payment_return_url: "http://localhost:3000/finish"
+      error_payment_return_url: "http://localhost:3000/error"
+      vtweb_server: "http://127.0.0.1:4000"
+
+    production:
+      merchant_id: "A100000000000001XXXXXX"
+      merchant_hash_key: "yourmerchanthashkey"
+      unfinish_payment_return_url: "http://yourweb.com/canceled"
+      finish_payment_return_url: "http://yourweb.com/thank_you"
+      error_payment_return_url: "http://yourweb.com/shop_again"
+      
+Create a file in 'config/initializers' to set config to vtweb.yml, for example 'store_config.rb':
+    
+    raw_config = File.read("#{Rails.root}/config/vtweb.yml")
+    CONFIG = YAML.load(raw_config)[Rails.env].symbolize_keys
+ 
+      
+In your controller, create a method to use the gem. I took the code from https://github.com/veritrans/veritrans-rails-sample-cart for the example with some modification:
+
+    def confirm
+      client = ::VtwebJson::Client.new
+      client.order_id     = SecureRandom.hex(5)
+      client.merchant_hash_key = CONFIG[:merchant_hash_key]
+
+      # Example 
+      @carts = Cart.all
+      @total = Cart.select(:sub_total).sum(:sub_total)
+  
+      params["item"] = []    
+
+      @carts.each do |item|
+        params["item"] << { "item_id" => item.product_id, "price" => item.product.price.to_s, "quantity" => item.quantity.to_s, 
+                                  "item_name1" => item.product.name, "item_name2" => item.product.name }
+      end
+  
+      client.item    							= params["item"]
+      client.billing_different_with_shipping 	= 1
+      client.required_shipping_address 			= 1
+      client.first_name    						= params[:shipping_first_name]
+      client.last_name     						= params[:shipping_last_name]
+      client.address1      						= params[:shipping_address1]
+      client.address2      						= params[:shipping_address2]
+      client.city          						= params[:shipping_city]
+      client.country_code  						= "IDN"
+      client.postal_code   						= params[:shipping_postal_code]
+      client.phone         						= params[:shipping_phone]    
+      client.shipping_first_name    			= params[:shipping_first_name]
+      client.shipping_last_name     			= params[:shipping_last_name]
+      client.shipping_address1      			= params[:shipping_address1]
+      client.shipping_address2      			= params[:shipping_address2]
+      client.shipping_city          			= params[:shipping_city]
+      client.shipping_country_code  			= "IDN"
+      client.shipping_postal_code   			= params[:shipping_postal_code]
+      client.shipping_phone         			= params[:shipping_phone]  
+      client.email 							    = params[:email] 
+  
+      # Payment Options
+      client.promo_bins             			= ['411111', '510510']    
+      client.enable_3d_secure      				= 1
+      client.installment_banks      			= ['bni', 'cimb', 'mandiri']
+      client.installment_terms      			= { bni: [3,12,2], cimb: [3,6,12] }
+      client.point_banks            			= ['cimb', 'bni']
+      client.bank                   			= 'bni'
+      client.payment_methods        			= ['credit_card', 'mandiri_clickpay']
+
+      client.tokens
+      @client = client
+      @tokens = JSON.parse client.tokens.body
+      render :layout => 'application'
+    end
+    
+After you get TOKEN_BROWSER and TOKEN_MERCHANT, you have to send a http post request merchant_id, order_id and TOKEN_BROWSER to redirection url of vtweb. This code was also taken from https://github.com/veritrans/veritrans-rails-sample-cart :
+
+    <h1 align="center">Confirm Purchase Items</h1>
+    <%= form_tag(@client.redirection_url, :name => "form_auto_post") do -%>
+    	<input type="hidden" name="merchant_id" value="<%= @client.merchant_id %>"> 
+    	<input type="hidden" name="order_id" value="<%= @client.order_id %>">
+    	<input type="hidden" name="token_browser" value="<%= @tokens["token_browser"] %>">
+    	<table border="1" align="center" width="80%" cellpadding="10" bgcolor="#FFFFCC">
+      <tr>
+        <th>Name</th>
+        <th>Price</th>
+        <th>Quantity</th>
+        <th>Sub Total</th>    
+      </tr>
+      
+      <% for cart in @carts %>
+        <tr>
+          <td><%= cart.product.name %></td>
+          <td><%= cart.product.price %></td>
+          <td><%= cart.quantity %></td>
+          <td><%= cart.sub_total %></td>
+        </tr>    
+      <% end %>  
+      <tr>
+      	<td colspan="2"></td>
+      	<td style="text-align=right"><strong>Total</strong></td>
+      	<td style="text-align=right"><strong><%= @total %> </strong></td>
+      </tr>
+    	</table>
+    	<br><br>
+    	<div align="center">
+    	<input type="submit" value="Go to payment page">
+    	</div>
+    <% end %>
+
+## Contributing
+
+1. Fork it http://github.com/panggi/vtweb_json/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

data/Rakefile

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

data/lib/vtweb_json/config.rb

@@ -0,0 +1,47 @@
+require "yaml"
+
+module VtwebJson
+
+  module Config
+    
+    # Server
+    VTWEB_SERVER         = "https://vtweb.veritrans.co.id"
+    GET_TOKENS_URL       = "/v1/tokens.json"
+    REDIRECTION_URL      = "/v1/payments.json"
+
+    # Params Config
+    BILLING_DIFFERENT_WITH_SHIPPING = '0'
+
+    def Config.included(mod)
+      class <<self
+        template = {
+          'merchant_id' => nil,
+          'merchant_hash_key' => nil,
+          'finish_payment_return_url' => nil,
+          'unfinish_payment_return_url' => nil,
+          'error_payment_return_url' => nil,
+          'vtweb_server' => nil
+        }
+        
+        @@config_env = ::Object.const_defined?(:Rails) ? Rails.env : "development"
+        @@config = File.exists?("./config/vtweb.yml") ? YAML.load_file("./config/vtweb.yml") : {}
+        @@config['development'] = {} if !@@config['development']
+        @@config['production' ] = {} if !@@config['production']
+        @@config['development'] = template.clone.merge(@@config['development'])
+        @@config['production']  = template.clone.merge(@@config['production'])
+      end
+
+      mod.instance_eval <<CODE
+
+      def self.config_env=(env)
+        @@config_env = env
+      end
+
+      def self.config
+        @@config[@@config_env]
+      end 
+CODE
+
+    end
+  end
+end

data/lib/vtweb_json/merchant_hash_generator.rb

@@ -0,0 +1,7 @@
+module VtwebJson
+  module MerchantHashGenerator
+    def self.generate(merchant_id, merchant_hash_key, order_id)
+      Digest::SHA512.hexdigest("#{merchant_hash_key},#{merchant_id},#{order_id}")
+    end
+  end
+end

data/lib/vtweb_json/version.rb

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

data/lib/vtweb_json.rb

@@ -0,0 +1,135 @@
+$:.unshift File.dirname(__FILE__)
+
+# Required gems
+require 'jbuilder'
+require 'faraday'
+require 'digest/sha2'
+
+# Other Requirements
+require "vtweb_json/config"
+require "vtweb_json/merchant_hash_generator"
+require "vtweb_json/version"
+
+module VtwebJson
+  class Client
+    include Config
+    def initialize(&block)
+      class <<self
+        self
+      end.class_eval do
+      attr_accessor :version, :merchant_id, :merchant_hash_key, :order_id, :billing_different_with_shipping, :required_shipping_address,
+                    :repeat_line, :item_id, :item_name1, :item_name2, :price, :quantity, :shipping_address1, :shipping_address2, :shipping_city,
+                    :shipping_country_code, :shipping_first_name, :shipping_last_name, :shipping_phone, :shipping_postal_code, :email,
+                    :payment_methods, :enable_3d_secure, :address1, :address2, :city, :country_code, :first_name, :last_name, :phone, :postal_code,
+                    :finish_payment_return_url, :error_payment_return_url, :unfinish_payment_return_url, :bank, :installment_banks, :installment_terms,
+                    :point_banks, :promo_bins, :item  
+      end
+    end
+    
+    # Define params
+    
+    def vtweb_server
+      return Client.config["vtweb_server"] ? Client.config["vtweb_server"] : Config::VTWEB_SERVER
+    end
+    
+    def redirection_url
+      "#{vtweb_server}#{Config::REDIRECTION_URL}"
+    end
+    
+    def _merchant_id
+      return Client.config["merchant_id"]
+    end
+    
+    def _merchant_hash_key
+      return Client.config["merchant_hash_key"]
+    end
+    
+    def _error_payment_return_url
+      return Client.config["error_payment_return_url"]
+    end
+
+    def _finish_payment_return_url
+      return Client.config["finish_payment_return_url"]
+    end
+
+    def _unfinish_payment_return_url
+      return Client.config["unfinish_payment_return_url"]
+    end
+    
+    # Calculate Merchant Hash
+    
+    def merchanthash
+      return MerchantHashGenerator::generate(_merchant_id, _merchant_hash_key, self.order_id);
+    end
+    
+    # Build JSON from defined params
+    
+    def build_json
+
+      Jbuilder.encode do |json|
+        # Required Params
+        json.version 1
+        json.merchant_id _merchant_id
+        json.merchanthash merchanthash
+        json.order_id self.order_id
+        json.billing_different_with_shipping self.billing_different_with_shipping
+        json.required_shipping_address self.required_shipping_address
+        json.repeat_line self.item.length
+        self.item.each do |item|
+          json.item_id [item['item_id']]
+          json.item_name1 [item['item_name1']]
+          json.item_name2 [item['item_name2']]
+          json.price [item['price']]
+          json.quantity [item['quantity']]
+        end
+        
+        # Required if required_shipping_address = 1
+        json.shipping_address1 self.shipping_address1
+        json.shipping_address2 self.shipping_address2
+        json.shipping_city self.shipping_city
+        json.shipping_country_code self.shipping_country_code
+        json.shipping_first_name self.shipping_first_name
+        json.shipping_last_name self.shipping_last_name
+        json.shipping_phone self.shipping_phone
+        json.shipping_postal_code self.shipping_postal_code
+        json.email self.email
+        
+        # Optional Params
+        json.payment_methods self.payment_methods
+        json.enable_3d_secure self.enable_3d_secure
+        json.address1 self.address1
+        json.address2 self.address2
+        json.city self.city
+        json.country_code self.country_code
+        json.first_name self.first_name
+        json.last_name self.last_name
+        json.phone self.phone
+        json.postal_code self.postal_code
+        json.finish_payment_return_url _finish_payment_return_url
+        json.error_payment_return_url _error_payment_return_url
+        json.unfinish_payment_return_url _unfinish_payment_return_url
+        json.bank self.bank
+        json.installment_banks self.installment_banks
+        json.installment_terms self.installment_terms
+        json.point_banks self.point_banks
+        json.promo_bins self.promo_bins
+      end
+    end
+    
+    # Get Token
+    
+    def tokens
+      conn = Faraday.new(:url => vtweb_server) do |faraday|            
+        faraday.adapter  Faraday.default_adapter  
+      end
+      
+      response = conn.post do |request|
+        request.url GET_TOKENS_URL
+        request.headers['Content-Type'] = 'application/json'
+        request.headers['Accept'] = 'application/json'
+        request.body = build_json
+      end
+      
+    end  
+  end  
+end

data/vtweb_json.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'vtweb_json/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "vtweb_json"
+  spec.version       = VtwebJson::VERSION
+  spec.authors       = ["Panggi Libersa Jasri Akadol"]
+  spec.email         = ["panggi@me.com"]
+  spec.summary       = %q{Ruby wrapper for Veritrans VT-Web using JSON Request.}
+  spec.description   = %q{VT-Web makes accepting online payments simple because the whole payment process is handled by Veritrans, and we take care most of the information security compliance requirements from the bank (Veritrans is certified as a PCI-DSS Level 1 Service Provider). Merchants focus on their core business, while we take care of the rest.}
+  spec.homepage      = "https://github.com/panggi/vtweb-json"
+  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 = ["lib"]
+  
+  spec.add_runtime_dependency "faraday", "0.8.8"
+  spec.add_runtime_dependency "jbuilder", "1.5.3"
+  spec.add_runtime_dependency "rake"
+  spec.add_runtime_dependency "pry"
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification
+name: vtweb_json
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Panggi Libersa Jasri Akadol
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.8.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.8.8
+- !ruby/object:Gem::Dependency
+  name: jbuilder
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.5.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.5.3
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+description: VT-Web makes accepting online payments simple because the whole payment
+  process is handled by Veritrans, and we take care most of the information security
+  compliance requirements from the bank (Veritrans is certified as a PCI-DSS Level
+  1 Service Provider). Merchants focus on their core business, while we take care
+  of the rest.
+email:
+- panggi@me.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/vtweb_json.rb
+- lib/vtweb_json/config.rb
+- lib/vtweb_json/merchant_hash_generator.rb
+- lib/vtweb_json/version.rb
+- vtweb_json.gemspec
+homepage: https://github.com/panggi/vtweb-json
+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.0.0
+signing_key: 
+specification_version: 4
+summary: Ruby wrapper for Veritrans VT-Web using JSON Request.
+test_files: []