blockscore 4.0.0 → 4.1.0

data/blockscore.gemspec

@@ -1,86 +1,35 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
-# -*- encoding: utf-8 -*-
-# stub: blockscore 4.0.0 ruby lib
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
-Gem::Specification.new do |s|
-  s.name = "blockscore"
-  s.version = "4.0.0"
+require 'blockscore/version'
 
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.require_paths = ["lib"]
-  s.authors = ["Alain Meier"]
-  s.date = "2014-11-17"
-  s.description = "A ruby client library for the BlockScore API."
-  s.email = "alain@blockscore.com"
-  s.extra_rdoc_files = [
-    "LICENSE.txt",
-    "README.md"
-  ]
-  s.files = [
-    ".document",
-    "Gemfile",
-    "LICENSE.txt",
-    "README.md",
-    "Rakefile",
-    "VERSION",
-    "blockscore-ruby.sublime-project",
-    "blockscore.gemspec",
-    "lib/blockscore.rb",
-    "lib/blockscore/candidates.rb",
-    "lib/blockscore/client.rb",
-    "lib/blockscore/companies.rb",
-    "lib/blockscore/error/authorization_error.rb",
-    "lib/blockscore/error/blockscore_error.rb",
-    "lib/blockscore/error/error_handler.rb",
-    "lib/blockscore/error/internal_server_error.rb",
-    "lib/blockscore/error/not_found_error.rb",
-    "lib/blockscore/error/parameter_error.rb",
-    "lib/blockscore/error/validation_error.rb",
-    "lib/blockscore/errors.rb",
-    "lib/blockscore/people.rb",
-    "lib/blockscore/question_sets.rb",
-    "lib/blockscore/watchlists.rb",
-    "test/helper.rb",
-    "test/test_blockscore.rb"
-  ]
-  s.homepage = "http://github.com/blockscore/blockscore-ruby"
-  s.licenses = ["MIT"]
-  s.rubygems_version = "2.2.2"
-  s.summary = "A ruby client library for the BlockScore API."
+Gem::Specification.new do |spec|
+  spec.name        = 'blockscore'
+  spec.version     = BlockScore::VERSION
+  spec.authors     = ['Alain Meier', 'John Backus', 'Connor Jacobsen']
+  spec.email       = ['alain@blockscore.com', 'john@blockscore.com']
 
-  if s.respond_to? :specification_version then
-    s.specification_version = 4
+  spec.summary     = 'A ruby client library for the BlockScore API.'
+  spec.description = 'BlockScore makes ID verification easier and faster. See https://blockscore.com for more.'
+  spec.homepage    = 'https://blockscore.com'
+  spec.license     = 'MIT'
 
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<httparty>, ["~> 0.11"])
-      s.add_development_dependency(%q<shoulda>, ["~> 3.5.0"])
-      s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
-      s.add_development_dependency(%q<bundler>, ["~> 1.0"])
-      s.add_development_dependency(%q<jeweler>, ["~> 2.0.1"])
-      s.add_development_dependency(%q<simplecov>, [">= 0"])
-      s.add_development_dependency(%q<minitest>, ["~> 4.0"])
-      s.add_development_dependency(%q<shoulda-context>, ["~> 1.2"])
-    else
-      s.add_dependency(%q<httparty>, ["~> 0.11"])
-      s.add_dependency(%q<shoulda>, ["~> 3.5.0"])
-      s.add_dependency(%q<rdoc>, ["~> 3.12"])
-      s.add_dependency(%q<bundler>, ["~> 1.0"])
-      s.add_dependency(%q<jeweler>, ["~> 2.0.1"])
-      s.add_dependency(%q<simplecov>, [">= 0"])
-      s.add_dependency(%q<minitest>, ["~> 4.0"])
-      s.add_dependency(%q<shoulda-context>, ["~> 1.2"])
-    end
-  else
-    s.add_dependency(%q<httparty>, ["~> 0.11"])
-    s.add_dependency(%q<shoulda>, ["~> 3.5.0"])
-    s.add_dependency(%q<rdoc>, ["~> 3.12"])
-    s.add_dependency(%q<bundler>, ["~> 1.0"])
-    s.add_dependency(%q<jeweler>, ["~> 2.0.1"])
-    s.add_dependency(%q<simplecov>, [">= 0"])
-    s.add_dependency(%q<minitest>, ["~> 4.0"])
-    s.add_dependency(%q<shoulda-context>, ["~> 1.2"])
-  end
-end
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.required_ruby_version  = '>= 1.9.3'
 
+  spec.add_dependency('httparty', '~> 0.11')
+
+  spec.add_development_dependency('shoulda', '~> 3.5', '>= 3.5.0')
+  spec.add_development_dependency('rdoc', '~> 3.12')
+  spec.add_development_dependency('bundler', '~> 1.0')
+  spec.add_development_dependency('simplecov', '~> 0')
+  spec.add_development_dependency('minitest', '~> 5.5')
+  spec.add_development_dependency('webmock', '1.21')
+  spec.add_development_dependency('faker', '1.4.3')
+  spec.add_development_dependency('factory_girl', '4.1.0')
+end

data/circle.yml

@@ -0,0 +1,13 @@
+dependencies:
+  override:
+    - "rvm-exec 1.9.3-p551 bundle install"
+    - "rvm-exec 2.0.0-p598 bundle install"
+    - "rvm-exec 2.1.5 bundle install"
+    - "rvm-exec 2.2.0 bundle install"
+
+test:
+  override:
+    - "rvm-exec 1.9.3-p551 bundle exec rake"
+    - "rvm-exec 2.0.0-p598 bundle exec rake"
+    - "rvm-exec 2.1.5 bundle exec rake"
+    - "rvm-exec 2.2.0 bundle exec rake"

data/lib/blockscore.rb

@@ -1,5 +1,44 @@
-require "httparty"
+require 'forwardable'
+require 'httparty'
+require 'json'
+require 'ostruct'
+require 'uri'
 
-Dir[File.dirname(__FILE__) + '/blockscore/*.rb'].each do |file|
-  require file
-end
+require 'blockscore/actions/all'
+require 'blockscore/actions/create'
+require 'blockscore/actions/delete'
+require 'blockscore/actions/retrieve'
+require 'blockscore/actions/update'
+
+require 'blockscore/errors/api_connection_error'
+require 'blockscore/errors/api_error'
+require 'blockscore/errors/authentication_error'
+require 'blockscore/errors/error'
+require 'blockscore/errors/invalid_request_error'
+require 'blockscore/errors/no_api_key_error'
+require 'blockscore/errors/not_found_error'
+
+require 'blockscore/base'
+require 'blockscore/candidate'
+require 'blockscore/company'
+require 'blockscore/person'
+require 'blockscore/question_set'
+require 'blockscore/watchlist_hit'
+
+require 'blockscore/collection'
+require 'blockscore/connection'
+require 'blockscore/dispatch'
+require 'blockscore/fingerprint'
+require 'blockscore/response'
+require 'blockscore/util'
+require 'blockscore/version'
+
+module BlockScore
+  def self.api_key=(api_key)
+    @api_key = api_key
+  end
+
+  def self.api_key
+    @api_key
+  end
+end

data/lib/blockscore/actions/all.rb

@@ -0,0 +1,27 @@
+module BlockScore
+  module Actions
+    # Public: Provides an :all action to including Classes.
+    #
+    # The :all method returns up to 25 items from the BlockScore API for
+    # the given class.
+    #
+    # :all accepts an options hash, which responds to the following options:
+    #
+    # count - Fixnum number of items to return per page.
+    # offset - Fixnum number of items to skip before returning @count items.
+    #
+    # If no count is provided, 25 items are returned, or all items if the total
+    # number of items is 25 of fewer.
+    module All
+      module ClassMethods
+        def all(options = {})
+          get(endpoint, options)
+        end
+      end
+
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+    end
+  end
+end

data/lib/blockscore/actions/create.rb

@@ -0,0 +1,34 @@
+module BlockScore
+  module Actions
+    # Public: Provides a :create class method which creates a new instance
+    # of the desired class using the BlockScore API.
+    #
+    # Examples
+    #
+    # candidate = BlockScore::Candidate.create(
+    #   note: "12341234",
+    #   ssn: "0001",
+    #   date_of_birth: "1940-08-11",
+    #   name_first: "John",
+    #   name_middle: "",
+    #   name_last: "Bredenkamp",
+    #   address_street1: "1 Infinite Loop",
+    #   address_city: "Cupertino",
+    #   address_country_code: "US"
+    # )
+    # => <BlockScore::Candidate:0x007fe39c424410>
+    #
+    # Returns an instance of the desired class.
+    module Create
+      module ClassMethods
+        def create(params = {})
+          post(endpoint, params)
+        end
+      end
+
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+    end
+  end
+end

data/lib/blockscore/actions/delete.rb

@@ -0,0 +1,31 @@
+require 'forwardable'
+
+module BlockScore
+  module Actions
+    # Provides a :delete instance method to including classes.
+    #
+    # Returns the updated object with deleted == true.
+    #
+    # Examples
+    #
+    # candidate.delete
+    # => #<BlockScore::Candidate:0x007fe39c424410>
+    module Delete
+      extend Forwardable
+
+      def_delegators 'self.class', :endpoint
+
+      def delete
+        delete!
+      rescue Error
+        false
+      end
+
+      def delete!
+        self.class.delete("#{endpoint}/#{id}", {})
+        attributes[:deleted] = true
+        true
+      end
+    end
+  end
+end

data/lib/blockscore/actions/retrieve.rb

@@ -0,0 +1,24 @@
+module BlockScore
+  module Actions
+    # Public: Provides a :retrieve class method to including classes.
+    #
+    # Returns a instance of the desired class on success, raises an
+    # appropriate error otherwise.
+    #
+    # Examples
+    #
+    # person = BlockScore::Person.retrieve('abc123def456')
+    # => #<BlockScore::Person:0x007fe39c424410>
+    module Retrieve
+      module ClassMethods
+        def retrieve(id)
+          get("#{endpoint}/#{id}", {})
+        end
+      end
+
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+    end
+  end
+end

data/lib/blockscore/actions/update.rb

@@ -0,0 +1,46 @@
+module BlockScore
+  module Actions
+    # Public: Contains the :save instance method, which updates the
+    # object with the BlockScore API to persist the changes.
+    #
+    # Examples
+    #
+    #  class Foo
+    #    include BlockScore::Actions::Update
+    #  end
+    #
+    #  foo = Foo.new
+    #  foo.name_first = 'John'
+    #  foo.save
+    #  # => true
+    module Update
+      extend Forwardable
+
+      # Attributes which will not change once the object is created.
+      PERSISTENT_ATTRIBUTES = [
+        :id,
+        :object,
+        :created_at,
+        :updated_at,
+        :livemode
+      ]
+
+      def_delegators 'self.class', :endpoint, :patch
+
+      def save!
+        if respond_to? :id
+          patch("#{endpoint}/#{id}", filter_params)
+          true
+        else
+          super
+        end
+      end
+
+      # Filters out the non-updateable params.
+      def filter_params
+        # Cannot %i syntax, not introduced until Ruby 2.0.0
+        attributes.reject { |key, _| PERSISTENT_ATTRIBUTES.include?(key) }
+      end
+    end
+  end
+end

data/lib/blockscore/base.rb

@@ -0,0 +1,117 @@
+require 'blockscore/connection'
+
+module BlockScore
+  class Base
+    extend Connection
+
+    attr_reader :attributes
+
+    def initialize(options = {})
+      @attributes = options
+    end
+
+    def inspect
+      "#<#{self.class}:0x#{object_id.to_s(16)} JSON: " + JSON.pretty_generate(attributes)
+    end
+
+    def refresh
+      r = self.class.retrieve(id)
+      @attributes = r.attributes
+
+      true
+    rescue Error
+      false
+    end
+
+    def save
+      save!
+    rescue
+      false
+    end
+
+    def save!
+      response = self.class.post(self.class.endpoint, attributes)
+      @attributes[:id] = response.id
+
+      refresh
+    end
+
+    def self.resource
+      @resource ||= Util.to_underscore(to_s.split('::').last)
+    end
+
+    def self.api_url
+      'https://api.blockscore.com/'
+    end
+
+    def self.endpoint
+      if self == Base
+        fail NotImplementedError, 'Base is an abstract class, not an API resource'
+      end
+
+      "#{api_url}#{Util.to_plural(resource)}"
+    end
+
+    protected
+
+    def add_accessor(symbol, *args)
+      singleton_class.instance_eval do
+        define_method(symbol) do
+          wrap_attribute(attributes[symbol])
+        end
+      end
+    end
+
+    def add_setter(symbol, *_args)
+      singleton_class.instance_eval do
+        define_method(symbol) do |value|
+          attributes[symbol.to_s.chop.to_sym] = value
+        end
+      end
+    end
+
+    private
+
+    def method_missing(method, *args, &block)
+      if respond_to_missing?(method)
+        if setter?(method)
+          add_setter(method, args)
+        else
+          add_accessor(method, args)
+        end
+        send(method, *args)
+      else
+        super
+      end
+    end
+
+    def respond_to_missing?(symbol, include_private = false)
+      setter?(symbol) || attributes && attributes.key?(symbol) || super
+    end
+
+    def setter?(symbol)
+      symbol.to_s.end_with?('=')
+    end
+
+    def wrap_attribute(attribute)
+      case attribute
+      when Array
+        wrap_array(attribute)
+      when Hash
+        wrap_hash(attribute)
+      else
+        attribute
+      end
+    end
+
+    def wrap_array(arr)
+      arr.map { |item| wrap_attribute(item) }
+    end
+
+    def wrap_hash(hsh)
+      hsh.each { |key, value| hsh[key] = wrap_attribute(value) }
+
+      OpenStruct.new(hsh)
+    end
+  end
+end