kount 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MjI5YTNkMmZiZTcxYWVlMmU1MzUyZWViMjc0ZmIzN2Y0ZDc2ZWExOA==
+  data.tar.gz: !binary |-
+    NmFhNWQ2MzEzYzYyMzU5ZmJkZTRjN2ZmOGFiZTRiMTZjYjlmNjBkNw==
+SHA512:
+  metadata.gz: !binary |-
+    YTYwZTgxMmE2NjVlMjkxM2NmMWFmZTg2ZTk2YWRiYTYwYjA4OTA1MTlmMDdl
+    ZGZjOWM4MzUzYzRlMTI3YzcxOWZlNzg5Y2ZjZDc0NjhhMzQ2YTdjYmJlYjAz
+    Mzk2N2E4YWE2YmYxNjg5ZDkzM2VhOGM3M2FiMzlmNTg1NzI1N2E=
+  data.tar.gz: !binary |-
+    ODRkZjYzNThmM2UyZTNkN2IwMzY0ZTRkN2YyMWFlZTE0OWM0ODAzNWE4Y2Zh
+    MDg2NjlkMDEzYjg0YjNiOTU1NjYxZGQ2ODQ4ZjRmMmYxODViZWY5YTU1OGQ2
+    OGQ1NzBlNzFlMzIyNDEzMTI5ZThlZmFlZGQxM2Q0MTM5MGZhMTc=

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,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Don Pflaster
+
+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,122 @@
+# Kount
+
+Ruby interface for the Kount fraud detection service
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'kount'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install kount
+
+## Usage
+
+### Setup
+
+Set up your credentials that you configured within the Kount administrative interface.
+If you have a login for Kount, the folks at Kount should also have supplied you with a guide for generating your API and Risk Inquiry service certificates.  The ultimate result is a certificate and key file in .pem format.  There should be one of these each for the API and Risk Inquiry services, and for the test and production environments for a total of 8 files.
+
+Suggested set up for a Rails app (place in an initializer):
+
+    # Set custom variables within gem
+
+    if Rails.env == 'production'
+      # API certificate
+      Kount.api_cert = 'config/keys/awc.kount.net.cert.pem'
+      Kount.api_cert_key = 'config/keys/awc.kount.net.key.pem'
+
+      # Risk Inquiry System Certificate
+      Kount.ris_cert = 'config/keys/ris.kount.net.cert.pem'
+      Kount.ris_cert_key = 'config/keys/ris.kount.net.key.pem'
+
+      Kount.mode = :production
+    else
+      # API certificate
+      Kount.api_cert = 'config/keys/awc.test.kount.net.cert.pem'
+      Kount.api_cert_key = 'config/keys/awc.test.kount.net.key.pem'
+
+      # Risk Inquiry System Certificate
+      Kount.ris_cert = 'config/keys/ris.test.kount.net.cert.pem'
+      Kount.ris_cert_key = 'config/keys/ris.test.kount.net.key.pem'
+
+      Kount.mode = :test
+    end
+
+Also set up your merchant ID (this should also have been supplied to you by Kount):
+
+    Kount.merchant_id = '123456'
+
+### Making calls
+
+In the following example, I am updating the status of an order to Declined through an API call to the Orders status endpoint.
+The basic usage is to first create a payload hash:
+
+    payload = {
+      ['status[',kount_transaction_id,']'].join => 'D',
+      ['note[',kount_transaction_id,']'].join => text
+    }
+
+Then instantiate a Kount::Request object and call "transmit" on it.  Arguments:
+
+1: The symbol :api to indicate it is an API call, as opposed to the Risk Inquiry service which would be :risk
+2: The endpoint to call
+3: 'get' or 'post'
+4: The payload hash constructed in the previous step
+
+    ou = Kount::Request.new
+    ou.transmit(:api,'v1/orders/status.json','post',payload)
+
+### Risk Inquiry Service
+
+Since the Risk Inquiry service has a very specific set of inputs, the Kount::RiskInquiry class is a layer of abstraction which accepts all of the input fields described in the Kount docs as accessor methods.
+
+Instantiate the object:
+
+    ri = Kount::RiskInquiry.new
+
+Set all the necessary fields to make a successful call:
+
+    ri.mode = 'Q'  # Standard mode for initial post
+    ri.mack = 'Y'
+
+    ri.ipad = created_by_ip_address
+    ri.uniq = buyer.id
+    ri.name = buyer.name
+    # et cetera
+
+Array fields accept arrays.  You can set the array directly or iterate over another array you have prepared:
+
+    ri.prod_type = prods.map(&:name)
+
+    # or
+
+    ri.prod_type = []
+    prods.each { |prod|
+      ri.prod_type << prod.name
+    }
+
+Custom fields that you have configured within Kount can be passed as a hash:
+
+    ri.custom_fields = {
+      :customfield1  => 'value1',
+      :customfield2  => 'value2'
+    }
+
+Transmit the inquiry, which will return a Kount::Response object:
+
+    ri.request
+
+## Contributing
+
+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

data/Rakefile

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

data/kount.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'kount/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "kount"
+  spec.version       = Kount::VERSION
+  spec.authors       = ["Don Pflaster"]
+  spec.email         = ["don@ticketevolution.com"]
+  spec.description   = %q{Interfaces with Kount Endpoints}
+  spec.summary       = %q{}
+  spec.homepage      = ""
+
+  spec.add_dependency 'curb'
+  spec.add_dependency 'json'
+
+  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_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", ">= 2.0.0"
+end

data/lib/kount.rb

@@ -0,0 +1,23 @@
+require "kount/version"
+require 'kount/request'
+require 'kount/response'
+require 'kount/error'
+require 'kount/defaults'
+
+require 'curb'
+require 'json'
+
+module Kount
+  class << self
+    attr_accessor :api_cert
+    attr_accessor :api_cert_key
+    attr_accessor :ris_cert
+    attr_accessor :ris_cert_key
+    attr_accessor :mode
+    attr_accessor :merchant_id
+  # Your code goes here...
+  end
+end
+
+require 'kount/risk_inquiry'
+

data/lib/kount/defaults.rb

@@ -0,0 +1,12 @@
+module Kount
+  KOUNT_SERVER_URLS = {
+    :api => {
+      :test =>       'https://api.test.kount.net/rpc/',
+      :production => 'https://api.kount.net/rpc/'
+    },
+    :risk => {
+      :test =>       'https://risk.test.kount.net',
+      :production => 'https://risk.kount.net'
+    }
+  }
+end

data/lib/kount/error.rb

@@ -0,0 +1,11 @@
+module Kount
+  class Error
+    attr_accessor :error_object
+
+    def initialize(error = nil)
+      @error_object = error
+    end
+  end
+end
+
+

data/lib/kount/request.rb

@@ -0,0 +1,45 @@
+module Kount
+  class Request
+    def transmit(service_type,endpoint_url,get_or_post,query_params={})
+      url = [Kount::KOUNT_SERVER_URLS[service_type][Kount.mode],endpoint_url].join
+
+      Rails.logger.info ["Kount request: ",url].join if defined?(Rails)
+
+      c = Curl::Easy.new(url) do |curl|
+        curl.certtype = 'PEM'
+        if service_type == :api
+          curl.cert = Kount.api_cert
+          curl.cert_key = Kount.api_cert_key
+        elsif service_type == :risk
+          curl.cert = Kount.ris_cert
+          curl.cert_key = Kount.ris_cert_key
+        end
+        curl.connect_timeout = 5
+      end
+
+      if get_or_post.downcase == 'get'
+        c.http_get
+      elsif get_or_post.downcase == 'post'
+        c.http_post(get_post_fields(query_params))
+      end
+      Kount::Response.new(service_type,c)
+    rescue Exception => e
+      Kount::Error.new(e)
+    end
+
+    def get_post_fields(query_params)
+      fields = []
+      query_params.each { |k,v|
+        if v.is_a?(Array)
+          v.each { |element|
+            fields << Curl::PostField.content(k,element)
+          }
+        else
+          fields << Curl::PostField.content(k,v)
+        end
+      }
+      fields
+    end
+  end
+end
+

data/lib/kount/response.rb

@@ -0,0 +1,40 @@
+module Kount
+  class Response
+    attr_accessor :attributes
+    attr_reader :body
+
+    def initialize(service_type,response = nil)
+      raise ArgumentError, 'Missing response object' unless response
+      begin
+        if service_type == :api
+          @body = JSON.parse(response.body_str)
+        elsif service_type == :risk
+          @body = Hash[response.body_str.split("\n").map {|l| l.split("=") }]
+        end
+      rescue
+        raise ["Could not parse JSON response.  Raw response: ",response.body_str].join("\n")
+      end
+    end
+
+    def result
+      @body['result']
+    end
+
+    def count
+      @body['count']
+    end
+
+    def errors
+      @body['errors']
+    end
+
+    def status
+      @body['status']
+    end
+
+    def is_risk_error?
+      @body['ERRO'].present?
+    end
+  end
+end
+

data/lib/kount/risk_inquiry.rb

@@ -0,0 +1,92 @@
+module Kount
+  class RiskInquiry < Request
+    MODES = ['Q','P','X','U']
+    REQUIRED_FIELDS = [
+      :anid, # Automatic Number Identification
+      :auth, # A or D, for accept or decline
+      :curr, # Country of currency submitted on order (USD)
+      :emal, # Customer's email
+      :ipad, # IP Address of Customer
+      :mack, # Merchant's acknowledgement to ship/process the order (Y)
+      :merc, # Merchant ID assigned to merchant by Kount
+      :mode, # Q, P, D, U
+      :ptok, # Payment token
+      :ptyp, # Payment type (CARD = Credit Card)
+      :sess, # Unique Session ID
+      :site, # Website Identifier of where order originated
+      :totl, # Total amount in currency (in pennies)
+      :tran, # Kount transaction ID (required for update modes U and X)
+      :vers  # Version of Kount
+    ]
+
+    REQUIRED_ARRAY_FIELDS = [
+      :prod_type, # High level item descriptions
+      :prod_item, # Typically the SKU
+      :prod_desc, # Specific description
+      :prod_quant, # Quantity of item purchased
+      :prod_price  # Price per unit item (in pennies)
+    ]
+    OPTIONAL_KEYS = [
+      :avst, # AVS Street (M, N, X)
+      :avsz, # AVS Zip (M, N, X)
+      :b2a1, # Billing address line 1
+      :b2a2, # Billing address Line 2
+      :b2cc, # Billing address Country
+      :b2ci, # Billing address City
+      :b2pc, # Billing Address Postal Code
+      :b2pn, # Bill-to Phone Number
+      :b2st, # Billing Address State/Province
+      :bpremise, #Bill-to premise for UK
+      :bstreet, # Bill-to street address for UK
+      :cash, # Total cash amount in currency submitted
+      :cvvr, # CVV response (M, N, X)
+      :dob, # Date of birth
+      :epoc, # Date customer account was created by merchant
+      :frmt, # Format of response (XML, JSON, YAML)
+      :gender, # M or F
+      :name, # Name submitted with order
+      :ordr, # Merchant's order number
+      :s2a1, # Shipping street address - Line 1
+      :s2a2, # Shipping street address - Line 2
+      :s2cc, # Shipping address - Country
+      :s2ci, # Shipping address - City
+      :s2em, # Shipping address - Email address
+      :s2nm, # Shipping address - Name
+      :s2pc, # Shipping address - Postal Code
+      :s2pn, # Shipping address - Ship-to Phone Number
+      :s2st, # Shipping address - State/Province
+      :shtp, # Shipping type
+      :spremise, # Ship-to premise for UK
+      :sstreet, # Ship-to Street for UK
+      :uniq, # Merchant assigned account number for consumer
+      :uagt # Consumer User-Agent HTTP Header
+    ]
+
+    (REQUIRED_FIELDS + REQUIRED_ARRAY_FIELDS + OPTIONAL_KEYS).each { |key| attr_accessor key }
+    attr_accessor :custom_fields                       # Hash
+
+    def initialize
+      @merc = Kount.merchant_id
+      @vers = Kount::API_VERSION
+      @custom_fields = {}
+    end
+
+    def payload
+      payload = {}
+      (REQUIRED_FIELDS + OPTIONAL_KEYS).each { |key|
+        payload[key.to_s.upcase] = self.send(key) unless self.send(key).nil?
+      }
+      (REQUIRED_ARRAY_FIELDS).each { |key|
+        payload[[key.to_s.upcase,'[]'].join] = self.send(key) unless self.send(key).nil?
+      }
+      custom_fields.each { |k,v|
+        payload.merge!({ ['UDF[',k.to_s.upcase,']'].join => v })
+      }
+      payload
+    end
+
+    def request
+      transmit(:risk,'','post',payload)
+    end
+  end
+end

data/lib/kount/version.rb

@@ -0,0 +1,4 @@
+module Kount
+  VERSION = "0.0.1"
+  API_VERSION = '0555'
+end

data/spec/kount/request_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+describe Kount::Request do
+  before do
+    Kount.cert = 'cert'
+    Kount.cert_key = 'cert_key'
+    @request = Kount::Request.new
+  end
+
+  it "requires a certificate and key" do
+    expect { Kount.cert }.to_not be_nil
+  end
+end

data/spec/kount/response_spec.rb

@@ -0,0 +1,12 @@
+require 'spec_helper'
+
+describe Kount::Response do
+  before do
+    Kount.cert = 'cert'
+    Kount.cert_key = 'cert_key'
+
+    request = Kount::Request.new
+    @response = request.process!
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+require 'rubygems'
+require 'bundler/setup'
+
+require 'kount'
+require 'json'
+
+RSpec.configure do |config|
+
+end
+
+def load_fixture(*filename)
+  #File.open(File.join('spec', 'data', *filename)).read
+end
+

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: kount
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Don Pflaster
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: curb
+  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: json
+  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.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+description: Interfaces with Kount Endpoints
+email:
+- don@ticketevolution.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- kount.gemspec
+- lib/kount.rb
+- lib/kount/defaults.rb
+- lib/kount/error.rb
+- lib/kount/request.rb
+- lib/kount/response.rb
+- lib/kount/risk_inquiry.rb
+- lib/kount/version.rb
+- spec/kount/request_spec.rb
+- spec/kount/response_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses: []
+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.1.11
+signing_key: 
+specification_version: 4
+summary: ''
+test_files:
+- spec/kount/request_spec.rb
+- spec/kount/response_spec.rb
+- spec/spec_helper.rb
+has_rdoc: