sift 1.1.0 → 4.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 57a679adbe12a556895633060cde177cf89fcb06
+  data.tar.gz: d3eff77b83c2ba5696c4c391f82d592a8df7443a
+SHA512:
+  metadata.gz: 5809b998556c975ff30faceacf5468a812e815dead3e836640343fe681c1d612192a9a26615f8a0c35c4c13a3cb9b232f3aff1bbf7649d6b3e6c8250cd7f2896
+  data.tar.gz: 8b941c79e41784d1452f8ae4fe8b1052f7f32ed3954f8afb16b16f3e7346a0bf6e5cfc71f6080c6475ff75a0fce78172a58e4f8ece8f73ab47385ffd57d3001a

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,91 @@
+=== 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.
+
+=== 2.0.0.0 2016-07-19
+* adds support for v204 of Sift Science's APIs
+* adds Workflow Status API, User Decisions API, Order Decisions API
+* v204 APIs are now called by default -- this is an incompatible change
+  (use :version => 203 to call the previous API version)
+* uses Hash arg for optional params in Client methods -- incompatible change
+
+=== 1.1.7.2 2015-04-13
+* Fixed backwards compatibility issue
+
+=== 1.1.7.0 2015-02-24
+* Added Unlabel functionality
+
+=== 1.1.6.2 2014-09-19
+* added API key parameter to track and label functions
+
+=== 1.1.6.0 2014-09-03
+* added module scoped API key variable
+
+=== 1.1.4 2014-01-02
+* removed support for ruby 1.9.2
+* track/label return nil on failure
+
+=== 1.1.3 2013-12-10
+* nil values are removed from JSON body sent to track/label now.
+* relaxed multi_json requirement to 1.0 or newer
+* relaxed httparty requirement to 0.11.0 or newer
+* migrated from fakeweb to webmock 1.16.0 or newer
+
+=== 1.1.1 2013-11-14
+* score request now requires API key
+
+=== 1.1.0 2013-11-08
+* now uses v203 API endpoint by default
+
+=== 1.0.13 2014-10-22
+* added path parameter to track function
+* added label function for applying labels
+* now requires httparty 0.12.0 or newer
+* now requires multi_json 1.8.2 or newer
+* now requires rspec 2.14.1 or newer for compilation only
+
+=== 1.0.12 2013-06-13
+* added score function for getting user scores.
+* now requires httparty 0.10.0 or newer
+* added rspec 2.0 or newer and rake dependency
+
+=== 1.0.10 2013-01-09
+* Add configurable path variable to Client
+
+=== 1.0.5 2012-07-20
+
+=== 1.0.3 2012-05-05
+
+=== 1.0.2 2012-05-03
+
+=== 1.0.1 2012-05-02
 
 === 1.0 2012-05-02
   * Initial release

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2013 Sift Science
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,253 @@
+# Sift Ruby bindings
+
+[![CircleCI](https://circleci.com/gh/SiftScience/sift-ruby.svg?style=svg)](https://circleci.com/gh/SiftScience/sift-ruby)
+
+## Requirements
+
+  * Ruby 2.0.0 or above.
+
+
+## Installation
+
+If you want to build the gem from source:
+
+```
+$ gem build sift.gemspec
+```
+
+Alternatively, you can install the gem from rubygems.org:
+
+```
+gem install sift
+```
+
+## Usage
+
+### Creating a Client:
+
+```ruby
+require "sift"
+
+Sift.api_key = '<your_api_key_here>'
+Sift.account_id = '<your_account_id_here>'
+client = Sift::Client.new()
+
+##### OR
+
+client = Sift::Client.new(api_key: '<your_api_key_here>', account_id: '<your_account_id_here>')
+
+```
+
+### Sending a transaction event
+
+```ruby
+event = "$transaction"
+
+user_id = "23056"  # User ID's may only contain a-z, A-Z, 0-9, =, ., -, _, +, @, :, &, ^, %, !, $
+
+properties = {
+ "$user_id" => user_id,
+  "$user_email" => "buyer@gmail.com",
+  "$seller_user_id" => "2371",
+  "seller_user_email" => "seller@gmail.com",
+  "$transaction_id" => "573050",
+  "$payment_method" => {
+    "$payment_type"    => "$credit_card",
+    "$payment_gateway" => "$braintree",
+    "$card_bin"        => "542486",
+    "$card_last4"      => "4444"
+  },
+  "$currency_code" => "USD",
+  "$amount" => 15230000,
+}
+
+response = client.track(event, properties)
+
+response.ok?  # returns true or false
+response.body  # API response body
+response.http_status_code  # HTTP response code, 200 is ok.
+response.api_status  # status field in the return body, Link to Error Codes
+response.api_error_message  # Error message associated with status Error Code
+
+# Request a score for the user with user_id 23056
+response = client.score(user_id)
+```
+
+## 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` or `:content`
+ - `abuse_types`: `["payment_abuse", "content_abuse", "content_abuse",
+   "account_abuse", "legacy", "account_takeover"]`
+
+**Returns**
+
+A `Response` object
+
+**Example:**
+```ruby
+# fetch a list of all your decisions
+response = client.decisions({
+  entity_type: :user,
+  abuse_types: ["payment_abuse", "content_abuse"]
+})
+
+# Check that response is okay.
+unless response.ok?
+  raise "Unable to fetch decisions #{response.api_error_message} " +
+    "#{response.api_error_description}"
+end
+
+# find a decisions with the id "block_bad_user"
+user_decision = response.body["data"].find do |decision|
+  decision["id"] == "block_bad_user"
+end
+
+# Get the next page
+
+if response.body["has_more"]
+  client.decisions(response.body)
+end
+```
+
+
+### Apply a decision
+
+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`
+
+**Other Params**
+- `order_id`: when applying a decision to an order, you must pass in the `order_id`
+- `session_id`: when applying a decision to a session, you must pass in the `session_id`
+- `analyst`: when `source` is set to `manual_review`, this field *is required*
+
+**Returns**
+`Response` object.
+
+**Examples:**
+```ruby
+# apply decision to a user
+response = client.apply_decision({
+  decision_id: "block_bad_user",
+  source: "manual_review",
+  analyst: "bob@your_company.com",
+  user_id: "john@example.com"
+})
+
+# apply decision to "john@example.com"'s order
+response = client.apply_decision({
+  decision_id: "block_bad_order",
+  source: "manual_review",
+  analyst: "bob@your_company.com",
+  user_id: "john@example.com",
+  order_id: "ORDER_1234"
+})
+
+# apply decision to "john@example.com"'s session
+response = client.apply_decision({
+  decision_id: "block_bad_session",
+  source: "manual_review",
+  analyst: "bob@your_company.com",
+  user_id: "john@example.com",
+  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?
+  # do stuff
+else
+  # Error message
+  response.api_error_message
+
+  # Summary of the error
+  response.api_error_description
+
+  # hash of errors:
+  #  key: field in question
+  #  value: description of the issue
+  response.api_error_issues
+end
+```
+
+## Sending a Label
+
+```ruby
+# Label the user with user_id 23056 as Bad with all optional fields
+response = client.label(user_id, {
+  "$is_bad" => true,
+  "$abuse_type" => "payment_abuse",
+  "$description" => "Chargeback issued",
+  "$source" => "Manual Review",
+  "$analyst" => "analyst.name@your_domain.com"
+})
+
+# Get the status of a workflow run
+response = client.get_workflow_status('my_run_id')
+
+# Get the latest decisions for a user
+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
+
+All requests to our apis will return a `Response` instance.
+
+### Public Methods:
+- `ok?` returns `true` when the response is a `200`-`299`, `false` if it isn't
+- `body` returns a hash representation of the json body returned.
+- `api_error_message` returns a string describing the api error code.
+- `api_error_description` a summary of the error that occured.
+- `api_error_issues` a hash describing the items the error occured. The `key` is the item and the `value` is the description of the error.
+
+
+## Building
+
+Building and publishing the gem is captured by the following steps:
+
+```ruby
+$ gem build sift.gemspec
+$ gem push sift-<current version>.gem
+
+$ bundle
+$ rake -T
+$ rake build
+$ rake install
+$ rake release
+```
+
+
+## Testing
+
+To run the various tests use the rake command as follows:
+
+```ruby
+$ rake spec
+```

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

@@ -0,0 +1,129 @@
+require "multi_json"
+
+require_relative "../../validate/decision"
+require_relative "../../client"
+require_relative "../../router"
+require_relative "../../utils/hash_getter"
+
+module Sift
+  class Client
+    class Decision
+      class ApplyTo
+        PROPERTIES = %w{
+          source
+          analyst
+          description
+          order_id
+          session_id
+          content_id
+          user_id
+          account_id
+          time
+        }
+
+        attr_reader :decision_id, :configs, :getter, :api_key
+
+        PROPERTIES.each do |attribute|
+          class_eval %{
+            def #{attribute}
+              getter.get(:#{attribute})
+            end
+          }
+        end
+
+        def initialize(api_key, decision_id, configs)
+          @api_key = api_key
+          @decision_id = decision_id
+          @configs = configs
+          @getter = Utils::HashGetter.new(configs)
+        end
+
+        def run
+          if errors.empty?
+            send_request
+          else
+            Response.new(
+              MultiJson.dump({
+                status: 55,
+                error_message: errors.join(", ")
+              }),
+              400,
+              nil
+            )
+          end
+        end
+
+        private
+
+        def send_request
+          Router.post(path, {
+            body: request_body,
+            headers: headers
+          })
+        end
+
+        def request_body
+          {
+            source: source,
+            description: description,
+            analyst: analyst,
+            decision_id: decision_id,
+            time: time
+          }
+        end
+
+        def errors
+          validator = Validate::Decision.new(configs)
+
+          if applying_to_order?
+            validator.valid_order?
+          elsif applying_to_session?
+            validator.valid_session?
+          else
+            validator.valid_user?
+          end
+
+          validator.error_messages
+        end
+
+        def applying_to_order?
+          configs.has_key?("order_id") || configs.has_key?(:order_id)
+        end
+
+        def applying_to_session?
+          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
+        end
+
+        def user_path
+          "#{base_path}/users/#{CGI.escape(user_id)}"
+        end
+
+        def base_path
+          "#{Client::API3_ENDPOINT}/v3/accounts/#{account_id}"
+        end
+
+        def headers
+          {
+            "Content-type" => "application/json"
+          }.merge(Client.build_auth_header(api_key))
+        end
+      end
+    end
+  end
+end

data/lib/sift/client/decision.rb

@@ -0,0 +1,66 @@
+require "cgi"
+
+require_relative "../router"
+require_relative "../validate/decision"
+require_relative "../utils/hash_getter"
+require_relative "./decision/apply_to"
+
+module Sift
+  class Client
+    class Decision
+      FILTER_PARAMS = %w{ limit entity_type abuse_types from }
+
+      attr_reader :account_id, :api_key
+
+      def initialize(api_key, account_id)
+        @account_id = account_id
+        @api_key = api_key
+      end
+
+      def list(options = {})
+        getter = Utils::HashGetter.new(options)
+
+        if path = getter.get(:next_ref)
+          request_next_page(path)
+        else
+          Router.get(index_path, {
+            query: build_query(getter),
+            headers: auth_header
+          })
+        end
+      end
+
+      def build_query(getter)
+        FILTER_PARAMS.inject({}) do |result, filter|
+          if value = getter.get(filter)
+            result[filter] = value.is_a?(Array) ? value.join(",") : value
+          end
+
+          result
+        end
+      end
+
+      def apply_to(configs = {})
+        getter = Utils::HashGetter.new(configs)
+        configs[:account_id] = account_id
+
+        ApplyTo.new(api_key, getter.get(:decision_id), configs).run
+      end
+
+      def index_path
+        "#{Client::API3_ENDPOINT}/v3/accounts/#{account_id}/decisions"
+      end
+
+      private
+
+      def request_next_page(path)
+        Router.get(path, headers: auth_header)
+      end
+
+      def auth_header
+        Client.build_auth_header(api_key)
+      end
+    end
+  end
+end
+