sift 1.1.6.2 → 1.1.7.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MzdkOThmNmZiYWRmMDI3ODgyYjI4MjYyMjc2ZDg1YjhkOTdlNGU0MQ==
+    MWU0ZjhlZTFmYWZiOGQwMDY3NDIwNjFiZDgyYmQ5NDUxMDgzZTI3Ng==
   data.tar.gz: !binary |-
-    N2RiZGI4ZTFlZWI1YjBkNDQ1MDQyM2MxYTNmMDNlMzUxZjMyZDM1OA==
+    YTZlNjYwZmVjMzZiZGZiNTMwYTYzY2E4OTBlMDVhM2M1MzI0OTViZQ==
 SHA512:
   metadata.gz: !binary |-
-    M2YzZTYyZmJhMzBjMDVmZmJiNWM5N2ZmNmJmNjkzOTMzN2ExODIxMTIwOGRh
-    OTBmYThlZDA1ZDVmMDYzZTI4MjIxZDcxYTFjYjZhMzc0MzlkYjk1ZThhZTMy
-    YjhlNGUwMzEwOTI2MjhlNGI5ODYwZTJmYmRkNGI4YzlkM2IzYTE=
+    M2NlMzk3MzQ2ZTgwMGQ4MzU5NGM1NDgyOTBjZWFlZTJkNDljYTk4OTE4Y2Iz
+    NzBlODBjMmIyZWMzNjY0MzQ0Mzk4MzA3YmU2Y2ZmMTQwNzE5ZjFmZTVkYTNi
+    YTVjZjI2NjM5Y2Y2NWFiYzYyZjgxNTUxY2Y2NTM4ZThkYTQ4NmQ=
   data.tar.gz: !binary |-
-    NGVjMmZjYTJiOWI0NDA4N2Y5NjU3NGNkNDk1NTNjMDdhZGQ3NGZmNDEwNTYw
-    MTVmZGQ5ZDQ4NTY4ZmEyMTkwNjYwZDFhMTBmZDgwNDNiYWVjMWUyZWE0OTk1
-    NThlNTY5N2M2ZDAyZTBkMWI5Mjg4YzVhMmM2M2MyZDU5YjU1MDE=
+    MzQ0MmRhODAyZmJkNGU2ODdhZjdkNmYyMzIwZjZiYWZlYmE0OWJmODFlYWFk
+    MDFhODRlZjc1NzVlNDQzNzhlMzQ4MWM2NDI5MDE3NGQ0OGJlNTQ3MGVkZTc2
+    ZGY1ZDlkZTk4MjE2YTZjMWI0ZGJjNjEzNDY1Njc1OGJiMGMxODM=

data/HISTORY

@@ -1,3 +1,47 @@
+=== 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/lib/sift/client.rb

@@ -7,6 +7,7 @@ module Sift
   #
   class Response
     attr_reader :body
+    attr_reader :http_class
     attr_reader :http_status_code
     attr_reader :api_status
     attr_reader :api_error_message
@@ -20,12 +21,17 @@ module Sift
     #   a JSON object that can be decoded into status, message and request
     #   sections.
     #
-    def initialize(http_response, http_response_code)
-      @body = MultiJson.load(http_response)
-      @request = MultiJson.load(@body["request"].to_s) if @body["request"]
+    def initialize(http_response, http_headers, http_response_code, http_raw_response)
       @http_status_code = http_response_code
-      @api_status = @body["status"].to_i
-      @api_error_message = @body["error_message"].to_s
+      @http_raw_response = http_raw_response
+
+      # 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"].to_s if @body["error_message"]
+      end
     end
 
     # Helper method returns true if and only if the response from the API call was
@@ -34,7 +40,14 @@ module Sift
     # == Returns:
     #   true on success; false otherwise
     def ok?
-      0 == @api_status.to_i
+
+      if @http_raw_response.kind_of? Net::HTTPNoContent
+        #if there is no content expected, use HTTP code
+        204 == @http_status_code
+      else
+        # otherwise use API status
+        @http_raw_response.kind_of? Net::HTTPOK and 0 == @api_status.to_i
+      end
     end
 
 
@@ -70,8 +83,8 @@ module Sift
     #   The path to the event API, e.g., "/v201/events"
     #
     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?
+      raise("api_key must be a non-empty string") if !api_key.is_a?(String) || api_key.empty?
+      raise("path must be a non-empty string") if !path.is_a?(String) || path.empty?
       @api_key = api_key
       @path = path
       @timeout = timeout
@@ -118,9 +131,9 @@ module Sift
     #   result, though.
     #
     def track(event, properties = {}, timeout = nil, path = nil, return_score = false, api_key = @api_key)
-      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?
-      raise(RuntimeError, "Bad api_key parameter") if api_key.empty?
+      raise("event must be a non-empty string") if (!event.is_a? String) || event.empty?
+      raise("properties cannot be empty") if properties.empty?
+      raise("Bad api_key parameter") if api_key.empty?
       path ||= @path
       timeout ||= @timeout
       if return_score
@@ -134,7 +147,7 @@ module Sift
       options.merge!(:timeout => timeout) unless timeout.nil?
       begin
         response = self.class.post(path, options)
-        Response.new(response.body, response.code)
+        Response.new(response.body, response.headers, response.code, response.response)
       rescue StandardError => e
         Sift.warn("Failed to track event: " + e.to_s)
         Sift.warn(e.backtrace)
@@ -156,15 +169,15 @@ module Sift
     #
     def score(user_id, timeout = nil, api_key = @api_key)
 
-      raise(RuntimeError, "user_id must be a non-empty string") if (!user_id.is_a? String) || user_id.to_s.empty?
-      raise(RuntimeError, "Bad api_key parameter") if api_key.empty?
+      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?
       timetout ||= @timeout
 
       options = { :headers => {"User-Agent" => user_agent} }
       options.merge!(:timeout => timeout) unless timeout.nil?
 
       response = self.class.get("/v#{API_VERSION}/score/#{user_id}/?api_key=#{api_key}", options)
-      Response.new(response.body, response.code)
+      Response.new(response.body, response.headers, response.code, response.response)
 
     end
 
@@ -189,12 +202,38 @@ module Sift
     #
     def label(user_id, properties = {}, timeout = nil, api_key = @api_key)
 
-      raise(RuntimeError, "user_id must be a non-empty string") if (!user_id.is_a? String) || user_id.to_s.empty?
+      raise("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, false, api_key)
     end
 
+    # Unlabels a user.  This call is blocking.
+    #
+    # == Parameters:
+    # user_id
+    #   A user's id. This id should be the same as the user_id used in
+    #   event calls.
+    #
+    # timeout (optional)
+    #   The number of seconds to wait before failing the request. By default this is
+    #   configured to 2 seconds (see above). This parameter is optional.
+    #
+    # == Returns:
+    #   A Response object is returned with only an http code of 204.
+    #
+    def unlabel(user_id, timeout = nil)
+
+      raise("user_id must be a non-empty string") if (!user_id.is_a? String) || user_id.to_s.empty?
+      timetout ||= @timeout
+
+      options = { :headers => {"User-Agent" => user_agent} }
+      options.merge!(:timeout => timeout) unless timeout.nil?
+      path = Sift.current_users_label_api_path(user_id)
+      response = self.class.delete(path + "?api_key=#{@api_key}", options)
+      Response.new(response.body, response.headers, response.code, response.response)
+    end
+
     private
     def delete_nils(properties)
       properties.delete_if do |k, v|

data/lib/sift/version.rb

@@ -1,4 +1,4 @@
 module Sift
-  VERSION = "1.1.6.2"
+  VERSION = "1.1.7.0"
   API_VERSION = "203"
 end

data/spec/unit/client_label_spec.rb

@@ -21,15 +21,29 @@ describe Sift::Client do
 
     stub_request(:post, "https://api.siftscience.com/v203/users/frodo_baggins/labels").
       with(:body => '{"$reasons":["$fake"],"$is_bad":true,"$description":"Listed a fake item","$type":"$label","$api_key":"foobar"}').
-      to_return(:body => MultiJson.dump(response_json), :status => 200, :content_type => "text/json")
+      to_return(:body => MultiJson.dump(response_json), :status => 200, :headers => 
+        {"content-type"=>"application/json; charset=UTF-8","content-length"=> "74"})
 
     api_key = "foobar"
     properties = valid_label_properties
 
     response = Sift::Client.new(api_key).label(user_id, properties)
-    response.ok?.should eq(true)
-    response.api_status.should eq(0)
-    response.api_error_message.should eq("OK")
+    expect(response.ok?).to eq(true)
+    expect(response.api_status).to eq(0)
+    expect(response.api_error_message).to eq("OK")
+  end
+
+  it "Successfully handles an $unlabel with the v203 API endpoing and returns OK" do
+    response_json = { :status => 0, :error_message => "OK" }
+    user_id = "frodo_baggins"
+
+    stub_request(:delete, "https://api.siftscience.com/v203/users/frodo_baggins/labels?api_key=foobar").
+      to_return(:status => 204)
+
+    api_key = "foobar"
+
+    response = Sift::Client.new(api_key).unlabel(user_id)
+    expect(response.ok?).to eq(true)
   end
 
 end

data/spec/unit/client_spec.rb

@@ -48,51 +48,51 @@ describe Sift::Client 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)
+    expect(Sift::Client.new().api_key).to 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)
+    expect(Sift::Client.new(api_key).api_key).to 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
+    expect(lambda { Sift::Client.new(nil) }).to raise_error
+    expect(lambda { Sift::Client.new("") }).to raise_error
+    expect(lambda { Sift::Client.new(123456) }).to raise_error
+    expect(lambda { Sift::Client.new() }).to 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
+    expect(lambda { Sift::Client.new(api_key, nil) }).to raise_error
+    expect(lambda { Sift::Client.new(api_key, "") }).to raise_error
+    expect(lambda { Sift::Client.new(api_key, 123456) }).to 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
+    expect(lambda { Sift::Client.new("test_local_api_key", Sift.current_rest_api_path, 4) }).not_to raise_error
   end
 
   it "Track call must specify an event name" do
-    lambda { Sift::Client.new("foo").track(nil) }.should raise_error
-    lambda { Sift::Client.new("foo").track("") }.should raise_error
+    expect(lambda { Sift::Client.new("foo").track(nil) }).to raise_error
+    expect(lambda { Sift::Client.new("foo").track("") }).to raise_error
   end
 
   it "Must specify an event name" do
-    lambda { Sift::Client.new("foo").track(nil) }.should raise_error
-    lambda { Sift::Client.new("foo").track("") }.should raise_error
+    expect(lambda { Sift::Client.new("foo").track(nil) }).to raise_error
+    expect(lambda { Sift::Client.new("foo").track("") }).to raise_error
   end
 
   it "Must specify properties" do
     event = "custom_event_name"
-    lambda { Sift::Client.new("foo").track(event) }.should raise_error
+    expect(lambda { Sift::Client.new("foo").track(event) }).to raise_error
   end
 
   it "Score call must specify a user_id" do
-    lambda { Sift::Client.new("foo").score(nil) }.should raise_error
-    lambda { Sift::Client.new("foo").score("") }.should raise_error
+    expect(lambda { Sift::Client.new("foo").score(nil) }).to raise_error
+    expect(lambda { Sift::Client.new("foo").score("") }).to raise_error
   end
 
   it "Doesn't raise an exception on Net/HTTP errors" do
@@ -105,7 +105,7 @@ describe Sift::Client do
 
     # This method should just return nil -- the track call failed because
     # of an HTTP error
-    Sift::Client.new(api_key).track(event, properties).should eq(nil)
+    expect(Sift::Client.new(api_key).track(event, properties)).to eq(nil)
   end
 
   it "Returns nil when a StandardError occurs within the request" do
@@ -118,7 +118,7 @@ describe Sift::Client do
 
     # This method should just return nil -- the track call failed because
     # a StandardError exception was thrown
-    Sift::Client.new(api_key).track(event, properties).should eq(nil)
+    expect(Sift::Client.new(api_key).track(event, properties)).to eq(nil)
   end
 
   it "Successfuly handles an event and returns OK" do
@@ -128,17 +128,17 @@ describe Sift::Client do
     stub_request(:post, "https://api.siftscience.com/v203/events").
       with { |request|
         parsed_body = JSON.parse(request.body)
-        parsed_body.should include("$buyer_user_id" => "123456")
-      }.to_return(:status => 200, :body => MultiJson.dump(response_json), :headers => {})
+        expect(parsed_body).to include("$buyer_user_id" => "123456")
+      }.to_return(:status => 200, :body => MultiJson.dump(response_json), :headers => {"content-type"=>"application/json; charset=UTF-8","content-length"=> "74"})
 
     api_key = "foobar"
     event = "$transaction"
     properties = valid_transaction_properties
 
     response = Sift::Client.new(api_key).track(event, properties)
-    response.ok?.should eq(true)
-    response.api_status.should eq(0)
-    response.api_error_message.should eq("OK")
+    expect(response.ok?).to eq(true)
+    expect(response.api_status).to eq(0)
+    expect(response.api_error_message).to eq("OK")
   end
 
   it "Successfully submits event with overriden key" do
@@ -146,8 +146,8 @@ describe Sift::Client do
     stub_request(:post, "https://api.siftscience.com/v203/events").
       with { | request|
         parsed_body = JSON.parse(request.body)
-        parsed_body.should include("$buyer_user_id" => "123456")
-        parsed_body.should include("$api_key" => "overridden")
+        expect(parsed_body).to include("$buyer_user_id" => "123456")
+        expect(parsed_body).to include("$api_key" => "overridden")
       }.to_return(:status => 200, :body => MultiJson.dump(response_json), :headers => {})
 
     api_key = "foobar"
@@ -155,9 +155,9 @@ describe Sift::Client do
     properties = valid_transaction_properties
 
     response = Sift::Client.new(api_key).track(event, properties, nil, nil, false, "overridden")
-    response.ok?.should eq(true)
-    response.api_status.should eq(0)
-    response.api_error_message.should eq("OK")
+    expect(response.ok?).to eq(true)
+    expect(response.api_status).to eq(0)
+    expect(response.api_error_message).to eq("OK")
   end
 
   it "Successfuly scrubs nils" do
@@ -167,9 +167,9 @@ describe Sift::Client do
     stub_request(:post, "https://api.siftscience.com/v203/events").
       with { |request|
         parsed_body = JSON.parse(request.body)
-        parsed_body.should_not include("fake_property")
-        parsed_body.should include("sub_object" => {"one" => "two"})
-      }.to_return(:status => 200, :body => MultiJson.dump(response_json), :headers => {})
+        expect(parsed_body).not_to include("fake_property")
+        expect(parsed_body).to include("sub_object" => {"one" => "two"})
+      }.to_return(:status => 200, :body => MultiJson.dump(response_json), :headers => {"content-type"=>"application/json; charset=UTF-8","content-length"=> "74"})
 
     api_key = "foobar"
     event = "$transaction"
@@ -181,9 +181,9 @@ describe Sift::Client do
       }
     )
     response = Sift::Client.new(api_key).track(event, properties)
-    response.ok?.should eq(true)
-    response.api_status.should eq(0)
-    response.api_error_message.should eq("OK")
+    expect(response.ok?).to eq(true)
+    expect(response.api_status).to eq(0)
+    expect(response.api_error_message).to eq("OK")
   end
 
   it "Successfully fetches a score" do
@@ -192,14 +192,14 @@ describe Sift::Client do
     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 => {})
+      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).score(score_response_json[:user_id])
-    response.ok?.should eq(true)
-    response.api_status.should eq(0)
-    response.api_error_message.should eq("OK")
+    expect(response.ok?).to eq(true)
+    expect(response.api_status).to eq(0)
+    expect(response.api_error_message).to eq("OK")
 
-    response.body["score"].should eq(0.93)
+    expect(response.body["score"]).to eq(0.93)
   end
 
   it "Successfully fetches a score with an overridden key" do
@@ -211,11 +211,11 @@ describe Sift::Client do
       to_return(:status => 200, :body => MultiJson.dump(response_json), :headers => {})
 
     response = Sift::Client.new(api_key).score(score_response_json[:user_id], nil, "overridden")
-    response.ok?.should eq(true)
-    response.api_status.should eq(0)
-    response.api_error_message.should eq("OK")
+    expect(response.ok?).to eq(true)
+    expect(response.api_status).to eq(0)
+    expect(response.api_error_message).to eq("OK")
 
-    response.body["score"].should eq(0.93)
+    expect(response.body["score"]).to eq(0.93)
   end
 
 
@@ -229,15 +229,15 @@ describe Sift::Client do
     }
 
     stub_request(:post, "https://api.siftscience.com/v203/events?return_score=true").
-      to_return(:status => 200, :body => MultiJson.dump(response_json), :headers => {})
+      to_return(:status => 200, :body => MultiJson.dump(response_json), :headers => {"content-type"=>"application/json; charset=UTF-8","content-length"=> "74"})
 
     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.body["score_response"]["score"].should eq(0.93)
+    expect(response.ok?).to eq(true)
+    expect(response.api_status).to eq(0)
+    expect(response.api_error_message).to eq("OK")
+    expect(response.body["score_response"]["score"]).to eq(0.93)
   end
 
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sift
 version: !ruby/object:Gem::Version
-  version: 1.1.6.2
+  version: 1.1.7.0
 platform: ruby
 authors:
 - Fred Sadaghiani
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-19 00:00:00.000000000 Z
+date: 2015-02-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -124,7 +124,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: sift
-rubygems_version: 2.1.11
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Sift Science Ruby API Gem