nextcaller_client 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f2349e07434c48f600ec72ea85cc10741e58b153
-  data.tar.gz: dd6243f52aad95b9ceff988150db838eb5d29a4b
+  metadata.gz: 3dad21050c4c7b20a11909629c5ac046c510e01f
+  data.tar.gz: e3d576fc8338e4e4ead88b24ba6b048c186d5f24
 SHA512:
-  metadata.gz: f0598de770e0c0eaceb0a4e9a574ec9f51c7310d23295567d0ff137a1129915c3ed6ea5825fc8e2068871e3579ce028fb92d82880d9be0cf157b927af10e4216
-  data.tar.gz: a8055a87666c80c0a6a4ede9419cf367996484082a6b3927c845308070cff80df250724b91735114bca02a73143aedbc1e8e8bc0c03e4042138e456b1b1dda05
+  metadata.gz: ee989ed5e9e42a07fabf5d6b4337d864e93a54d16efd3a0da4d833707907c7cdaafda820a606d894e449ffad1fa7344ae600144318b15dd46602b883cb995036
+  data.tar.gz: 85cb16a130a0d5084d43e4cc5c42e63df321bd2003d3f336f5626a4cbf63442bd98b67b1b5a328ae5e6241923ef22ca6577caa8f60bd26cb3da865ec36e8ff5f

data/.gitignore

@@ -1 +1,4 @@
 /pkg
+
+# RubyMine project files
+.idea

data/Gemfile.lock

@@ -0,0 +1,27 @@
+PATH
+  remote: .
+  specs:
+    nextcaller_client (0.0.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.3.6)
+    crack (0.4.2)
+      safe_yaml (~> 1.0.0)
+    minitest (5.4.3)
+    rake (10.4.2)
+    safe_yaml (1.0.4)
+    webmock (1.20.4)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (>= 1.5)
+  minitest (> 5.0.1)
+  nextcaller_client!
+  rake (>= 10.0)
+  webmock (>= 1.16)

data/README.md

@@ -25,23 +25,23 @@ Or install it yourself as:
 **Example**
 
     require 'nextcaller_client'
-    api_key = "XXXXX"
-    api_secret = "YYYYY"
+    username = "XXXXX"
+    password = "YYYYY"
     phone_number = "121212..."
-    client = NextcallerClient::Client.new(api_key, api_secret)
+    client = NextcallerClient::NextCallerClient.new(username, password)
     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)
+    username = "XXXXX"
+    password = "YYYYY"
+    client = NextcallerClient::NextCallerClient.new(username, password)
     
 **Get profile by phone**
 
-    resp = client.get_by_phone(phone, response_format, debug)
+    resp = client.get_by_phone(phone, debug)
     
     # arguments:
     #   phone           -- 10 digits phone, str or int, required
@@ -49,7 +49,7 @@ Or install it yourself as:
 
 **Get profile by id**
 
-    resp = client.get_by_profile_id(profile_id, response_format, debug)
+    resp = client.get_by_profile_id(profile_id, debug)
     
     # arguments:
     #   profile_id      -- Profile identifier, required
@@ -66,13 +66,30 @@ Or install it yourself as:
     
     # Returns 204 response in the case of the succesfull request.
 
+**Get fraud level**
 
-##Exceptions
+    resp = client.get_fraud_level(phone, debug)
 
-**NextcallerClient::HttpException**
+    # arguments:
+    #   phone           -- 10 digits phone, str or int, required
+    #   debug           -- boolean (default false)
+
+
+##Errors handling
+
+In case of wrong phone number a ArgumentError exception will be thrown:
+
+    ArgumentError('Invalid phone number: 1221. .........)
+
+In case of wrong profile id a ArgumentError exception will be thrown:
+
+    ArgumentError('Invalid profile id: assw2. .........)
+
+In case of wrong platform name a ArgumentError exception will be thrown:
+
+    ArgumentError('Invalid platform name: sd#s. .........)
 
-Thrown in the case of 4xx or 5xx response from server.
-'content' attribute contains parsed response body.
+[NextcallerClient::HttpException](https://github.com/Nextcaller/nextcaller-ruby-api/blob/master/lib/nextcaller_client/exceptions.rb) exeception is raised in the case of 4xx or 5xx response from server. 'content' attribute contains parsed response body.
 
     
 ##Notes

data/examples/client_get_by_phone.rb

@@ -0,0 +1,71 @@
+require 'nextcaller_client'
+
+username = 'E72D42B98D2232703EE3'
+password = '826f22ade660d6612523b212b997094c70dba8e1'
+
+sandbox = false
+phone_number = '2125558383'
+
+client = NextcallerClient::NextCallerClient.new(username, password, sandbox)
+
+begin
+  response_content = client.get_by_phone(phone_number)
+  puts response_content.class # Response is a hash
+  puts "First name: " + response_content['records'][0]['first_name'] # Retrieve first name for example
+  puts response_content                             
+rescue ArgumentError => error
+  puts error.message
+rescue NextcallerClient::HttpException => error
+  puts error.message
+  puts error.content
+end
+# Output:
+# Hash
+# First name: Jerry
+# {
+#   "records":[
+#     {
+#       "id": "97d949a413f4ea8b85e9586e1f2d9a", 
+#       "first_name": "Jerry", 
+#       "middle_name": "", 
+#       "last_name": "Seinfeld", 
+#       "name": "Jerry Seinfeld", 
+#       "language": "English", 
+#       "phone":[
+#         {
+#           "number": "2125558383", 
+#           "resource_uri": "/v2/records/2125558383/"
+#         }
+#       ], 
+#       "carrier": "Verizon Wireless", 
+#       "address":[
+#         {
+#           "city": "New York", 
+#           "extended_zip": "", 
+#           "country": "USA", 
+#           "line1": "129 West 81st Street", 
+#           "line2": "Apt 5a", "state": "NY", 
+#           "zip_code": "10024"
+#         }
+#       ], 
+#       "relatives": [], 
+#       "email": "demo@nextcaller.com", 
+#       "linked_emails": ["demo@nextcaller.com"], 
+#       "social_links": [], 
+#       "age": "", 
+#       "education": "", 
+#       "gender": "Male", 
+#       "high_net_worth": "", 
+#       "home_owner_status": "", 
+#       "household_income": "", 
+#       "length_of_residence": "", 
+#       "line_type": "", 
+#       "marital_status": "", 
+#       "market_value": "", 
+#       "occupation": "", 
+#       "presence_of_children": "", 
+#       "department": "not specified", 
+#       "resource_uri": "/v2/users/97d949a413f4ea8b85e9586e1f2d9a/"
+#     }
+#   ]
+# }

data/examples/client_get_by_profile_id.rb

@@ -0,0 +1,70 @@
+require 'nextcaller_client'
+
+username = 'XXXXX'
+password = 'XXXXX'
+sandbox = false
+profile_id = '97d949a413f4ea8b85e9586e1f2d9a'
+
+client = NextcallerClient::NextCallerClient.new(username, password, sandbox)
+
+begin
+  response_content = client.get_by_profile_id(profile_id)
+  puts response_content.class # Response is a hash
+  puts "First name: " + response_content['first_name'] # Retrieve first name for example
+  puts response_content
+rescue ArgumentError => error
+  puts error.message
+rescue NextcallerClient::HttpException => error
+  puts error.message
+  puts error.content
+end
+# Output:
+# Hash
+# First name: Jerry
+# Response example: 
+# {
+#   {
+#     "id": "97d949a413f4ea8b85e9586e1f2d9a", 
+#     "first_name": "Jerry", 
+#     "middle_name": "", 
+#     "last_name": "Seinfeld", 
+#     "name": "Jerry Seinfeld", 
+#     "language": "English", 
+#     "phone":[
+#       {
+#         "number": "2125558383", 
+#         "resource_uri": "/v2/records/2125558383/"
+#       }
+#     ], 
+#     "carrier": "Verizon Wireless", 
+#     "address":[
+#       {
+#         "city": "New York", 
+#         "extended_zip": "", 
+#         "country": "USA", 
+#         "line1": "129 West 81st Street", 
+#         "line2": "Apt 5a", "state": "NY", 
+#         "zip_code": "10024"
+#       }
+#     ], 
+#     "relatives": [], 
+#     "email": "demo@nextcaller.com", 
+#     "linked_emails": ["demo@nextcaller.com"], 
+#     "social_links": [], 
+#     "age": "", 
+#     "education": "", 
+#     "gender": "Male", 
+#     "high_net_worth": "", 
+#     "home_owner_status": "", 
+#     "household_income": "", 
+#     "length_of_residence": "", 
+#     "line_type": "", 
+#     "marital_status": "", 
+#     "market_value": "", 
+#     "occupation": "", 
+#     "presence_of_children": "", 
+#     "department": "not specified", 
+#     "resource_uri": "/v2/users/97d949a413f4ea8b85e9586e1f2d9a/"
+#   }
+# }
+# First name: Jerry

data/examples/client_get_fraud_level.rb

@@ -0,0 +1,27 @@
+require 'nextcaller_client'
+
+username = 'XXXXX'
+password = 'XXXXX'
+sandbox = false
+phone_number = '2125558383'
+
+client = NextcallerClient::NextCallerClient.new(username, password, sandbox)
+
+begin
+  response_content = client.get_fraud_level(phone_number)
+  puts response_content.class # Response is a hash
+  puts "Fraud risk: " + response_content['fraud_risk'] # Retrieve fraud risk for example
+  puts response_content
+rescue ArgumentError => error
+  puts error.message
+rescue NextcallerClient::HttpException => error
+  puts error.message
+  puts error.content
+end
+# Output:
+# Hash
+# Fraud risk: medium
+# { 
+#   "fraud_risk"=>"medium", 
+#   "spoofed"=>"unknown"
+# }

data/examples/client_update_by_profile_id.rb

@@ -0,0 +1,37 @@
+require 'nextcaller_client'
+
+username = 'XXXXX'
+password = 'XXXXX'
+sandbox = false
+profile_id = '97d949a413f4ea8b85e9586e1f2d9a'
+
+client = NextcallerClient::NextCallerClient.new(username, password, sandbox)
+
+begin
+  data = { 
+    first_name: "Clark",
+    last_name:"Kent",
+    email:"clarkkent@supermail.com",
+    phone1:"1234567890",
+    phone2:"2345678901",
+    phone3:"3456789012",
+    shipping_address1:{
+        line1:"223 Kryptonite Ave.",
+        line2:"",
+        city:"Smallville",
+        state:"KS",
+        zip_code:"66002"
+    }
+  } 
+  response = client.update_by_profile_id(profile_id, data)
+  puts response.class # Response is a object of Net::HTTPNoContent
+  puts 'Success'
+rescue ArgumentError => error
+  puts error.message
+rescue NextcallerClient::HttpException => error
+  puts error.message
+  puts error.content
+end
+# Output: 
+# Net::HTTPNoContent
+# Success

data/examples/platform_get_by_phone.rb

@@ -0,0 +1,57 @@
+require 'nextcaller_client'
+
+username = 'XXXXX'
+password = 'XXXXX'
+sandbox = false
+platform_username = 'user12345'
+phone_number = '2125558383'
+
+client = NextcallerClient::NextCallerPlatformClient.new(username, password, sandbox)
+
+begin
+  response_content = client.get_by_phone(phone_number, platform_username)
+  puts response_content.class # Response is a hash
+  puts "First name: " + response_content['records'][0]['first_name'] # Retrieve first name for example
+  puts response_content
+rescue ArgumentError => error
+  puts error.message
+rescue NextcallerClient::HttpException => error
+  puts error.message
+  puts error.content
+end
+# Output:
+# Hash
+# First name: Jerry
+# {
+#   "records"=>[
+#     {
+#       "id"=>"97d949a413f4ea8b85e9586e1f2d9a", 
+#       "first_name"=>"Jerry", 
+#       "middle_name"=>"", 
+#       "last_name"=>"Seinfeld", 
+#       "name"=>"Jerry Seinfeld", 
+#       "language"=>"English", 
+#       "phone"=>[
+#         {
+#           "number"=>"2125558383", 
+#           "resource_uri"=>"/v2/records/2125558383/"
+#         }
+#       ], 
+#       "carrier"=>"Verizon Wireless", 
+#       "address"=>[
+#         {
+#           "city"=>"New York", 
+#           "extended_zip"=>"", 
+#           "country"=>"USA", 
+#           "line1"=>"129 West 81st Street", 
+#           "line2"=>"Apt 5a", 
+#           "state"=>"NY", 
+#           "zip_code"=>"10024"
+#         }
+#       ], 
+#       "line_type"=>"", 
+#       "department"=>"not specified", 
+#       "resource_uri"=>"/v2/users/97d949a413f4ea8b85e9586e1f2d9a/"
+#     }
+#   ]
+# }

data/examples/platform_get_by_profile_id.rb

@@ -0,0 +1,55 @@
+require 'nextcaller_client'
+
+username = 'XXXXX'
+password = 'XXXXX'
+sandbox = false
+platform_username = 'user12345'
+profile_id = '97d949a413f4ea8b85e9586e1f2d9a'
+
+client = NextcallerClient::NextCallerPlatformClient.new(username, password, sandbox)
+
+begin
+  response_content = client.get_by_profile_id(profile_id, platform_username)
+  puts response_content.class # Response is a hash
+  puts "First name: " + response_content['first_name'] # Retrieve first name for example
+  puts response_content
+rescue ArgumentError => error
+  puts error.message
+rescue NextcallerClient::HttpException => error
+  puts error.message
+  puts error.content
+end
+# Output:
+# Hash
+# First name: Jerry
+# {
+#   {
+#     "id"=>"97d949a413f4ea8b85e9586e1f2d9a", 
+#     "first_name"=>"Jerry", 
+#     "middle_name"=>"", 
+#     "last_name"=>"Seinfeld", 
+#     "name"=>"Jerry Seinfeld", 
+#     "language"=>"English", 
+#     "phone"=>[
+#       {
+#         "number"=>"2125558383", 
+#         "resource_uri"=>"/v2/records/2125558383/"
+#       }
+#     ], 
+#     "carrier"=>"Verizon Wireless", 
+#     "address"=>[
+#       {
+#         "city"=>"New York", 
+#         "extended_zip"=>"", 
+#         "country"=>"USA", 
+#         "line1"=>"129 West 81st Street", 
+#         "line2"=>"Apt 5a", 
+#         "state"=>"NY", 
+#         "zip_code"=>"10024"
+#       }
+#     ], 
+#     "line_type"=>"", 
+#     "department"=>"not specified", 
+#     "resource_uri"=>"/v2/users/97d949a413f4ea8b85e9586e1f2d9a/"
+#   }
+# }

data/examples/platform_get_fraud_level.rb

@@ -0,0 +1,28 @@
+require 'nextcaller_client'
+
+username = 'XXXXX'
+password = 'XXXXX'
+sandbox = false
+platform_username = 'user12345'
+phone_number = '2125558383'
+
+client = NextcallerClient::NextCallerPlatformClient.new(username, password, sandbox)
+
+begin
+  response_content = client.get_fraud_level(phone_number, platform_username)
+  puts response_content.class # Response is a hash
+  puts "Fraud risk: " + response_content['fraud_risk'] # Retrieve fraud risk for example
+  puts response_content
+rescue ArgumentError => error
+  puts error.message
+rescue NextcallerClient::HttpException => error
+  puts error.message
+  puts error.content
+end
+# Output:
+# Hash
+# Fraud risk: medium
+# {
+#   "fraud_risk"=>"medium", 
+#   "spoofed"=>"unknown"
+# }

data/examples/platform_get_statistics.rb

@@ -0,0 +1,48 @@
+require 'nextcaller_client'
+
+username = 'XXXXX'
+password = 'XXXXX'
+sandbox = false
+
+client = NextcallerClient::NextCallerPlatformClient.new(username, password, sandbox)
+
+begin
+  response_content = client.get_platform_statistics
+  puts response_content.class # Response is a hash
+  puts "Platform name: " + response_content['object_list'][0]['username'] # Retrieve platform name for example
+  puts response_content
+rescue ArgumentError => error
+  puts error.message
+rescue NextcallerClient::HttpException => error
+  puts error.message
+  puts error.content
+end
+# Output:
+# Hash
+# Platform name: user1
+# {
+#   "object_list"=>[
+#     {
+#       "username"=>"user1", 
+#       "first_name"=>"", 
+#       "last_name"=>"", 
+#       "company_name"=>"", 
+#       "email"=>"", 
+#       "number_of_operations"=>1777, 
+#       "total_calls"=>
+#         {
+#           "2014-12"=>56, 
+#           "2014-10"=>9, 
+#           "2014-11"=>3
+#         }, 
+#       "successful_calls"=>
+#         {
+#           "2014-12"=>56, 
+#           "2014-10"=>9, 
+#           "2014-11"=>3
+#         }, 
+#       "resource_uri"=>"/v2/platform_users/user1/"
+#     },
+#     ...
+#   ]
+# }

data/examples/platform_get_user.rb

@@ -0,0 +1,42 @@
+require 'nextcaller_client'
+
+username = 'XXXXX'
+password = 'XXXXX'
+sandbox = false
+platform_username = 'user12345'
+
+client = NextcallerClient::NextCallerPlatformClient.new(username, password, sandbox)
+
+begin
+  response_content = client.get_platform_user(platform_username)
+  puts response_content.class # Response is a hash
+  puts "First name: " + response_content['first_name'] # Retrieve first name for example
+  puts response_content
+rescue ArgumentError => error
+  puts error.message
+rescue NextcallerClient::HttpException => error
+  puts error.message
+  puts error.content
+end
+# Output:
+# Hash
+# First name: platform_user1_fname
+# {
+#   "username"=>"user12345", 
+#   "first_name"=>"platform_user1_fname", 
+#   "last_name"=>"platform_user1_lname", 
+#   "company_name"=>"platform_company1_name", 
+#   "email"=>"test@test.com", 
+#   "number_of_operations"=>71, 
+#   "total_calls"=>
+#     {
+#       "2014-12"=>14, 
+#       "2014-11"=>57
+#     }, 
+#   "successful_calls"=>
+#     {
+#       "2014-12"=>14, 
+#       "2014-11"=>57
+#     }, 
+#   "resource_uri"=>"/v2/platform_users/user12345/"
+# }

data/examples/platform_update_by_profile_id.rb

@@ -0,0 +1,24 @@
+require 'nextcaller_client'
+
+username = 'XXXXX'
+password = 'XXXXX'
+sandbox = false
+profile_id = '97d949a413f4ea8b85e9586e1f2d9a'
+platform_username = 'user12345'
+
+client = NextcallerClient::NextCallerPlatformClient.new(username, password, sandbox)
+
+begin
+  data = { email: 'test@test.com' } 
+  response = client.update_by_profile_id(profile_id, platform_username, data)
+  puts response.class # Response is a object of Net::HTTPNoContent
+  puts 'Success'
+rescue ArgumentError => error
+  puts error.message
+rescue NextcallerClient::HttpException => error
+  puts error.message
+  puts error.content
+end
+# Output: 
+# Net::HTTPNoContent
+# Success

data/examples/platform_update_platform_user.rb

@@ -0,0 +1,23 @@
+require 'nextcaller_client'
+
+username = 'XXXXX'
+password = 'XXXXX'
+sandbox = false
+platform_username = 'user12345'
+
+client = NextcallerClient::NextCallerPlatformClient.new(username, password, sandbox)
+
+begin
+  data = { email: 'test@test.com' } 
+  response = client.update_platform_user(platform_username, data)
+  puts response.class # Response is a object of Net::HTTPNoContent
+  puts 'Success'
+rescue ArgumentError => error
+  puts error.message
+rescue NextcallerClient::HttpException => error
+  puts error.message
+  puts error.content
+end
+# Output: 
+# Net::HTTPNoContent
+# Success