onfido 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2b1dc6db6e4973faba6292df170163a8d0d48c7d
+  data.tar.gz: 14a83b00ff4b77f746bfaf4d4b916af4cfa01c92
+SHA512:
+  metadata.gz: 9f646210c77a49dcb05d9a9c8b8cff9696509cfa16fd6ebbe9fbe591c3f0f219fc352c6230299d2b2c8e494a23244e6a76ace37edb09f3a4acb58435f3b5e2cb
+  data.tar.gz: 69243a11afe9e5a9f683210d7d0ad5f0165b7b778812d75571db9cb989254754296e0a93515c8708df61e01ed05329e0c5d7e5959ab3007e6015a64af8336782

data/.gitignore

@@ -0,0 +1,161 @@
+# Created by https://www.gitignore.io
+
+### Emacs ###
+# -*- mode: gitignore; -*-
+*~
+\#*\#
+/.emacs.desktop
+/.emacs.desktop.lock
+*.elc
+auto-save-list
+tramp
+.\#*
+
+# Org-mode
+.org-id-locations
+*_archive
+
+# flymake-mode
+*_flymake.*
+
+# eshell files
+/eshell/history
+/eshell/lastdir
+
+# elpa packages
+/elpa/
+
+# reftex files
+*.rel
+
+# AUCTeX auto folder
+/auto/
+
+# cask packages
+.cask/
+
+
+### OSX ###
+.DS_Store
+.AppleDouble
+.LSOverride
+
+# Icon must end with two \r
+Icon
+
+
+# Thumbnails
+._*
+
+# Files that might appear in the root of a volume
+.DocumentRevisions-V100
+.fseventsd
+.Spotlight-V100
+.TemporaryItems
+.Trashes
+.VolumeIcon.icns
+
+# Directories potentially created on remote AFP share
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk
+
+
+### Linux ###
+*~
+
+# KDE directory preferences
+.directory
+
+# Linux trash folder which might appear on any partition or disk
+.Trash-*
+
+
+### RubyMine ###
+# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm
+
+*.iml
+
+## Directory-based project format:
+.idea/
+# if you remove the above rule, at least ignore the following:
+
+# User-specific stuff:
+# .idea/workspace.xml
+# .idea/tasks.xml
+# .idea/dictionaries
+
+# Sensitive or high-churn files:
+# .idea/dataSources.ids
+# .idea/dataSources.xml
+# .idea/sqlDataSources.xml
+# .idea/dynamic.xml
+# .idea/uiDesigner.xml
+
+# Gradle:
+# .idea/gradle.xml
+# .idea/libraries
+
+# Mongo Explorer plugin:
+# .idea/mongoSettings.xml
+
+## File-based project format:
+*.ipr
+*.iws
+
+## Plugin-specific files:
+
+# IntelliJ
+/out/
+
+# mpeltonen/sbt-idea plugin
+.idea_modules/
+
+# JIRA plugin
+atlassian-ide-plugin.xml
+
+# Crashlytics plugin (for Android Studio and IntelliJ)
+com_crashlytics_export_strings.xml
+crashlytics.properties
+crashlytics-build.properties
+
+
+### Ruby ###
+*.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/
+Gemfile.lock
+
+# 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/.rspec

@@ -0,0 +1,3 @@
+--color
+--require spec_helper
+--format documentation

data/.ruby-version

@@ -0,0 +1 @@
+2.1.3

data/Gemfile

@@ -0,0 +1,14 @@
+source 'https://rubygems.org'
+gemspec
+
+group :development, :test do
+  gem 'pry'
+  gem 'pry-byebug'
+  gem 'pry-stack_explorer'
+end
+
+group :test do
+  gem 'rspec', '~> 3.1.0'
+  gem 'webmock', '~> 1.20.4'
+  gem 'sinatra', '~> 1.4.6'
+end

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Hassle
+
+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/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Pericles Theodorou
+
+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,154 @@
+# Onfido
+
+A wrapper for Onfido's [API](https://onfido.com/documentation#introduction). You should always refer to the documentation for valid API calls.
+
+[!['gitter room'][2]][1]
+
+  [1]: https://gitter.im/hvssle/onfido
+  [2]: https://badges.gitter.im/gitterHQ/developers.png
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'onfido'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install onfido
+
+
+## Usage
+
+There are 3 configuration options for Onfido, including  your `api_key`, throwing exceptions for failed responses and logging the requests. By default, `throws_exceptions` is set to `true`. If set to `false`, the response body will be returned instead.
+
+```ruby
+  Onfido.configure do |config|
+    config.api_key = 'MY_API_KEY'
+    config.logger = Logger.new(STDOUT)
+    config.throws_exceptions = false
+  end
+```
+
+Assuming you have a valid key, you can conveniently make API calls by using an instance of the `API` class.
+
+```ruby
+  api = Onfido::API.new
+```
+
+### Making calls to Onfido's resources
+
+All resources share the same interface when making API calls. For creating a resource you can use `.create`, for finding one `.find` and for fetching all records for a resource `.all`.
+
+**Note:** *All param keys should be a symbol e.g. `{type: 'express', reports: [{name: 'identity'}]}`*
+
+
+### Applicant
+
+To create an applicant, you can simply use
+
+```ruby
+  api.applicant.create(params)
+```
+
+To find an existing applicant
+
+```ruby
+  api.applicant.find('applicant_id')
+```
+
+To get all applicants
+
+```ruby
+  api.applicant.all
+```
+
+### Document
+
+To upload a document for an applicant, you can simply use
+
+```ruby
+  api.document.create('applicant_id', {file: 'http://example.com', type: 'passport')
+```
+
+The file can both be a `File` object or a link to an image.
+
+### Check
+
+To create a check for an applicant, you can simply use
+
+```ruby
+  api.check.create('applicant_id', {type: 'express', reports: [{name: 'identity'}]})
+```
+
+To find an existing check for an applicant
+
+```ruby
+  api.check.find('applicant_id', 'check_id')
+```
+
+To get all checks for an applicant
+
+```ruby
+  api.check.all('applicant_id')
+```
+
+### Report
+
+To find an existing report for a check
+
+```ruby
+  api.report.find('check_id', 'report_id')
+```
+
+To get all reports for a check
+
+```ruby
+  api.report.all('check_id')
+```
+
+### Address Picker
+
+To search for addresses by postcode
+
+```ruby
+  api.address.all('SE1 4NG')
+```
+
+## Error Handling
+
+By default, Onfido will attempt to raise errors returned by the API automatically.
+
+If you set the `throws_exceptions` to false, it will simply return the response body. This allows you to handle errors manually.
+
+If you rescue Onfido::RequestError, you are provided with the error message itself as well as the type of error, response code and fields that have errored. Here's how you might do that:
+
+```ruby
+  def create_applicant
+    api.applicant.create(params)
+  rescue Onfido::RequestError => e
+    e.type # returns 'validation_error'
+    e.fields # returns {"email": {"messages": ["invalid format"]}
+    e.response_code # returns '401'
+  end
+```
+
+### Roadmap
+
+- Improve test coverage with more scenarios
+- Add custom errors based on the response code.
+- Improve documentation
+
+## Contributing
+
+1. Fork it ( https://github.com/hvssle/onfido/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,2 @@
+require 'bundler/gem_tasks'
+

data/lib/onfido.rb

@@ -0,0 +1,23 @@
+require 'json'
+require 'rack'
+require 'rest-client'
+require 'open-uri'
+
+require 'onfido/version'
+require 'onfido/configuration'
+require 'onfido/request_error'
+require 'onfido/response_handler'
+require 'onfido/null_logger'
+require 'onfido/requestable'
+require 'onfido/resource'
+require 'onfido/address'
+require 'onfido/applicant'
+require 'onfido/document'
+require 'onfido/check'
+require 'onfido/report'
+require 'onfido/api'
+
+
+module Onfido
+  extend Configuration
+end

data/lib/onfido/address.rb

@@ -0,0 +1,10 @@
+module Onfido
+  class Address < Resource
+    def all(postcode)
+      get(
+        url: url_for('addresses/pick'),
+        payload: {postcode: postcode.delete(' ')}
+      )
+    end
+  end
+end

data/lib/onfido/api.rb

@@ -0,0 +1,18 @@
+module Onfido
+  class API
+    def method_missing(method, *args)
+      klass = method.to_s.capitalize
+      Object.const_get("Onfido::#{klass}").new
+    rescue NameError
+      super
+    end
+
+    def respond_to_missing?(method, include_private = false)
+      klass = method.to_s.capitalize
+      Object.const_get("Onfido::#{klass}")
+      true
+    rescue NameError
+      super
+    end
+  end
+end