sift 4.4.0 → 4.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3ba7bb7dc985a6f320db6c39717c90e349a16306ec2b85f7a2ba28945c5e2f64
-  data.tar.gz: 8665633d78bb4c9502443f241943d4fb98015ede3060d233913169f5921d528b
+  metadata.gz: 0be867318fbb8cb5cb85b614e48de3748def9c8d9a6122c066c785d65c6b3b48
+  data.tar.gz: abf0fe3da0bbf939f29cdb1071e9acb7db62473bc9fdc37dcde52631db930abc
 SHA512:
-  metadata.gz: 75ce0e5c6631fbd4aa22ad72cb2ad9cebc0cf5ee0ec7e7de1dc308d9d90d3c1ef288a75a699ac0ef04ae650700a4a7b63ad1ece30d1386da0c06ceefcea10420
-  data.tar.gz: 3804c62aaf0795bfce7eadc4d048ae36d3a67a0d1dd9c81548d31926f950a5908a4fb158a8363182bb14ebb77545d3c671b37292802c093ea31719176683bb26
+  metadata.gz: cc2d9d80295f6f4605413d001bb29b4745e28ecc58e9595a526bd8a7d8529d2b63dc14fce063e1ee347bde3b9d9370ad160917a795e59377a54d5eeb50f876b7
+  data.tar.gz: f5f75423865db471ed649a4146a8e3e388203977ec6607c20966c9622f9b074f8e149574f9bbe28db22f44b21203e9ae082b52386bea6f8c2096afd869955a65

data/.github/workflows/ci.yml

@@ -0,0 +1,49 @@
+name: Ruby-ci
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    branches:
+      - master
+
+env:
+  ACCOUNT_ID: ${{ secrets.ACCOUNT_ID }}
+  API_KEY: ${{ secrets.API_KEY }}
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.4.2']
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+      - name: Run tests
+        run: bundle exec rspec --format RspecJunitFormatter --out test_results/rspec.xml --format progress
+
+  run_integration_tests:
+    runs-on: ubuntu-latest
+    if: ${{ github.ref == 'refs/heads/master' }}
+    strategy:
+      matrix:
+        ruby-version: [ '2.4.2' ]
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+      - name: Run tests
+        run: |
+          bundle exec ruby test_integration_app/main.rb 

data/HISTORY

@@ -1,3 +1,9 @@
+=== 4.5.1 2025-04-07
+- Fix Verification URLs
+
+=== 4.5.0 2024-05-16
+- Support for warnings in Events API
+
 === 4.4.0 2023-10-05
 - Score percentiles in Score 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

@@ -139,6 +139,7 @@ module Sift
       @api_key = opts[:api_key] || Sift.api_key
       @account_id = opts[:account_id] || Sift.account_id
       @version = opts[:version] || API_VERSION
+      @verification_version = opts[:verification_version] || VERIFICATION_API_VERSION
       @timeout = opts[:timeout] || 2  # 2-second timeout by default
       @path = opts[:path] || Sift.rest_api_path(@version)
 
@@ -201,10 +202,13 @@ 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:
     #
     # In the case of a network error (timeout, broken connection, etc.),
@@ -223,6 +227,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?
@@ -235,8 +240,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 = {
@@ -278,7 +287,7 @@ 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.
     #
@@ -342,7 +351,7 @@ 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.
     #
@@ -747,7 +756,7 @@ module Sift
 
     def verification_send(properties = {}, opts = {})
       api_key = opts[:api_key] || @api_key
-      version = opts[:version] || @version
+      version = opts[:verification_version] || @verification_version
       timeout = opts[:timeout] || @timeout
 
       raise("properties cannot be empty") if properties.empty?
@@ -759,14 +768,13 @@ module Sift
         :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
+      version = opts[:verification_version] || @verification_version
       timeout = opts[:timeout] || @timeout
 
       raise("properties cannot be empty") if properties.empty?
@@ -785,7 +793,7 @@ module Sift
 
     def verification_check(properties = {}, opts = {})
       api_key = opts[:api_key] || @api_key
-      version = opts[:version] || @version
+      version = opts[:verification_version] || @verification_version
       timeout = opts[:timeout] || @timeout
 
       raise("properties cannot be empty") if properties.empty?

data/lib/sift/version.rb

@@ -1,4 +1,5 @@
 module Sift
-  VERSION = "4.4.0"
+  VERSION = "4.5.1"
   API_VERSION = "205"
+  VERIFICATION_API_VERSION = "1.1"
 end

data/lib/sift.rb

@@ -10,17 +10,17 @@ module Sift
   end
 
   # Returns the path for the specified API version
-  def self.verification_api_send_path(version=API_VERSION)
+  def self.verification_api_send_path(version=VERIFICATION_API_VERSION)
     "/v#{version}/verification/send"
   end
 
   # Returns the path for the specified API version
-  def self.verification_api_resend_path(version=API_VERSION)
+  def self.verification_api_resend_path(version=VERIFICATION_API_VERSION)
     "/v#{version}/verification/resend"
   end
 
   # Returns the path for the specified API version
-  def self.verification_api_check_path(version=API_VERSION)
+  def self.verification_api_check_path(version=VERIFICATION_API_VERSION)
     "/v#{version}/verification/check"
   end
 

data/spec/unit/client_spec.rb

@@ -110,6 +110,15 @@ describe Sift::Client do
     }
   end
 
+  def warnings
+    {
+      :count => 1,
+      :items => [{
+        :message => 'Invalid currency'
+      }]
+    }
+  end
+
   def percentile_response_json
     {
       :user_id => 'billy_jones_301',
@@ -689,4 +698,25 @@ describe Sift::Client do
     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