vsafe-ruby 0.2.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9554215e285634ed75d2a15ee084aee48fd4dc21
+  data.tar.gz: fc340a8c12c446ec0e6c168b9fcb777e3a7dd819
+SHA512:
+  metadata.gz: 15a2f77685b3c972eba40a1c1db35112f0ca56706048c6632889b0be2685bdbf3635307948177c407247b4b95712188cc62b169ae23513d3e78add18c1661c1e
+  data.tar.gz: 6668a08b8e4c50006814118e5ce1f8de165f7fc9eec840e84bbe3cb251255a3f6b0d41c29016564a43a67e0fd43c6bd3e5f26bfc9f6bfc3b29ac0f9bc65e9abf

data/README.md

@@ -0,0 +1,241 @@
+# VSafe
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'vsafe-ruby'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install vsafe-ruby
+
+## Configuration
+
+```ruby
+VSafe.configure do |config|
+  config.account_name = "YOUR VESTA ACCOUNT"
+  config.password = "YOUR VESTA PASSWORD"
+  config.sandbox = true # Sandbox mode, Default to true
+  config.request_timeout = 20 # Request timeout, default to 20
+end
+```
+
+Config can also be overridden when initializing a request client:
+
+```ruby
+client = VSafe::Client.new do |config|
+  config.sandbox = !Rails.env.production?
+  config.request_timeout = 3
+end
+```
+
+## Request & Response
+
+First, Setup a client for making request:
+
+```ruby
+client = VSafe::Client.new
+```
+
+##### Heartbeat request
+```ruby
+# Check if VSafe API is up or not
+client.heartbeat.success?
+
+```
+
+##### Get vesta session tags
+```ruby
+response = client.get_session_tags # => #<VSafe::Responses::GetSessionTags ...>
+
+# Response attributes
+response.org_id
+response.web_session_id
+```
+
+##### Authorize charge
+```ruby
+auth_params = {
+  TransactionID: "...",
+  ChargeAccountNumberToken: "...",
+  ChargeAmount: 10,
+  WebSessionID: "100_000000000", # Fingerprint generated by get_session_tags as part of ChargeSource::WEB transaction
+  PaymentDescriptor: "...",
+  ChargeSource: VSafe::ChargeSource::WEB, # Or VSafe::ChargeSource::PPD/VSafe::ChargeSource::TEL
+  RiskInformation: "...", # XML string for the transaction
+  IsTempToken: false,
+  CardHolderFirstName: "Foo",
+  CardHolderLastName: "Bar",
+  CardHolderAddressLine1: "...",
+  CardHolderAddressLine2: "...",
+  CardHolderCity: "...",
+  CardHolderRegion: "...",
+  CardHolderPostalCode: "...",
+  CardHolderCountryCode: "...",
+  ChargeCVN: 123, # Card's CVV
+  ChargeExpirationMMYY: "1221", # Card's expiration date in MMYY format
+  StoreCard: true # Get a permanent token or not
+}
+
+client.charge_authorize(params) # => #<VSafe::Responses::ChargeAuthorize ...>
+
+# Response attributes
+response.avs_result
+response.auth_result
+response.cvn_result
+response.charge_permanent_token
+response.payment_acquirer_name
+response.payment_id
+response.payment_status
+```
+
+##### Authorize charge
+
+Authorize a credit card charge attempt for later confirm usage.
+
+```ruby
+auth_params = {
+  TransactionID: "...",
+  ChargeAccountNumberToken: "...",
+  ChargeAmount: 10,
+  WebSessionID: "100_000000000", # Fingerprint generated by get_session_tags as part of ChargeSource::WEB transaction
+  PaymentDescriptor: "...",
+  ChargeSource: VSafe::ChargeSource::WEB, # Or VSafe::ChargeSource::PPD/VSafe::ChargeSource::TEL
+  RiskInformation: "...", # XML string for the transaction
+  IsTempToken: false,
+  CardHolderFirstName: "Foo",
+  CardHolderLastName: "Bar",
+  CardHolderAddressLine1: "...",
+  CardHolderAddressLine2: "...",
+  CardHolderCity: "...",
+  CardHolderRegion: "...",
+  CardHolderPostalCode: "...",
+  CardHolderCountryCode: "...",
+  ChargeCVN: 123, # Card's CVV
+  ChargeExpirationMMYY: "1221", # Card's expiration date in MMYY format
+  StoreCard: true # Get a permanent token or not
+}
+
+response = client.charge_authorize(params) # => #<VSafe::Responses::ChargeAuthorize ...>
+
+# Response attributes
+response.avs_result
+response.auth_result
+response.cvn_result
+response.charge_permanent_token
+response.payment_acquirer_name
+response.payment_id
+response.payment_status
+```
+
+##### Confirm charge
+
+This should coupled with `charge_authorize`, confirms the previous authorized charge attempt.
+
+```ruby
+auth_response = client.charge_authorize(auth_params)
+
+confirm_params = {
+  PaymentID: auth_response.payment_id,
+  ChargeAmount: auth_params[:ChargeAmount],
+  TransactionID: auth_params[:TransactionID]
+}
+
+response = client.charge_confirm(confirm_params) # => #<VSafe::Responses::ChargeConfirm ...>
+
+response.payment_status
+```
+
+##### Charge sale
+
+Directly charge credit card.
+
+```ruby
+charge_params = {
+                  #... Same as authorize charge params
+                }
+
+response = client.charge_sale(charge_params) # => #<VSafe::Responses::ChargeSale ...>
+
+# Response attributes
+response.avs_result
+response.auth_result
+response.cvn_result
+response.charge_permanent_token
+response.payment_acquirer_name
+response.payment_id
+response.payment_id_pk
+response.payment_status
+```
+
+##### Reverse payment
+
+Reverse a previously charged payment.
+
+```ruby
+params = {
+  RefundAmount: 10.0,
+  PaymentID: "...", # payment id from charge_confirm or charge_sale
+  TransactionID: "..." # transaction id passed-in in charge/auth params
+}
+
+response = client.reverse_payment(params) # => #<VSafe::Responses::ReversePayment ...>
+
+# Response attributes
+response.available_refund_amount
+response.payment_acquirer_name
+response.payment_id
+```
+
+##### Validate Credit card
+
+Check to see if a credit card is valid.
+
+```ruby
+params = {
+  TransactionID: "...",
+  ChargeAccountNumberToken: "...",
+  WebSessionID: "100_000000000", # Fingerprint generated by get_session_tags as part of ChargeSource::WEB transaction
+  IsTempToken: true,
+  StoreCard: true,
+  PaymentDescriptor: "...",
+  ChargeSource: VSafe::ChargeSource::WEB,
+  CardHolderFirstName: "Foo",
+  CardHolderLastName: "Bar",
+  CardHolderAddressLine1: "...",
+  CardHolderAddressLine2: "...",
+  CardHolderCity: "...",
+  CardHolderRegion: "...",
+  CardHolderPostalCode: "...",
+  CardHolderCountryCode: "...",
+  ChargeCVN: 123, # Card's CVV
+  ChargeExpirationMMYY: "1221", # Card's expiration date in MMYY format
+}
+
+response = client.validate_charge_account(params)
+
+response.avs_result
+response.auth_result
+response.cvn_result
+response.charge_permanent_token
+response.payment_acquirer_name
+response.payment_id
+response.payment_status
+```
+
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/vsafe-ruby/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 a new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+task default: :spec
+
+RSpec::Core::RakeTask.new

data/lib/vsafe.rb

@@ -0,0 +1,14 @@
+require "vsafe/client"
+require "vsafe/config"
+
+module VSafe
+  def self.configure(&block)
+    yield config
+
+    nil
+  end
+
+  def self.config
+    @config ||= Config.new
+  end
+end

data/lib/vsafe/auth_result.rb

@@ -0,0 +1,11 @@
+module VSafe
+  class AuthResult
+    INSUFFICENT_FUNDS = 1
+
+    attr_reader :code
+
+    def initialize(code)
+      @code = code.to_i
+    end
+  end
+end

data/lib/vsafe/avs_result.rb

@@ -0,0 +1,24 @@
+module VSafe
+  class AvsResult
+    AVS_NOT_PERFORMED = 5
+    NO_ADDRESS_SUPPLIED = 6
+    AVS_DATA_INVALID = 7
+    FOREIGN_ADDRESS_MATCH = 8
+    FOREIGN_ADDRESS_MISMATCH = 9
+    AVS_NOT_AVAILABLE = 10
+    AVS_POSTAL_CODE_AND_LOCALE_MATCH = 11
+    AVS_LOCALE_MATCH = 12
+    AVS_POSTAL_CODE_MATCH = 13
+    AVS_NOT_MATCHED = 14
+    FORIEGN_ISSUER_AVS_NOT_AVAILABLE = 16
+    AVS_SYSTEM_UNAVAILABLE = 24
+    AVS_PARTIAL_MATCH = 39
+    AMEX_AUTOMATED_ADDRESS_VERIFICATION = 2000
+
+    attr_reader :code
+
+    def initialize(code)
+      @code = code.to_i
+    end
+  end
+end

data/lib/vsafe/card_type.rb

@@ -0,0 +1,29 @@
+module VSafe
+  class CardType
+    AMERICAN_EXPRESS = 3
+    VISA = 4
+    MASTERCARD = 5
+    DISCOVER = 6
+    DINERS_CLUB = 7
+    OPTIMA = 10
+
+    HUMANIZED_NAMES = {
+      AMERICAN_EXPRESS => "American Express".freeze,
+      VISA => "Visa".freeze,
+      MASTERCARD => "MasterCard".freeze,
+      DISCOVER => "Discover".freeze,
+      DINERS_CLUB => "Diners Club".freeze,
+      OPTIMA => "Optima".freeze
+    }
+
+    attr_reader :code
+
+    def initialize(code)
+      @code = code.to_i
+    end
+
+    def description
+      HUMANIZED_NAMES[code]
+    end
+  end
+end

data/lib/vsafe/charge_source.rb

@@ -0,0 +1,12 @@
+module VSafe
+  class ChargeSource
+    # Use this to specify that the payment has been prearranged. This is used
+    # when the payment device has been validated or already had a successful
+    # charge against it. When this option is used, the ChargeCVN is not required.
+    PPD = "PPD"
+    # Use this to specify that the payment has been taken over the telephone.
+    TEL = "TEL"
+    # Use this to specify that the payment has been taken over the Web.
+    WEB = "WEB"
+  end
+end

data/lib/vsafe/client.rb

@@ -0,0 +1,101 @@
+require "vsafe/config"
+require "vsafe/charge_source"
+require "vsafe/response"
+require "vsafe/responses/get_session_tags"
+require "vsafe/responses/charge_authorize"
+require "vsafe/responses/charge_confirm"
+require "vsafe/responses/reverse_payment"
+require "vsafe/responses/charge_account_to_temporary_token"
+require "vsafe/responses/charge_sale"
+require "vsafe/responses/validate_charge_account"
+require "securerandom"
+require "uri"
+
+module VSafe
+  class Client
+    SANDBOX_FINGERPRINT_PATH = "ThreatMetrixUIRedirector".freeze
+    FINGERPRINT_PATH = "PaySafeUIRedirector".freeze
+    # We should only use JSONP_SERVICE_PATH for charge_acct_to_tempory_token call in web js.
+    JSONP_SERVICE_PATH = "GatewayProxyJSON/Service".freeze
+    SERVICE_PATH = "GatewayProxy/Service".freeze
+    REQUEST_CONTENT_TYPE = "application/json; charset=utf-8".freeze
+
+    attr_reader :config
+
+    def initialize
+      # dup config in case we need to override default settings
+      @config = VSafe.config.dup
+
+      yield config if block_given?
+    end
+
+    def get_session_tags
+      params = {
+        TransactionID: SecureRandom.uuid
+      }
+
+      VSafe::Responses::GetSessionTags.new(request(service_url("GetSessionTags"), params))
+    end
+
+    def charge_authorize(params)
+      VSafe::Responses::ChargeAuthorize.new(request(service_url("ChargeAuthorize"), params))
+    end
+
+    def charge_confirm(params)
+      VSafe::Responses::ChargeConfirm.new(request(service_url("ChargeConfirm"), params))
+    end
+
+    def reverse_payment(params)
+      VSafe::Responses::ReversePayment.new(request(service_url("ReversePayment"), params))
+    end
+
+    def heartbeat
+      VSafe::Response.new(request(service_url("HeartBeat")))
+    end
+
+    def charge_sale(params)
+      VSafe::Responses::ChargeSale.new(request(service_url("ChargeSale"), params))
+    end
+
+    def validate_charge_account(params)
+      VSafe::Responses::ValidateChargeAccount.new(request(service_url("ValidateChargeAccount"), params))
+    end
+
+    def service_url(endpoint = nil, jsonp = false)
+      parts = [
+        config.url,
+        jsonp ? JSONP_SERVICE_PATH : SERVICE_PATH
+      ]
+      parts << endpoint if endpoint
+
+      File.join(parts)
+    end
+
+    def fingerprint_url
+      @_fingerprint_url ||= URI.join(config.url, config.sandbox ? SANDBOX_FINGERPRINT_PATH : FINGERPRINT_PATH).to_s
+    end
+
+    private
+
+    def request(url, params = {})
+      options = {
+        timeout: config.request_timeout,
+        body: params.merge(
+          AccountName: config.account_name,
+          Password: config.password
+        ).to_json,
+        headers: {
+          "Content-Type" => REQUEST_CONTENT_TYPE
+        }
+      }
+
+      # The HTTPS endpoint for VSafe Sandbox has an outdated SSL version.
+      # We need to do this so that we can actually connect.
+      if config.sandbox
+        options[:ssl_version] = :TLSv1
+      end
+
+      response = HTTParty.post(url, options)
+    end
+  end
+end