sift 2.0.0.0 → 2.1.0.0

data/spec/unit/client_203_spec.rb

@@ -1,4 +1,5 @@
-require File.expand_path(File.join(File.dirname(__FILE__), "..", "spec_helper"))
+require_relative "../spec_helper"
+require "sift"
 
 describe Sift::Client do
 

data/spec/unit/client_label_spec.rb

@@ -1,4 +1,5 @@
-require File.expand_path(File.join(File.dirname(__FILE__), "..", "spec_helper"))
+require_relative "../spec_helper"
+require "sift"
 
 describe Sift::Client do
 
@@ -41,7 +42,6 @@ describe Sift::Client do
 
 
   it "Successfully handles an $unlabel and returns OK" do
-    response_json = { :status => 0, :error_message => "OK" }
     user_id = "frodo_baggins"
 
     stub_request(:delete,
@@ -77,7 +77,6 @@ describe Sift::Client do
 
 
   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,

data/spec/unit/client_spec.rb

@@ -1,4 +1,5 @@
-require File.expand_path(File.join(File.dirname(__FILE__), "..", "spec_helper"))
+require_relative "../spec_helper"
+require "sift"
 
 describe Sift::Client do
 
@@ -104,7 +105,6 @@ describe Sift::Client do
 
 
   it "Cannot instantiate client with empty, non-string, or blank path" do
-    api_key = "test_local_api_key"
     expect(lambda { Sift::Client.new(:path => "") }).to raise_error(StandardError)
     expect(lambda { Sift::Client.new(:path => 123456) }).to raise_error(StandardError)
   end
@@ -373,7 +373,7 @@ describe Sift::Client do
     response = client.get_user_decisions("example_user")
 
     expect(response.ok?).to eq(true)
-    expect(response.body["decisions"]["content_abuse"]["decision"]["id"]).to eq("user_decision")    
+    expect(response.body["decisions"]["content_abuse"]["decision"]["id"]).to eq("user_decision")
   end
 
 

data/spec/unit/router_spec.rb

@@ -0,0 +1,37 @@
+require_relative "../spec_helper"
+
+require "sift/router"
+
+module Sift
+  describe Router do
+    let(:path) { "https://example.com" }
+    let(:body) { { question: "Do you wanna go ball?" } }
+
+    describe ".get" do
+      it "with a successful request will return a response object" do
+        stub_request(:get, path)
+          .with(body: MultiJson.dump(body))
+          .to_return(body: MultiJson.dump({ cool: true }))
+
+        response = Router.get(path, { body: body })
+
+        expect(response.ok?).to be(true)
+        expect(response.body["cool"]).to be(true)
+      end
+
+      it "with an unsuccessful request will return a response object" do
+        stub_request(:get, path)
+          .with(body: MultiJson.dump(body))
+          .to_return(body: MultiJson.dump({ cool: false}), status: 403)
+
+        response = Router.get(path, { body: body })
+
+        expect(response.ok?).to be(false)
+        expect(response.body["cool"]).to be(false)
+      end
+
+    end
+  end
+end
+
+

data/spec/unit/validate/decision_spec.rb

@@ -0,0 +1,85 @@
+require_relative "../../spec_helper"
+
+require "sift/validate/decision"
+
+module Sift
+  module Validate
+    describe Decision do
+      describe "#valid_user?" do
+        it "will return true" do
+          validator = Decision.new(
+            user_id: "hello world",
+            source: :hello_world,
+            analyst: "asdfsadf@heyo.com"
+          )
+
+          expect(validator.valid_user?).to be(true)
+        end
+
+        it "with invalid user_id, will return false" do
+          validator = Decision.new(order_id: "asfasdf")
+          expect(validator.valid_user?).to be(false), "nil user is valid"
+
+          validator = Decision.new(order_id: "asfasdf", user_id: {})
+          expect(validator.valid_user?).to be(false), "user hash is valid"
+
+          validator = Decision.new(order_id: "asfasdf", user_id: /werwer/)
+          expect(validator.valid_user?).to be(false), "regex user is valid"
+        end
+      end
+
+      describe "#valid_order?" do
+        it "will return true with valid configs" do
+          validator = Decision.new(
+            order_id: "order_foo_bar_12354",
+            user_id: "hello world",
+            source: :hello_world,
+            analyst: "asdfsadf@heyo.com"
+          )
+
+          expect(validator.valid_order?).to be(true)
+        end
+
+        context "with invalid params:" do
+          it "user_id, will return false" do
+            validator = Decision.new(order_id: "asfasdf")
+            expect(validator.valid_order?).to be(false), "nil user is valid"
+
+            validator = Decision.new(order_id: "asfasdf", user_id: {})
+            expect(validator.valid_order?).to be(false), "user hash is valid"
+
+            validator = Decision.new(order_id: "asfasdf", user_id: /werwer/)
+            expect(validator.valid_order?).to be(false), "regex user is valid"
+          end
+
+          it "order_id, will return false" do
+            validator = Decision.new(user_id: 1235)
+            expect(validator.valid_order?).to be(false)
+
+            validator = Decision.new(user_id: 1235, order_id: {})
+            expect(validator.valid_order?).to be(false)
+
+            validator = Decision.new(user_id: 1235, order_id: /23424/)
+            expect(validator.valid_order?).to be(false)
+          end
+        end
+      end
+
+      describe "#error_messages" do
+        it "will return an array of error messages" do
+          validator = Decision.new
+
+          error_message =
+            "#{Primitive::ERROR_MESSAGES[:non_empty_string]}, got NilClass"
+
+          validator.valid_order?
+
+          expect(validator.error_messages).to contain_exactly(
+            "order_id #{error_message}",
+            "user_id #{error_message}"
+          )
+        end
+      end
+    end
+  end
+end

data/spec/unit/validate/primitive_spec.rb

@@ -0,0 +1,73 @@
+require_relative "../../spec_helper"
+
+require "sift/validate/primitive"
+
+module Sift
+  module Validate
+    describe Primitive do
+      describe ".non_empty_string" do
+        it "will return nil for valid values" do
+          expect(Primitive.non_empty_string("foobar")).to be_nil
+        end
+
+        it "will return an error message" do
+          [nil, 1, /asdfasdf/].each do |value|
+            error_message = "#{Primitive::ERROR_MESSAGES[:non_empty_string]}" \
+                            ", got #{value.class}"
+
+            expect(Primitive.non_empty_string(value)).to eq(error_message)
+          end
+
+          expect(Primitive.non_empty_string("")).to(
+            eq(Primitive.send(:empty_string_message, :non_empty_string))
+          )
+        end
+      end
+
+      describe ".is_numeric" do
+        it "will return nil for numeric values" do
+          [1, 29.01, 29 ** 1992848499198, -2].each do |value|
+            expect(Primitive.numeric(value)).to(
+              be_nil,
+              "#{value} is a non numeric value"
+            )
+          end
+        end
+
+        it "will return an error message for non numeric values" do
+          ["foobar", nil, :hello_world, {}].each do |value|
+            expect(Primitive.numeric(value)).to(
+              be(Primitive::ERROR_MESSAGES[:numeric]),
+              "#{value} is a numeric value"
+            )
+          end
+        end
+      end
+
+      describe ".is_string_or_number?" do
+        it "will return nil for numeric or strings" do
+          [1234, "asdfasdf", "1234_asdfsdf"].each do |value|
+            expect(Primitive.string_or_number(value)).to(
+              be_nil,
+              "#{value} is a non numeric value"
+            )
+          end
+        end
+
+        it "will return an error message for any other type" do
+          [{}, [], :hello_world, nil].each do |value|
+            error_message = "#{Primitive::ERROR_MESSAGES[:string_or_number]}," \
+                            " got #{value.class}"
+
+            expect(Primitive.string_or_number(value)).to eq(error_message)
+          end
+
+          error_message = "#{Primitive::ERROR_MESSAGES[:string_or_number]}, " \
+                          "got an empty string"
+          expect(Primitive.string_or_number("")).to eq(error_message)
+        end
+      end
+    end
+  end
+end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sift
 version: !ruby/object:Gem::Version
-  version: 2.0.0.0
+  version: 2.1.0.0
 platform: ruby
 authors:
 - Fred Sadaghiani
@@ -10,22 +10,36 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-19 00:00:00.000000000 Z
+date: 2017-01-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.14.1
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.14.1
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
@@ -100,19 +114,31 @@ files:
 - Gemfile
 - HISTORY
 - LICENSE
-- README.rdoc
+- README.md
 - Rakefile
 - examples/simple.rb
 - lib/sift.rb
 - lib/sift/client.rb
+- lib/sift/client/decision.rb
+- lib/sift/client/decision/apply_to.rb
+- lib/sift/error.rb
+- lib/sift/router.rb
+- lib/sift/utils/hash_getter.rb
+- lib/sift/validate/decision.rb
+- lib/sift/validate/primitive.rb
 - lib/sift/version.rb
 - sift.gemspec
+- spec/fixtures/fake_responses.rb
 - spec/integration/sift_spec.rb
 - spec/spec_helper.rb
+- spec/unit/client/decision/apply_to_spec.rb
+- spec/unit/client/decision_spec.rb
 - spec/unit/client_203_spec.rb
 - spec/unit/client_label_spec.rb
 - spec/unit/client_spec.rb
-- spec/unit/sift_spec.rb
+- spec/unit/router_spec.rb
+- spec/unit/validate/decision_spec.rb
+- spec/unit/validate/primitive_spec.rb
 homepage: http://siftscience.com
 licenses: []
 metadata: {}
@@ -132,14 +158,19 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: sift
-rubygems_version: 2.4.6
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Sift Science Ruby API Gem
 test_files:
+- spec/fixtures/fake_responses.rb
 - spec/integration/sift_spec.rb
 - spec/spec_helper.rb
+- spec/unit/client/decision/apply_to_spec.rb
+- spec/unit/client/decision_spec.rb
 - spec/unit/client_203_spec.rb
 - spec/unit/client_label_spec.rb
 - spec/unit/client_spec.rb
-- spec/unit/sift_spec.rb
+- spec/unit/router_spec.rb
+- spec/unit/validate/decision_spec.rb
+- spec/unit/validate/primitive_spec.rb

data/README.rdoc

@@ -1,110 +0,0 @@
-= 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:
-
-  $ gem build sift.gemspec
-
-Alternatively, you can install the gem from Rubyforge:
-
-  $ gem install sift
-  
-
-== Usage
-
-  require "sift"
-
-  Sift.api_key = '<your_api_key_here>'
-  Sift.account_id = '<your_account_id_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, =, ., -, _, +, @, :, &, ^, %, !, $
-
-  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)
-
-
-  # 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')
-
-
-== Building
-
-Building and publishing the gem is captured by the following steps:
-
-  $ 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:
-
-  $ rake spec