nextcaller_client 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f2349e07434c48f600ec72ea85cc10741e58b153
+  data.tar.gz: dd6243f52aad95b9ceff988150db838eb5d29a4b
+SHA512:
+  metadata.gz: f0598de770e0c0eaceb0a4e9a574ec9f51c7310d23295567d0ff137a1129915c3ed6ea5825fc8e2068871e3579ce028fb92d82880d9be0cf157b927af10e4216
+  data.tar.gz: a8055a87666c80c0a6a4ede9419cf367996484082a6b3927c845308070cff80df250724b91735114bca02a73143aedbc1e8e8bc0c03e4042138e456b1b1dda05

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - 1.9.2
+  - 1.9.3
+  - 2.1.0
+  - jruby-19mode
+  - ruby-head

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in dogeify.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014  Next Caller Inc.
+
+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,88 @@
+# NextcallerClient
+
+A ruby wrapper around the Nextcaller API.
+
+[![Build Status](https://travis-ci.org/Nextcaller/nextcaller-ruby-api.svg?branch=master)](https://travis-ci.org/Nextcaller/nextcaller-ruby-api)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'nextcaller_client'
+
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install nextcaller_client
+    
+
+## Usage
+
+**Example**
+
+    require 'nextcaller_client'
+    api_key = "XXXXX"
+    api_secret = "YYYYY"
+    phone_number = "121212..."
+    client = NextcallerClient::Client.new(api_key, api_secret)
+    resp = client.get_by_phone(phone_number)
+    print resp
+    
+**Initializing client**
+
+    require 'nextcaller_client'
+    api_key = "XXXXX"
+    api_secret = "YYYYY"
+    client = NextcallerClient::Client.new(api_key, api_secret)
+    
+**Get profile by phone**
+
+    resp = client.get_by_phone(phone, response_format, debug)
+    
+    # arguments:
+    #   phone           -- 10 digits phone, str or int, required
+    #   debug           -- boolean (default false)
+
+**Get profile by id**
+
+    resp = client.get_by_profile_id(profile_id, response_format, debug)
+    
+    # arguments:
+    #   profile_id      -- Profile identifier, required
+    #   debug           -- boolean (default false)
+
+**Update profile by id**
+    
+    resp = client.update_by_profile_id(profile_id, data, debug)
+    
+    # arguments:
+    #   profile_id      -- Profile identifier, required
+    #   data            -- dictionary with changed data, required
+    #   debug           -- boolean (default false)
+    
+    # Returns 204 response in the case of the succesfull request.
+
+
+##Exceptions
+
+**NextcallerClient::HttpException**
+
+Thrown in the case of 4xx or 5xx response from server.
+'content' attribute contains parsed response body.
+
+    
+##Notes
+
+It is possible to override the default response handler 
+by passing a block to get_by_phone/get_by_profile_id/update_by_profile_id function. 
+For example:
+
+    result = client.get_by_phone(number) { |resp| {body: JSON.parse(resp.body), code: resp.code} } # resp is Net::HTTPResponse object
+
+Default handler for get_by_* methods:
+    
+    JSON.parse(resp.body)

data/Rakefile

@@ -0,0 +1,9 @@
+require 'rake/testtask'
+require "bundler/gem_tasks"
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+end
+
+desc "Run tests"
+task :default => :test

data/lib/nextcaller_client/client.rb

@@ -0,0 +1,82 @@
+module NextcallerClient
+  #The NextCaller API client
+  class Client
+
+    attr_accessor :auth
+
+    def initialize(api_key, api_secret)
+      auth = {username: api_key, password: api_secret}
+      @transport = Transport.new(auth, DEFAULT_USER_AGENT)
+    end
+
+    # Get profiles by phone
+    # arguments:
+    #   phone           -- 10 digits phone, str ot int, required
+    #   debug           -- boolean (default false)
+    #
+    def get_by_phone(phone, debug=false)
+
+      method = 'GET'
+      Utils.validate_phone(phone)
+      url_params = {
+          phone: phone,
+          format: JSON_RESPONSE_FORMAT
+      }
+      url = Utils.prepare_url('records', url_params)
+      response = @transport.make_http_request(url, method, debug)
+
+      if block_given?
+        yield response
+      else
+        JSON.parse(response.body)
+      end
+    end
+
+    # Get profile by id
+    # arguments:
+    #   profile_id      -- Profile identifier, required
+    #   debug           -- boolean (default false)
+    #
+    def get_by_profile_id(profile_id, debug=false)
+
+      method = 'GET'
+      url_params = {
+          format: JSON_RESPONSE_FORMAT
+      }
+      url = Utils.prepare_url('users/%s/' % profile_id, url_params)
+      response = @transport.make_http_request(url, method, debug)
+
+      if block_given?
+        yield response
+      else
+        JSON.parse(response.body)
+      end
+    end
+
+    # Update profile by id
+    # arguments:
+    #   profile_id      -- Profile identifier, required
+    #   data            -- dictionary with changed data, required
+    #   debug           -- boolean (default false)
+    #
+    def update_by_profile_id(profile_id, data, debug=false)
+
+      method = 'POST'
+      url_params = {
+          format: JSON_RESPONSE_FORMAT
+      }
+      url = Utils.prepare_url('users/%s/' % profile_id, url_params)
+      data = Utils.prepare_json_data(data)
+      response = @transport.make_http_request(url, method, debug, data)
+
+      if block_given?
+        yield response
+      else
+        response
+      end
+    end
+
+  end
+
+end
+

data/lib/nextcaller_client/constants.rb

@@ -0,0 +1,12 @@
+module NextcallerClient
+  # default values
+  DEFAULT_REQUEST_TIMEOUT = 60
+  JSON_RESPONSE_FORMAT = 'json'
+  DEFAULT_PHONE_LENGTH = 10
+  DEFAULT_USER_AGENT = 'nextcaller/ruby/%s' % VERSION
+
+  # urls
+  BASE_URL = 'api.nextcaller.com/v2/'
+  FULL_URL = 'https://api.nextcaller.com/v2/'
+
+end

data/lib/nextcaller_client/exceptions.rb

@@ -0,0 +1,12 @@
+module NextcallerClient
+
+  class HttpException < StandardError
+
+    attr_reader :content
+
+    def initialize(content)
+      @content = content
+    end
+  end
+
+end

data/lib/nextcaller_client/transport.rb

@@ -0,0 +1,53 @@
+module NextcallerClient
+
+  class Transport
+
+    attr_accessor :auth, :user_agent, :log
+
+    def initialize(auth, user_agent=DEFAULT_USER_AGENT)
+      @auth = auth
+      @user_agent = user_agent
+      @log = Logger.new(STDOUT)
+      @log.level = Logger::DEBUG
+    end
+
+    def make_http_request(url, method='GET', debug=false, data={})
+      uri = URI.parse(url)
+      case method
+        when 'GET'
+          request = Net::HTTP::Get.new('%s?%s' % [uri.path, uri.query])
+        when 'POST'
+          request = Net::HTTP::Post.new('%s?%s' % [uri.path, uri.query])
+          request['Content-Type'] = 'application/json'
+          request.body = data
+      end
+      request.basic_auth(@auth[:username], @auth[:password])
+      request['Connection'] = 'Keep-Alive'
+      request['User-Agent'] = @user_agent if @user_agent
+
+      hostname =  /\A\[(.*)\]\z/ =~ uri.host ? $1 : uri.host # ruby prior to 1.9.3 does not have 'hostname', which removes brackets from ipv6 addresses
+      https = Net::HTTP.new(hostname, uri.port)
+      https.read_timeout = DEFAULT_REQUEST_TIMEOUT
+      https.use_ssl = true
+
+      # https.set_debug_output($stderr) if debug              #deep debug
+      @log.debug('Request url: %s' % url) if debug
+      @log.debug('Request body: %s' % data.to_s) if debug && method == 'POST'
+
+      response = https.start { |http| http.request(request) }
+      case response
+        when Net::HTTPSuccess then
+          response
+        else
+          if response.code.to_i.between?(400, 499)
+            raise HttpException.new(Utils.parse_error_response(response)), '%s Client Error: %s' % [response.code, response.message]
+          elsif response.code.to_i.between?(500, 599)
+            raise HttpException.new(Utils.parse_error_response(response)), '%s Server Error: %s' % [response.code, response.message]
+          end
+      end
+    end
+
+  end
+
+end
+

data/lib/nextcaller_client/utils.rb

@@ -0,0 +1,43 @@
+module NextcallerClient
+
+  module Utils
+
+    def self.prepare_json_data(data)
+      unless data.is_a? Hash
+        raise ArgumentError, 'Data should be a hash.'
+      end
+      data.to_json
+    end
+
+    def self.parse_error_response(resp)
+      if resp['Content-Type'].include? 'application/json'
+        JSON.parse(resp.body)
+      else
+        resp.body
+      end
+    end
+
+    #Validate phone format
+    def self.validate_phone(value, length=DEFAULT_PHONE_LENGTH)
+      value = value.to_s
+      unless value =~ /^[0-9]{10}$/
+        raise ArgumentError, 'Invalid phone number: %s. Phone should consists of 10 digits.' % value
+      end
+    end
+
+    #Prepare url from path and params
+    def self.prepare_url(path, url_params={})
+      url = '%s%s' % [FULL_URL, path]
+      unless url.end_with?('/')
+        url += '/'
+      end
+      unless url_params.empty?
+        url_params_str = url_params.collect { |k, v| "#{CGI::escape(k.to_s)}=#{CGI::escape(v.to_s)}" }.join('&')
+        url += "?#{url_params_str}"
+      end
+      url
+    end
+
+  end
+
+end

data/lib/nextcaller_client/version.rb

@@ -0,0 +1,3 @@
+module NextcallerClient
+  VERSION = "0.0.2"
+end

data/lib/nextcaller_client.rb

@@ -0,0 +1,12 @@
+require 'cgi'
+require 'json'
+require 'uri'
+require 'logger'
+require 'net/http'
+
+require "nextcaller_client/version"
+require "nextcaller_client/constants"
+require "nextcaller_client/exceptions"
+require "nextcaller_client/utils"
+require "nextcaller_client/transport"
+require "nextcaller_client/client"

data/nextcaller_client.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'nextcaller_client/version'
+
+Gem::Specification.new do |s|
+  s.name          = "nextcaller_client"
+  s.version       = NextcallerClient::VERSION
+  s.authors       = ["Zenovich Alexey"]
+  s.email         = ["zenovich.alexey@itechart-group.com"]
+  s.summary       = 'A Ruby wrapper around the Nextcaller API.'
+  s.description   = 'A Ruby wrapper around the Nextcaller API. See https://dev.nextcaller.com/documentation/ for details.'
+  s.homepage      = 'http://rubygems.org/gems/nextcaller-client'
+  s.license       = "MIT"
+
+  s.files         = `git ls-files -z`.split("\x0")
+  s.executables   = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency "bundler", ">= 1.5"
+  s.add_development_dependency "rake", ">= 10.0"
+  s.add_development_dependency "minitest", "> 5.0.1"
+  s.add_development_dependency 'webmock', ">= 1.16"
+
+  s.required_ruby_version = '>= 1.9.2'
+end

data/test/test_base.rb

@@ -0,0 +1,21 @@
+require 'nextcaller_client'
+require 'webmock/minitest'
+require 'minitest/autorun'
+
+TEST_USERNAME = 'username'
+TEST_PASSWORD = 'password'
+
+def prepare_url_for_test(path)
+  return Regexp.new 'https://%s:%s@%s%s*' %[TEST_USERNAME, TEST_PASSWORD, NextcallerClient::BASE_URL, path]
+end
+
+class BaseTestCase < Minitest::Test
+
+  def initialize(name)
+    @client = NextcallerClient::Client.new(TEST_USERNAME, TEST_PASSWORD)
+    super(name)
+  end
+
+end
+
+ 

data/test/test_by_phone.rb

@@ -0,0 +1,73 @@
+require_relative './test_base'
+
+PHONE_JSON_RESULT_EXAMPLE = '
+{
+    "records": [
+        {
+            "id": "97d949a413f4ea8b85e9586e1f2d9a",
+            "first_name": "Jerry",
+            "last_name": "Seinfeld",
+            "name": "Jerry Seinfeld",
+            "language": "English",
+            "fraud_threat": "low",
+            "spoof": "false",
+            "phone": [
+                {
+                    "number": "2125558383"
+                }
+            ],
+            "carrier": "Verizon Wireless",
+            "line_type": "LAN",
+            "address": [
+                {
+                    "city": "New York",
+                    "extended_zip": "",
+                    "country": "USA",
+                    "line2": "Apt 5a",
+                    "line1": "129 West 81st Street",
+                    "state": "NY",
+                    "zip_code": "10024"
+                }
+            ],
+            "email": "demo@nextcaller.com",
+            "age": "45-54",
+            "gender": "Male",
+            "household_income": "50k-75k",
+            "marital_status": "Single",
+            "presence_of_children": "No",
+            "home_owner_status": "Rent",
+            "market_value": "350k-500k",
+            "length_of_residence": "12 Years",
+            "high_net_worth": "No",
+            "occupation": "Entertainer",
+            "education": "Completed College",
+            "department": "not specified"
+        }
+    ]
+}'
+
+class PhoneTestCase < BaseTestCase
+
+  def test_by_short_phone
+    phone = '212555838'
+    stub_request(:get, prepare_url_for_test('records')).to_return(:body => PHONE_JSON_RESULT_EXAMPLE, :status => 200)
+    assert_raises(ArgumentError) { @client.get_by_phone(phone)}
+  end
+
+  def test_by_wrong_phone
+    phone = 'XXXXXXXXXX'
+    stub_request(:get, prepare_url_for_test('records')).to_return(:body => PHONE_JSON_RESULT_EXAMPLE, :status => 200)
+    assert_raises(ArgumentError) { @client.get_by_phone(phone)}
+  end
+
+  def test_by_phone_json_request
+    phone = '2125558383'
+    stub_request(:get, prepare_url_for_test('records')).to_return(:body => PHONE_JSON_RESULT_EXAMPLE, :status => 200)
+    res = @client.get_by_phone(phone)
+    refute_nil(res['records'])
+    assert_equal(res['records'][0]['email'], 'demo@nextcaller.com')
+    assert_equal(res['records'][0]['first_name'], 'Jerry')
+    assert_equal(res['records'][0]['last_name'], 'Seinfeld')
+  end
+
+end

data/test/test_by_profile.rb

@@ -0,0 +1,77 @@
+require_relative './test_base'
+
+PROFILE_JSON_REQUEST_EXAMPLE = {
+    first_name: 'Clark',
+    last_name: 'Kent',
+    shipping_address1: {
+        line1: '225 Kryptonite Ave.',
+        line2: '',
+        city: 'Smallville',
+        state: 'KS',
+        zip_code: '66002'
+    }
+}
+
+PROFILE_JSON_RESULT_EXAMPLE = '
+{
+    "id": "97d949a413f4ea8b85e9586e1f2d9a",
+    "first_name": "Jerry",
+    "last_name": "Seinfeld",
+    "name": "Jerry Seinfeld",
+    "language": "English",
+    "fraud_threat": "low",
+    "spoof": "false",
+    "phone": [
+        {
+            "number": "2125558383"
+        }
+    ],
+    "carrier": "Verizon Wireless",
+    "line_type": "LAN",
+    "address": [
+        {
+            "city": "New York",
+            "extended_zip": "",
+            "country": "USA",
+            "line2": "Apt 5a",
+            "line1": "129 West 81st Street",
+            "state": "NY",
+            "zip_code": "10024"
+        }
+    ],
+    "email": "demo@nextcaller.com",
+    "age": "45-54",
+    "gender": "Male",
+    "household_income": "50k-75k",
+    "marital_status": "Single",
+    "presence_of_children": "No",
+    "home_owner_status": "Rent",
+    "market_value": "350k-500k",
+    "length_of_residence": "12 Years",
+    "high_net_worth": "No",
+    "occupation": "Entertainer",
+    "education": "Completed College",
+    "department": "not specified"
+}'
+
+class ProfileTestCase <BaseTestCase
+
+  def initialize(name)
+    @profile_id = '97d949a413f4ea8b85e9586e1f2d9a'
+    super(name)
+  end
+
+  def test_profile_get_json_request
+    stub_request(:get, prepare_url_for_test('users/')).to_return(:body => PROFILE_JSON_RESULT_EXAMPLE, :status => 200)
+    res = @client.get_by_profile_id(@profile_id)
+    assert_equal(res['email'], 'demo@nextcaller.com')
+    assert_equal(res['first_name'], 'Jerry')
+    assert_equal(res['last_name'], 'Seinfeld')
+  end
+
+  def test_profile_update_json_request
+    stub_request(:post, prepare_url_for_test('users/')).to_return(:status => 204)
+    res = @client.update_by_profile_id(@profile_id, PROFILE_JSON_REQUEST_EXAMPLE)
+    assert_equal(res.code, '204')
+  end
+end

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: nextcaller_client
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Zenovich Alexey
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 5.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 5.0.1
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.16'
+description: A Ruby wrapper around the Nextcaller API. See https://dev.nextcaller.com/documentation/
+  for details.
+email:
+- zenovich.alexey@itechart-group.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/nextcaller_client.rb
+- lib/nextcaller_client/client.rb
+- lib/nextcaller_client/constants.rb
+- lib/nextcaller_client/exceptions.rb
+- lib/nextcaller_client/transport.rb
+- lib/nextcaller_client/utils.rb
+- lib/nextcaller_client/version.rb
+- nextcaller_client.gemspec
+- test/test_base.rb
+- test/test_by_phone.rb
+- test/test_by_profile.rb
+homepage: http://rubygems.org/gems/nextcaller-client
+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.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: A Ruby wrapper around the Nextcaller API.
+test_files:
+- test/test_base.rb
+- test/test_by_phone.rb
+- test/test_by_profile.rb