fraudrecord 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8324882d5e84016b3e34e099d2efa34193b40b4c
+  data.tar.gz: 26736044fb731b660612ff3ccde5c1703bdd52de
+SHA512:
+  metadata.gz: ef41aa56bb74caa1dd6b4455a94335d191ac4e557760226682644a396d4a4954e99bdf1ee68e2bc8fa4e5b2dfbea411828e186d1e87ddfc9fd2a4872d53f3707
+  data.tar.gz: 16dfcdd82db34805e2f92a5ed31c4608c6128bc3509201a29b193b729eac14eae91c030f3f0fcf636d4790dd0cdec46d30d80991ffb16a8e514db77971c8254c

data/.gitignore

@@ -0,0 +1 @@
+pkg/

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/Gemfile.lock

@@ -0,0 +1,64 @@
+PATH
+  remote: .
+  specs:
+    fraudrecord (0.0.1)
+      activesupport
+      faraday (~> 0.9.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (4.2.0)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    addressable (2.3.8)
+    coveralls (0.7.2)
+      multi_json (~> 1.3)
+      rest-client (= 1.6.7)
+      simplecov (>= 0.7)
+      term-ansicolor (= 1.2.2)
+      thor (= 0.18.1)
+    crack (0.4.2)
+      safe_yaml (~> 1.0.0)
+    docile (1.1.5)
+    faraday (0.9.1)
+      multipart-post (>= 1.2, < 3)
+    i18n (0.7.0)
+    json (1.8.2)
+    mime-types (2.4.3)
+    minitest (5.3.5)
+    multi_json (1.11.0)
+    multipart-post (2.0.0)
+    rest-client (1.6.7)
+      mime-types (>= 1.16)
+    safe_yaml (1.0.4)
+    simplecov (0.8.2)
+      docile (~> 1.1.0)
+      multi_json
+      simplecov-html (~> 0.8.0)
+    simplecov-html (0.8.0)
+    term-ansicolor (1.2.2)
+      tins (~> 0.8)
+    thor (0.18.1)
+    thread_safe (0.3.5)
+    tins (0.13.2)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+    vcr (2.8.0)
+    webmock (1.8.11)
+      addressable (>= 2.2.7)
+      crack (>= 0.1.7)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  coveralls (~> 0.7.0)
+  fraudrecord!
+  minitest (~> 5.3.1)
+  simplecov (~> 0.8.2)
+  vcr (~> 2.8.0)
+  webmock (~> 1.8.0)

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2015 Sean Handley
+
+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,60 @@
+# Fraud Record
+
+Gem wrapper for [fraudrecord.com](https://fraudrecord.com).
+
+## Installing
+
+```
+gem install fraudrecord
+```
+
+or
+
+(in Gemfile or .gemspec)
+```ruby
+gem 'fraudrecord'
+```
+
+then
+
+```ruby
+require 'fraudrecord'
+```
+
+## Usage
+
+First, you will need to create an account on https://www.fraudrecord.com and make a reporter profile. This will create an API key for you. Expose this to your Ruby runtime in the form of an environment variable i.e.
+
+```
+export FRAUD_RECORD_API_KEY=f656a57c78
+```
+
+Secondly, call the `query` method with a Ruby hash of parameters containing the data you wish to query. This will automatically be salted and hashed before being submitted to Fraud Record.
+
+```ruby
+Fraudrecord.query name: 'Billy Jones', email: 'billy@fraudsters.com'
+=> {:value=>30, :count=>3, :reliability=>8.2, :report=>"https://www.fraudrecord.com/api/?showreport=2bbf78f6f8"}
+```
+
+Fraud Record accepts variables as long as the variable name consists of [a-z] characters, 16 characters max. Uppercase variables will be converted to lowercase internally. The dash (hyphen) character is also accepted. For example, "paypal-email" is a valid variable name.
+
+There is also a common set of accepted variables to choose from:
+
+| Variable Name | Description                                                 |
+|---------------|-------------------------------------------------------------|
+| name          | Client name.                                                |
+| password      | Client password. Usually a good indicator of identity.      |
+| company       | Company name which the client inputs.                       |
+| email         | Client's email address.                                     |
+| address       | Client's postal address.                                    |
+| phone         | Client's phone number.                                      |
+| ip            | Client's registration IP address.                           |
+| hostname      | Hostname for server clients.                                |
+| accountuser   | Hosting account username.                                   |
+| accountpass   | Hosting account password.                                   |
+| domain        | Domain name of the hosting client.                          |
+| payment       | Payment processor identification, e.g. paypal email address |
+| ccname        | Name on credit card                                         |
+| ccnumber      | Credit card number.                                         |
+
+To learn more, please read https://www.fraudrecord.com/developers.

data/Rakefile

@@ -0,0 +1,15 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+namespace :test do
+  Rake::TestTask.new("unit") do |t|
+    t.libs << 'test'
+    t.pattern = "#{File.dirname(__FILE__)}/test/all.rb"
+  end
+end
+
+desc "Run tests"
+task :test => ["test:unit"]
+
+task :default => :test

data/coverage/.last_run.json

@@ -0,0 +1,5 @@
+{
+  "result": {
+    "covered_percent": 100.0
+  }
+}

data/coverage/.resultset.json

@@ -0,0 +1,49 @@
+{
+  "Unit Tests": {
+    "coverage": {
+      "/Users/sean/src/fraudrecord/lib/fraudrecord.rb": [
+        1,
+        1,
+        1,
+        1,
+        null,
+        1,
+        1,
+        1,
+        null,
+        1,
+        1,
+        null,
+        null,
+        1,
+        null,
+        1,
+        1,
+        null,
+        null,
+        1,
+        1,
+        1,
+        1,
+        null,
+        null,
+        null,
+        1,
+        1,
+        2,
+        2,
+        null,
+        null,
+        null,
+        1,
+        2,
+        64000,
+        null,
+        2,
+        null,
+        null
+      ]
+    },
+    "timestamp": 1429704742
+  }
+}

data/fraudrecord.gemspec

@@ -0,0 +1,26 @@
+Gem::Specification.new do |gem|
+  gem.name = 'fraudrecord'
+  gem.version = '0.0.1'
+  gem.date = '2015-04-22'
+  gem.summary = 'fraudrecord'
+  gem.description = 'API wrapper for FraudRecord.com'
+  gem.authors = [ 'Sean Handley' ]
+  gem.email = 'sean.handley@gmail.com'
+  gem.files = `git ls-files`.split("\n")
+  gem.homepage = 'https://github.com/seanhandley/fraudrecord'
+  gem.license = 'MIT'
+  
+  gem.required_ruby_version = '> 2.0.0'
+  
+  # Runtime Dependencies
+  gem.add_runtime_dependency 'faraday', '~> 0.9.0'
+  gem.add_runtime_dependency 'activesupport', '~> 4.2.0'
+  
+  # Development Dependencies
+  gem.add_development_dependency 'vcr', '~> 2.8.0'
+  gem.add_development_dependency 'webmock', '~> 1.8.0'
+  gem.add_development_dependency 'minitest', '~> 5.3.1'
+  gem.add_development_dependency 'simplecov', '~> 0.8.2'
+  gem.add_development_dependency 'coveralls', '~> 0.7.0'
+
+end

data/lib/fraudrecord.rb

@@ -0,0 +1,47 @@
+require 'faraday'
+require 'active_support'
+require 'active_support/core_ext'
+require 'digest/sha1'
+
+module Fraudrecord
+  def self.query(args={})
+    raise(ArgumentError, "Env variable FRAUD_RECORD_API_KEY not set") unless ENV["FRAUD_RECORD_API_KEY"]
+    processed_args = process_args(args).merge!('_action' => 'query',
+                                            '_api'    => ENV["FRAUD_RECORD_API_KEY"])
+    response = conn.get '/api/', processed_args
+    value, count, reliability, report = *Hash.from_xml(response.body)['report'].split('-')
+    {
+      value: value.to_i,
+      count: count.to_i,
+      reliability: reliability.to_f,
+      report: "https://www.fraudrecord.com/api/?showreport=#{report}"
+    }
+  end
+
+  private
+
+  def self.default_host
+    "https://www.fraudrecord.com"
+  end
+
+  def self.conn
+    Faraday.new(:url => default_host, ssl: { verify: false }) do |faraday|
+      faraday.request  :url_encoded
+      faraday.adapter  Faraday.default_adapter
+    end
+  end
+
+  def self.process_args(args)
+    args.inject({}) do |acc, v|
+      acc[v[0]] = salt_and_hash(v[1].gsub(/\s/,'').downcase)
+      acc
+    end
+  end
+
+  def self.salt_and_hash(value)
+    32_000.times do
+      value = Digest::SHA1.hexdigest("fraudrecord-#{value}")
+    end
+    value
+  end
+end

data/test/all.rb

@@ -0,0 +1,6 @@
+dir = File.dirname(__FILE__)
+$LOAD_PATH.unshift(dir)
+
+Dir["#{dir}/**/*_test.rb"].sort.each do |file|
+  require file.sub(/^#{dir}\/(.*)\.rb$/, '\1')
+end

data/test/test_helper.rb

@@ -0,0 +1,24 @@
+require 'simplecov'
+if require 'coveralls'
+  SimpleCov.formatter = Coveralls::SimpleCov::Formatter
+  SimpleCov.start do
+    add_filter '/test/'
+  end
+end
+
+require 'vcr'
+
+VCR.configure do |c|
+  c.cassette_library_dir = 'test/vcr_cassettes'
+  c.hook_into :webmock
+end
+
+require_relative '../lib/fraudrecord'
+
+TEST_ENV = true
+
+require 'rubygems'
+gem "minitest"
+require 'minitest/autorun'
+
+ENV["FRAUD_RECORD_API_KEY"] = "foo"

data/test/unit/lib/fraudrecord_test.rb

@@ -0,0 +1,15 @@
+module Fraudrecord
+  
+  require_relative '../../test_helper'
+  
+  class FraudrecordTest < Minitest::Test
+    def test_query
+      VCR.use_cassette('standard_query') do
+        results = Fraudrecord.query(name: "Bob Jones", email: 'bob@jones.co.uk')
+        assert_equal 0,   results[:value]
+        assert_equal 0,   results[:count]
+        assert_equal 0.0, results[:reliability]
+      end
+    end
+  end
+end

data/test/vcr_cassettes/standard_query.yml

@@ -0,0 +1,38 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://www.fraudrecord.com/api/?_action=query&_api=foo&email=52fde613f7b9d8aa992d7eeab8ad13c03c85e96c&name=225c0aa2542aa22fab3d441ff43b7a752c85aeba
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Faraday v0.9.1
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - nginx/1.2.1
+      Date:
+      - Wed, 22 Apr 2015 12:07:35 GMT
+      Content-Type:
+      - text/html
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      X-Powered-By:
+      - PHP/5.4.33
+    body:
+      encoding: UTF-8
+      string: "<report>0-0-0.0-ad8f2f262e234522</report>"
+    http_version: 
+  recorded_at: Wed, 22 Apr 2015 12:07:33 GMT
+recorded_with: VCR 2.9.3

metadata

@@ -0,0 +1,157 @@
+--- !ruby/object:Gem::Specification
+name: fraudrecord
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Sean Handley
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-04-22 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.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.3.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.3.1
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.2
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+description: API wrapper for FraudRecord.com
+email: sean.handley@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".DS_Store"
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- coverage/.last_run.json
+- coverage/.resultset.json
+- coverage/.resultset.json.lock
+- fraudrecord.gemspec
+- lib/fraudrecord.rb
+- test/all.rb
+- test/test_helper.rb
+- test/unit/lib/fraudrecord_test.rb
+- test/vcr_cassettes/standard_query.yml
+homepage: https://github.com/seanhandley/fraudrecord
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: fraudrecord
+test_files: []