sift 2.2.1 → 4.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: e4c2e3042d8ff485909a45e093bfe1f1145e8f28
-  data.tar.gz: 57c0c4e3bb6cfdfe26cb5907717581d4ba8d3e25
+SHA256:
+  metadata.gz: 4b20b0230176dc6340e5ea4939e51b6e1ed2642e788c25fa2f7f4e829b5c61ff
+  data.tar.gz: 28932a0fddd658fe868c6c6b6b408ab1d8529060cfbe0766ffeef76e2398e43e
 SHA512:
-  metadata.gz: 8f81535b358bab94f1156197e54612f3e8c81210dbbe38a45e68309eb3327bfc9c6ac164921fcece99059577ded9b6431f65caae9016513c00dfb512e4e76d3a
-  data.tar.gz: 063f7691c9f6f99f241db47f837135dd0e32fcb1d65d5c35aea1aece78effb4fa6fdfbdb97d758d2b9d6fb8905837f030bfd7b56b5c1ab942f7787bb1ef73a9f
+  metadata.gz: b905f6002c28777a4cf82cc6b0e59b2c79c300fdf1f4b4b3bf8b0bff8691946325d83794da812d5abc4b344b5e35d24f72b720aae1ddc0783b7e935117f35588
+  data.tar.gz: e161d32f1c210f3fc4562b985537ceb6e2f304330a3fb14ddbce142cd105b0a0c567f6e177dd3c29c99e6c50133e3a7eb40c5ba922071914d9cf56b540c8f427

data/.circleci/config.yml

@@ -0,0 +1,43 @@
+version: 2
+
+jobs:
+  build:
+    parallelism: 3 # run three instances of this job in parallel
+    docker:
+      - image: circleci/ruby:2.4.2-jessie-node
+        environment:
+          BUNDLE_JOBS: 3
+          BUNDLE_RETRY: 3
+          BUNDLE_PATH: vendor/bundle
+    steps:
+      - checkout
+
+      - run:
+          name: Which bundler?
+          command: bundle -v
+
+      - restore_cache:
+          keys:
+            - sift-bundle-{{ checksum "sift.gemspec" }}
+            - sift-bundle-
+
+      - run:
+          name: Bundle Install
+          command: bundle check || bundle install
+
+      - save_cache:
+          key: sift-bundle-{{ checksum "sift.gemspec" }}
+          paths:
+            - vendor/bundle
+
+      - run:
+          name: Run rspec in parallel
+          command: |
+            bundle exec rspec --profile 10 \
+                              --format RspecJunitFormatter \
+                              --out test_results/rspec.xml \
+                              --format progress \
+                              $(circleci tests glob "spec/**/*_spec.rb" | circleci tests split --split-by=timings)
+
+      - store_test_results:
+          path: test_results

data/HISTORY

@@ -1,3 +1,34 @@
+=== 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
+- Add Circle build
+
+=== 3.3.0 2018-07-31
+- Add support for rescore_user and get_user_score APIs
+
+=== 3.2.0 2018-07-05
+- Add new query parameter force_workflow_run
+
+=== 3.1.0 2018-06-04
+- Adds support for get session decisions to [Decisions API](https://siftscience.com/developers/docs/curl/decisions-api)
+
+=== 3.0.1 2018-04-06
+- Improved documentation on HISTORY and README.MD
+
+=== 3.0.0 2018-03-05
+- Adds support for Sift Science API Version 205, including new [`$create_content`](https://siftscience.com/developers/docs/curl/events-api/reserved-events/create-content) and [`$update_content`](https://siftscience.com/developers/docs/curl/events-api/reserved-events/update-content) formats
+- V205 APIs are now called -- **this is an incompatible change**
+   - (use `:version => 204` to call the previous API version)
+- Adds support for content decisions to [Decisions API](https://siftscience.com/developers/docs/curl/decisions-api)
+
+INCOMPATIBLE CHANGES INTRODUCED IN API V205:
+- `$create_content` and `$update_content` have significantly changed, and the old format will be rejected
+- `$send_message` and `$submit_review` events are no longer valid
+- V205 improves server-side event data validation. In V204 and earlier, server-side validation accepted some events that did not conform to the published APIs in our [developer documentation](https://siftscience.com/developers/docs/curl/events-api). V205 does not modify existing event APIs other than those mentioned above, but may reject invalid event data that were previously accepted. **Please test your integration on V205 in sandbox before using in production.**
+
 === 2.2.1.0 2018-02-12
 * Add session level decisions in Apply Decisions APIs.
 

data/README.md

@@ -1,8 +1,11 @@
-# Sift Science Ruby bindings [![Build Status](https://travis-ci.org/SiftScience/sift-ruby.png?branch=master)](https://travis-ci.org/SiftScience/sift-ruby)
+# 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 1.9.3 or above.
+  * Ruby 2.0.0 or above.
 
 
 ## Installation
@@ -32,7 +35,7 @@ client = Sift::Client.new()
 
 ##### OR
 
-client = Sift::Client.new(api_key: '<your_api_key_here>', account_id: '<your_account_id_here>'
+client = Sift::Client.new(api_key: '<your_api_key_here>', account_id: '<your_account_id_here>')
 
 ```
 
@@ -73,14 +76,14 @@ response = client.score(user_id)
 
 ## Decisions
 
-To learn more about the decisions endpoint visit our [developer docs](https://siftscience.com/developers/docs/ruby/decisions-api/get-decisions).
+To learn more about the decisions endpoint visit our [developer docs](https://sift.com/developers/docs/ruby/decisions-api/get-decisions).
 
 ### List of Configured Decisions
 
 Get a list of your decisions.
 
 **Optional Params**
- - `entity_type`: `:user` or `:order` or `:session`
+ - `entity_type`: `:user` or `:order` or `:session` or `:content`
  - `abuse_types`: `["payment_abuse", "content_abuse", "content_abuse",
    "account_abuse", "legacy", "account_takeover"]`
 
@@ -117,7 +120,7 @@ end
 
 ### Apply a decision
 
-Applies a decision to an entity. Visit our [developer docs](http://siftscience.com/developers/docs/ruby/decisions-api/apply-decision) for more information.
+Applies a decision to an entity. Visit our [developer docs](http://sift.com/developers/docs/ruby/decisions-api/apply-decision) for more information.
 
 **Required Params:**
 - `decision_id`, `source`, `user_id`
@@ -140,7 +143,7 @@ response = client.apply_decision({
   user_id: "john@example.com"
 })
 
-# apply decision to "bob@example.com"'s order
+# apply decision to "john@example.com"'s order
 response = client.apply_decision({
   decision_id: "block_bad_order",
   source: "manual_review",
@@ -149,7 +152,7 @@ response = client.apply_decision({
   order_id: "ORDER_1234"
 })
 
-# apply decision to "bob@example.com"'s session
+# apply decision to "john@example.com"'s session
 response = client.apply_decision({
   decision_id: "block_bad_session",
   source: "manual_review",
@@ -158,6 +161,16 @@ response = client.apply_decision({
   session_id: "SESSION_ID_1234"
 })
 
+# apply decision to "john@example.com"'s content
+response = client.apply_decision({
+  decision_id: "block_bad_session",
+  source: "manual_review",
+  analyst: "bob@your_company.com",
+  user_id: "john@example.com",
+  content_id: "CONTENT_ID_1234"
+})
+
+
 # Make sure you handle the response after applying a decision:
 
 if response.ok?
@@ -196,6 +209,12 @@ response = client.get_user_decisions('example_user_id')
 
 # Get the latest decisions for an order
 response = client.get_order_decisions('example_order_id')
+
+# Get the latest decisions for a session
+response = client.get_session_decisions('example_user_id', 'example_session_id')
+
+# Get the latest decisions for an content
+response = client.get_content_decisions('example_user_id', 'example_order_id')
 ```
 
 ## Response Object

data/lib/sift/client/decision/apply_to.rb

@@ -15,6 +15,7 @@ module Sift
           description
           order_id
           session_id
+          content_id
           user_id
           account_id
           time
@@ -93,11 +94,17 @@ module Sift
           configs.has_key?("session_id") || configs.has_key?(:session_id)
         end
 
+        def applying_to_content?
+          configs.has_key?("content_id") || configs.has_key?(:content_id)
+        end
+
         def path
           if applying_to_order?
             "#{user_path}/orders/#{CGI.escape(order_id)}/decisions"
           elsif applying_to_session?
             "#{user_path}/sessions/#{CGI.escape(session_id)}/decisions"
+          elsif applying_to_content?
+            "#{user_path}/content/#{CGI.escape(content_id)}/decisions"
           else
             "#{user_path}/decisions"
           end

data/lib/sift/client.rb

@@ -34,15 +34,25 @@ module Sift
 
       # only set these variables if a message-body is expected.
       if not @http_raw_response.kind_of? Net::HTTPNoContent
-        @body = MultiJson.load(http_response) unless http_response.nil?
-        @request = MultiJson.load(@body["request"].to_s) if @body["request"]
-        @api_status = @body["status"].to_i if @body["status"]
-        @api_error_message = @body["error_message"]
-
-        if @body["error"]
-          @api_error_message = @body["error"]
-          @api_error_description = @body["description"]
-          @api_error_issues = @body["issues"] || {}
+
+        begin
+          @body = MultiJson.load(http_response) unless http_response.nil?
+        rescue
+          if @http_status_code == 200
+            raise TypeError.new
+          end
+        end
+
+        if not @body.nil?
+          @request = MultiJson.load(@body["request"].to_s) if @body["request"]
+          @api_status = @body["status"].to_i if @body["status"]
+          @api_error_message = @body["error_message"]
+
+          if @body["error"]
+            @api_error_message = @body["error"]
+            @api_error_description = @body["description"]
+            @api_error_issues = @body["issues"] || {}
+          end
         end
       end
     end
@@ -118,7 +128,7 @@ module Sift
     #
     #   :version::
     #     The version of the Events API, Score API, and Labels API to call.
-    #     By default, version 204.
+    #     By default, version 205.
     #
     #   :path::
     #     The URL path to use for Events API path.  By default, the
@@ -132,7 +142,7 @@ module Sift
       @timeout = opts[:timeout] || 2  # 2-second timeout by default
       @path = opts[:path] || Sift.rest_api_path(@version)
 
-      raise("api_key must be a non-empty string") if !@api_key.is_a?(String) || @api_key.empty?
+      raise("api_key") if !@api_key.is_a?(String) || @api_key.empty?
       raise("path must be a non-empty string") if !@path.is_a?(String) || @path.empty?
     end
 
@@ -194,8 +204,8 @@ module Sift
     #
     # ==== Returns:
     #
-    # In the case of a connection error (timeout, broken connection,
-    # etc.), this method returns nil; otherwise, a Response object is
+    # In the case of a network error (timeout, broken connection, etc.),
+    # this method propagates the exception, otherwise, a Response object is
     # returned that captures the status message and status code.
     #
     def track(event, properties = {}, opts = {})
@@ -206,6 +216,8 @@ 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]
 
       raise("event must be a non-empty string") if (!event.is_a? String) || event.empty?
@@ -216,6 +228,8 @@ 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
 
       options = {
@@ -226,14 +240,8 @@ module Sift
       }
       options.merge!(:timeout => timeout) unless timeout.nil?
 
-      begin
-        response = self.class.post(path, options)
-        Response.new(response.body, response.code, response.response)
-      rescue StandardError => e
-        Sift.warn("Failed to track event: " + e.to_s)
-        Sift.warn(e.backtrace)
-        nil
-      end
+      response = self.class.post(path, options)
+      Response.new(response.body, response.code, response.response)
     end
 
 
@@ -293,6 +301,114 @@ module Sift
     end
 
 
+    # Fetches the latest score(s) computed for the specified user and abuse types.
+    #
+    # As opposed to client.score() and client.rescore_user(), this *does not* compute
+    # a new score for the user; it simply fetches the latest score(s) which have computed.
+    # These scores may be arbitrarily old.
+    #
+    # See https://siftscience.com/developers/docs/ruby/score-api/get-score for more details.
+    #
+    # ==== Parameters:
+    #
+    # user_id::
+    #   A user's id. This id should be the same as the user_id used in
+    #   event calls.
+    #
+    # opts (optional)::
+    #   A Hash of optional parameters for the request --
+    #
+    #   :abuse_types::
+    #     List of abuse types, specifying for which abuse types a
+    #     score should be returned.  By default, a score is returned
+    #     for every abuse type to which you are subscribed.
+    #
+    #   :api_key::
+    #     Overrides the API key for this call.
+    #
+    #   :timeout::
+    #     Overrides the timeout (in seconds) for this call.
+    #
+    # ==== Returns:
+    #
+    # A Response object containing a status code, status message, and,
+    # if successful, the user's score(s).
+    #
+    def get_user_score(user_id, opts = {})
+      abuse_types = opts[:abuse_types]
+      api_key = opts[:api_key] || @api_key
+      timeout = opts[:timeout] || @timeout
+
+      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?
+
+      query = {}
+      query["api_key"] = api_key
+      query["abuse_types"] = abuse_types.join(",") if abuse_types
+
+      options = {
+        :headers => {"User-Agent" => user_agent},
+        :query => query
+      }
+      options.merge!(:timeout => timeout) unless timeout.nil?
+
+      response = self.class.get(Sift.user_score_api_path(user_id, @version), options)
+      Response.new(response.body, response.code, response.response)
+    end
+
+
+    # Rescores the specified user for the specified abuse types and returns the resulting score(s).
+    #
+    # See https://siftscience.com/developers/docs/ruby/score-api/rescore for more details.
+    #
+    # ==== Parameters:
+    #
+    # user_id::
+    #   A user's id. This id should be the same as the user_id used in
+    #   event calls.
+    #
+    # opts (optional)::
+    #   A Hash of optional parameters for the request --
+    #
+    #   :abuse_types::
+    #     List of abuse types, specifying for which abuse types a
+    #     score should be returned.  By default, a score is returned
+    #     for every abuse type to which you are subscribed.
+    #
+    #   :api_key::
+    #     Overrides the API key for this call.
+    #
+    #   :timeout::
+    #     Overrides the timeout (in seconds) for this call.
+    #
+    # ==== Returns:
+    #
+    # A Response object containing a status code, status message, and,
+    # if successful, the user's score(s).
+    #
+    def rescore_user(user_id, opts = {})
+      abuse_types = opts[:abuse_types]
+      api_key = opts[:api_key] || @api_key
+      timeout = opts[:timeout] || @timeout
+
+      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?
+
+      query = {}
+      query["api_key"] = api_key
+      query["abuse_types"] = abuse_types.join(",") if abuse_types
+
+      options = {
+        :headers => {"User-Agent" => user_agent},
+        :query => query
+      }
+      options.merge!(:timeout => timeout) unless timeout.nil?
+
+      response = self.class.post(Sift.user_score_api_path(user_id, @version), options)
+      Response.new(response.body, response.code, response.response)
+    end
+
+
     # Labels a user.
     #
     # See https://siftscience.com/developers/docs/ruby/labels-api/label-user .
@@ -504,6 +620,86 @@ module Sift
       Response.new(response.body, response.code, response.response)
     end
 
+    # Gets the decision status of a session.
+    #
+    # See https://siftscience.com/developers/docs/ruby/decisions-api/decision-status .
+    #
+    # ==== Parameters
+    #
+    # user_id::
+    #   The ID of the user in the session.
+    #
+    # session_id::
+    #   The ID of a session.
+    #
+    # opts (optional)::
+    #   A Hash of optional parameters for this request --
+    #
+    #   :account_id::
+    #     Overrides the account id for this call.
+    #
+    #   :api_key::
+    #     Overrides the API key for this call.
+    #
+    #   :timeout::
+    #     Overrides the timeout (in seconds) for this call.
+    #
+    def get_session_decisions(user_id, session_id, opts = {})
+      account_id = opts[:account_id] || @account_id
+      api_key = opts[:api_key] || @api_key
+      timeout = opts[:timeout] || @timeout
+
+      options = {
+        :headers => { "User-Agent" => user_agent },
+        :basic_auth => { :username => api_key, :password => "" }
+      }
+      options.merge!(:timeout => timeout) unless timeout.nil?
+
+      uri = API3_ENDPOINT + Sift.session_decisions_api_path(account_id, user_id, session_id)
+      response = self.class.get(uri, options)
+      Response.new(response.body, response.code, response.response)
+    end
+
+    # Gets the decision status of a piece of content.
+    #
+    # See https://siftscience.com/developers/docs/ruby/decisions-api/decision-status .
+    #
+    # ==== Parameters
+    #
+    # user_id::
+    #   The ID of the owner of the content.
+    #
+    # content_id::
+    #   The ID of a piece of content.
+    #
+    # opts (optional)::
+    #   A Hash of optional parameters for this request --
+    #
+    #   :account_id::
+    #     Overrides the API key for this call.
+    #
+    #   :api_key::
+    #     Overrides the API key for this call.
+    #
+    #   :timeout::
+    #     Overrides the timeout (in seconds) for this call.
+    #
+    def get_content_decisions(user_id, content_id, opts = {})
+      account_id = opts[:account_id] || @account_id
+      api_key = opts[:api_key] || @api_key
+      timeout = opts[:timeout] || @timeout
+
+      options = {
+        :headers => { "User-Agent" => user_agent },
+        :basic_auth => { :username => api_key, :password => "" }
+      }
+      options.merge!(:timeout => timeout) unless timeout.nil?
+
+      uri = API3_ENDPOINT + Sift.content_decisions_api_path(account_id, user_id, content_id)
+      response = self.class.get(uri, options)
+      Response.new(response.body, response.code, response.response)
+    end
+
     def decisions(opts = {})
       decision_instance.list(opts)
     end

data/lib/sift/validate/decision.rb

@@ -20,6 +20,12 @@ module Sift
           validate_key(:non_empty_string, :user_id, :session_id)
         end
       end
+
+      def valid_content?
+        run do
+          validate_key(:non_empty_string, :user_id, :content_id)
+        end
+      end
       
       def valid_user?
         run do

data/lib/sift/version.rb

@@ -1,4 +1,4 @@
 module Sift
-  VERSION = "2.2.1"
-  API_VERSION = "204"
+  VERSION = "4.1.0"
+  API_VERSION = "205"
 end

data/lib/sift.rb

@@ -1,5 +1,6 @@
-require_relative "./sift/version"
-require_relative "./sift/client"
+require_relative './sift/version'
+require_relative './sift/client'
+require 'erb'
 
 module Sift
 
@@ -10,27 +11,49 @@ module Sift
 
   # 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/#{URI.encode(user_id)}/"
+    "/v#{version}/score/#{ERB::Util.url_encode(user_id)}/"
+  end
+
+  # Returns the User Score API path for the specified user ID and API version
+  def self.user_score_api_path(user_id, version=API_VERSION)
+    "/v#{version}/users/#{ERB::Util.url_encode(user_id)}/score"
   end
 
   # Returns the users API path for the specified user ID and API version
   def self.users_label_api_path(user_id, version=API_VERSION)
-    "/v#{version}/users/#{URI.encode(user_id)}/labels"
+    "/v#{version}/users/#{ERB::Util.url_encode(user_id)}/labels"
   end
 
   # Returns the path for the Workflow Status API
   def self.workflow_status_path(account_id, run_id)
-    "/v3/accounts/#{account_id}/workflows/runs/#{run_id}"
+    "/v3/accounts/#{ERB::Util.url_encode(account_id)}" \
+      "/workflows/runs/#{ERB::Util.url_encode(run_id)}"
   end
 
   # Returns the path for User Decisions API
   def self.user_decisions_api_path(account_id, user_id)
-    "/v3/accounts/#{account_id}/users/#{user_id}/decisions"
+    "/v3/accounts/#{ERB::Util.url_encode(account_id)}" \
+      "/users/#{ERB::Util.url_encode(user_id)}/decisions"
   end
 
   # Returns the path for Orders Decisions API
   def self.order_decisions_api_path(account_id, order_id)
-    "/v3/accounts/#{account_id}/orders/#{order_id}/decisions"
+    "/v3/accounts/#{ERB::Util.url_encode(account_id)}" \
+      "/orders/#{ERB::Util.url_encode(order_id)}/decisions"
+  end
+
+  # Returns the path for Session Decisions API
+  def self.session_decisions_api_path(account_id, user_id, session_id)
+    "/v3/accounts/#{ERB::Util.url_encode(account_id)}" \
+      "/users/#{ERB::Util.url_encode(user_id)}" \
+      "/sessions/#{ERB::Util.url_encode(session_id)}/decisions"
+  end
+
+  # Returns the path for Content Decisions API
+  def self.content_decisions_api_path(account_id, user_id, content_id)
+    "/v3/accounts/#{ERB::Util.url_encode(account_id)}" \
+      "/users/#{ERB::Util.url_encode(user_id)}" \
+      "/content/#{ERB::Util.url_encode(content_id)}/decisions"
   end
 
   # Module-scoped public API key
@@ -64,5 +87,4 @@ module Sift
   def self.fatal(msg)
     @logger.fatal(msg) if @logger
   end
-
 end

data/sift.gemspec

@@ -21,6 +21,7 @@ Gem::Specification.new do |s|
 
   # Gems that must be intalled for sift to compile and build
   s.add_development_dependency "rspec", "~> 3.5"
+  s.add_development_dependency "rspec_junit_formatter"
   s.add_development_dependency "pry"
   s.add_development_dependency "webmock", ">= 1.16.0", "< 2"
 

data/spec/unit/client_label_spec.rb

@@ -25,7 +25,7 @@ describe Sift::Client do
     response_json = { :status => 0, :error_message => "OK" }
     user_id = "frodo_baggins"
 
-    stub_request(:post, "https://api.siftscience.com/v204/users/frodo_baggins/labels")
+    stub_request(:post, "https://api.siftscience.com/v205/users/frodo_baggins/labels")
       .with(:body => ('{"$abuse_type":"content_abuse","$is_bad":true,"$description":"Listed a fake item","$type":"$label","$api_key":"foobar"}'))
       .to_return(:body => MultiJson.dump(response_json), :status => 200,
                  :headers => {"content-type"=>"application/json; charset=UTF-8",
@@ -45,7 +45,7 @@ describe Sift::Client do
     user_id = "frodo_baggins"
 
     stub_request(:delete,
-                 "https://api.siftscience.com/v204/users/frodo_baggins/labels?api_key=foobar&abuse_type=payment_abuse")
+                 "https://api.siftscience.com/v205/users/frodo_baggins/labels?api_key=foobar&abuse_type=payment_abuse")
       .to_return(:status => 204)
 
     api_key = "foobar"

data/spec/unit/client_spec.rb

@@ -43,6 +43,38 @@ describe Sift::Client do
     }
   end
 
+  def user_score_response_json
+    {
+      :entity_type => "user",
+      :entity_id => "247019",
+      :scores => {
+        :payment_abuse => {
+          :score => 0.78
+        },
+        :content_abuse => {
+          :score => 0.11
+        }
+      },
+      :latest_decisions => {
+        :payment_abuse => {
+          :id => "user_looks_bad_payment_abuse",
+          :category => "block",
+          :source => "AUTOMATED_RULE",
+          :time => 1352201880,
+          :description => "Bad Fraudster"
+        }
+      },
+      :latest_labels => {
+        :payment_abuse => {
+          :is_bad => true,
+          :time => 1352201880
+        }
+      },
+      :status => 0,
+      :error_message => "OK"
+    }
+  end
+
   def action_response_json
     {
       :user_id => "247019",
@@ -140,36 +172,59 @@ describe Sift::Client do
   end
 
 
-  it "Doesn't raise an exception on Net/HTTP errors" do
+  it "Handles parse exceptions for 500 status" do
     api_key = "foobar"
     event = "$transaction"
     properties = valid_transaction_properties
+    res = nil
+
+    stub_request(:any, /.*/).to_return(:body => "{123", :status => 500)
+
+    expect { res = Sift::Client.new(:api_key => api_key).track(event, properties) }.not_to raise_error
+    expect(res.http_status_code).to eq(500)
+  end
+
+
+  it "Handles parse exceptions for 200 status" do
+    api_key = "foobar"
+    event = "$transaction"
+    properties = valid_transaction_properties
+    res = nil
+
+    stub_request(:any, /.*/).to_return(:body => "{123", :status => 200)
+
+    expect { res = Sift::Client.new(:api_key => api_key).track(event, properties) }.to raise_error(TypeError)
+  end
+
+
+  it "Preserves response on HTTP errors but does not raise an exception" do
+    api_key = "foobar"
+    event = "$transaction"
+    properties = valid_transaction_properties
+    res = nil
 
     stub_request(:any, /.*/).to_return(:status => 401)
 
-    # This method should just return nil -- the track call failed because
-    # of an HTTP error
-    expect(Sift::Client.new(:api_key => api_key).track(event, properties)).to eq(nil)
+    expect { res = Sift::Client.new(:api_key => api_key).track(event, properties) }.not_to raise_error
+    expect(res.http_status_code).to eq(401)
   end
 
 
-  it "Returns nil when a StandardError occurs within the request" do
+  it "Propagates exception when a StandardError occurs within the request" do
     api_key = "foobar"
     event = "$transaction"
     properties = valid_transaction_properties
 
     stub_request(:any, /.*/).to_raise(StandardError)
 
-    # This method should just return nil -- the track call failed because
-    # a StandardError exception was thrown
-    expect(Sift::Client.new(:api_key => api_key).track(event, properties)).to eq(nil)
+    expect { Sift::Client.new(:api_key => api_key).track(event, properties) }.to raise_error(StandardError)
   end
 
 
   it "Successfuly handles an event and returns OK" do
     response_json = { :status => 0, :error_message => "OK" }
 
-    stub_request(:post, "https://api.siftscience.com/v204/events").
+    stub_request(:post, "https://api.siftscience.com/v205/events").
       with { |request|
         parsed_body = JSON.parse(request.body)
         expect(parsed_body).to include("$buyer_user_id" => "123456")
@@ -190,7 +245,7 @@ describe Sift::Client do
 
   it "Successfully submits event with overridden key" do
     response_json = { :status => 0, :error_message => "OK"}
-    stub_request(:post, "https://api.siftscience.com/v204/events").
+    stub_request(:post, "https://api.siftscience.com/v205/events").
       with { | request|
         parsed_body = JSON.parse(request.body)
         expect(parsed_body).to include("$buyer_user_id" => "123456")
@@ -212,7 +267,7 @@ describe Sift::Client do
   it "Successfully scrubs nils" do
     response_json = { :status => 0, :error_message => "OK" }
 
-    stub_request(:post, "https://api.siftscience.com/v204/events")
+    stub_request(:post, "https://api.siftscience.com/v205/events")
       .with { |request|
         parsed_body = JSON.parse(request.body)
         expect(parsed_body).not_to include("fake_property")
@@ -241,7 +296,7 @@ describe Sift::Client do
     api_key = "foobar"
     response_json = score_response_json
 
-    stub_request(:get, "https://api.siftscience.com/v204/score/247019/?api_key=foobar")
+    stub_request(:get, "https://api.siftscience.com/v205/score/247019/?api_key=foobar")
       .to_return(:status => 200, :body => MultiJson.dump(response_json),
                  :headers => {"content-type"=>"application/json; charset=UTF-8",
                               "content-length"=> "74"})
@@ -259,7 +314,7 @@ describe Sift::Client do
     api_key = "foobar"
     response_json = score_response_json
 
-    stub_request(:get, "https://api.siftscience.com/v204/score/247019/?api_key=overridden")
+    stub_request(:get, "https://api.siftscience.com/v205/score/247019/?api_key=overridden")
       .to_return(:status => 200, :body => MultiJson.dump(response_json), :headers => {})
 
     response = Sift::Client.new(:api_key => api_key)
@@ -272,6 +327,88 @@ describe Sift::Client do
   end
 
 
+  it "Successfully executes client.get_user_score()" do
+    api_key = "foobar"
+    response_json = user_score_response_json
+
+    stub_request(:get, "https://api.siftscience.com/v205/users/247019/score?api_key=foobar")
+      .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])
+    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 executes client.get_user_score() with abuse types specified" do
+    api_key = "foobar"
+    response_json = user_score_response_json
+
+    stub_request(:get, "https://api.siftscience.com/v205/users/247019/score" +
+                 "?api_key=foobar&abuse_types=content_abuse,payment_abuse")
+      .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],
+                                                                    :abuse_types => ["content_abuse",
+                                                                                     "payment_abuse"])
+    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 executes client.rescore_user()" do
+    api_key = "foobar"
+    response_json = user_score_response_json
+
+    stub_request(:post, "https://api.siftscience.com/v205/users/247019/score?api_key=foobar")
+      .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).rescore_user(user_score_response_json[:entity_id])
+    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 executes client.rescore_user() with abuse types specified" do
+    api_key = "foobar"
+    response_json = user_score_response_json
+
+    stub_request(:post, "https://api.siftscience.com/v205/users/247019/score" +
+                 "?api_key=foobar&abuse_types=content_abuse,payment_abuse")
+      .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).rescore_user(user_score_response_json[:entity_id],
+                                                                  :abuse_types => ["content_abuse",
+                                                                                   "payment_abuse"])
+    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 make a sync score request" do
     api_key = "foobar"
     response_json = {
@@ -280,7 +417,7 @@ describe Sift::Client do
       :score_response => score_response_json
     }
 
-    stub_request(:post, "https://api.siftscience.com/v204/events?return_score=true")
+    stub_request(:post, "https://api.siftscience.com/v205/events?return_score=true")
       .to_return(:status => 200, :body => MultiJson.dump(response_json),
                  :headers => {"content-type"=>"application/json; charset=UTF-8",
                               "content-length"=> "74"})
@@ -304,7 +441,7 @@ describe Sift::Client do
       :score_response => action_response_json
     }
 
-    stub_request(:post, "https://api.siftscience.com/v204/events?return_action=true")
+    stub_request(:post, "https://api.siftscience.com/v205/events?return_action=true")
       .to_return(:status => 200, :body => MultiJson.dump(response_json),
                  :headers => {"content-type"=>"application/json; charset=UTF-8",
                               "content-length"=> "74"})
@@ -332,7 +469,7 @@ describe Sift::Client do
     }
 
     stub_request(:post,
-                 "https://api.siftscience.com/v204/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"})
@@ -341,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")
@@ -363,7 +501,7 @@ describe Sift::Client do
   end
 
 
-    it "Successfully make a user decisions request" do
+  it "Successfully make a user decisions request" do
     response_text = '{"decisions":{"content_abuse":{"decision":{"id":"user_decision"},"time":1468707128659,"webhook_succeeded":false}}}'
 
     stub_request(:get, "https://foobar:@api3.siftscience.com/v3/accounts/ACCT/users/example_user/decisions")
@@ -390,4 +528,30 @@ describe Sift::Client do
     expect(response.body["decisions"]["payment_abuse"]["decision"]["id"]).to eq("decision7")
   end
 
+  it "Successfully make a session decisions request" do
+    response_text = '{"decisions":{"account_takeover":{"decision":{"id":"session_decision"},"time":1468707128659,"webhook_succeeded":false}}}'
+
+    stub_request(:get, "https://foobar:@api3.siftscience.com/v3/accounts/ACCT/users/example_user/sessions/example_session/decisions")
+      .to_return(:status => 200, :body => response_text, :headers => {})
+
+    client = Sift::Client.new(:api_key => "foobar", :account_id => "ACCT")
+    response = client.get_session_decisions("example_user", "example_session")
+
+    expect(response.ok?).to eq(true)
+    expect(response.body["decisions"]["account_takeover"]["decision"]["id"]).to eq("session_decision")
+  end
+
+  it "Successfully make an content decisions request" do
+    response_text = '{"decisions":{"content_abuse":{"decision":{"id":"decision7"},"time":1468599638005,"webhook_succeeded":false}}}'
+
+    stub_request(:get, "https://foobar:@api3.siftscience.com/v3/accounts/ACCT/users/USER/content/example_content/decisions")
+      .to_return(:status => 200, :body => response_text, :headers => {})
+
+    client = Sift::Client.new(:api_key => "foobar", :account_id => "ACCT")
+    response = client.get_content_decisions("USER", "example_content", :timeout => 3)
+
+    expect(response.ok?).to eq(true)
+    expect(response.body["decisions"]["content_abuse"]["decision"]["id"]).to eq("decision7")
+  end
+
 end

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: sift
 version: !ruby/object:Gem::Version
-  version: 2.2.1
+  version: 4.1.0
 platform: ruby
 authors:
 - Fred Sadaghiani
 - Yoav Schatzberg
 - Jacob Burnim
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-02-15 00:00:00.000000000 Z
+date: 2022-07-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -26,6 +26,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: rspec_junit_formatter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -109,8 +123,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".circleci/config.yml"
 - ".gitignore"
-- ".travis.yml"
 - Gemfile
 - HISTORY
 - LICENSE
@@ -142,7 +156,7 @@ files:
 homepage: http://siftscience.com
 licenses: []
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -157,9 +171,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: sift
-rubygems_version: 2.4.6
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: Sift Science Ruby API Gem
 test_files:

data/.travis.yml

@@ -1,18 +0,0 @@
-language: ruby
-script: "bundle exec rake spec"
-rvm:
-  - 1.9.3
-  - 2.0.0
-  - 2.1.5
-  - 2.2.1
-before_install:
-  - gem install bundler
-  - bundle --version
-env:
-  # None for now
-gemfile:
-  - Gemfile
-services:
-  # None for now
-notifications:
-  # None for now