sift 4.0.0 → 4.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 57a679adbe12a556895633060cde177cf89fcb06
-  data.tar.gz: d3eff77b83c2ba5696c4c391f82d592a8df7443a
+SHA256:
+  metadata.gz: cf4d6cd2e8ea54d5ea80fdca8b5668a1f86aa2639eaa1b69a105e8e81dd31222
+  data.tar.gz: cd087556fba6bbfd8269366fb8a7ae1c4727841a184056f09406a9c6d78658f5
 SHA512:
-  metadata.gz: 5809b998556c975ff30faceacf5468a812e815dead3e836640343fe681c1d612192a9a26615f8a0c35c4c13a3cb9b232f3aff1bbf7649d6b3e6c8250cd7f2896
-  data.tar.gz: 8b941c79e41784d1452f8ae4fe8b1052f7f32ed3954f8afb16b16f3e7346a0bf6e5cfc71f6080c6475ff75a0fce78172a58e4f8ece8f73ab47385ffd57d3001a
+  metadata.gz: 66a74c28328b082be3b0f492f0f001c998a7bc99bd95ede179a4c950974b332b4b55158cf418677ce4b904307464912f3248a56b200b88bb76038fd38cdff281
+  data.tar.gz: e6bb108cbcbf692266ff6d87a0a426476e8ad0a4523a2436a9f3d6f201ceeab63baad1121466e6a1ef7ec16df7135a577e59e532fe3d463ea47c6c7f47955576

data/.circleci/config.yml

@@ -1,4 +1,40 @@
-version: 2
+version: 2.1
+
+orbs:
+  slack: circleci/slack@4.4.2
+
+commands:
+  export_slack_id:
+    steps:
+      - run:
+          name  : Exporting circleci username as slack id.
+          command: echo 'export SLACK_PARAM_MENTIONS="$CIRCLE_USERNAME"' >> "$BASH_ENV"
+      - run:
+          name : CircleCi To Slack user mapping.
+          command: |
+            echo $GITHUB_SLACK_USERMAPPING | base64 --decode > github_slack
+            while read -r line || [[ -n $line ]];
+            do
+              [[ ${line//[[:space:]]/} =~ ^#.* || -z "$line" ]] && continue
+              echo "$line" | tr "=" "\n" | while read -r key; do
+              read -r value
+              if [ "$CIRCLE_USERNAME" = "${key}" ]; then
+                echo "export SLACK_PARAM_MENTIONS='<@${value}>'" >> $BASH_ENV
+              fi
+              done
+            done < github_slack
+            rm github_slack
+
+slack/notify: &slack_notify
+  branch_pattern: master
+  event: fail
+  channel: ci-build-status
+  template: SLACK_TAG_CI_FAILURE_TEMPLATE
+
+context: &context
+  - slack-templates
+  - slack_Oauth
+  - Github_Slack_UserMapping
 
 jobs:
   build:
@@ -11,6 +47,7 @@ jobs:
           BUNDLE_PATH: vendor/bundle
     steps:
       - checkout
+      - export_slack_id
 
       - run:
           name: Which bundler?
@@ -41,3 +78,11 @@ jobs:
 
       - store_test_results:
           path: test_results
+      - slack/notify:
+          <<: *slack_notify
+
+workflows:
+  ruby-test:
+    jobs:
+      - build:
+          context: *context

data/.github/pull_request_template.md

@@ -0,0 +1,12 @@
+## Purpose
+
+## Summary
+
+## Testing
+
+## Checklist
+- [ ] The change was thoroughly tested manually
+- [ ] The change was covered with unit tests
+- [ ] The change was tested with real API calls (if applicable)
+- [ ] Necessary changes were made in the integration tests (if applicable)
+- [ ] New functionality is reflected in README

data/HISTORY

@@ -1,3 +1,10 @@
+=== 4.2.0 2023-06-20
+- Verification API support [Verification API](https://sift.com/developers/docs/curl/verification-api/overview)
+- Support for score percentiles (only applicable for the accounts with the feature enabled)
+
+=== 4.1.0 2022-06-22
+- Add return_route_info query param
+
 === 4.0.0 2019-05-15
 - Breaking change: Propagate exception in Client.track() – previously we were silently swallowing exceptions and now we are bubbling them up. You will need to add exception handling code.
 - Fix URL encoding

data/README.md

@@ -1,7 +1,8 @@
-# Sift Ruby bindings
-
+# sift-ruby
 [![CircleCI](https://circleci.com/gh/SiftScience/sift-ruby.svg?style=svg)](https://circleci.com/gh/SiftScience/sift-ruby)
 
+The official Ruby bindings for the latest version (v205) of the [Sift API](https://sift.com/developers/docs/java/apis-overview).
+
 ## Requirements
 
   * Ruby 2.0.0 or above.

data/examples/validation_apis.rb

@@ -0,0 +1,47 @@
+require "sift"
+require 'multi_json'
+
+#$api_key = "put-a-valid-apikey"
+#$user_id = "put-a-valid-userid"
+
+def valid_send_properties
+    {
+      :$user_id => $user_id,
+	  :$send_to => $user_id,
+      :$verification_type => '$email',
+      :$brand_name => 'all',
+      :$language => 'en',
+      :$event => {
+                :$session_id => 'gigtleqddo84l8cm15qe4il',
+                :$verified_event => '$login',
+                :$reason => '$automated_rule',
+                :$ip => '192.168.1.1',
+                :$browser => {
+                    :$user_agent => 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_3) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/56.0.2924.87 Safari/537.36'
+                }
+            }
+    }
+end
+
+def valid_resend_properties
+    {
+      :$user_id => $user_id,
+      :$verified_event => '$login'
+    }
+end
+
+def valid_check_properties
+    {
+      :$user_id => $user_id,
+      :$code => '668316'
+    }
+end
+
+  #response = Sift::Client.new(:api_key => $api_key,:user_id => $user_id,:version=>1.1).verification_send(valid_send_properties)
+
+  #response = Sift::Client.new(:api_key => $api_key,:user_id => $user_id,:version=>1.1).verification_resend(valid_resend_properties)
+  response = Sift::Client.new(:api_key => $api_key,:user_id => $user_id,:version=>1.1).verification_check(valid_check_properties)
+
+  p response
+
+  puts "completed"

data/lib/sift/client.rb

@@ -216,8 +216,10 @@ module Sift
       return_score = opts[:return_score]
       return_action = opts[:return_action]
       return_workflow_status = opts[:return_workflow_status]
+      return_route_info = opts[:return_route_info]
       force_workflow_run = opts[:force_workflow_run]
       abuse_types = opts[:abuse_types]
+      include_score_percentiles = opts[:include_score_percentiles]
 
       raise("event must be a non-empty string") if (!event.is_a? String) || event.empty?
       raise("properties cannot be empty") if properties.empty?
@@ -227,8 +229,12 @@ module Sift
       query["return_score"] = "true" if return_score
       query["return_action"] = "true" if return_action
       query["return_workflow_status"] = "true" if return_workflow_status
+      query["return_route_info"] = "true" if return_route_info
       query["force_workflow_run"] = "true" if force_workflow_run
       query["abuse_types"] = abuse_types.join(",") if abuse_types
+      if include_score_percentiles == "true"
+        query["fields"] =  "SCORE_PERCENTILES"
+      end
 
       options = {
         :body => MultiJson.dump(delete_nils(properties).merge({"$type" => event,
@@ -714,6 +720,71 @@ module Sift
       handle_response(apply_decision(configs))
     end
 
+    def build_default_headers_post(api_key)
+      {
+        "Authorization" => "Basic #{Base64.encode64(api_key+":")}",
+        "User-Agent" => "SiftScience/v#{@version} sift-ruby/#{VERSION}",
+        "Content-Type" => "application/json"
+      }
+    end
+
+    def verification_send(properties = {}, opts = {})
+      api_key = opts[:api_key] || @api_key
+      version = opts[:version] || @version
+      timeout = opts[:timeout] || @timeout
+
+      raise("properties cannot be empty") if properties.empty?
+      raise("api_key cannot be empty") if api_key.empty?
+
+
+      options = {
+        :body => MultiJson.dump(delete_nils(properties)),
+        :headers => build_default_headers_post(api_key)
+      }
+      options.merge!(:timeout => timeout) unless timeout.nil?
+
+      response = self.class.post(Sift.verification_api_send_path(@version), options)
+      Response.new(response.body, response.code, response.response)
+    end
+
+    def verification_resend(properties = {}, opts = {})
+      api_key = opts[:api_key] || @api_key
+      version = opts[:version] || @version
+      timeout = opts[:timeout] || @timeout
+
+      raise("properties cannot be empty") if properties.empty?
+      raise("api_key cannot be empty") if api_key.empty?
+
+
+      options = {
+        :body => MultiJson.dump(delete_nils(properties)),
+        :headers => build_default_headers_post(api_key)
+      }
+      options.merge!(:timeout => timeout) unless timeout.nil?
+
+      response = self.class.post(Sift.verification_api_resend_path(@version), options)
+      Response.new(response.body, response.code, response.response)
+    end
+
+    def verification_check(properties = {}, opts = {})
+      api_key = opts[:api_key] || @api_key
+      version = opts[:version] || @version
+      timeout = opts[:timeout] || @timeout
+
+      raise("properties cannot be empty") if properties.empty?
+      raise("api_key cannot be empty") if api_key.empty?
+
+
+      options = {
+        :body => MultiJson.dump(delete_nils(properties)),
+        :headers => build_default_headers_post(api_key)
+      }
+      options.merge!(:timeout => timeout) unless timeout.nil?
+
+      response = self.class.post(Sift.verification_api_check_path(@version), options)
+      Response.new(response.body, response.code, response.response)
+    end
+
     private
 
     def handle_response(response)

data/lib/sift/version.rb

@@ -1,4 +1,4 @@
 module Sift
-  VERSION = "4.0.0"
+  VERSION = "4.2.0"
   API_VERSION = "205"
 end

data/lib/sift.rb

@@ -9,6 +9,21 @@ module Sift
     "/v#{version}/events"
   end
 
+  # Returns the path for the specified API version
+  def self.verification_api_send_path(version=API_VERSION)
+    "/v#{version}/verification/send"
+  end
+
+  # Returns the path for the specified API version
+  def self.verification_api_resend_path(version=API_VERSION)
+    "/v#{version}/verification/resend"
+  end
+
+  # Returns the path for the specified API version
+  def self.verification_api_check_path(version=API_VERSION)
+    "/v#{version}/verification/check"
+  end
+
   # Returns the Score API path for the specified user ID and API version
   def self.score_api_path(user_id, version=API_VERSION)
     "/v#{version}/score/#{ERB::Util.url_encode(user_id)}/"

data/spec/unit/client_205_spec.rb

@@ -0,0 +1,117 @@
+require_relative '../spec_helper'
+require 'sift'
+
+describe Sift::Client do
+
+  before :each do
+    Sift.api_key = nil
+  end
+
+  def valid_transaction_properties
+    {
+      :$type => "$add_item_to_cart",
+      :$user_id => "haneeshv@exalture.com",
+      :$session_id => "gigtleqddo84l8cm15qe4il",
+      :$item => {
+        :$item_id => "B004834GQO",
+        :$product_title => "The Slanket Blanket-Texas Tea",
+        :$price => 39990000,
+        :$currency_code => "USD",
+        :$upc => "6786211451001",
+        :$sku => "004834GQ",
+        :$brand => "Slanket",
+        :$manufacturer => "Slanket",
+        :$category => "Blankets & Throws",
+        :$tags => [
+              "Awesome",
+              "Wintertime specials"
+        ],
+        :$color => "Texas Tea",
+        :$quantity => 16
+      },
+      :$brand_name => "sift",
+      :$site_domain => "sift.com",
+      :$site_country => "US",
+      :$browser => {
+        :$user_agent => "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_3) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/56.0.2924.87 Safari/537.36",
+        :$accept_language => "en-US",
+        :$content_language => "en-GB"
+      }
+    }
+  end
+
+  def percentile_response_json
+    {
+      :user_id => 'haneeshv@exalture.com',
+      :latest_labels => {},
+      :workflow_statuses => [],
+      :scores => {
+        :account_abuse => {
+          :score => 0.32787917675535705,
+          :reasons => [{
+            :name => 'Latest item product title',
+            :value => 'The Slanket Blanket-Texas Tea'
+          }],
+          :percentiles => {
+            :last_7_days => -1.0, :last_1_days => -1.0, :last_10_days => -1.0, :last_5_days => -1.0
+          }
+        },
+        :acontent_abuse => {
+          :score => 0.28056292905897995,
+          :reasons => [{
+            :name => 'timeSinceFirstEvent',
+            :value => '13.15 minutes'
+          }],
+          :percentiles => {
+            :last_7_days => -1.0, :last_1_days => -1.0, :last_10_days => -1.0, :last_5_days => -1.0
+          }
+        },
+        :payment_abuse => {
+          :score => 0.28610507028376797,
+          :reasons => [{
+            :name => 'Latest item currency code',
+            :value => 'USD'
+          }, {
+            :name => 'Latest item item ID',
+            :value => 'B004834GQO'
+          }, {
+            :name => 'Latest item product title',
+            :value => 'The Slanket Blanket-Texas Tea'
+          }],
+          :percentiles => {
+            :last_7_days => -1.0, :last_1_days => -1.0, :last_10_days => -1.0, :last_5_days => -1.0
+          }
+        },
+        :promotion_abuse => {
+          :score => 0.05731508921450917,
+          :percentiles => {
+            :last_7_days => -1.0, :last_1_days => -1.0, :last_10_days => -1.0, :last_5_days => -1.0
+          }
+        }
+      },
+      :status => 0,
+      :error_message => 'OK'
+    }
+  end
+
+  it "Successfully submits a v205 event with SCORE_PERCENTILES" do
+    response_json =
+    { :status => 0, :error_message => "OK",  :score_response => percentile_response_json}
+    stub_request(:post, "https://api.siftscience.com/v205/events?fields=SCORE_PERCENTILES&return_score=true").
+      with { | request|
+        parsed_body = JSON.parse(request.body)
+        expect(parsed_body).to include("$api_key" => "overridden")
+      }.to_return(:status => 200, :body => MultiJson.dump(response_json), :headers => {})
+
+    api_key = "foobar"
+    event = "$transaction"
+    properties = valid_transaction_properties
+
+    response = Sift::Client.new(:api_key => api_key, :version => "205")
+              .track(event, properties, :api_key => "overridden", :include_score_percentiles => "true", :return_score => "true")
+    expect(response.ok?).to eq(true)
+    expect(response.api_status).to eq(0)
+    expect(response.api_error_message).to eq("OK")
+    expect(response.body["score_response"]["scores"]["account_abuse"]["percentiles"]["last_7_days"]).to eq(-1.0)
+  end
+end

data/spec/unit/client_spec.rb

@@ -469,7 +469,7 @@ describe Sift::Client do
     }
 
     stub_request(:post,
-                 "https://api.siftscience.com/v205/events?return_workflow_status=true&abuse_types=legacy,payment_abuse")
+                 "https://api.siftscience.com/v205/events?return_workflow_status=true&return_route_info=true&abuse_types=legacy,payment_abuse")
       .to_return(:status => 200, :body => MultiJson.dump(response_json),
                  :headers => {"content-type"=>"application/json; charset=UTF-8",
                               "content-length"=> "74"})
@@ -478,7 +478,8 @@ describe Sift::Client do
     properties = valid_transaction_properties
     response = Sift::Client.new(:api_key => api_key)
                .track(event, properties,
-                      :return_workflow_status => true, :abuse_types => ['legacy', 'payment_abuse'])
+                      :return_workflow_status => true, :return_route_info => true,
+                      :abuse_types => ['legacy', 'payment_abuse'])
     expect(response.ok?).to eq(true)
     expect(response.api_status).to eq(0)
     expect(response.api_error_message).to eq("OK")

data/spec/unit/client_validationapi_spec.rb

@@ -0,0 +1,91 @@
+require_relative "../spec_helper"
+require "sift"
+
+describe Sift::Client do
+
+  before :each do
+    Sift.api_key = nil
+  end
+
+  def valid_send_properties
+    {
+      :$user_id => 'billy_jones_301',
+	    :$send_to => 'billy_jones_301@gmail.com',
+      :$verification_type => '$email',
+      :$brand_name => 'MyTopBrand',
+      :$language => 'en',
+      :$event => {
+                :$session_id => '09f7f361575d11ff',
+                :$verified_event => '$login',
+                :$reason => '$automated_rule',
+                :$ip => '192.168.1.1',
+                :$browser => {
+                    :$user_agent => 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_3) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/56.0.2924.87 Safari/537.36'
+                }
+            }
+    }
+  end
+
+  def valid_resend_properties
+    {
+      :$user_id => 'billy_jones_301',
+      :$verified_event => '$login'
+    }
+  end
+
+  def valid_check_properties
+    {
+      :$user_id => 'billy_jones_301',
+      :$code => '123456'
+    }
+  end
+
+  it "Successfully calls send" do
+    api_key = "foobar1"
+    user_id = "foobar2"
+
+    response_json = { :status => 0, :error_message => "OK"}
+
+    stub_request(:post, "https://foobar1:@api.siftscience.com/v1.1/verification/send")
+      .to_return(:status => 200, :body => MultiJson.dump(response_json))
+
+    response = Sift::Client.new(:api_key => api_key,:user_id => user_id,:version=>1.1).verification_send(valid_send_properties,:version => 205)
+    expect(response.ok?).to eq(true)
+    expect(response.api_status).to eq(0)
+    expect(response.api_error_message).to eq("OK")
+
+  end
+
+  it "Successfully calls resend" do
+    api_key = "foobar1"
+    user_id = "foobar2"
+
+    response_json = { :status => 0, :error_message => "OK"}
+
+    stub_request(:post, "https://foobar1:@api.siftscience.com/v1.1/verification/resend")
+      .to_return(:status => 200, :body => MultiJson.dump(response_json))
+
+    response = Sift::Client.new(:api_key => api_key,:user_id => user_id,:version=>1.1).verification_resend(valid_resend_properties,:version => 205)
+    expect(response.ok?).to eq(true)
+    expect(response.api_status).to eq(0)
+    expect(response.api_error_message).to eq("OK")
+
+  end
+
+  it "Successfully calls check" do
+    api_key = "foobar1"
+    user_id = "foobar2"
+
+    response_json = { :status => 0, :error_message => "OK"}
+
+    stub_request(:post, "https://foobar1:@api.siftscience.com/v1.1/verification/check")
+      .to_return(:status => 200, :body => MultiJson.dump(response_json))
+
+    response = Sift::Client.new(:api_key => api_key,:user_id => user_id,:version=>1.1).verification_check(valid_check_properties,:version => 205)
+    expect(response.ok?).to eq(true)
+    expect(response.api_status).to eq(0)
+    expect(response.api_error_message).to eq("OK")
+
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sift
 version: !ruby/object:Gem::Version
-  version: 4.0.0
+  version: 4.2.0
 platform: ruby
 authors:
 - Fred Sadaghiani
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-15 00:00:00.000000000 Z
+date: 2023-07-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -124,6 +124,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".circleci/config.yml"
+- ".github/pull_request_template.md"
 - ".gitignore"
 - Gemfile
 - HISTORY
@@ -131,6 +132,7 @@ files:
 - README.md
 - Rakefile
 - examples/simple.rb
+- examples/validation_apis.rb
 - lib/sift.rb
 - lib/sift/client.rb
 - lib/sift/client/decision.rb
@@ -148,8 +150,10 @@ files:
 - spec/unit/client/decision/apply_to_spec.rb
 - spec/unit/client/decision_spec.rb
 - spec/unit/client_203_spec.rb
+- spec/unit/client_205_spec.rb
 - spec/unit/client_label_spec.rb
 - spec/unit/client_spec.rb
+- spec/unit/client_validationapi_spec.rb
 - spec/unit/router_spec.rb
 - spec/unit/validate/decision_spec.rb
 - spec/unit/validate/primitive_spec.rb
@@ -171,8 +175,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: sift
-rubygems_version: 2.5.2.3
+rubygems_version: 3.0.3.1
 signing_key: 
 specification_version: 4
 summary: Sift Science Ruby API Gem
@@ -183,8 +186,10 @@ test_files:
 - spec/unit/client/decision/apply_to_spec.rb
 - spec/unit/client/decision_spec.rb
 - spec/unit/client_203_spec.rb
+- spec/unit/client_205_spec.rb
 - spec/unit/client_label_spec.rb
 - spec/unit/client_spec.rb
+- spec/unit/client_validationapi_spec.rb
 - spec/unit/router_spec.rb
 - spec/unit/validate/decision_spec.rb
 - spec/unit/validate/primitive_spec.rb