blockscore 4.0.0 → 4.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e88b157232ca06038bc84c1ac5b2a396faa9653f
-  data.tar.gz: 3a3298c56a4aeccead937ab406797257e057a4b0
+  metadata.gz: 05cc2f4bb7d4097bb8e2ec1cf9206a9d7445eb25
+  data.tar.gz: 995dbf9d743ebce299876212bbe76b602f795377
 SHA512:
-  metadata.gz: 059eeb15b132025b08fe50e95ecf554af98f2fd781025123eb7c1fb654493028037ea96886f3ac2e76895e8135c32bba03b11ae65d29e02c72466d82e4a4ca93
-  data.tar.gz: f20a55a0e6a8d49819398d0bbcc6c83ddf65052fb61f58a6fb5a0442bf74e9a73e11d2725d549ca56e1124555fefbf6ae61fe0c84948b5e1b8c28d69b53e6df5
+  metadata.gz: 24ad5442fc429636b6aa1664efa88644486065112676cf3d0cbe198a4c4c3a01fa17df0dcc8170e288e79077e84b7b86eb9e1ccf1f52713f45d48129ffa705e9
+  data.tar.gz: 0af307d785861b7be81e4558492568a9ed42a915cfe2ccf1a78e122f25b10fe5269c0add3b1ca58fddb611bfd9725063742a73b8544b321ae444eff9ea566230

data/.gitignore

@@ -0,0 +1,58 @@
+# rcov generated
+coverage
+coverage.data
+
+# rdoc generated
+rdoc
+
+# yard generated
+doc
+.yardoc
+
+# bundler
+.bundle
+
+# jeweler generated
+pkg
+
+# Have editor/IDE/OS specific files you need to ignore? Consider using a global gitignore: 
+#
+# * Create a file at ~/.gitignore
+# * Include files you want ignored
+# * Run: git config --global core.excludesfile ~/.gitignore
+#
+# After doing this, these files will be ignored in all your git projects,
+# saving you from having to 'pollute' every project you touch with them
+#
+# Not sure what to needs to be ignored for particular editors/OSes? Here's some ideas to get you started. (Remember, remove the leading # of the line)
+#
+# For MacOS:
+#
+#.DS_Store
+
+# For TextMate
+#*.tmproj
+#tmtags
+
+# For emacs:
+#*~
+#\#*
+#.\#*
+
+# For vim:
+#*.swp
+
+# For redcar:
+#.redcar
+
+# For rubinius:
+#*.rbc
+
+*.sublime-workspace
+*.sublime-project
+
+*.DS_Store
+
+blockscore-*.gem
+
+Gemfile.lock

data/.hound.yml

@@ -0,0 +1,217 @@
+AllCops:
+  Include:
+  - "**/*.rake"
+  - "**/Gemfile"
+  - "**/Rakefile"
+  Exclude:
+  - "vendor/**/*"
+  - "db/**/*"
+  DisplayCopNames: true
+  RunRailsCops: true
+Style/HashSyntax:
+  Description: Use hash rockets for backwards compatibility syntax { :a => 1, :b => 2 }.
+  Enabled: true
+  EnforcedStyle: hash_rockets
+  SupportedStyles:
+  - ruby19
+  - hash_rockets
+TrailingWhitespace:
+  Enabled: false
+Style/TrailingBlankLines:
+  Enabled: false
+Style/ExtraSpacing:
+  Enabled: false
+StringLiterals:
+  EnforcedStyle: single_quotes
+Metrics/LineLength:
+  Max: 100
+Style/DotPosition:
+  EnforcedStyle: leading
+Style/CommentAnnotation:
+  Description: Checks formatting of special comments (TODO, FIXME, OPTIMIZE, HACK,
+    REVIEW).
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#annotate-keywords
+  Enabled: true
+Rails/Delegate:
+  Description: Prefer delegate method for delegations.
+  Enabled: true
+Style/FileName:
+  Enabled: true
+Style/GlobalVars:
+  Enabled: true
+Style/IfUnlessModifier:
+  Description: Favor modifier if/unless usage when you have a single-line body.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#if-as-a-modifier
+  Enabled: true
+  MaxLineLength: 100
+Style/Next:
+  Description: Use `next` to skip iteration instead of a condition at the end.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-nested-conditionals
+  Enabled: true
+  EnforcedStyle: always
+  SupportedStyles:
+  - skip_modifier_ifs
+  - always
+Style/NumericLiterals:
+  Description: Add underscores to large numeric literals to improve their readability.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#underscores-in-numerics
+  Enabled: true
+  MinDigits: 5
+Style/PercentLiteralDelimiters:
+  Description: Use `%`-literal delimiters consistently
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#percent-literal-braces
+  Enabled: true
+  PreferredDelimiters:
+    "%": "()"
+    "%i": "()"
+    "%q": "()"
+    "%Q": "()"
+    "%r": "()"
+    "%s": "()"
+    "%w": "()"
+    "%W": "()"
+    "%x": "()"
+Style/RegexpLiteral:
+  Description: Use %r for regular expressions matching more than `MaxSlashes` '/'
+    characters. Use %r only for regular expressions matching more than `MaxSlashes`
+    '/' character.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#percent-r
+  Enabled: true
+  MaxSlashes: 1
+Style/SignalException:
+  Description: Checks for proper usage of fail and raise.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#fail-method
+  Enabled: true
+Style/SingleLineMethods:
+  Description: Avoid single-line methods.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-single-line-methods
+  Enabled: true
+  AllowIfMethodIsEmpty: true
+Style/TrivialAccessors:
+  Enabled: true
+  ExactNameMatch: false
+  AllowPredicates: false
+  AllowDSLWriters: false
+  IgnoreClassMethods: false
+  Whitelist:
+    - to_ary
+    - to_a
+    - to_c
+    - to_enum
+    - to_h
+    - to_hash
+    - to_i
+    - to_int
+    - to_io
+    - to_open
+    - to_path
+    - to_proc
+    - to_r
+    - to_regexp
+    - to_str
+    - to_s
+    - to_sym
+Style/WordArray:
+  Description: Use %w or %W for arrays of words.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#percent-w
+  Enabled: true
+  MinSize: 0
+  WordRegex: !ruby/regexp /\A[\p{Word}]+\z/
+Metrics/ClassLength:
+  Description: Avoid classes longer than 250 lines of code.
+  Enabled: true
+  CountComments: false
+  Max: 250
+Style/MethodCalledOnDoEndBlock:
+  Description: Avoid chaining a method call on a do...end block.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#single-line-blocks
+  Enabled: true
+Style/SymbolArray:
+  Description: Use %i or %I for arrays of symbols.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#percent-i
+  Enabled: true
+Style/AccessorMethodName:
+  Description: Check the naming of accessor methods for get_/set_.
+  Enabled: true
+Style/CharacterLiteral:
+  Description: Checks for uses of character literals.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-character-literals
+  Enabled: true
+Style/ClassVars:
+  Description: Avoid the use of class variables.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-class-vars
+  Enabled: true
+Style/ColonMethodCall:
+  Description: 'Do not use :: for method call.'
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#double-colons
+  Enabled: true
+Style/DeprecatedHashMethods:
+  Description: Checks for use of deprecated Hash methods.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#hash-key
+  Enabled: true
+Style/Documentation:
+  Description: Document classes and non-namespace modules.
+  Enabled: true
+Style/DoubleNegation:
+  Description: Checks for uses of double negation (!!).
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-bang-bang
+  Enabled: true
+Style/EachWithObject:
+  Description: Prefer `each_with_object` over `inject` or `reduce`.
+  Enabled: true
+Style/EmptyLiteral:
+  Description: Prefer literals to Array.new/Hash.new/String.new.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#literal-array-hash
+  Enabled: true
+Style/IfWithSemicolon:
+  Description: Do not use if x; .... Use the ternary operator instead.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-semicolon-ifs
+  Enabled: true
+Style/Lambda:
+  Description: Use the new lambda literal syntax for single-line blocks.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#lambda-multi-line
+  Enabled: true
+Style/LineEndConcatenation:
+  Description: Use \ instead of + or << to concatenate two string literals at line
+    end.
+  Enabled: true
+Style/ModuleFunction:
+  Description: Checks for usage of `extend self` in modules.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#module-function
+  Enabled: true
+Style/NegatedIf:
+  Description: Favor unless over if for negative conditions (or control flow or).
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#unless-for-negatives
+  Enabled: true
+Style/NegatedWhile:
+  Description: Favor until over while for negative conditions.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#until-for-negatives
+  Enabled: true
+Style/NilComparison:
+  Description: Prefer x.nil? to x == nil.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#predicate-methods
+  Enabled: true
+Style/SelfAssignment:
+  Description: Checks for places where self-assignment shorthand should have been
+    used.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#self-assignment
+  Enabled: true
+Style/StructInheritance:
+  Description: Checks for inheritance from Struct.new.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-extend-struct-new
+  Enabled: true
+Style/VariableInterpolation:
+  Description: Don't interpolate global, instance and class variables directly in
+    strings.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#curlies-interpolate
+  Enabled: true
+Lint/UnderscorePrefixedVariableName:
+  Description: Do not use prefix `_` for a variable that is used.
+  Enabled: true
+Style/MultilineOperationIndentation:
+  Description: Checks indentation of binary operations that span more than one line.
+  Enabled: true
+  EnforcedStyle: aligned
+  SupportedStyles:
+  - aligned
+  - indented

data/Gemfile

@@ -5,11 +5,23 @@ gem 'httparty', '~> 0.11'
 # Add dependencies to develop your gem here.
 # Include everything needed to run rake, tests, features, etc.
 group :development do
-  gem "shoulda", "~> 3.5.0"
-  gem "rdoc", "~> 3.12"
-  gem "bundler", "~> 1.0"
-  gem "jeweler", "~> 2.0.1"
-  gem "simplecov", ">= 0"
-  gem "minitest", "~> 4.0"
-  gem 'shoulda-context', '~> 1.2'
+  gem 'rdoc', '~> 3.12'
+  gem 'bundler', '~> 1.0'
+  gem 'simplecov', '>= 0'
+end
+
+group :development, :test do
+  gem 'test-unit', '~> 3.0'
+  gem 'test-unit-activesupport', '~> 1.0'
+  gem 'activesupport', '4.1.0.rc1'
+  gem 'mutant', github: 'kbrock/mutant', branch: 'minitest'
+  gem 'mutant-minitest', github: 'kbrock/mutant', branch: 'minitest'
+  gem 'minitest', '~> 5.3'
+  gem 'minitest-rg', github: 'blowmage/minitest-rg', branch: 'master'
+end
+
+group :test do
+  gem 'webmock', '~> 1.21'
+  gem 'factory_girl', '~> 4.1.0'
+  gem 'faker', '~> 1.4.3'
 end

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2013-2015 BlockScore
+
+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

@@ -1,6 +1,6 @@
-# blockscore-ruby
+# blockscore-ruby [![Circle CI](https://circleci.com/gh/BlockScore/blockscore-ruby/tree/master.svg?style=shield)](https://circleci.com/gh/BlockScore/blockscore-ruby/tree/4.1.0) [![Test Coverage](https://codeclimate.com/github/BlockScore/blockscore-ruby/badges/coverage.svg)](https://codeclimate.com/github/BlockScore/blockscore-ruby/coverage) [![Dependency Status](https://gemnasium.com/BlockScore/blockscore-ruby.svg)](https://gemnasium.com/BlockScore/blockscore-ruby)
 
-This is the official library for Ruby clients of the BlockScore API. [Click here to read the full documentation including code examples](http://docs.blockscore.com/v4.0/ruby/).
+This is the official library for Ruby clients of the BlockScore API. [Click here to read the full documentation including code examples](http://docs.blockscore.com/ruby/).
 
 ## Install
 
@@ -13,7 +13,7 @@ gem install blockscore
 If you are using Rails, add the following to your `Gemfile`:
 
 ```ruby
-gem 'blockscore', '~> 4.0.0'
+gem 'blockscore', '~> 4.1.0'
 ```
 
 ## Getting Started
@@ -21,40 +21,44 @@ gem 'blockscore', '~> 4.0.0'
 To get started, you can initialize the library with one line:
 
 ```ruby
-client = BlockScore::Client.new('your-api-key')
+BlockScore.api_key = 'your-api-key'
 ```
 
-To see the list of calls you can make, please visit out [full Ruby API reference](http://docs.blockscore.com/4.0/ruby).
+To verify a person:
 
-## Exceptions and Errors
-
-### Error Description
-
-* The generic error class is BlockscoreError. All other types of errors are derived from BlockscoreError.
-* Errors contain information such as the HTTP response code, a short message describing the error, the type of error, and if applicable, the parameter and error code at issue.
-* Also available in the error object is the full JSON text representation of the data.
-
-### Error Types
-
-* BlockscoreError (Generic error, base class)
-* AuthenticationError (401 : Invalid API Key)
-* ValidationError (400 : Input could not be validated)
-* ParameterError (400 : Missing parameter)
-* NotFoundError (404 : Attempting to reference nonexistent endpoint)
-* InternalServerError (500 : Error on the Blockscore API)
+```ruby
+person = BlockScore::Person.create(
+  birth_day: '23',
+  birth_month: '8',
+  birth_year: '1980',
+  document_type: 'ssn',
+  document_value: '0000',
+  name_first: 'John',
+  name_middle: 'Pearce',
+  name_last: 'Doe',
+  address_street1: '1 Infinite Loop',
+  address_street2: 'Apt 6',
+  address_city: 'Cupertino',
+  address_state: 'CA',
+  address_postal_code: '95014',
+  address_country_code: 'US'
+)
+
+# Check the validation status of the Person
+person.status
+# => 'valid'
+
+# Or view some of the other attributes
+person.details.address
+# => 'mismatch'
+```
 
-## Contributing to BlockScore
- 
-* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
-* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
-* Fork the project.
-* Start a feature/bugfix branch.
-* Commit and push until you are happy with your contribution.
-* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
-* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+To see the list of calls you can make, please visit our [full Ruby API reference](http://docs.blockscore.com/ruby/).
 
-## Copyright
+## Testing
 
-Copyright (c) 2014 BlockScore. See LICENSE.txt for
-further details.
+The test suite uses a public BlockScore API key that was created specifically to ease the testing and contribution processes. **Please do not enter personal details for tests.** In order to run the test suite:
 
+```shell
+$ rake test
+```

data/Rakefile

@@ -11,24 +11,10 @@ rescue Bundler::BundlerError => e
 end
 require 'rake'
 
-require 'jeweler'
-Jeweler::Tasks.new do |gem|
-  # gem is a Gem::Specification... see http://guides.rubygems.org/specification-reference/ for more options
-  gem.name = "blockscore"
-  gem.homepage = "http://github.com/blockscore/blockscore-ruby"
-  gem.license = "MIT"
-  gem.summary = %Q{A ruby client library for the BlockScore API.}
-  gem.description = %Q{A ruby client library for the BlockScore API.}
-  gem.email = "alain@blockscore.com"
-  gem.authors = ["Alain Meier"]
-  # dependencies defined in Gemfile
-end
-Jeweler::RubygemsDotOrgTasks.new
-
 require 'rake/testtask'
 Rake::TestTask.new(:test) do |test|
   test.libs << 'lib' << 'test'
-  test.pattern = 'test/**/test_*.rb'
+  test.pattern = 'test/*_test.rb'
   test.verbose = true
 end