sift 1.0.5

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+**.swp
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in sift.gemspec
+gemspec

data/HISTORY

@@ -0,0 +1,3 @@
+
+=== 1.0 2012-05-02
+  * Initial release

data/README.rdoc

@@ -0,0 +1,41 @@
+= Sift Science Ruby bindings
+
+== 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
+
+== Requirements
+
+  * Ruby 1.8.7 or above. (Ruby 1.8.6 might work if you load ActiveSupport.)
+  * HTTParty, 0.8.3 or greater
+
+For development only:
+  * bundler
+  * rspec, 2.9 or greater
+  * fakeweb, 1.3 or greater
+
+== 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:unit
+  $ rake spec:integration

data/Rakefile

@@ -0,0 +1,14 @@
+begin
+  require "bundler/gem_tasks"
+  Bundler::GemHelper.install_tasks
+rescue LoadError => e
+  warn "It is recommended that you use bundler during development: gem install bundler"
+end
+
+require "rspec/core/rake_task"
+
+desc "Run tests"
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+task :test => :spec

data/examples/simple.rb

@@ -0,0 +1,50 @@
+#!/usr/bin/env ruby
+#
+# A simple example of how to use the API.
+
+require 'rubygems'
+require 'sift'
+require 'multi_json'
+
+api_key = "" # TODO: Set your API key here
+
+class MyLogger
+  def warn(e)
+    puts "[WARN]  " + e.to_s
+  end
+
+  def error(e)
+    puts "[ERROR] " + e.to_s
+  end
+
+  def fatal(e)
+    puts "[FATAL] " + e.to_s
+  end
+
+  def info(e)
+    puts "[INFO]  " + e.to_s
+  end
+end
+
+Sift.logger = MyLogger.new
+
+client = Sift::Client.new(api_key)
+event = "my_custom_event"
+properties = {
+  "my_custom_field1" => "my custom value 1",
+  "my_custom_field2" => "my custom value 2",
+  "$user_id" => "3",
+  "$time" => Time.now.to_i,
+}
+
+response = client.track(event, properties)
+if response.nil?
+  puts 'Error: there was an HTTP error calling through the API'
+else
+  puts 'Successfully sent request; was ok? : ' + response.ok?.to_s
+  puts 'API error message                  : ' + response.api_error_message.to_s
+  puts 'API status code                    : ' + response.api_status.to_s
+  puts 'HTTP status code                   : ' + response.http_status_code.to_s
+  puts 'original request                   : ' + response.original_request.to_s
+end
+

data/lib/sift.rb

@@ -0,0 +1,33 @@
+require "sift/version"
+require "sift/client"
+
+module Sift
+
+  # Returns the path for the current API version
+  def self.current_rest_api_path
+    "/v202/events"
+  end
+
+  # Sets the Output logger to use within the client. This can be left uninitializaed
+  # but is useful for debugging.
+  def self.logger=(logger)
+    @logger = logger
+  end
+
+  def self.info(msg)
+    @logger.info(msg) if @logger
+  end
+
+  def self.warn(msg)
+    @logger.warn(msg) if @logger
+  end
+
+  def self.error(msg)
+    @logger.error(msg) if @logger
+  end
+
+  def self.fatal(msg)
+    @logger.fatal(msg) if @logger
+  end
+
+end

data/lib/sift/client.rb

@@ -0,0 +1,108 @@
+require 'httparty'
+require 'multi_json'
+
+module Sift
+
+  # Represents the payload returned from a call through the track API
+  #
+  class Response
+    attr_reader :json
+    attr_reader :http_status_code
+    attr_reader :api_status
+    attr_reader :api_error_message
+    attr_reader :original_request
+
+    # Constructor
+    #
+    # == Parameters:
+    # http_response
+    #   The HTTP body text returned from the API call. The body is expected to be
+    #   a JSON object that can be decoded into status, message and request 
+    #   sections.
+    #
+    def initialize(http_response, http_response_code)
+      @json = MultiJson.load(http_response)
+      @original_request = MultiJson.load(@json["request"].to_s) if @json["request"]
+      @http_status_code = http_response_code
+      @api_status = @json["status"].to_i
+      @api_error_message = @json["error_message"].to_s
+    end
+
+    # Helper method returns true if and only if the response from the API call was
+    # successful
+    #
+    # == Returns:
+    #   true on success; false otherwise
+    def ok?
+      0 == @api_status.to_i
+    end
+  end
+
+  # This class wraps accesses through the API
+  #
+  class Client
+    API_ENDPOINT = "https://api.siftscience.com"
+    API_TIMEOUT = 2
+
+    include HTTParty
+    base_uri API_ENDPOINT
+    default_timeout API_TIMEOUT
+
+    # Constructor
+    #
+    # == Parameters:
+    # api_key
+    #   The Sift Science API key associated with your customer account. This parameter
+    #   cannot be nil or blank.
+    # 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
+      @path = path
+      raise(RuntimeError, "api_key is required") if @api_key.nil? || @api_key.empty?
+    end
+
+    # Tracks an event and associated properties through the Sift Science API. This call
+    # is blocking.
+    #
+    # == Parameters:
+    # event
+    #   The name of the event to send. This can be either a reserved event name, like
+    #   $transaction or $label or a custom event name (that does not start with a $).
+    #   This parameter must be specified.
+    #
+    # properties
+    #   A hash of name-value pairs that specify the event-specific attributes to track.
+    #   This parameter must be specified.
+    #
+    # timeout
+    #   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:
+    #   In the case of an HTTP error (timeout, broken connection, etc.), this
+    #   method returns nil; otherwise, a Response object is returned and captures
+    #   the status message and status code. In general, you can ignore the returned
+    #   result, though.
+    #
+    def track(event, properties = {}, timeout = nil)
+
+      raise(RuntimeError, "event must be a string") if event.nil? || event.to_s.empty?
+      raise(RuntimeError, "properties cannot be empty") if properties.empty?
+
+      options = {
+        :body => MultiJson.dump(properties.merge({"$type" => event, 
+                                                  "$api_key" => @api_key})),
+      }
+      options.merge!(:timeout => timeout) unless timeout.nil?
+      begin
+        response = self.class.post(@path, options)
+        Response.new(response.body, response.code)
+      rescue StandardError => e
+        Sift.warn("Failed to track event: " + e.to_s)
+        Sift.warn(e.backtrace)
+      end
+    end
+  end
+end

data/lib/sift/version.rb

@@ -0,0 +1,3 @@
+module Sift
+  VERSION = "1.0.5"
+end

data/sift.gemspec

@@ -0,0 +1,29 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "sift/version"
+
+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.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.}
+
+  s.rubyforge_project = "sift"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # Gems that must be intalled for sift to compile and build
+  s.add_development_dependency "rspec", "~> 2.9.0"
+  s.add_development_dependency "fakeweb", "~> 1.3.0"
+
+  # Gems that must be intalled for sift to work
+  s.add_dependency "httparty", ">= 0.8.3"
+  s.add_dependency "multi_json", ">= 1.3.4"
+end

data/spec/integration/sift_spec.rb

@@ -0,0 +1,7 @@
+require File.expand_path(File.join(File.dirname(__FILE__), "..", "spec_helper"))
+
+describe Sift do
+
+
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+
+require "bundler/setup"
+require "sift"
+require "fakeweb"
+
+# Setup Fakeweb
+FakeWeb.allow_net_connect = false
+
+RSpec.configure do |config|
+end

data/spec/unit/client_spec.rb

@@ -0,0 +1,82 @@
+require File.expand_path(File.join(File.dirname(__FILE__), "..", "spec_helper"))
+
+describe Sift::Client do
+
+  def valid_transaction_properties
+    {
+      :$buyer_user_id => "123456",
+      :$seller_user_id => "654321",
+      :$amount => 1253200,
+      :$currency_code => "USD",
+      :$time => Time.now.to_i,
+      :$transaction_id => "my_transaction_id",
+      :$billing_name => "Mike Snow",
+      :$billing_bin => "411111",
+      :$billing_last4 => "1111",
+      :$billing_address1 => "123 Main St.",
+      :$billing_city => "San Francisco",
+      :$billing_region => "CA",
+      :$billing_country => "US",
+      :$billing_zip => "94131",
+      :$buyer_email => "mike@example.com"
+    }
+  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
+    lambda { Sift::Client.new(nil) }.should raise_error
+    lambda { Sift::Client.new("") }.should 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
+  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
+  end
+
+  it "Must specify properties" do
+    event = "custom_event_name"
+    lambda { Sift::Client.new("foo").track(event) }.should raise_error
+  end
+
+  it "Doesn't raise an exception on Net/HTTP errors" do
+
+    FakeWeb.register_uri(:post, fully_qualified_api_endpoint,
+                         :body => nil, :exception => Net::HTTPError)
+
+    api_key = "foobar"
+    event = "$transaction"
+    properties = valid_transaction_properties
+
+    # This method should just return false -- the track call failed because
+    # of an HTTP error
+    Sift::Client.new(api_key).track(event, properties).should eq(nil)
+  end
+
+  it "Successfuly handles an event and returns OK" do
+
+    response_json = { :status => 0, :error_message => "OK" }
+
+    FakeWeb.register_uri(:post, fully_qualified_api_endpoint,
+                         :body => MultiJson.dump(response_json),
+                         :status => [Net::HTTPOK, "OK"],
+                         :content_type => "text/json")
+
+    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")
+  end
+
+end

data/spec/unit/sift_spec.rb

@@ -0,0 +1,6 @@
+require File.expand_path(File.join(File.dirname(__FILE__), "..", "spec_helper"))
+
+describe Sift do
+
+
+end

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification
+name: sift
+version: !ruby/object:Gem::Version
+  version: 1.0.5
+  prerelease: 
+platform: ruby
+authors:
+- Fred Sadaghiani
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-08-02 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70093902351140 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.9.0
+  type: :development
+  prerelease: false
+  version_requirements: *70093902351140
+- !ruby/object:Gem::Dependency
+  name: fakeweb
+  requirement: &70093902438840 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+  type: :development
+  prerelease: false
+  version_requirements: *70093902438840
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: &70093902565360 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.8.3
+  type: :runtime
+  prerelease: false
+  version_requirements: *70093902565360
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: &70093902656720 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.3.4
+  type: :runtime
+  prerelease: false
+  version_requirements: *70093902656720
+description: Sift Science Ruby API. Please see http://siftscience.com for more details.
+email:
+- freds@siftscience.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- HISTORY
+- README.rdoc
+- Rakefile
+- examples/simple.rb
+- lib/sift.rb
+- lib/sift/client.rb
+- lib/sift/version.rb
+- sift.gemspec
+- spec/integration/sift_spec.rb
+- spec/spec_helper.rb
+- spec/unit/client_spec.rb
+- spec/unit/sift_spec.rb
+homepage: http://siftscience.com
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: sift
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Sift Science Ruby API Gem
+test_files:
+- spec/integration/sift_spec.rb
+- spec/spec_helper.rb
+- spec/unit/client_spec.rb
+- spec/unit/sift_spec.rb