brite-api 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ca64f3e25faa0daca60ba21b6f9e5157cb5ac233
+  data.tar.gz: 3c7952590be9b3b447e76f205ef9fadc9ba73a20
+SHA512:
+  metadata.gz: e036a814c627332c4fd8bffb6f5b53f6408ddc133ca2569b61635e86bac5146627272fc8c5287fcbb4a607ce41b2979f1c46e1701123ca6992a0184ef17f69b0
+  data.tar.gz: 6ed26407e6f1cad5ad1d417ecd9dee97f2eb0de09c1cbf036212c0f2f237acfb01917753f8d403a71b512782fe1ad524f078f6c6946f217a88a93f03f8ed89dd

data/README.md

@@ -0,0 +1,38 @@
+brite-api-ruby
+==============
+
+The official BriteVerify API Client for Ruby
+
+# Usage
+
+```ruby
+client = BriteAPI::Client.new(api_key)
+
+contact = client.contacts.create(email: 'fake@example.com', name: 'James Bond', ip: '123.213.123.123', phone: '+12345678')
+
+# Alternative way:
+# contact = BriteAPI::Contact.new(api_key, options, data)
+
+# Set and read values in runtime
+contact.name = 'Santa Claus'
+contact.address = {street: '120 N Cedar', unit: 'Apt 3201', zip: '28210'}
+
+# Send verification requests
+contact.verify!
+# => false
+
+contact.valid?
+# => false
+
+contact.errors
+# => {:phone=>"Invalid format", :email=>"Email address invalid"}
+
+contact.error_codes
+# => ["invalid_format", "email_address_invalid"]
+
+contact.status
+# => "unknown"
+
+contact.response[:name]
+# => {"fullname"=>"Santa Claus","prefix"=>nil, "prefix2"=>nil,...}
+```

data/lib/brite-api/api_client.rb

@@ -0,0 +1,28 @@
+require 'rest'
+require 'json'
+
+module BriteAPI
+  class APIClient
+    API_HOST = 'https://bpi.briteverify.com'
+
+    def initialize(api_key, options = {})
+      @api_key = api_key
+      @options = options
+      @rest = Rest::Client.new(:gem => options[:gem])
+    end
+
+    def verify(value)
+      raise "Not implemented"
+    end
+
+    def get(url, params = {})
+
+      options = {
+        :params => params.merge(:apikey => @api_key)
+      }
+
+      JSON.parse @rest.get(url, options).body
+    end
+
+  end
+end

data/lib/brite-api/client.rb

@@ -0,0 +1,26 @@
+module BriteAPI
+
+  class Client
+    def initialize(api_key, options = {})
+      raise ArgumentError, "Missing BriteVerify API key" if api_key.nil? || api_key == ''
+      @api_key = api_key
+      @options = options
+    end
+
+
+
+    def contact_create(data = {})
+      BriteAPI::Contact.new(@api_key, @options, data)
+    end
+
+    def contacts
+      self
+    end
+
+
+    alias_method :create, :contact_create
+    alias_method :contact, :contact_create
+
+
+  end
+end

data/lib/brite-api/clients/address_api_client.rb

@@ -0,0 +1,17 @@
+module BriteAPI
+  class AddressAPIClient < BriteAPI::APIClient
+    API_HATH = '/addresses.json'
+
+
+    def verify(value)
+      raise "Address should be a Hash" unless value.respond_to? :each
+      params = {}
+      value.each do |k, v|
+        params["address[#{k}]"] = v
+      end
+
+      get API_HOST + API_HATH, params
+    end
+
+  end
+end

data/lib/brite-api/clients/email_api_client.rb

@@ -0,0 +1,15 @@
+module BriteAPI
+  class EmailAPIClient < BriteAPI::APIClient
+    API_HATH = '/emails.json'
+
+
+    def verify(value)
+      params = { :address => value }
+      if @options[:verify_connected] || @options['verify_connected']
+        params[:verify_connected] = true
+      end
+      get API_HOST + API_HATH, params
+    end
+
+  end
+end

data/lib/brite-api/clients/ip_api_client.rb

@@ -0,0 +1,11 @@
+module BriteAPI
+  class IpAPIClient < BriteAPI::APIClient
+    API_HATH = '/ips.json'
+
+
+    def verify(value)
+      get API_HOST + API_HATH, { :address => value }
+    end
+
+  end
+end

data/lib/brite-api/clients/name_api_client.rb

@@ -0,0 +1,11 @@
+module BriteAPI
+  class NameAPIClient < BriteAPI::APIClient
+    API_HATH = '/names.json'
+
+
+    def verify(value)
+      get API_HOST + API_HATH, { :fullname => value }
+    end
+
+  end
+end

data/lib/brite-api/clients/phone_api_client.rb

@@ -0,0 +1,11 @@
+module BriteAPI
+  class PhoneAPIClient < BriteAPI::APIClient
+    API_HATH = '/phones.json'
+
+
+    def verify(value)
+      get API_HOST + API_HATH, { :number => value }
+    end
+
+  end
+end

data/lib/brite-api/contact.rb

@@ -0,0 +1,76 @@
+module BriteAPI
+
+  class Contact
+
+    attr_reader :response
+
+    FIELDS = [:email, :phone, :address, :name, :ip]
+
+    # Define accessors
+    FIELDS.each do |f|
+      define_method f do
+        @data[f]
+      end
+      define_method "#{f}=" do |val|
+        @data[f] = val
+      end
+    end
+
+    def initialize(api_key, options = {}, data = {})
+      raise ArgumentError, "Missing BriteVerify API key" if api_key.nil? || api_key == ''
+      @api_key = api_key
+      @options = options
+      @data = {}
+      FIELDS.each { |key| @data[key] = data[key] || data[key.to_s] }
+
+      @response = {}
+    end
+
+    def verify!
+      @response = {}
+
+      data = @data.select{ |_, v| v != nil }
+
+      # send async requests
+      threads = []
+      data.each do |key, value|
+
+        threads << Thread.new(key, value) do |k, v|
+          klass = BriteAPI.const_get(k.to_s.capitalize + "APIClient")
+          @response[k] = klass.new(@api_key, @options).verify(v)
+        end
+      end
+
+      threads.each { |thr| thr.join }
+
+      self
+    end
+
+    def valid?
+      return if @response == {}
+      @response.all?{ |_, data| data['status'] == 'valid' }
+    end
+
+    def status
+      return if @response == {}
+      states = ['valid', 'unknown', 'invalid']
+      states.each_with_index do |state, index|
+        return state if @response.all?{ |_, data| states[0, index + 1].include? data['status'] }
+      end
+      'unknown'
+    end
+
+    def errors
+      err = {}
+      @response.each do |key, data|
+        err[key] = data['error'] if data['error']
+      end
+      err
+    end
+
+    def error_codes
+      @response.map{ |_, data| data['error_code'] }.compact.uniq
+    end
+
+  end
+end

data/lib/brite-api/version.rb

@@ -0,0 +1,3 @@
+module BriteAPI
+  VERSION = '0.0.2'
+end

data/lib/brite-api.rb

@@ -0,0 +1,10 @@
+
+require File.expand_path('brite-api/version', File.dirname(__FILE__))
+require File.expand_path('brite-api/api_client', File.dirname(__FILE__))
+require File.expand_path('brite-api/clients/address_api_client', File.dirname(__FILE__))
+require File.expand_path('brite-api/clients/email_api_client', File.dirname(__FILE__))
+require File.expand_path('brite-api/clients/ip_api_client', File.dirname(__FILE__))
+require File.expand_path('brite-api/clients/name_api_client', File.dirname(__FILE__))
+require File.expand_path('brite-api/clients/phone_api_client', File.dirname(__FILE__))
+require File.expand_path('brite-api/client', File.dirname(__FILE__))
+require File.expand_path('brite-api/contact', File.dirname(__FILE__))

metadata

@@ -0,0 +1,141 @@
+--- !ruby/object:Gem::Specification
+name: brite-api
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Alexander Shapiotko
+- BriteVerify
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  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: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>'
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>'
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+description: Ruby client for BriteVerify API
+email:
+- support@briteverify.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/brite-api/api_client.rb
+- lib/brite-api/client.rb
+- lib/brite-api/clients/address_api_client.rb
+- lib/brite-api/clients/email_api_client.rb
+- lib/brite-api/clients/ip_api_client.rb
+- lib/brite-api/clients/name_api_client.rb
+- lib/brite-api/clients/phone_api_client.rb
+- lib/brite-api/contact.rb
+- lib/brite-api/version.rb
+- lib/brite-api.rb
+- README.md
+- LICENSE
+homepage: https://github.com/BriteVerify/brite-api-ruby
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '1.9'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: 1.3.6
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.0
+signing_key: 
+specification_version: 4
+summary: Ruby client for BriteVerify API
+test_files: []