sift 4.3.0 → 4.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e538e799471ba36d0c73d8b6bdea81f56e5928ef018a01a8aa0d1d376151ba97
-  data.tar.gz: 7ba73b5ea722594550ce5fb2b9259c8728b6658ac393206f991ac182e6216fd1
+  metadata.gz: 71be696ff04ffb1503d22a724241e5087809d2ffa2ab29f08666939ecd6bb98b
+  data.tar.gz: e2e841d8259fbea8c247b1b2bd3cdf208bd53ded613a765a75f595714a2e1e8d
 SHA512:
-  metadata.gz: d6a650d190c215fa627b364e134e51d35012edd1b40682c8d24e8ea446e7bbbcfc2121189d9ef1335a5f67ee5aeb4472c42823e99737bd5879ea14a51c4f0e2c
-  data.tar.gz: 1569ecf84bf4bfee1991a7664922293a24ab6993ac56766b28a10183cd8cc593641ff301c3e68fbdc1e8f2f51b3425b1ad64131332c12c4ded51489e54703eb3
+  metadata.gz: 9b578f6bccf6323d4ef53947cea5a517678920d882439da1d1df262cf5eb39e45064aab3a1dee702da01f41f29a522df0c5e7b850c68e1ac302fa0f7d9830e29
+  data.tar.gz: 3c4565ffc5f98626ac67a07b378adfd80aaef787e47ffc50d84780da4b62788bdfb43e1b2e4ed90ca59cb4ee0fe23ec727dad8d1c0dd9413c137d7ec1de95510

data/.circleci/config.yml

@@ -81,8 +81,25 @@ jobs:
       - slack/notify:
           <<: *slack_notify
 
+  run_integration_tests:
+    docker:
+        - image: circleci/ruby:2.4.2-jessie-node
+    steps:
+      - checkout
+      - run:
+          name: Install bundle and run the tests
+          command: | 
+            bundle check || bundle install
+            bundle exec ruby test_integration_app/main.rb      
+
 workflows:
   ruby-test:
     jobs:
       - build:
           context: *context
+  ruby-integration-tests:
+    jobs:
+      - run_integration_tests:
+          filters:
+            branches:
+              only: master

data/.github/workflows/publishing_sift_ruby.yml

@@ -12,18 +12,14 @@ jobs:
     steps:
       - name: Checkout code
         uses: actions/checkout@v3
-        
-          
       - name: Set up Ruby
         uses: ruby/setup-ruby@v1
         with:
           ruby-version: 2.7
-
       - name: Install Bundler
         run: |
           sudo gem install bundler
           bundle install
-
       - name: Build and push gem
         run: |
           mkdir -p $HOME/.gem
@@ -37,14 +33,6 @@ jobs:
               gem build sift.gemspec
               gem push sift-$version.gem
               rm -rf $HOME/.gem
-              ls -la $HOME/
           else
               echo "Gem version $version exists on RubyGems"
           fi
-
-      - name: Run Rake tasks
-        run: |
-          bundle exec rake -T
-          bundle exec rake build
-          bundle exec rake install
-          bundle exec rake release

data/.jenkins/Jenkinsfile

@@ -0,0 +1,103 @@
+// Load Jenkins shared library
+jenkinsBranch = 'v0.37.0'
+sharedLib = library("shared-lib@${jenkinsBranch}")
+
+def siftRubyWorkflow = sharedLib.com.sift.ci.SiftRubyWorkflow.new()
+def ciUtil = sharedLib.com.sift.ci.CIUtil.new()
+def stackdriver = sharedLib.com.sift.ci.StackDriverMetrics.new()
+
+// Default GitHub status context for automatically triggered builds
+def defaultStatusContext = 'Jenkins:auto'
+
+// Pod template file for Jenkins agent pod
+// Pod template yaml file is defined in https://github.com/SiftScience/jenkins/tree/master/resources/jenkins-k8s-pod-templates
+def ruby2PodTemplateFile = 'ruby-2-4-2-pod-template.yaml'
+def ruby2PodLabel = "ruby2-${BUILD_TAG}"
+
+
+// GitHub repo name
+def repoName = 'sift-ruby'
+
+pipeline {
+    agent none
+    options {
+        timestamps()
+        skipDefaultCheckout()
+        disableConcurrentBuilds()
+        disableRestartFromStage()
+        parallelsAlwaysFailFast()
+        buildDiscarder logRotator(artifactDaysToKeepStr: '', artifactNumToKeepStr: '', daysToKeepStr: '30', numToKeepStr: '')
+        timeout(time: 1, unit: 'HOURS')
+    }
+    environment {
+        GIT_BRANCH = "${env.CHANGE_BRANCH != null? env.CHANGE_BRANCH : env.BRANCH_NAME}"
+    }
+    stages {
+        stage('Initialize') {
+            steps {
+                script {
+                    statusContext = defaultStatusContext
+                    // Get the commit sha for the build
+                    commitSha = ciUtil.commitHashForBuild()
+                    ciUtil.updateGithubCommitStatus(repoName, statusContext, 'Started', 'pending', commitSha)
+                }
+            }
+        }
+        stage ('Build and Test Workflows') {
+            steps {
+                script {
+                    def workflows = [:]
+                    def stage1 = 'Run Integration Tests - ruby'
+                    workflows[stage1] = {
+                        stage(stage1) {
+                            if (env.GIT_BRANCH.equals('master')) {
+                                ciUtil.updateGithubCommitStatus(repoName, stage1, 'Started', 'pending', commitSha)
+                                try {
+                                    siftRubyWorkflow.runSiftRubyIntegration(ruby2PodTemplateFile, ruby2PodLabel)
+                                    ciUtil.updateGithubCommitStatus(repoName, stage1, 'SUCCESS', 'success', commitSha)
+                                } catch (Exception e) {
+                                    ciUtil.updateGithubCommitStatus(repoName, stage1, 'FAILURE', 'failure', commitSha)
+                                    print("${stage1} failed")
+                                    throw e
+                                }
+                            }
+                        }
+                    }
+                    def stage2 = 'Test - ruby'
+                    workflows[stage2] = {
+                        stage(stage2) {
+                            ciUtil.updateGithubCommitStatus(repoName, stage2, 'Started', 'pending', commitSha)
+                            try {
+                                siftRubyWorkflow.runSiftRubyTest(ruby2PodTemplateFile, ruby2PodLabel)
+                                ciUtil.updateGithubCommitStatus(repoName, stage2, 'SUCCESS', 'success', commitSha)
+                            } catch (Exception e) {
+                                ciUtil.updateGithubCommitStatus(repoName, stage2, 'FAILURE', 'failure', commitSha)
+                                print("${stage2} failed")
+                                throw e
+                            }
+                        }
+                    }
+                    parallel workflows
+                }
+            }
+        }
+    }
+    post {
+        success {
+            script {
+                ciUtil.updateGithubCommitStatus(repoName, statusContext, currentBuild.currentResult, 'success', commitSha)
+            }
+        }
+        unsuccessful {
+            script {
+                ciUtil.updateGithubCommitStatus(repoName, statusContext, currentBuild.currentResult, 'failure', commitSha)
+                ciUtil.notifySlack(repoName, commitSha)
+            }
+        }
+        always {
+            script {
+                stackdriver.updatePipelineStatistics(this)
+            }
+        }
+    }
+}

data/HISTORY

@@ -1,3 +1,9 @@
+=== 4.5.0 2024-05-16
+- Support for warnings in Events API
+
+=== 4.4.0 2023-10-05
+- Score percentiles in Score API
+
 === 4.3.0 2023-08-21
 - PSP Merchant Management API
 

data/README.md

@@ -1,5 +1,4 @@
 # 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).
 
@@ -39,8 +38,22 @@ client = Sift::Client.new(api_key: '<your_api_key_here>', account_id: '<your_acc
 
 ```
 
-### Sending a transaction event
+### Sending an event
+Send event to Sift.
+To learn more about the Events API visit our [developer docs](https://developers.sift.com/docs/ruby/events-api/overview).
 
+
+**Optional Params**
+- `return_score`: `:true` or `:false`
+- `return_action`: `:true` or `:false`
+- `return_workflow_status`: `:true` or `:false`
+- `return_route_info`: `:true` or `:false`
+- `force_workflow_run`: `:true` or `:false`
+- `include_score_percentiles`: `:true` or `:false`
+- `warnings`: `:true` or `:false`
+- `abuse_types`: `["payment_abuse", "content_abuse", "content_abuse", "account_abuse", "legacy", "account_takeover"]`
+
+**Example:**
 ```ruby
 event = "$transaction"
 
@@ -318,3 +331,21 @@ To run the various tests use the rake command as follows:
 ```ruby
 $ rake spec
 ```
+
+## Integration testing app
+
+For testing the app with real calls it is possible to run the integration testing app,
+it makes calls to almost all our public endpoints to make sure the library integrates
+well. At the moment, the app is run on every merge to master
+
+#### How to run it locally
+
+1. Add env variable `ACCOUNT_ID` with the valid account id
+2. Add env variable `API_KEY` with the valid Api Key associated from the account
+3. Run the following under the project root folder
+```
+# Install the budle locally
+bundle check || bundle install
+# Run the app
+bundle exec ruby test_integration_app/main.rb
+```

data/lib/sift/client.rb

@@ -201,6 +201,12 @@ module Sift
     #
     #   :path::
     #     Overrides the URI path for this API call.
+    # 
+    #   :include_score_percentiles::
+    #     include_score_percentiles(optional) : Whether to add new parameter in the query parameter.
+    #
+    #   :warnings::
+    #     warnings(optional) : Whether to add list of warnings (if any) to response.
     #
     # ==== Returns:
     #
@@ -220,6 +226,7 @@ module Sift
       force_workflow_run = opts[:force_workflow_run]
       abuse_types = opts[:abuse_types]
       include_score_percentiles = opts[:include_score_percentiles]
+      warnings = opts[:warnings]
 
       raise("event must be a non-empty string") if (!event.is_a? String) || event.empty?
       raise("properties cannot be empty") if properties.empty?
@@ -232,8 +239,12 @@ module Sift
       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"
+
+      if include_score_percentiles == "true" || warnings == "true"
+        fields = []
+        fields << "SCORE_PERCENTILES" if include_score_percentiles == "true"
+        fields << "WARNINGS" if warnings == "true"
+        query["fields"] = fields.join(",")
       end
 
       options = {
@@ -275,6 +286,9 @@ module Sift
     #
     #   :version::
     #     Overrides the version of the Events API to call.
+    # 
+    #   :include_score_percentiles::
+    #     include_score_percentiles(optional) : Whether to add new parameter in the query parameter.
     #
     # ==== Returns:
     #
@@ -286,6 +300,7 @@ module Sift
       api_key = opts[:api_key] || @api_key
       timeout = opts[:timeout] || @timeout
       version = opts[:version] || @version
+      include_score_percentiles = opts[:include_score_percentiles]
 
       raise("user_id must be a non-empty string") if (!user_id.is_a? String) || user_id.to_s.empty?
       raise("Bad api_key parameter") if api_key.empty?
@@ -293,6 +308,9 @@ module Sift
       query = {}
       query["api_key"] = api_key
       query["abuse_types"] = abuse_types.join(",") if abuse_types
+      if include_score_percentiles == "true"
+        query["fields"] =  "SCORE_PERCENTILES"
+      end
 
       options = {
         :headers => {"User-Agent" => user_agent},
@@ -332,6 +350,9 @@ module Sift
     #
     #   :timeout::
     #     Overrides the timeout (in seconds) for this call.
+    # 
+    #   :include_score_percentiles::
+    #     include_score_percentiles(optional) : Whether to add new parameter in the query parameter.
     #
     # ==== Returns:
     #
@@ -342,6 +363,7 @@ module Sift
       abuse_types = opts[:abuse_types]
       api_key = opts[:api_key] || @api_key
       timeout = opts[:timeout] || @timeout
+      include_score_percentiles = opts[:include_score_percentiles]
 
       raise("user_id must be a non-empty string") if (!user_id.is_a? String) || user_id.to_s.empty?
       raise("Bad api_key parameter") if api_key.empty?
@@ -349,6 +371,9 @@ module Sift
       query = {}
       query["api_key"] = api_key
       query["abuse_types"] = abuse_types.join(",") if abuse_types
+      if include_score_percentiles == "true"
+        query["fields"] =  "SCORE_PERCENTILES"
+      end
 
       options = {
         :headers => {"User-Agent" => user_agent},

data/lib/sift/version.rb

@@ -1,4 +1,4 @@
 module Sift
-  VERSION = "4.3.0"
+  VERSION = "4.5.0"
   API_VERSION = "205"
 end

data/spec/unit/client_spec.rb

@@ -110,6 +110,69 @@ describe Sift::Client do
     }
   end
 
+  def warnings
+    {
+      :count => 1,
+      :items => [{
+        :message => 'Invalid currency'
+      }]
+    }
+  end
+
+  def percentile_response_json
+    {
+      :user_id => 'billy_jones_301',
+      :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
+
   def fully_qualified_api_endpoint
     Sift::Client::API_ENDPOINT + Sift.rest_api_path
   end
@@ -554,4 +617,106 @@ describe Sift::Client do
     expect(response.body["decisions"]["content_abuse"]["decision"]["id"]).to eq("decision7")
   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
+
+  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
+
+  it "Successfully fetches a v205 score with SCORE_PERCENTILES" do
+
+    api_key = "foobar"
+    response_json = score_response_json
+
+    stub_request(:get, "https://api.siftscience.com/v205/score/247019/?api_key=foobar&fields=SCORE_PERCENTILES")
+      .to_return(:status => 200, :body => MultiJson.dump(response_json),
+                 :headers => {"content-type"=>"application/json; charset=UTF-8",
+                              "content-length"=> "74"})
+
+    response = Sift::Client.new(:api_key => api_key)
+               .score(score_response_json[:user_id], :version => 205, :include_score_percentiles => "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"]).to eq(0.93)
+  end
+
+  it "Successfully executes client.get_user_score() with SCORE_PERCENTILES" do
+
+    api_key = "foobar"
+    response_json = user_score_response_json
+
+    stub_request(:get, "https://api.siftscience.com/v205/users/247019/score?api_key=foobar&fields=SCORE_PERCENTILES")
+      .to_return(:status => 200, :body => MultiJson.dump(response_json),
+                 :headers => {"content-type"=>"application/json; charset=UTF-8",
+                              "content-length"=> "74"})
+
+    response = Sift::Client.new(:api_key => api_key)
+               .get_user_score(user_score_response_json[:entity_id], :include_score_percentiles => "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["entity_id"]).to eq("247019")
+    expect(response.body["scores"]["payment_abuse"]["score"]).to eq(0.78)
+  end
+
+  it "Successfully submits a v205 event with WARNINGS" do
+    response_json =
+    { :status => 0, :error_message => "OK", :warnings => warnings}
+    stub_request(:post, "https://api.siftscience.com/v205/events?fields=WARNINGS").
+      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",:warnings => "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["warnings"]["count"]).to eq(1)
+    expect(response.body["warnings"]["items"][0]["message"]).to eq("Invalid currency")
+  end
 end

data/test_integration_app/decisions_api/test_decisions_api.rb

@@ -0,0 +1,31 @@
+require "sift"
+
+class DecisionAPI
+
+    @@client = Sift::Client.new(:api_key => ENV["API_KEY"], :account_id => ENV["ACCOUNT_ID"])
+
+    def apply_user_decision()
+          properties = {
+            "decision_id": "integration_app_watch_account_abuse",
+            "description": "User linked to three other payment abusers and ordering high value items",
+            "source": "manual_review",
+            "analyst": "analyst@example.com",
+            "user_id": "userId"
+          }
+
+          return @@client.apply_decision(properties)
+      end
+
+      def apply_order_decision()
+          properties = {
+            "decision_id": "block_order_payment_abuse",
+            "description": "applied via the high priority queue, queued user because their risk score exceeded 85",
+            "source": "AUTOMATED_RULE",
+            "user_id": "userId",
+            "order_id": "orderId"
+          }
+  
+          return @@client.apply_decision(properties)
+      end
+
+end