sift 1.1.5 → 1.1.6.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    OWIwOGNhOTBlNjNlZmZlOThiNTg2ODMwNjAzYjc2ZDJlZTUxMTc2Yw==
+    YzY5Mjg2YTQ4ZjRmYWRlOTQ4NTk4NzFmNjNiZjFmYmE3NTg3MDM2MQ==
   data.tar.gz: !binary |-
-    OWI1ZTAyZmFmNTUxYWRmM2NiZjYyZGQ0YjVmOWUzMTNiMDU5MzU0Nw==
-!binary "U0hBNTEy":
+    ZGIzOTAwOWE4OTExMWQ0MzlkYTRiYjk4OTQzNmU0NzQ5YWVkMzg3OQ==
+SHA512:
   metadata.gz: !binary |-
-    ZDE2ZjMxY2Q2MWY5MzgzYTE0MjVhZjY3OWFhMTQxZWUwMTE0NDY5ZjI3Njlm
-    Yzk1MjA4NmRhNWZmNWVkNDJhOWM1NDVhYWM2NzVlMWY3YTRhZWY0MDYwNjRj
-    N2Y3NzJlODgxZjc3ODNjZmU0Yzk3NmQxODQ3YmY3ZTQ2MWNkZjU=
+    NTM1ZTM3ZGU3ODI4ZmE5YzdiMTQ4ZWMxODUxZDhjZTAzZmZiYTAzMGZjMzZk
+    YzYxZjI5MDk1MjQ4ZWI1NDFhNWI1ODY2Y2MyYjk1MTI3YTA4ZjdmZjhjOTNl
+    NTc0ZGYzYzM5NmI0N2ZiM2JmMzgzMDg5M2ZhZWIwYjQwNWY1MGQ=
   data.tar.gz: !binary |-
-    Yzc4YmFhYzJjMWVjYTcyZmM2NGEzYzQ2NjUyMTY5YWEzZTY3NTU0YjZhYTNh
-    Y2UwZDU4MWNiYzRiNTk5NzExMDdiOTU0NDAwYjk5NmQ1MmZkZDg4MGFhN2U4
-    OWE1NmRiNDNhYjFlMTM5YjdjMjdlNGE1NjQzZTQ0ZjU1YzY4Yzg=
+    NzlhNGRiODU4M2UzNWQzZGRkM2U2OGM4MTk5MWVkZmE4ZjQ1YmJkYzcxZjI2
+    OWY1OGI5OWRjMzA4ODM1YWVkZGE4MGVhMzBhMjRkNDg3M2ZlMzNhY2M0YTQ4
+    OWJkNjkwN2EzNzIyOTRjMGNhOGNjNzIyMWYzNDdmN2Y3OWQ4ZTE=

data/README.rdoc

@@ -1,5 +1,17 @@
 = Sift Science Ruby bindings {<img src="https://travis-ci.org/SiftScience/sift-ruby.png?branch=master" alt="Build Status" />}[https://travis-ci.org/SiftScience/sift-ruby]
 
+== Requirements
+
+  * Ruby 1.8.7 or above. (Ruby 1.8.6 might work if you load ActiveSupport.)
+  * HTTParty, 0.11.0 or greater
+  * Multi Json, 1.0 or greater
+
+For development only:
+  * bundler
+  * rspec, 2.14.1 or greater
+  * webmock, 1.16 or greater
+  * rake, any version
+
 == Installation
 
 If you want to build the gem from source:
@@ -9,16 +21,49 @@ If you want to build the gem from source:
 Alternatively, you can install the gem from Rubyforge:
 
   $ gem install sift
+  
+== Usage
+  require "sift"
 
-== Requirements
+  Sift.api_key = '<your_api_key_here>'
+  client = Sift::Client.new()
+  
+  # send a transaction event -- note this is blocking 
+  event = "$transaction"
+  
+  user_id = "23056" # User ID's may only contain a-z, A-Z, 0-9, =, ., -, _, +, @, :, &, ^, %, !, $
 
-  * Ruby 1.8.7 or above. (Ruby 1.8.6 might work if you load ActiveSupport.)
-  * HTTParty, 0.8.3 or greater
+  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.http_status_code # HTTP response code, 200 is ok.
 
-For development only:
-  * bundler
-  * rspec, 2.9 or greater
-  * fakeweb, 1.3 or greater
+  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 forthe user with user_id 23056
+  response = client.score(user_id)
+  
+  # Label the user with user_id 23056 as Bad with all optional fields
+  response = client.label(user_id,{ "$is_bad" => true, "$reasons" => ["$chargeback", ], "$description" => "Chargeback issued", "$source" => "Manual Review", "$analyst" => "analyst.name@your_domain.com"})
 
 == Building
 

data/lib/sift.rb

@@ -5,12 +5,17 @@ module Sift
 
   # Returns the path for the current API version
   def self.current_rest_api_path
-    "/v203/events"
+    "/v#{API_VERSION}/events"
   end
 
   def self.current_users_label_api_path(user_id)
     # This API version is a minor version ahead of the /events API
-    "/v203/users/#{URI.encode(user_id)}/labels"
+    "/v#{API_VERSION}/users/#{URI.encode(user_id)}/labels"
+  end
+ 
+  # Adding module scoped public API key 
+  class << self
+    attr_accessor :api_key
   end
 
   # Sets the Output logger to use within the client. This can be left uninitializaed

data/lib/sift/client.rb

@@ -6,11 +6,11 @@ module Sift
   # Represents the payload returned from a call through the track API
   #
   class Response
-    attr_reader :json
+    attr_reader :body
     attr_reader :http_status_code
     attr_reader :api_status
     attr_reader :api_error_message
-    attr_reader :original_request
+    attr_reader :request
 
     # Constructor
     #
@@ -21,11 +21,11 @@ module Sift
     #   sections.
     #
     def initialize(http_response, http_response_code)
-      @json = MultiJson.load(http_response)
-      @original_request = MultiJson.load(@json["request"].to_s) if @json["request"]
+      @body = MultiJson.load(http_response)
+      @request = MultiJson.load(@body["request"].to_s) if @body["request"]
       @http_status_code = http_response_code
-      @api_status = @json["status"].to_i
-      @api_error_message = @json["error_message"].to_s
+      @api_status = @body["status"].to_i
+      @api_error_message = @body["error_message"].to_s
     end
 
     # Helper method returns true if and only if the response from the API call was
@@ -36,6 +36,19 @@ module Sift
     def ok?
       0 == @api_status.to_i
     end
+
+
+    # DEPRECIATED
+    # Getter method for depreciated 'json' member variable.
+    def json
+      @body
+    end
+
+    # DEPRECIATED
+    # Getter method for depreciated 'original_request' member variable.
+    def original_request
+      @request
+    end
   end
 
   # This class wraps accesses through the API
@@ -46,7 +59,6 @@ module Sift
 
     include HTTParty
     base_uri API_ENDPOINT
-    default_timeout API_TIMEOUT
 
     # Constructor
     #
@@ -57,10 +69,22 @@ module Sift
     # path
     #   The path to the event API, e.g., "/v201/events"
     #
-    def initialize(api_key, path = Sift.current_rest_api_path)
-      @api_key = api_key.to_s
+    def initialize(api_key = Sift.api_key, path = Sift.current_rest_api_path, timeout = API_TIMEOUT)
+      raise(RuntimeError, "api_key must be a non-empty string") if (!api_key.is_a? String) || api_key.empty?
+      raise(RuntimeError, "path must be a non-empty string") if (!path.is_a? String) || path.empty?
+      @api_key = api_key
       @path = path
-      raise(RuntimeError, "api_key is required") if @api_key.nil? || @api_key.empty?
+      @timeout = timeout
+
+      
+    end
+
+    def api_key
+      @api_key
+    end
+
+    def user_agent
+      "SiftScience/v#{API_VERSION} sift-ruby/#{VERSION}"
     end
 
     # Tracks an event and associated properties through the Sift Science API. This call
@@ -94,13 +118,17 @@ module Sift
     #   result, though.
     #
     def track(event, properties = {}, timeout = nil, path = nil, return_score = false)
-      raise(RuntimeError, "event must be a string") if event.nil? || event.to_s.empty?
+      raise(RuntimeError, "event must be a non-empty string") if (!event.is_a? String) || event.empty?
       raise(RuntimeError, "properties cannot be empty") if properties.empty?
       path ||= @path
-      path = path + "?return_score=#{return_score ? "true" : "false"}"
+      timeout ||= @timeout
+      if return_score
+        path = path + "?return_score=true"
+      end
       options = {
         :body => MultiJson.dump(delete_nils(properties).merge({"$type" => event,
-                                                               "$api_key" => @api_key}))
+                                                               "$api_key" => @api_key})),
+        :headers => {"User-Agent" => user_agent}
       }
       options.merge!(:timeout => timeout) unless timeout.nil?
       begin
@@ -125,11 +153,15 @@ module Sift
     #   A Response object is returned and captures the status message and
     #   status code. In general, you can ignore the returned result, though.
     #
-    def score(user_id)
+    def score(user_id, timeout = nil)
+
+      raise(RuntimeError, "user_id must be a non-empty string") if (!user_id.is_a? String) || user_id.to_s.empty?
+      timetout ||= @timeout
 
-      raise(RuntimeError, "user_id must be a string") if user_id.nil? || user_id.to_s.empty?
+      options = { :headers => {"User-Agent" => user_agent} }
+      options.merge!(:timeout => timeout) unless timeout.nil?
 
-      response = self.class.get("/v203/score/#{user_id}/?api_key=#{@api_key}")
+      response = self.class.get("/v#{API_VERSION}/score/#{user_id}/?api_key=#{@api_key}", options)
       Response.new(response.body, response.code)
 
     end
@@ -155,7 +187,7 @@ module Sift
     #
     def label(user_id, properties = {}, timeout = nil)
 
-      raise(RuntimeError, "user_id must be a string") if user_id.nil? || user_id.to_s.empty?
+      raise(RuntimeError, "user_id must be a non-empty string") if (!user_id.is_a? String) || user_id.to_s.empty?
 
       path = Sift.current_users_label_api_path(user_id)
       track("$label", delete_nils(properties), timeout, path)

data/lib/sift/version.rb

@@ -1,3 +1,4 @@
 module Sift
-  VERSION = "1.1.5"
+  VERSION = "1.1.6.0"
+  API_VERSION = "203"
 end

data/sift.gemspec

@@ -6,8 +6,8 @@ Gem::Specification.new do |s|
   s.name        = "sift"
   s.version     = Sift::VERSION
   s.platform    = Gem::Platform::RUBY
-  s.authors     = ["Fred Sadaghiani"]
-  s.email       = ["freds@siftscience.com"]
+  s.authors     = ["Fred Sadaghiani", "Yoav Schatzberg"]
+  s.email       = ["support@siftscience.com"]
   s.homepage    = "http://siftscience.com"
   s.summary     = %q{Sift Science Ruby API Gem}
   s.description = %q{Sift Science Ruby API. Please see http://siftscience.com for more details.}
@@ -20,13 +20,12 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   # Gems that must be intalled for sift to compile and build
-  s.add_development_dependency "rspec", "~> 2.14.1"
-  s.add_development_dependency "webmock", "~> 1.16.0"
+  s.add_development_dependency "rspec", ">=2.14.1"
+  s.add_development_dependency "webmock", ">= 1.16.0"
 
   # Gems that must be intalled for sift to work
   s.add_dependency "httparty", ">= 0.11.0"
-  s.add_dependency "multi_json", "~> 1.0"
+  s.add_dependency "multi_json", ">= 1.0"
 
-  s.add_development_dependency("rspec", ">= 2.0")
   s.add_development_dependency("rake")
 end

data/spec/unit/client_spec.rb

@@ -2,6 +2,10 @@ require File.expand_path(File.join(File.dirname(__FILE__), "..", "spec_helper"))
 
 describe Sift::Client do
 
+  before :each do
+    Sift.api_key = nil
+  end
+
   def valid_transaction_properties
     {
       :$buyer_user_id => "123456",
@@ -22,13 +26,53 @@ describe Sift::Client do
     }
   end
 
+  def score_response_json
+    {
+      :user_id => "247019",
+      :score => 0.93,
+      :reasons => [{
+                     :name => "UsersPerDevice",
+                     :value => 4,
+                     :details => {
+                     :users => "a, b, c, d"
+                     }
+                   }],
+      :status => 0,
+      :error_message => "OK"
+    }
+  end
+
   def fully_qualified_api_endpoint
     Sift::Client::API_ENDPOINT + Sift.current_rest_api_path
   end
 
-  it "Cannot instantiate client with nil or blank api key" do
+  it "Can instantiate client with blank api key if Sift.api_key set" do
+    Sift.api_key = "test_global_api_key"
+    Sift::Client.new().api_key.should eq(Sift.api_key)
+  end
+
+  it "Parameter passed api key takes precedence over Sift.api_key" do
+    Sift.api_key = "test_global_api_key"
+    api_key = "test_local_api_key"
+    Sift::Client.new(api_key).api_key.should eq(api_key)
+  end
+
+  it "Cannot instantiate client with nil, empty, non-string, or blank api key" do
     lambda { Sift::Client.new(nil) }.should raise_error
     lambda { Sift::Client.new("") }.should raise_error
+    lambda { Sift::Client.new(123456) }.should raise_error
+    lambda { Sift::Client.new() }.should raise_error
+  end
+
+  it "Cannot instantiate client with nil, empty, non-string, or blank path" do
+    api_key = "test_local_api_key"
+    lambda { Sift::Client.new(api_key, nil) }.should raise_error
+    lambda { Sift::Client.new(api_key, "") }.should raise_error
+    lambda { Sift::Client.new(api_key, 123456) }.should raise_error
+  end
+
+  it "Can instantiate client with non-default timeout" do
+    lambda { Sift::Client.new("test_local_api_key", Sift.current_rest_api_path, 4) }.should_not raise_error
   end
 
   it "Track call must specify an event name" do
@@ -126,31 +170,38 @@ describe Sift::Client do
   it "Successfully fetches a score" do
 
     api_key = "foobar"
-    user_id = "247019"
+    response_json = score_response_json
 
+    stub_request(:get, "https://api.siftscience.com/v203/score/247019/?api_key=foobar").
+      to_return(:status => 200, :body => MultiJson.dump(response_json), :headers => {})
+
+    response = Sift::Client.new(api_key).score(score_response_json[:user_id])
+    response.ok?.should eq(true)
+    response.api_status.should eq(0)
+    response.api_error_message.should eq("OK")
+
+    response.body["score"].should eq(0.93)
+  end
+
+  it "Successfuly make a sync score request" do
+
+    api_key = "foobar"
     response_json = {
-      :user_id => user_id,
-      :score => 0.93,
-      :reasons => [{
-                     :name => "UsersPerDevice",
-                     :value => 4,
-                     :details => {
-                       :users => "a, b, c, d"
-                     }
-                   }],
       :status => 0,
-      :error_message => "OK"
+      :error_message => "OK",
+      :score_response => score_response_json
     }
 
-    stub_request(:get, "https://api.siftscience.com/v203/score/247019/?api_key=foobar").
+    stub_request(:post, "https://api.siftscience.com/v203/events?return_score=true").
       to_return(:status => 200, :body => MultiJson.dump(response_json), :headers => {})
 
-    response = Sift::Client.new(api_key).score(user_id)
+    event = "$transaction"
+    properties = valid_transaction_properties
+    response = Sift::Client.new(api_key).track(event, properties, nil, nil, true)
     response.ok?.should eq(true)
     response.api_status.should eq(0)
     response.api_error_message.should eq("OK")
-
-    response.json["score"].should eq(0.93)
+    response.body["score_response"]["score"].should eq(0.93)
   end
 
 end

metadata

@@ -1,41 +1,42 @@
 --- !ruby/object:Gem::Specification
 name: sift
 version: !ruby/object:Gem::Version
-  version: 1.1.5
+  version: 1.1.6.0
 platform: ruby
 authors:
 - Fred Sadaghiani
+- Yoav Schatzberg
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-31 00:00:00.000000000 Z
+date: 2014-09-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 2.14.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 2.14.1
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 1.16.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 1.16.0
 - !ruby/object:Gem::Dependency
@@ -56,30 +57,16 @@ dependencies:
   name: multi_json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '1.0'
   type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '1.0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '2.0'
-  type: :development
-  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -96,7 +83,7 @@ dependencies:
         version: '0'
 description: Sift Science Ruby API. Please see http://siftscience.com for more details.
 email:
-- freds@siftscience.com
+- support@siftscience.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -137,7 +124,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: sift
-rubygems_version: 2.0.7
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Sift Science Ruby API Gem