beanstream 1.0.0.rc1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: abe714a2b18a419e345b2f43e52ce2aacfadc260
+  data.tar.gz: 7a42a8d0ee4870b12d79abbec7ee171441885de7
+SHA512:
+  metadata.gz: a3d415ae9448fe7717e59085c686b8b3f1a114c5ffdfc58d8a8fc0b4167c6e9b59abe71aaa02305dceabe8313440f60d3253dcce13fd53d353a1f3a801b40e95
+  data.tar.gz: fe7f78d9f92f5d06a198338dcc955007c72cc824e29865fffc84e6970745e4808efa2d088fef55996558693d48a02f537c627fd0d5cc1d47f63d3f6eb4bc2f41

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,6 @@
+source "https://rubygems.org"
+gemspec
+
+
+  gem 'rest-client', '~> 1.8.0'
+  gem 'shoulda'

data/Gemfile.lock

@@ -0,0 +1,66 @@
+PATH
+  remote: .
+  specs:
+    beanstream (1.0.0.rc1)
+      json (~> 1.8.1)
+      rest-client (~> 1.4)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (4.2.3)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    domain_name (0.5.24)
+      unf (>= 0.0.5, < 1.0.0)
+    ffi (1.9.10-x64-mingw32)
+    http-cookie (1.0.2)
+      domain_name (~> 0.5)
+    i18n (0.7.0)
+    json (1.8.3)
+    mime-types (2.6.1)
+    minitest (5.8.0)
+    netrc (0.10.3)
+    power_assert (0.2.4)
+    rake (10.4.2)
+    rest-client (1.8.0)
+      http-cookie (>= 1.0.2, < 2.0)
+      mime-types (>= 1.16, < 3.0)
+      netrc (~> 0.7)
+    rest-client (1.8.0-x64-mingw32)
+      ffi (~> 1.9)
+      http-cookie (>= 1.0.2, < 2.0)
+      mime-types (>= 1.16, < 3.0)
+      netrc (~> 0.7)
+    shoulda (3.5.0)
+      shoulda-context (~> 1.0, >= 1.0.1)
+      shoulda-matchers (>= 1.4.1, < 3.0)
+    shoulda-context (1.2.1)
+    shoulda-matchers (2.8.0)
+      activesupport (>= 3.0.0)
+    test-unit (3.1.3)
+      power_assert
+    thread_safe (0.3.5)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.1)
+    unf_ext (0.0.7.1-x64-mingw32)
+
+PLATFORMS
+  ruby
+  x64-mingw32
+
+DEPENDENCIES
+  beanstream!
+  rake
+  rest-client (~> 1.8.0)
+  shoulda
+  test-unit
+
+BUNDLED WITH
+   1.10.6

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Beanstream Digital River World Payments
+
+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,4 @@
+# Beanstream's Ruby SDK
+**NOTE! This SDK is currently under development and is not rated for production use.**
+
+If you would like to contribute to it and earn some cash from our code bounty program please contact bowens@beanstream.com

data/Rakefile

@@ -0,0 +1,7 @@
+require 'rake/testtask'
+
+task :default => [:test]
+
+Rake::TestTask.new do |t|
+  t.pattern = './test/**/*_test.rb'
+end

data/beanstream.gemspec

@@ -0,0 +1,26 @@
+#$:.unshift(File.join(File.dirname(__FILE__), 'lib'))
+
+
+Gem::Specification.new do |s|
+  s.name        = 'beanstream'
+  s.version     = '1.0.0.rc1'
+  s.date        = '2015-08-14'
+  s.summary     = "Beanstream Ruby SDK"
+  s.description = "Accept payments using Beanstream and Ruby"
+  s.authors     = ["Brent Owens", "Colin Walker", "Tom Mengda"]
+  s.email       = 'bowens@beanstream.com'
+  s.homepage    ='http://developer.beanstream.com'
+  s.license     = 'MIT'
+  
+  s.files = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- test/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ['lib']
+  
+  s.add_dependency('rest-client', '~> 1.4')
+  s.add_dependency('json', '~> 1.8.1')
+
+  s.add_development_dependency('shoulda', '~> 3.4.0')
+  s.add_development_dependency('test-unit')
+  s.add_development_dependency('rake')
+end

data/lib/beanstream.rb

@@ -0,0 +1,52 @@
+require 'beanstream/transaction'
+require 'beanstream/payments_api'
+require 'beanstream/profiles_api'
+require 'beanstream/reporting_api'
+require 'beanstream/util'
+require 'beanstream/exceptions'
+
+module Beanstream
+  
+  @url_prefix = "www"
+  @url_suffix = "api"
+  @url_base = "beanstream.com"
+  @url_version = "v1"
+  @ssl_ca_cert = File.dirname(__FILE__) + '/resources/cacert.pem'
+  @timeout = 80
+  @open_timeout = 40
+  
+  class << self
+    attr_accessor :merchant_id, :payments_api_key, :profiles_api_key, :reporting_api_key
+    attr_accessor :url_prefix, :url_base, :url_suffix, :url_version
+    attr_accessor :url_payments, :url_return, :url_void
+    attr_accessor :ssl_ca_cert, :timeout, :open_timeout
+  end
+  
+  def self.api_host_url()
+    "https://#{@url_prefix}.#{url_base}"
+  end
+  
+  def self.api_base_url()
+    "/#{url_suffix}/#{url_version}"
+  end
+  
+  def self.PaymentsAPI()
+    Beanstream::PaymentsAPI.new()
+  end
+  
+  def self.ProfilesAPI()
+    Beanstream::ProfilesAPI.new()
+  end
+  
+  def self.ReportingAPI()
+    Beanstream::ReportingAPI.new()
+  end
+end
+
+
+def run()
+  Beanstream.merchant_id = "300200578"
+  Beanstream.payments_api_key = "4BaD82D9197b4cc4b70a221911eE9f70"
+  result = Beanstream.PaymentsAPI().make_creditcard_payment(12.5)
+  puts "Payment result: #{result}"
+end

data/lib/beanstream/exceptions.rb

@@ -0,0 +1,71 @@
+module Beanstream
+
+  class BeanstreamException < StandardError
+    attr_reader :code, :category, :message, :http_status_code
+    def initialize(code=nil, category=nil, message=nil, http_status_code=nil)
+      @code = code
+      @category = category
+      @message = message
+      @http_status_code = http_status_code
+    end
+    
+    def is_user_error()
+      false
+    end
+    
+    def user_facing_message()
+      "There was an error processing your request. Please try again or use a different card."
+    end
+  end
+  
+  
+  class BusinessRuleException < BeanstreamException
+    def initialize(code, category, message, http_status_code)
+      super(code, category, message, http_status_code)
+    end
+  end
+  
+  class UnauthorizedException < BeanstreamException
+    def initialize(code, category, message, http_status_code)
+      super(code, category, message, http_status_code)
+    end
+  end
+  
+  class ForbiddenException < BeanstreamException
+    def initialize(code, category, message, http_status_code)
+      super(code, category, message, http_status_code)
+    end
+  end
+  
+  class InvalidRequestException < BeanstreamException
+    def initialize(code, category, message, http_status_code)
+      super(code, category, message, http_status_code)
+    end
+    
+    def is_user_error()
+      if (@category ==1)
+        true
+      elsif (@category == 3 && code == 52)
+        true
+      else
+        false
+      end
+    end
+    
+    def user_facing_message()
+      if (is_user_error())
+        return @message
+      else
+        super
+      end
+    end
+    
+  end
+  
+  class InternalServerException < BeanstreamException
+    def initialize(code, category, message, http_status_code)
+      super(code, category, message, http_status_code)
+    end
+  end
+  
+end

data/lib/beanstream/payments_api.rb

@@ -0,0 +1,161 @@
+require 'securerandom'
+
+module Beanstream
+
+  class PaymentMethods
+    CARD = "card"
+    CASH = "cash"
+    CHEQUE = "cheque"
+    TOKEN = "token"
+    PROFILE = "payment_profile"
+  end
+  
+  class PaymentsAPI < Transaction
+  
+    def self.generateRandomOrderId(prefix)
+      "#{prefix}_#{SecureRandom.hex(8)}"
+    end
+
+    
+    # Urls
+    
+    def make_payment_url
+      "#{Beanstream.api_base_url()}/payments/"
+    end
+    
+    def payment_returns_url(transaction_id)
+      "#{Beanstream.api_base_url}/payments/#{transaction_id}/returns"
+    end
+    
+    def payment_void_url(transaction_id)
+      "#{Beanstream.api_base_url}/payments/#{transaction_id}/void"
+    end
+    
+    def get_transaction_url(transaction_id)
+      "#{Beanstream.api_base_url}/payments/#{transaction_id}"
+    end
+    
+    #Payment Request Hash for making a payment with a Legato token
+    def getTokenPaymentRequestTemplate()
+      request = getPaymentRequestTemplate()
+      request[:payment_method] = PaymentMethods::TOKEN
+      request[:token] = {
+        :name => "",
+        :code => "",
+        :complete => true
+      }
+    end
+    
+    #Payment Request Hash for making a payment with a credit card number
+    def getCardPaymentRequestTemplate()
+      request = getPaymentRequestTemplate()
+      request[:payment_method] = PaymentMethods::CARD
+      request[:card] = {
+        :name => "",
+        :number => "",
+        :expiry_month => "",
+        :expiry_year => "",
+        :cvd => "",
+        :complete => true
+       }
+    end
+    
+    #Payment Request Hash for making a payment with a Payment Profile
+    def getProfilePaymentRequestTemplate()
+      request = getPaymentRequestTemplate()
+      request[:payment_method] = PaymentMethods::PROFILE
+      request[:token] = {
+        :customer_code => "",
+        :card_id => 1,
+        :complete => true
+      }
+    end
+    
+    # Base Payment Request Hash for making a payments
+    # Use one of getTokenPaymentRequestTemplate, getCardPaymentRequestTemplate, or getProfilePaymentRequestTemplate
+    # +Required parameters+:: :amount, :order_number, :payment_method, and one of [:card, :token, :payment_profile] if not paying for Cash or Cheque.
+    # Use PaymentMethods:: for the available payment_method options
+    def getPaymentRequestTemplate()
+      request = {
+        :order_number => "",
+        :amount => 0,
+        :language=> "",
+        :customer_ip=> "",
+        :term_url=> "",
+        :comments=> "",
+        :billing=> {
+          :name=> "",
+          :address_line1=> "",
+          :address_line2=> "",
+          :city=> "",
+          :province=> "",
+          :country=> "",
+          :postal_code=> "",
+          :phone_number=> "",
+          :email_address=> ""
+        },
+        :shipping=> {
+          :name=> "",
+          :address_line1=> "",
+          :address_line2=> "",
+          :city=> "",
+          :province=> "",
+          :country=> "",
+          :postal_code=> "",
+          :phone_number=> "",
+          :email_address=> ""
+        },
+        :custom=> {
+          :ref1=> "",
+          :ref2=> "",
+          :ref3=> "",
+          :ref4=> "",
+          :ref5=> ""
+        }
+      }
+    end
+    
+    #API operations
+    
+    # Make a payment. If the payment is approved the PaymentResponse will be returned. If for any reason
+    # the payment is declined or if there is a connection error an exception will be thrown.
+    # This will accept a PaymentRequest Hash as defined by getTokenPaymentRequestTemplate(), getCardPaymentRequestTemplate(),
+    # or getProfilePaymentRequestTemplate().
+    # +PreAuth+:: For a pre-auth you must set the 'complete' parameter of the Card, Token, or Profile to be 'false'.
+    def make_payment(payment)
+      val = transaction_post("POST", make_payment_url, Beanstream.merchant_id, Beanstream.payments_api_key, payment)
+    end
+    
+    def complete_preauth(transaciton_id, amount)
+      complete_url = make_payment_url+transaciton_id+"/completions"
+      completion = { :amount => amount }
+      val = transaction_post("POST", complete_url, Beanstream.merchant_id, Beanstream.payments_api_key, completion)
+    end
+
+    def self.payment_approved(payment_response)
+      success = payment_response['approved'] == "1" && payment_response['message'] == "Approved"
+    end
+    
+    def get_legato_token(card_info)
+      turl = "/scripts/tokenization/tokens"
+      result = Transaction.new().transaction_post("POST", turl, "", "", card_info)
+      token = result['token']
+    end
+
+    def get_transaction(transaction_id)
+      transaction_post("GET", get_transaction_url(transaction_id), Beanstream.merchant_id, Beanstream.payments_api_key)
+    end
+
+    def return_payment(transaction_id, amount)
+      data = { amount: amount }
+      transaction_post("POST", payment_returns_url(transaction_id), Beanstream.merchant_id, Beanstream.payments_api_key, data)
+    end
+
+    def void_payment(transaction_id, amount)
+      data = { amount: amount }
+      transaction_post("POST", payment_void_url(transaction_id), Beanstream.merchant_id, Beanstream.payments_api_key, data)
+    end
+  
+  end
+
+end