nextcaller_client 0.0.3 → 0.0.4

data/lib/nextcaller_client/constants.rb

@@ -6,9 +6,15 @@ module NextcallerClient
   DEFAULT_PROFILE_ID_LENGTH = 30
   DEFAULT_USER_AGENT = 'nextcaller/ruby/%s' % VERSION
 
+  DEFAULT_PLATFORM_ACCOUNT_HEADER = 'Nc-Account-Id'
+  DEFAULT_PLATFORM_ACCOUNT_ID = 'ME'
+
   # urls
-  BASE_URL = 'api.nextcaller.com/v2/'
-  FULL_URL = 'https://api.nextcaller.com/v2/'
-  FULL_SANDBOX_URL = 'https://api.sandbox.nextcaller.com/v2/'
+  BASE_URL = 'api.nextcaller.com/v2.1/'
+  FULL_URL = 'https://api.nextcaller.com/v2.1/'
+  FULL_SANDBOX_URL = 'https://api.sandbox.nextcaller.com/v2.1/'
 
+  # address
+  ADDRESS_MANDATORY_FIELDS = %w(first_name last_name address)
+  ADDRESS_ALLOWED_FIELDS = ADDRESS_MANDATORY_FIELDS + %w(city state zip_code middle_name apt_suite extended_zip)
 end

data/lib/nextcaller_client/exceptions.rb

@@ -9,4 +9,14 @@ module NextcallerClient
     end
   end
 
+  class TooManyRequestsException < HttpException
+
+    attr_reader :content, :retry_after
+
+    def initialize(content, retry_after)
+      @content = content
+      @retry_after = retry_after
+    end
+  end
+
 end

data/lib/nextcaller_client/transport.rb

@@ -11,7 +11,7 @@ module NextcallerClient
       @log.level = Logger::DEBUG
     end
 
-    def make_http_request(url, method='GET', debug=false, data={})
+    def make_http_request(url, method='GET', data={}, account_id=nil)
       uri = URI.parse(url)
       case method
         when 'GET'
@@ -21,25 +21,25 @@ module NextcallerClient
           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
+      request[DEFAULT_PLATFORM_ACCOUNT_HEADER] = account_id if account_id
 
       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'
-
       begin
         response = https.start { |http| http.request(request) }
         case response
           when Net::HTTPSuccess then response
           else
-            if response.code.to_i.between?(400, 499)
+            if response.code.to_i.equal? 429
+              raise TooManyRequestsException.new(Utils.parse_error_response(response), Utils.parse_error_response_retry_after(response))
+            elsif 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]

data/lib/nextcaller_client/utils.rb

@@ -9,6 +9,10 @@ module NextcallerClient
       data.to_json
     end
 
+    def self.parse_error_response_retry_after(resp)
+      resp['Retry-After']
+    end
+
     def self.parse_error_response(resp)
       if resp['Content-Type'].include? 'application/json'
         JSON.parse(resp.body)
@@ -17,30 +21,6 @@ module NextcallerClient
       end
     end
 
-    #Validate phone format
-    def self.validate_phone(value, length=DEFAULT_PHONE_LENGTH)
-      value = value.to_s
-      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, sandbox, url_params={})
       url = '%s%s' % [sandbox ? FULL_SANDBOX_URL : FULL_URL, path]

data/lib/nextcaller_client/version.rb

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

data/test/constants.rb

@@ -173,7 +173,7 @@ PLATFORM_STATISTICS_JSON_RESULT = '
   }'
 
 PLATFORM_USER_JSON_REQUEST_EXAMPLE = 
-  { 
+  {
     first_name: "platform_user1_fname",  
     last_name: "platform_user1_lname",  
     company_name: "platform_company1_name",  

data/test/test_by_address_name.rb

@@ -0,0 +1,27 @@
+require_relative './test_base'
+require_relative './constants'
+
+class AddressNameTestCase < BaseTestCase
+
+  def initialize(name)
+    @address_data = {
+        'first_name' => 'Jerry',
+        'last_name' => 'Seinfeld',
+        'address' => '129 West 81st Street',
+        'city' => 'New York',
+        'state' => 'NY',
+        'zip_code' => '10024'
+    }
+    super(name)
+  end
+
+  def test_profile_get_name_address_json_request
+    stub_request(:get, prepare_url_for_test('records/')).to_return(:body => PHONE_JSON_RESULT_EXAMPLE, :status => 200)
+    res = @client.get_by_name_address(@address_data)
+
+    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_phone.rb

@@ -8,18 +8,6 @@ class PhoneTestCase < BaseTestCase
     super(name)
   end
 
-  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
     stub_request(:get, prepare_url_for_test('records')).to_return(:body => PHONE_JSON_RESULT_EXAMPLE, :status => 200)
     res = @client.get_by_phone(@phone)

data/test/test_by_profile.rb

@@ -16,18 +16,6 @@ class ProfileTestCase < BaseTestCase
     assert_equal(res['last_name'], 'Seinfeld')
   end
 
-  def test_by_wrong_profile_id
-    @profile_id = 'XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX'
-    stub_request(:get, prepare_url_for_test('users/')).to_return(:body => PROFILE_JSON_RESULT_EXAMPLE, :status => 200)
-    assert_raises(ArgumentError) { @client.get_by_profile_id(@profile_id) }
-  end
-
-  def test_profile_update_by_wrong_profile_id
-    @profile_id = 'XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX'
-    stub_request(:post, prepare_url_for_test('users/')).to_return(:status => 204)
-    assert_raises(ArgumentError) { @client.get_by_profile_id(@profile_id) }
-  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)

data/test/test_fraud_level.rb

@@ -14,11 +14,5 @@ class FraudLevelTestCase < BaseTestCase
     assert_equal(res['spoofed'], 'false')
     assert_equal(res['fraud_risk'], 'low')
   end
-
-  def test_fraud_level_by_wrong_phone
-    @phone = '123'
-    stub_request(:get, prepare_url_for_test('fraud/')).to_return(:body => FRAUD_LEVEL_JSON_RESULT_EXAMPLE, :status => 200)
-    assert_raises(ArgumentError) { @client.get_fraud_level(@phone) }
-  end
-
+  
 end

data/test/test_platform_by_address_name.rb

@@ -0,0 +1,29 @@
+require_relative './test_base'
+require_relative './constants'
+
+class PlatformProfileTestCase < BaseTestCase
+
+  def initialize(name)
+    @account_id = 'user12345'
+        super(name)
+  end
+
+  def test_platform_profile_get_name_address_json_request
+    stub_request(:get, prepare_url_for_test('records/')).to_return(:body => PHONE_JSON_RESULT_EXAMPLE, :status => 200)
+    name_address_data = {
+        'first_name' => 'Jerry',
+        'last_name' => 'Seinfeld',
+        'address' => '129 West 81st Street',
+        'city' => 'New York',
+        'state' => 'NY',
+        'zip_code' => '10024'
+    }
+
+    res = @client_platform.get_by_name_address(name_address_data, @account_id)
+
+    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_platform_by_phone.rb

@@ -5,25 +5,13 @@ class PlatformPhoneTestCase < BaseTestCase
 
   def initialize(name)
     @phone = '2125558383'
-    @platform_username = 'user12345'
+    @account_id = 'user12345'
     super(name)
   end
 
-  def test_by_wrong_phone
-    @phone = '212555838'
-    stub_request(:get, prepare_url_for_test('records')).to_return(:body => PHONE_JSON_RESULT_EXAMPLE, :status => 200)
-    assert_raises(ArgumentError) { @client_platform.get_by_phone(@phone, @platform_username) }
-  end
-
-  def test_by_wrong_platform
-    @platform_username = 'user#12345'
-    stub_request(:get, prepare_url_for_test('records')).to_return(:body => PHONE_JSON_RESULT_EXAMPLE, :status => 200)
-    assert_raises(ArgumentError) { @client_platform.get_by_phone(@phone, @platform_username) }
-  end
-
   def test_by_phone_json_request
     stub_request(:get, prepare_url_for_test('records')).to_return(:body => PHONE_JSON_RESULT_EXAMPLE, :status => 200)
-    res = @client_platform.get_by_phone(@phone, @platform_username)
+    res = @client_platform.get_by_phone(@phone, @account_id)
     refute_nil(res['records'])
     assert_equal(res['records'][0]['email'], 'demo@nextcaller.com')
     assert_equal(res['records'][0]['first_name'], 'Jerry')

data/test/test_platform_by_profile_id.rb

@@ -5,45 +5,21 @@ class PlatformProfileTestCase < BaseTestCase
 
   def initialize(name)
     @profile_id = '97d949a413f4ea8b85e9586e1f2d9a'
-    @platform_username = 'user12345'
+    @account_id = 'user12345'
     super(name)
   end
 
   def test_platform_profile_get_json_request
     stub_request(:get, prepare_url_for_test('users/')).to_return(:body => PROFILE_JSON_RESULT_EXAMPLE, :status => 200)
-    res = @client_platform.get_by_profile_id(@profile_id, @platform_username)
+    res = @client_platform.get_by_profile_id(@profile_id, @account_id)
     assert_equal(res['email'], 'demo@nextcaller.com')
     assert_equal(res['first_name'], 'Jerry')
     assert_equal(res['last_name'], 'Seinfeld')
   end
 
-  def test_platform_profile_by_wrong_profile_id
-    @profile_id = 'XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX'
-    stub_request(:get, prepare_url_for_test('users/')).to_return(:body => PROFILE_JSON_RESULT_EXAMPLE, :status => 200)
-    assert_raises(ArgumentError) { @client_platform.get_by_profile_id(@profile_id, @platform_username) }
-  end
-
-  def test_platform_profile_by_wrong_platform
-    @platform_username = 'user#12345'
-    stub_request(:get, prepare_url_for_test('users/')).to_return(:body => PROFILE_JSON_RESULT_EXAMPLE, :status => 200)
-    assert_raises(ArgumentError) { @client_platform.get_by_profile_id(@profile_id, @platform_username) }
-  end
-
-  def test_platform_profile_update_json_request_by_wrong_profile_id
-    @profile_id = 'XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX'
-    stub_request(:post, prepare_url_for_test('users/')).to_return(:status => 204)
-    assert_raises(ArgumentError) { @client_platform.update_by_profile_id(@profile_id, @platform_username) }
-  end
-
-  def test_platform_profile_update_json_request_by_wrong_wrong_platform
-    @platform_username = 'user#12345'
-    stub_request(:post, prepare_url_for_test('users/')).to_return(:status => 204)
-    assert_raises(ArgumentError) { @client_platform.update_by_profile_id(@profile_id, @platform_username) }
-  end
-
   def test_platform_profile_update_json_request
     stub_request(:post, prepare_url_for_test('users/')).to_return(:status => 204)
-    res = @client_platform.update_by_profile_id(@profile_id, @platform_username, PROFILE_JSON_REQUEST_EXAMPLE)
+    res = @client_platform.update_by_profile_id(@profile_id, @account_id, PROFILE_JSON_REQUEST_EXAMPLE)
     assert_equal(res.code, '204')
   end
 

data/test/test_platform_fraud_level.rb

@@ -5,27 +5,15 @@ class PlatformFraudLevelTestCase < BaseTestCase
 
   def initialize(name)
     @phone = '2125558383'
-    @platform_username = 'user12345'
+    @account_id = 'user12345'
     super(name)
   end
 
   def test_platform_fraud_level_json_request
     stub_request(:get, prepare_url_for_test('fraud/')).to_return(:body => FRAUD_LEVEL_JSON_RESULT_EXAMPLE, :status => 200)
-    res = @client_platform.get_fraud_level(@phone, @platform_username)
+    res = @client_platform.get_fraud_level(@phone, @account_id)
     assert_equal(res['spoofed'], 'false')
     assert_equal(res['fraud_risk'], 'low')
   end
 
-  def test_fraud_level_by_wrong_phone
-    @phone = '123'
-    stub_request(:get, prepare_url_for_test('fraud/')).to_return(:body => FRAUD_LEVEL_JSON_RESULT_EXAMPLE, :status => 200)
-    assert_raises(ArgumentError) { @client_platform.get_fraud_level(@phone, @platform_username) }
-  end
-
-  def test_fraud_level_by_wrong_platform
-    @platform_username = 'user#12345'
-    stub_request(:get, prepare_url_for_test('fraud/')).to_return(:body => FRAUD_LEVEL_JSON_RESULT_EXAMPLE, :status => 200)
-    assert_raises(ArgumentError) { @client_platform.get_fraud_level(@phone, @platform_username) }
-  end
-
 end

data/test/test_platform_statistics.rb

@@ -4,8 +4,8 @@ require_relative './constants'
 class PlatformStatisticsTestCase < BaseTestCase
 
   def test_platform_statistics_json_response
-    stub_request(:get, prepare_url_for_test('platform_users/')).to_return(:body => PLATFORM_STATISTICS_JSON_RESULT, :status => 200)
-    res = @client_platform.get_platform_statistics
+    stub_request(:get, prepare_url_for_test('accounts/')).to_return(:body => PLATFORM_STATISTICS_JSON_RESULT, :status => 200)
+    res = @client_platform.get_platform_statistics(1)
     assert_equal(res['platform_users'][0]['username'], 'pl2_un1')
     assert_equal(res['platform_users'][1]['username'], 'pl2_un2')
   end

data/test/test_platform_user.rb

@@ -4,31 +4,19 @@ require_relative './constants'
 class PlatformUserTestCase < BaseTestCase
 
   def initialize(name)
-    @platform_username = 'user12345'
+    @account_id = 'user12345'
     super(name)
   end
 
-  def test_platform_user_by_wrong_platform
-    @platform_username = 'user#12345'
-    stub_request(:get, prepare_url_for_test('platform_users/%s' % @platform_username)).to_return(:body => PLATFORM_USER_JSON_RESULT, :status => 200)
-    assert_raises(ArgumentError) { @client_platform.get_platform_user(@platform_username) }
-  end
-
   def test_platform_user_json_request
-    stub_request(:get, prepare_url_for_test('platform_users/%s' % @platform_username)).to_return(:body => PLATFORM_USER_JSON_RESULT, :status => 200)
-    res = @client_platform.get_platform_user(@platform_username)
+    stub_request(:get, prepare_url_for_test('accounts/%s' % @account_id)).to_return(:body => PLATFORM_USER_JSON_RESULT, :status => 200)
+    res = @client_platform.get_platform_account(@account_id)
     assert_equal(res['number_of_operations'], 24)
   end
 
-  def test_platform_update_user_by_wrong_platform
-    @platform_username = 'user#12345'
-    stub_request(:post, prepare_url_for_test('platform_users/%s' % @platform_username)).to_return(:status => 204)
-    assert_raises(ArgumentError) { @client_platform.update_platform_user(@platform_username) }
-  end
-
   def test_platform_update_user_json_request
-    stub_request(:post, prepare_url_for_test('platform_users/%s' % @platform_username)).to_return(:status => 204)
-    res = @client_platform.update_platform_user(@platform_username, PLATFORM_USER_JSON_REQUEST_EXAMPLE)
+    stub_request(:post, prepare_url_for_test('accounts/%s' % @account_id)).to_return(:status => 204)
+    res = @client_platform.update_platform_account(PLATFORM_USER_JSON_REQUEST_EXAMPLE, @account_id)
     assert_equal(res.code, '204')
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nextcaller_client
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Zenovich Alexey
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-09 00:00:00.000000000 Z
+date: 2015-11-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -81,10 +81,14 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- examples/client_get_by_address_name.rb
+- examples/client_get_by_email.rb
 - examples/client_get_by_phone.rb
 - examples/client_get_by_profile_id.rb
 - examples/client_get_fraud_level.rb
 - examples/client_update_by_profile_id.rb
+- examples/platform_get_by_address_name.rb
+- examples/platform_get_by_email.rb
 - examples/platform_get_by_phone.rb
 - examples/platform_get_by_profile_id.rb
 - examples/platform_get_fraud_level.rb
@@ -102,9 +106,11 @@ files:
 - nextcaller_client.gemspec
 - test/constants.rb
 - test/test_base.rb
+- test/test_by_address_name.rb
 - test/test_by_phone.rb
 - test/test_by_profile.rb
 - test/test_fraud_level.rb
+- test/test_platform_by_address_name.rb
 - test/test_platform_by_phone.rb
 - test/test_platform_by_profile_id.rb
 - test/test_platform_fraud_level.rb
@@ -130,16 +136,18 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: A Ruby wrapper around the Nextcaller API.
 test_files:
 - test/constants.rb
 - test/test_base.rb
+- test/test_by_address_name.rb
 - test/test_by_phone.rb
 - test/test_by_profile.rb
 - test/test_fraud_level.rb
+- test/test_platform_by_address_name.rb
 - test/test_platform_by_phone.rb
 - test/test_platform_by_profile_id.rb
 - test/test_platform_fraud_level.rb