lenddo 1.2.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 350b88ad9104210e08000ba8a4700b61b9c3e1d0
-  data.tar.gz: f796abd968e770e39eeabfc9f0a6ea1bf4a87f3a
+  metadata.gz: 603cfccd052d8658a46e83938799ae942fa48980
+  data.tar.gz: 71c60182b2cc54af3c10583a61dbf9caadad69b0
 SHA512:
-  metadata.gz: c9e89869897a649b4d0d9cd27fc064452b89a2edf834e2a758d82aca0924af00c256db2d1081eb1a978e85d3b7f002e78609898674c1d4d8f838d1b5fd3cb845
-  data.tar.gz: 4b7db1ce4b0dfe63a4c7291bb9d7d6339aac41866d08d1677ce0a6873348aec2f54ba56d951b370dfc54a74d913237601ff2862332fab58d696f852fcaa93abf
+  metadata.gz: 8dc3ba9ee5422458f5beb11f76c87f77779015433d3611c43d5a9933991d87f59a0606347f00acf01b6cefd19e71504f5c9d342a128e9f6271b401b2477501d5
+  data.tar.gz: 1a696ba8287a6a8e8c1f54aa9faa26a8c07c2431f6ea94c7be324a6075294254d1d44ee8a586d4c4a83fcbc4cb0dca1e0ed62895525e25be9aac97a510ae043d

data/README.md

@@ -1,6 +1,9 @@
 # ruby-lenddo
 
 ruby-lenddo allow you to contact Lenddo's REST based services.
+
+Note: 2.0 is not compatible with 1.X.X version for more info click [here](https://github.com/Lenddo/ruby-lenddo/wiki/Breaking-changes-with-2.0)
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -40,42 +43,53 @@ The `ServiceClient` allows the client to send extra information or retrieve the
 
 To retrieve the score you'll need the application ID and the partner script ID that you used to create the application.
 
-        require 'lenddo/service_client'
+Usage:
+   
+    require 'lenddo/service_client'
         
-        Lenddo::ServiceClient.application_score(@application_id, @partnerscript_id)
+    Lenddo::ServiceClient.application_score(@application_id, @partnerscript_id)
 
 ### Get Multiple scores
 
 Return an array of LenddoScore records for the supplied application id using models specifically tuned to the applicant pool of the partner associated with the current API user. LenddoScore is a measure of the expected creditworthiness of a Lenddo user. It ranges is from 0 (the highest risk) to 1000 (the lowest risk). Lenddo's scoring algorithms consider over 300 features per user when generating a score. These features are calculated from Lenddo's proprietary social graph as well as from any data specifically shared by the partner. In the event that a score cannot be correctly calculated, the LenddoScore will be returned as -1 along with an array of flag codes.
 
-        require 'lenddo/service_client'
+Usage:
+   
+    require 'lenddo/service_client'
         
-        Lenddo::ServiceClient.application_multiple_scores(@application_id, @partnerscript_id)
+    Lenddo::ServiceClient.application_multiple_scores(@application_id, @partnerscript_id)
 
 ### Get a Verification
 
 To retrieve the verification you'll need the application ID and the partner script ID that you used to create the application.
 
-        require 'lenddo/service_client'
+Usage:
+    
+    require 'lenddo/service_client'
         
-        Lenddo::ServiceClient.application_verification(@application_id, @partnerscript_id)
+    Lenddo::ServiceClient.application_verification(@application_id, @partnerscript_id)
     
 ### Get an Application Decision
 
 To retrieve the decision you'll need the application ID and the partner script ID that you used to create the application.
 
-        require 'lenddo/service_client'
+Usage:    
+       
+    require 'lenddo/service_client'
         
-        Lenddo::ServiceClient.application_decision(@application_id, @partnerscript_id)
+    Lenddo::ServiceClient.application_decision(@application_id, @partnerscript_id)
 
 ### Get MobileData
 
 If you want to retrieve the mobile data stream from your partner script ID you can use this method.
 
-        require 'lenddo/service_client'
-        
-        Lenddo::ServiceClient.mobile_data(@partnerscript_id)
-
+Usage:
+   
+    require 'lenddo/service_client'
+                
+    Lenddo::ServiceClient.mobile_data(@partnerscript_id)
+ 
+    
 ### Send Extra Application Data
 
 If you're sending extra information with your application you can use this method to submit it. Extra Application Data may be used to enhance the model performance based on data you may already have about a user.
@@ -109,20 +123,29 @@ PartnerToken has the following arguments:
 
 3. **OAuth key** - this is the key returned by OAuth for interacting with the token.
 
-    note: The key and secret are not your application key and secret. They're the values which are returned after a user successfully authenticates with the social network's OAuth.
+    Note: The key and secret are not your application key and secret. They're the values which are returned after a user successfully authenticates with the social network's OAuth.
 OAuth secret - optional, leave null if not applicable. Some OAuth providers may return a secret when this is returned Lenddo will require the secret to using the token.
 
 4. **token data** - This is the raw token as it was received from the provider in an Hash format. This may include a **extra_data** key.
 
-        require 'lenddo/white_label_client'
+   Usage:
+
+       require 'lenddo/white_label_client'
+        
+       application_id = "GENERATED_UNIQUE_ID"
+       oauth_key = "USER_ACCESS_TOKEN"
+        
+       response = Lenddo::WhiteLabelClient.partner_token(@application_id, provider = "Facebook", @oauth_key, oauth_secret = nil, token_data = {})
         
-        application_id = "GENERATED_UNIQUE_ID"
-        oauth_key = "USER_ACCESS_TOKEN"
+   Response:
         
-        Lenddo::WhiteLabelClient.partner_token(@application_id, provider = "Facebook", @oauth_key, oauth_secret = nil, token_data = {})
-        # response example - {"profile_id"=>"100000000000000FB"}
+       puts response.response_code
+       => 200
+       puts response.status
+       => "200 OK"
+       puts response.body
+       => {"profile_id": "100000000000000FB"}"
     
-
 #### Errors
 
 * **BAD_REQUEST** *HTTP Status Code: 400* Request was malformed, or missing required data.
@@ -144,15 +167,66 @@ CommitPartnerJob has the following arguments:
 3. **profile ids** - This is an array of ID's composed from the results of the `Lenddo::WhiteLabelClient.partner_token` service call.
 
 4. **verification** - This is an optional argument which will allow you to send probe data with the verification object.
-
-        require 'lenddo/white_label_client'
+   
+   Sample verification object:
+   
+       verificationData = {
+           "name": {
+               "first": "John",
+               "middle": "J",
+               "last": "Doe"
+            },
+           "date_of_birth": "1990-01-01",
+           "employer": "LenddoEFL",
+           "phone": { 
+               "mobile": "55512456789", 
+               "home": "0254897" 
+           },
+           "employment_period": { 
+               "start_date": "2010-05-01", 
+               "end_date": "2015-02-30"
+           },
+           "mothers_maiden_name": {
+               "first": "Martha",
+               "middle": "K",
+               "last": "Smith"
+           },
+           "government_ids": {[
+               "ID1": "555"
+           ]},
+           "university": "University Name",
+           "email": "John@gmail.com",
+           "work_email": "John@work.com",
+           "address": {
+               "latitude" : "40.758896",
+               "longitude" : "-73.985130",
+               "line_1": "Street 1",
+               "line_2": "Street 2",
+               "administrative_division" : "Manhattan",
+               "city": "New York", 
+               "postal_code":"39531",
+               "country_code: "USA"
+           }
+       }   
+
+   Usage:
+
+       require 'lenddo/white_label_client'
         
-        partnerscript_id = "YOUR_PARTNERSCRIPT_ID"
-        application_id = "GENERATED_UNIQUE_ID"
-        profile_ids = ["100000000000000FB"]
+       partnerscript_id = "YOUR_PARTNERSCRIPT_ID"
+       application_id = "GENERATED_UNIQUE_ID"
+       profile_ids = ["100000000000000FB"]
         
-        Lenddo::WhiteLabelClient.commit_partner_job(@partnerscript_id, @application_id, @profile_ids, verification = nil)
-        # response example - {"success": true}
+       response = Lenddo::WhiteLabelClient.commit_partner_job(@partnerscript_id, @application_id, @profile_ids, verification = nil)
+       
+   Response:
+       
+       puts response.response_code
+       => 200
+       puts response.status
+       => "200 OK"
+       puts response.body
+       => {"success": true}
 
 ### Errors
 

data/lib/lenddo/network_service/self.rb

@@ -1,7 +1,7 @@
 module Lenddo
   class NetworkService
     def mobile_data(partnerscript_id)
-      response = signed_request(
+      signed_request(
         method: "GET",
         host: Lenddo.configuration.network_service,
         path: "/MobileData",
@@ -9,11 +9,10 @@ module Lenddo
           partner_script_id: partnerscript_id
         }
       )
-      JSON.parse(response.body)
     end
 
     def extra_application_data(application_id, partnerscript_id, extra_data)
-      response = signed_request(
+      signed_request(
         method: "POST",
         host: Lenddo.configuration.network_service,
         path: "/ExtraApplicationData",
@@ -23,11 +22,10 @@ module Lenddo
           extra_data: extra_data
         }.to_json
       )
-      JSON.parse(response.body)
     end
 
     def partner_token(application_id, provider, token_data, oauth_key, oauth_secret)
-      response = signed_request(
+      signed_request(
         method: "POST",
         host: Lenddo.configuration.network_service,
         path: "/PartnerToken",
@@ -40,11 +38,10 @@ module Lenddo
           client_id: application_id
         }.to_json
       )
-      JSON.parse(response.body)
     end
 
     def commit_partner_job(partnerscript_id, application_id, profile_ids, verification)
-      response = signed_request(
+      signed_request(
         method: "POST",
         host: Lenddo.configuration.network_service,
         path: "/CommitPartnerJob",
@@ -55,7 +52,6 @@ module Lenddo
           verification_data: verification
         }.to_json
       )
-      JSON.parse(response.body)
     end
   end
 end

data/lib/lenddo/response.rb

@@ -0,0 +1,19 @@
+module Lenddo
+  class Response
+    def initialize(http_response)
+      @http_response = http_response
+    end
+
+    def status
+      @http_response.status
+    end
+
+    def response_code
+      @http_response.response_code
+    end
+
+    def body
+      JSON.parse(@http_response.body)
+    end
+  end
+end

data/lib/lenddo/score_service/self.rb

@@ -1,7 +1,7 @@
 module Lenddo
   class ScoreService
     def application_score(application_id, partnerscript_id)
-      response = signed_request(
+      signed_request(
         method: "GET",
         host: Lenddo.configuration.score_service,
         path: "/ClientScore/#{application_id}",
@@ -9,11 +9,10 @@ module Lenddo
           partner_script_id: partnerscript_id
         }
       )
-      JSON.parse(response.body)
     end
 
     def application_multiple_scores(application_id, partnerscript_id)
-      response = signed_request(
+      signed_request(
         method: "GET",
         host: Lenddo.configuration.score_service,
         path: "/ApplicationMultipleScores/#{application_id}",
@@ -21,11 +20,10 @@ module Lenddo
           partner_script_id: partnerscript_id
         }
       )
-      JSON.parse(response.body)
     end
 
     def application_verification(application_id, partnerscript_id)
-      response = signed_request(
+      signed_request(
         method: "GET",
         host: Lenddo.configuration.score_service,
         path: "/ClientVerification/#{application_id}",
@@ -33,11 +31,10 @@ module Lenddo
           partner_script_id: partnerscript_id
         }
       )
-      JSON.parse(response.body)
     end
 
     def application_decision(application_id, partnerscript_id)
-      response = signed_request(
+      signed_request(
         method: "GET",
         host: Lenddo.configuration.score_service,
         path: "/ApplicationDecision/#{application_id}",
@@ -45,7 +42,6 @@ module Lenddo
           partner_script_id: partnerscript_id
         }
       )
-      JSON.parse(response.body)
     end
   end
 end

data/lib/lenddo/service_client.rb

@@ -1,5 +1,6 @@
 require "lenddo"
 require "lenddo/authentication"
+require "lenddo/response"
 require "lenddo/score_service/self"
 
 include Lenddo::Authentication
@@ -13,35 +14,35 @@ module Lenddo
       # @param string partnerscript_id
       def application_score(application_id, partnerscript_id)
         @score_service ||= ScoreService.new
-        @score_service.application_score(application_id, partnerscript_id)
+        Response.new @score_service.application_score(application_id, partnerscript_id)
       end
       # Calls the Lenddo Service with the provided application_id and partner_script_id to return an array of LenddoScore records
       # @param string application_id
       # @param string partnerscript_id
       def application_multiple_scores(application_id, partnerscript_id)
         @score_service ||= ScoreService.new
-        @score_service.application_multiple_scores(application_id, partnerscript_id)
+        Response.new @score_service.application_multiple_scores(application_id, partnerscript_id)
       end
       # Calls the Lenddo Service with the provided application_id and partner_script_idto return a application verification result.
       # @param string application_id
       # @param string partnerscript_id
       def application_verification(application_id, partnerscript_id)
         @score_service ||= ScoreService.new
-        @score_service.application_verification(application_id, partnerscript_id)
+        Response.new @score_service.application_verification(application_id, partnerscript_id)
       end
       # Calls the Lenddo Service with the provided application_id and partner_script_id to return a application decision result.
       # @param string application_id
       # @param string partnerscript_id
       def application_decision(application_id, partnerscript_id)
         @score_service ||= ScoreService.new
-        @score_service.application_decision(application_id, partnerscript_id)
+        Response.new @score_service.application_decision(application_id, partnerscript_id)
       end
 
       # Get mobile data using the partner_script_id
       # @param string partnerscript_id
       def mobile_data(partnerscript_id)
         @network_service ||= NetworkService.new
-        @network_service.mobile_data(partnerscript_id)
+        Response.new @network_service.mobile_data(partnerscript_id)
       end
     end
   end

data/lib/lenddo/version.rb

@@ -1,5 +1,5 @@
 module Lenddo
   def self.version
-    "1.2.0"
+    "2.0.0"
   end
-end
+end

data/lib/lenddo/white_label_client.rb

@@ -1,5 +1,6 @@
 require "lenddo"
 require "lenddo/authentication"
+require "lenddo/response"
 require "lenddo/network_service/self"
 
 include Lenddo::Authentication
@@ -18,7 +19,7 @@ module Lenddo
         if !extra_data.is_a?(Hash)
           raise ArgumentError.new("@extra_data must be a Hash.")
         else
-          @network_service.extra_application_data(application_id, partnerscript_id, extra_data)
+          Response.new @network_service.extra_application_data(application_id, partnerscript_id, extra_data)
         end
       end
       # Posting network tokens, if successful, returns a "Profile ID" which is used when submitting a client for scoring.
@@ -35,7 +36,7 @@ module Lenddo
         elsif !token_data.is_a?(Hash)
           raise ArgumentError.new("@token_data must be a Hash.")
         else
-          @network_service.partner_token(application_id, provider, token_data, oauth_key, oauth_secret)
+          Response.new @network_service.partner_token(application_id, provider, token_data, oauth_key, oauth_secret)
         end
       end
       # Submit an application with profile ids for scoring to Lenddo.
@@ -52,7 +53,7 @@ module Lenddo
         elsif profile_ids.empty?
           raise ArgumentError.new("@profile_ids must contain at least one entry.")
         else
-          @network_service.commit_partner_job(partnerscript_id, application_id, profile_ids, verification)
+          Response.new @network_service.commit_partner_job(partnerscript_id, application_id, profile_ids, verification)
         end
       end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lenddo
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 2.0.0
 platform: ruby
 authors:
 - arjay salvadora
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-01-17 00:00:00.000000000 Z
+date: 2018-03-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -103,6 +103,7 @@ files:
 - lib/lenddo/configuration.rb
 - lib/lenddo/errors/configuration.rb
 - lib/lenddo/network_service/self.rb
+- lib/lenddo/response.rb
 - lib/lenddo/score_service/self.rb
 - lib/lenddo/service_client.rb
 - lib/lenddo/version.rb