nextcaller_client 0.0.2 → 0.0.3

data/lib/nextcaller_client/client.rb

@@ -1,11 +1,12 @@
 module NextcallerClient
   #The NextCaller API client
-  class Client
+  class NextCallerClient
 
     attr_accessor :auth
 
-    def initialize(api_key, api_secret)
-      auth = {username: api_key, password: api_secret}
+    def initialize(username, password, sandbox=false)
+      auth = {username: username, password: password}
+      @sandbox = sandbox
       @transport = Transport.new(auth, DEFAULT_USER_AGENT)
     end
 
@@ -15,67 +16,203 @@ module NextcallerClient
     #   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
+        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
+      url = Utils.prepare_url('records/', @sandbox, url_params)
+      response = @transport.make_http_request(url, 'GET', debug)
+
+      block_given? ? yield(response) : JSON.parse(response.body)
     end
 
     # Get profile by id
     # arguments:
-    #   profile_id      -- Profile identifier, required
+    #   profile_id      -- Profile identifier, required, length is 30
     #   debug           -- boolean (default false)
     #
     def get_by_profile_id(profile_id, debug=false)
-
-      method = 'GET'
+      Utils.validate_profile_id(profile_id)
       url_params = {
-          format: JSON_RESPONSE_FORMAT
+        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
+      url = Utils.prepare_url('users/%s/' % profile_id, @sandbox, url_params)
+      response = @transport.make_http_request(url, 'GET', debug)
+
+      block_given? ? yield(response) : JSON.parse(response.body)
     end
 
     # Update profile by id
     # arguments:
-    #   profile_id      -- Profile identifier, required
+    #   profile_id      -- Profile identifier, required, length is 30
     #   data            -- dictionary with changed data, required
     #   debug           -- boolean (default false)
     #
     def update_by_profile_id(profile_id, data, debug=false)
+      Utils.validate_profile_id(profile_id)
+      url_params = {
+        format: JSON_RESPONSE_FORMAT
+      }
+      url = Utils.prepare_url('users/%s/' % profile_id, @sandbox, url_params)
+      data = Utils.prepare_json_data(data)
+      response = @transport.make_http_request(url, 'POST', debug, data)
 
-      method = 'POST'
+      block_given? ? yield(response) : response
+    end
+
+    # Get fraud level for phone
+    # arguments:
+    #   phone           -- 10 digits phone, str ot int, required
+    #   debug           -- boolean (default false)
+    #
+    def get_fraud_level(phone, debug=false)
+      Utils.validate_phone(phone)
       url_params = {
-          format: JSON_RESPONSE_FORMAT
+        phone: phone,
+        format: JSON_RESPONSE_FORMAT
       }
-      url = Utils.prepare_url('users/%s/' % profile_id, url_params)
+      url = Utils.prepare_url('fraud/', @sandbox, url_params)
+      response = @transport.make_http_request(url, 'GET', debug)
+
+      block_given? ? yield(response) : JSON.parse(response.body)
+    end
+
+  end
+
+
+  #The NextCaller platform API client
+  class NextCallerPlatformClient < NextCallerClient
+
+    # Get profiles by phone
+    # arguments:
+    #   phone               -- 10 digits phone, str ot int, required
+    #   platform_username   -- platform username, str.
+    #   debug               -- boolean (default false)
+    #
+    def get_by_phone(phone, platform_username, debug=false)
+      Utils.validate_phone(phone)
+      Utils.validate_platform_username(platform_username)
+      url_params = {
+        phone: phone,
+        platform_username: platform_username, 
+        format: JSON_RESPONSE_FORMAT
+      }
+      url = Utils.prepare_url('records/', @sandbox, url_params)
+      response = @transport.make_http_request(url, 'GET', debug)
+
+      block_given? ? yield(response) : JSON.parse(response.body)
+    end
+
+    # Get profiles by phone
+    # arguments:
+    #   profile_id          -- Profile identifier, required, length is 30
+    #   platform_username   -- platform username, str.
+    #   debug               -- boolean (default false)
+    #
+    def get_by_profile_id(profile_id, platform_username, debug=false)
+      Utils.validate_profile_id(profile_id)
+      Utils.validate_platform_username(platform_username)
+      url_params = {
+        platform_username: platform_username,
+        format: JSON_RESPONSE_FORMAT        
+      }
+      url = Utils.prepare_url('users/%s/' % profile_id, @sandbox, url_params)
+      response = @transport.make_http_request(url, 'GET', debug)
+
+      block_given? ? yield(response) : JSON.parse(response.body)
+    end
+
+    # Get profiles by phone
+    # arguments:
+    #   profile_id          -- Profile identifier, required, length is 30
+    #   data                -- dictionary with changed data, required
+    #   platform_username   -- platform username, str.
+    #   debug               -- boolean (default false)
+    #
+    def update_by_profile_id(profile_id, platform_username, data, debug=false)
+      Utils.validate_profile_id(profile_id)
+      Utils.validate_platform_username(platform_username)
+      url_params = {
+        platform_username: platform_username, 
+        format: JSON_RESPONSE_FORMAT
+      }
+      url = Utils.prepare_url('users/%s/' % profile_id, @sandbox, url_params)
       data = Utils.prepare_json_data(data)
-      response = @transport.make_http_request(url, method, debug, data)
+      response = @transport.make_http_request(url, 'POST', debug, data)
+
+      block_given? ? yield(response) : response
+    end
+
+    # Get profiles by phone
+    # arguments:
+    #   phone               -- 10 digits phone, str ot int, required
+    #   data                -- dictionary with changed data, required
+    #   platform_username   -- platform username, str.
+    #   debug               -- boolean (default false)
+    #
+    def get_fraud_level(phone, platform_username, debug=false)
+      Utils.validate_phone(phone)
+      Utils.validate_platform_username(platform_username)
+      url_params = {
+        platform_username: platform_username,
+        phone: phone,
+        format: JSON_RESPONSE_FORMAT
+      }
+      url = Utils.prepare_url('fraud/', @sandbox, url_params)
+      response = @transport.make_http_request(url, 'GET', debug)
+
+      block_given? ? yield(response) : JSON.parse(response.body)
+    end
+
+    # Get platform statistics
+    # arguments:
+    #   debug               -- boolean (default false)
+    #
+    def get_platform_statistics(debug=false)
+      url_params = {
+        format: JSON_RESPONSE_FORMAT
+      }
+      url = Utils.prepare_url('platform_users/', @sandbox, url_params)
+      response = @transport.make_http_request(url, 'GET', debug)
+
+      block_given? ? yield(response) : JSON.parse(response.body)
+    end
+
+    # Get platform user
+    # arguments:
+    #   platform_username   -- platform username, str.
+    #   debug               -- boolean (default false)
+    #
+    def get_platform_user(platform_username, debug=false)
+      Utils.validate_platform_username(platform_username)
+      url_params = {
+        format: JSON_RESPONSE_FORMAT
+      }
+      url = Utils.prepare_url('platform_users/%s/' % platform_username, @sandbox, url_params)
+      response = @transport.make_http_request(url, 'GET', debug)
 
-      if block_given?
-        yield response
-      else
-        response
-      end
+      block_given? ? yield(response) : JSON.parse(response.body)
     end
 
+    # Update platform user data
+    # arguments:
+    #   platform_username   -- platform username, str.
+    #   data                -- dictionary with changed data, required
+    #   debug               -- boolean (default false)
+    #
+    def update_platform_user(platform_username, data, debug=false)
+      Utils.validate_platform_username(platform_username)
+      url_params = {
+        format: JSON_RESPONSE_FORMAT
+      }
+      url = Utils.prepare_url('platform_users/%s/' % platform_username, @sandbox, url_params)
+      data = Utils.prepare_json_data(data)
+      response = @transport.make_http_request(url, 'POST', debug, data)
+
+      block_given? ? yield(response) : response
+    end  
+
   end
 
 end

data/lib/nextcaller_client/constants.rb

@@ -3,10 +3,12 @@ module NextcallerClient
   DEFAULT_REQUEST_TIMEOUT = 60
   JSON_RESPONSE_FORMAT = 'json'
   DEFAULT_PHONE_LENGTH = 10
+  DEFAULT_PROFILE_ID_LENGTH = 30
   DEFAULT_USER_AGENT = 'nextcaller/ruby/%s' % VERSION
 
   # urls
   BASE_URL = 'api.nextcaller.com/v2/'
   FULL_URL = 'https://api.nextcaller.com/v2/'
+  FULL_SANDBOX_URL = 'https://api.sandbox.nextcaller.com/v2/'
 
 end

data/lib/nextcaller_client/transport.rb

@@ -34,20 +34,22 @@ module NextcallerClient
       @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
+      begin
+        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
+      rescue Net::ReadTimeout
+        raise HttpException.new({}), 'Server Error: read timeout error'
       end
     end
 
   end
 
-end
-
+end

data/lib/nextcaller_client/utils.rb

@@ -20,14 +20,30 @@ module NextcallerClient
     #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
+      unless value =~ /^[0-9]{#{length}}$/
+        raise ArgumentError, 'Invalid phone number: %s. Phone should consists of #{length} digits.' % value
+      end
+    end
+
+    #Validate porfile id
+    def self.validate_profile_id(value, length=DEFAULT_PROFILE_ID_LENGTH)
+      value = value.to_s
+      unless value =~ /^[0-9a-zA-Z]{#{length}}$/
+        raise ArgumentError, 'Invalid profile id: %s. Profile id should consists of #{length} characters.' % value
+      end
+    end
+
+    #Validate platform_username
+    def self.validate_platform_username(value)
+      value = value.to_s
+      if value =~ /\W/
+        raise ArgumentError, 'Invalid platform name: %s. Platfrom name should contain only an alphanumeric character, including _.' % value
       end
     end
 
     #Prepare url from path and params
-    def self.prepare_url(path, url_params={})
-      url = '%s%s' % [FULL_URL, path]
+    def self.prepare_url(path, sandbox, url_params={})
+      url = '%s%s' % [sandbox ? FULL_SANDBOX_URL : FULL_URL, path]
       unless url.end_with?('/')
         url += '/'
       end

data/lib/nextcaller_client/version.rb

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

data/test/constants.rb

@@ -0,0 +1,206 @@
+# encoding: utf-8
+
+TEST_USERNAME = 'username'
+TEST_PASSWORD = 'password'
+
+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"
+      }
+    ]
+  }'
+
+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"
+  }'
+
+FRAUD_LEVEL_JSON_RESULT_EXAMPLE = '
+  {
+    "spoofed": "false",
+    "fraud_risk": "low"
+  }'
+
+PLATFORM_STATISTICS_JSON_RESULT = '
+  { 
+    "platform_users": [ 
+      {  
+        "created_time": "2014­03­16T10:40:12", 
+        "number_of_operations": 1, 
+        "resource_uri": "/api/v2/platform_users/pl2_un2/", 
+        "total_calls": 
+          { 
+            "2014­05": 2 
+          }, 
+        "successful_calls": 
+          { 
+            "2014­05": 1 
+          }, 
+        "billable_calls": { }, 
+        "username": "pl2_un1" 
+      }, 
+      { 
+        "created_time": "2014­04­16T13:42:00", 
+        "number_of_operations": 24, 
+        "resource_uri": "/api/v2/platform_users/pl2_un1/", 
+        "total_calls": 
+          {
+            "2014­03": 7,
+            "2014­04": 12, 
+            "2014­05": 10 
+          }, 
+        "successful_calls": 
+          { 
+            "2014­03": 6, 
+            "2014­04": 10, 
+            "2014­05": 8 
+          }, 
+        "billable_calls": 
+          { 
+            "2014­04": 1, 
+            "2014­05": 1 
+          }, 
+        "username": "pl2_un2" 
+      } 
+    ], 
+    "total_platform_calls": 
+      { 
+        "2014­03": 7, 
+        "2014­04": 12, 
+        "2014­05": 2 
+      }, 
+    "successful_platform_calls": 
+      {  
+        "2014­03": 6, 
+        "2014­04": 10, 
+        "2014­05": 9 
+      }, 
+    "billable_platform_calls": 
+      { 
+        "2014­04": 1, 
+        "2014­05": 1 
+      } 
+  }'
+
+PLATFORM_USER_JSON_REQUEST_EXAMPLE = 
+  { 
+    first_name: "platform_user1_fname",  
+    last_name: "platform_user1_lname",  
+    company_name: "platform_company1_name",  
+    email: "company_email@company1.com"  
+  }
+
+PLATFORM_USER_JSON_RESULT = '
+  {
+    "created_time": "2014­04­16T13:42:00", 
+    "number_of_operations": 24,  
+    "resource_uri": "/api/v2/platform_users/user12345/",  
+    "total_calls": 
+      {  
+        "2014­03": 7,  
+        "2014­04": 12,  
+        "2014­05": 10  
+      },  
+    "successful_calls": 
+      {  
+        "2014­03": 6,  
+        "2014­04": 10,  
+        "2014­05": 8  
+      },  
+    "billable_calls": 
+      {  
+        "2014­04": 1,  
+        "2014­05": 1  
+      },  
+    "username": "user12345"  
+  }'

data/test/test_base.rb

@@ -1,9 +1,7 @@
 require 'nextcaller_client'
 require 'webmock/minitest'
 require 'minitest/autorun'
-
-TEST_USERNAME = 'username'
-TEST_PASSWORD = 'password'
+require_relative './constants'
 
 def prepare_url_for_test(path)
   return Regexp.new 'https://%s:%s@%s%s*' %[TEST_USERNAME, TEST_PASSWORD, NextcallerClient::BASE_URL, path]
@@ -12,7 +10,8 @@ end
 class BaseTestCase < Minitest::Test
 
   def initialize(name)
-    @client = NextcallerClient::Client.new(TEST_USERNAME, TEST_PASSWORD)
+    @client = NextcallerClient::NextCallerClient.new(TEST_USERNAME, TEST_PASSWORD)
+    @client_platform = NextcallerClient::NextCallerPlatformClient.new(TEST_USERNAME, TEST_PASSWORD)
     super(name)
   end
 

data/test/test_by_phone.rb

@@ -1,69 +1,28 @@
 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"
-        }
-    ]
-}'
+require_relative './constants'
 
 class PhoneTestCase < BaseTestCase
 
+  def initialize(name)
+    @phone = '2125558383'
+    super(name)
+  end
+
   def test_by_short_phone
-    phone = '212555838'
+    @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)}
+    assert_raises(ArgumentError) { @client.get_by_phone(@phone) }
   end
 
   def test_by_wrong_phone
-    phone = 'XXXXXXXXXX'
+    @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)}
+    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)
+    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')