Merge pull request #56 from SiftScience/kkarpierz_v205_ruby

(Gary L.) Added Content Decisions to library, incremented version to V205

Author: admiral-akk

HISTORY

@@ -1,3 +1,9 @@
+=== 3.0.0.0 2018-03-05
+* adds support for v205 of Sift Science's APIs
+* v205 APIs are now called by default -- this is an incompatible change
+  (use :version => 204 to call the previous API version)
+* Add content level decisions in Apply Decisions APIs.
+
 === 2.2.1.0 2018-02-12
 * Add session level decisions in Apply Decisions APIs.
 

README.md

@@ -140,7 +140,7 @@ response = client.apply_decision({
   user_id: "[email protected]"
 })
 
-# 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 +149,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 +158,16 @@ response = client.apply_decision({
   session_id: "SESSION_ID_1234"
 })
 
+# apply decision to "[email protected]"'s content
+response = client.apply_decision({
+  decision_id: "block_bad_session",
+  source: "manual_review",
+  analyst: "bob@your_company.com",
+  user_id: "[email protected]",
+  content_id: "CONTENT_ID_1234"
+})
+
+
 # Make sure you handle the response after applying a decision:
 
 if response.ok?
@@ -196,6 +206,9 @@ 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 an content
+response = client.get_content_decisions('example_user_id', 'example_order_id')
 ```
 
 ## Response Object

lib/sift.rb

@@ -33,6 +33,11 @@ def self.order_decisions_api_path(account_id, order_id)
     "/v3/accounts/#{account_id}/orders/#{order_id}/decisions"
   end
 
+  # Returns the path for Content Decisions API
+  def self.content_decisions_api_path(account_id, user_id, content_id)
+    "/v3/accounts/#{account_id}/users/#{user_id}/content/#{content_id}/decisions"
+  end
+
   # Module-scoped public API key
   class << self
     attr_accessor :api_key

lib/sift/client.rb

@@ -118,7 +118,7 @@ def self.user_agent
     #
     #   :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 +132,7 @@ def initialize(opts = {})
       @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
 
@@ -504,6 +504,47 @@ def get_order_decisions(order_id, opts = {})
       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

lib/sift/client/decision/apply_to.rb

@@ -15,6 +15,7 @@ class ApplyTo
           description
           order_id
           session_id
+          content_id
           user_id
           account_id
           time
@@ -93,11 +94,17 @@ 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

lib/sift/validate/decision.rb

@@ -20,6 +20,12 @@ def valid_session?
           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

lib/sift/version.rb

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

spec/unit/client_label_spec.rb

@@ -25,7 +25,7 @@ def valid_label_properties_203
     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 @@ def valid_label_properties_203
     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"

spec/unit/client_spec.rb

@@ -169,7 +169,7 @@ def fully_qualified_api_endpoint
   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 +190,7 @@ def fully_qualified_api_endpoint
 
   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 +212,7 @@ def fully_qualified_api_endpoint
   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 +241,7 @@ def fully_qualified_api_endpoint
     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 +259,7 @@ def fully_qualified_api_endpoint
     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)
@@ -280,7 +280,7 @@ def fully_qualified_api_endpoint
       :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 +304,7 @@ def fully_qualified_api_endpoint
       :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 +332,7 @@ def fully_qualified_api_endpoint
     }
 
     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&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"})
@@ -390,4 +390,18 @@ def fully_qualified_api_endpoint
     expect(response.body["decisions"]["payment_abuse"]["decision"]["id"]).to eq("decision7")
   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