sift-partner 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MTU3NTgwNzFlMGY0ZTQyM2ExZDFkYTJmYjZmMmFlM2IxNzExOTZhYw==
+  data.tar.gz: !binary |-
+    YTA5MDY4M2MwOGIzZjAzODY3YmQzNjk1N2VhNGU3ODg0MjZmOGRlZg==
+SHA512:
+  metadata.gz: !binary |-
+    MTU4NTBmY2MzOTNjN2JjMTYyZTFhMjUyNjNkYjgwMTZjMDdlMDdhZDMwYWRk
+    ZTIzZjJkZjViNTkxNDAxZjBjYTQ1Yjg2NmVlNWMzNmY4MjUyZGM5OTFkYTFj
+    ZWM0Yjg1OGIyN2ZlNDkwZjY2YTQ5ODllMjYxNWNkYTA1OGQ5ODU=
+  data.tar.gz: !binary |-
+    MTdkZmYyMDUyMDA4MmExMzEyOGUwYzJmNWU2OTdkZTJmMjA2YzY1MzRjOGE4
+    ZDdlMDg1MTM1YzYzNDQ4Njk3MGZmMmVkZDcxZTZlZWVmNWZkYTg1MzMxYmVk
+    MzRlMmJjN2YyODE3MzRjMDdmOGUxOTQyMWM1ZjE4Yjk0YTYxYTY=

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,50 @@
+PATH
+  remote: .
+  specs:
+    sift-partner (0.0.1)
+      httparty (>= 0.11.0)
+      multi_json (>= 1.0)
+      sift (>= 1.1.6.2)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    addressable (2.3.6)
+    crack (0.4.2)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.2.5)
+    httparty (0.13.1)
+      json (~> 1.8)
+      multi_xml (>= 0.5.2)
+    json (1.8.1)
+    multi_json (1.10.1)
+    multi_xml (0.5.5)
+    rake (10.3.2)
+    rspec (3.1.0)
+      rspec-core (~> 3.1.0)
+      rspec-expectations (~> 3.1.0)
+      rspec-mocks (~> 3.1.0)
+    rspec-core (3.1.4)
+      rspec-support (~> 3.1.0)
+    rspec-expectations (3.1.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.1.0)
+    rspec-mocks (3.1.1)
+      rspec-support (~> 3.1.0)
+    rspec-support (3.1.0)
+    safe_yaml (1.0.3)
+    sift (1.1.6.2)
+      httparty (>= 0.11.0)
+      multi_json (>= 1.0)
+    webmock (1.18.0)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rake
+  rspec (>= 2.14.1)
+  sift-partner!
+  webmock (>= 1.16.0)

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2014 Sift Science
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,69 @@
+= Sift Science Partner Ruby bindings
+
+== 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
+* sift, 1.1.6.2 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-partner.gemspec
+
+Alternatively, you can install the gem from Rubyforge:
+
+  $ gem install sift-partner
+
+== Usage
+  
+    require "sift-partner"
+    
+    # you can get these values from the console
+    partner_client = SiftPartner::Client.new(partner_api_key, partner_acct_id)
+
+    # create a new account for a given merchant
+    merchant_account = partner_client.new_account(
+      "merchantsite.com", # the url for the merchant's site
+      "shopowner@merchantsite.com", # an email belonging to the merchant
+      "johndoe@merchantsite.com", # an email used to log in to Sift
+      "s0m3l0ngp455w0rd" # password associated with that log in
+    )
+
+    # get a listing of all your accounts
+    all_accounts = partner_client.get_accounts
+
+    # config http notifications
+    cfg = {
+        :http_notification_threshold => 0.15,
+        :http_notification_url => "http://api.partner.com/notify?id=%s"
+    }
+    updated = partner_client.update_notification_config(cfg)
+  
+
+== Building
+
+Building and publishing the gem is captured by the following steps:
+
+  $ gem build sift-partner.gemspec
+  $ gem push sift-partner<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

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"
+task :default => :spec
+
+desc "Run tests"
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.pattern = "./spec/**/*_spec.rb"
+end

data/lib/sift-partner.rb

@@ -0,0 +1,2 @@
+require "sift-partner/client"
+require "sift-partner/version"

data/lib/sift-partner/client.rb

@@ -0,0 +1,122 @@
+require 'uri'
+require 'json'
+require 'httparty'
+require 'sift' # we use Response
+
+module SiftPartner
+
+  # Ruby bindings for Sift Science's Partner API.
+  # For background and examples on how to use the Partner API with this client
+  # please refer to https://siftscience.com/resources/references/partner-ruby.html
+  class Client
+    API_ENDPOINT = "https://partner.siftscience.com/v3"
+    API_TIMEOUT = 2
+
+    #
+    # Constructor
+    # == Parameters:
+    # api_key
+    #   The api_key of the partner
+    #   (which may be found in the api_keys section of the console)
+    # id
+    #   The account id of the partner
+    #   (which may be found in the settings page of the console)
+    def initialize(api_key = Sift.api_key, id = Sift.account_id)
+      @api_key = api_key
+      @id = id
+    end
+
+    # Creates a new merchant account under the given partner.
+    # == Parameters:
+    # site_url
+    #    the url of the merchant site
+    # site_email
+    #    an email address for the merchant
+    # analyst_email
+    #    an email address which will be used to log in at the Sift Console
+    # password
+    #    password (at least 10 chars) to be used to sign into the Console
+    #
+    # When successful, returns a including the new account id and credentials.
+    # When an error occurs, returns nil.
+    def new_account(site_url, site_email, analyst_email, password)
+      reqBody = {:site_url => site_url, :site_email => site_email,
+                 :analyst_email => analyst_email, :password => password}
+      begin
+        http_post(accounts_url(), reqBody)
+      rescue Exception => e
+        puts e.message
+        puts e.backtrace.inspect
+      end
+
+    end
+
+    # Gets a listing of the ids and keys for all merchant accounts that have
+    # been created by this partner.
+    #
+    # When successful, returns a hash including the key :data, which is an
+    # array of account descriptions. (Each element has the same structure as a
+    # single response from new_account).
+    def get_accounts()
+      http_get(accounts_url)
+    end
+
+    # Updates the configuration which controls http notifications for all merchant
+    # accounts under this partner.
+    #
+    # == Parameters
+    # cfg
+    #   A Hash, with keys :http_notification_url and :http_notification_threshold
+    #   The value of the notification_url will be a url containing the string '%s' exactly once.
+    #   This allows the url to be used as a template, into which a merchant account id can be substituted.
+    #   The  notification threshold should be a floating point number between 0.0 and 1.0
+    def update_notification_config(cfg)
+      http_put(notification_config_url(), cfg)
+    end
+
+    private
+      def accounts_url
+        URI("#{API_ENDPOINT}/partners/#{@id}/accounts")
+      end
+
+      def notification_config_url
+        URI("#{API_ENDPOINT}/accounts/#{@id}/config")
+      end
+
+      def safe_json(http_response)
+        response = Sift::Response.new(http_response.body, http_response.code)
+        if !response.nil? and response.ok?
+          response.json
+        else
+          puts "bad value in safeJson :"
+          PP.pp(response)
+        end
+      end
+
+      def prep_https(uri)
+        https = Net::HTTP.new(uri.host, uri.port)
+        https.use_ssl = true
+        https
+      end
+
+      def http_get(uri)
+        header =  {"Authorization" => "Basic #{@api_key}"}
+        http_response = HTTParty.get(uri, :headers =>header)
+        safe_json(http_response)
+      end
+
+      def http_put(uri, bodyObj)
+        header = {"Content-Type" => "application/json",
+                  "Authorization" => "Basic #{@api_key}"}
+        http_response = HTTParty.put(uri, :body => bodyObj.to_json, :headers => header)
+        safe_json(http_response)
+      end
+
+      def http_post(uri, bodyObj)
+        header = {"Content-Type" => "application/json",
+                  "Authorization" => "Basic #{@api_key}"}
+        http_response = HTTParty.post(uri, :body => bodyObj.to_json, :headers => header)
+        safe_json(http_response)
+      end
+  end
+end

data/lib/sift-partner/version.rb

@@ -0,0 +1,3 @@
+module SiftPartner
+  VERSION = "0.0.1"
+end

data/sift-partner.gemspec

@@ -0,0 +1,32 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "sift-partner/version"
+
+Gem::Specification.new do |s|
+  s.name        = "sift-partner"
+  s.version     = SiftPartner::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Aaron Beppu"]
+  s.email       = ["support@siftscience.com"]
+  s.homepage    = "http://siftscience.com"
+  s.summary     = %q{Sift Science Ruby Partner API Gem}
+  s.description = %q{Sift Science Ruby Partner API. Please see http://siftscience.com for more details.}
+
+  s.rubyforge_project = "sift-partner"
+
+  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.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 "sift", ">= 1.1.6.2"
+
+  s.add_development_dependency("rake")
+end

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+
+require "bundler/setup"
+require "sift-partner"
+require "webmock/rspec"
+
+# Setup Fakeweb
+WebMock.disable_net_connect!
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |c|
+    c.syntax = :should
+  end
+  config.mock_with :rspec do |c|
+    c.syntax = :should
+  end
+end

data/spec/unit/client_spec.rb

@@ -0,0 +1,114 @@
+require File.expand_path(File.join(File.dirname(__FILE__), "..", "spec_helper"))
+
+describe SiftPartner::Client do
+  partner_id = "65653548"
+  partner_api_key = "98463454389754"
+  expected_account_body = {
+      "account_id" => "1234567890abcdef",
+      "production" => {
+        "api_keys" => [
+          {
+            "id" => "54321abcdef",
+            "state" => "ACTIVE",
+            "key" => "fedcba0987654321"
+          }
+        ],
+        "beacon_keys" => [
+          {
+            "id" => "4321abcdef5",
+            "state" => "ACTIVE",
+            "key" => "edcba0987654321f"
+          }
+        ]
+      },
+      "sandbox" => {
+        "api_keys" => [
+          {
+            "id" => "321abcdef54",
+            "state" => "ACTIVE",
+            "key" => "dcba0987654321fe"
+          }
+        ],
+        "beacon_keys" => [
+          {
+            "id" => "21abcdef543",
+            "state" => "ACTIVE",
+            "key" => "cba0987654321fed"
+          }
+        ]
+      }
+    }
+
+  it "should march through create acct flow" do
+    site_url = "merchant123.com"
+    site_email = "owner@merchant123.com"
+    analyst_email = "analyst+merchant123@partner.com"
+    password = "s0m3l0ngp455w0rd"
+    # when we receive the mocked url, it will include the basic auth header encoded
+    # and regurgitated before the host name
+    stub_request(:post, /https:\/\/.*\@partner\.siftscience\.com\/v3\/partners\/#{partner_id}\/accounts/).
+      with { |request|
+        parsed_body = JSON.parse(request.body)
+        parsed_body.should include("site_url" => site_url)
+        parsed_body.should include("site_email" => site_email)
+        parsed_body.should include("analyst_email" => analyst_email)
+        parsed_body.should include("password" => password)
+      }.to_return({
+        :status => 200,
+        :headers => {},
+        :body => expected_account_body.to_json})
+      partner_client = SiftPartner::Client.new(partner_api_key, partner_id)
+
+      response = partner_client.new_account(site_url, site_email, analyst_email,
+      password)
+      response.should_not be_nil
+      response["production"]["api_keys"][0]["state"].should eq("ACTIVE")
+    end
+
+  it "should march through account listing flow" do
+    stub_request(:get, /https:\/\/.*partner\.siftscience\.com\/v3\/partners\/#{partner_id}\/accounts/).
+      to_return(
+        {:body =>
+          { "type" => "partner_account", "data" => [expected_account_body.to_json],
+            "hasMore" => false,
+            "nextRef" => nil,
+            "totalResults" => 1}.to_json,
+         :status => 200,
+         :headers => {}}
+      )
+      partner_client = SiftPartner::Client.new(partner_api_key, partner_id)
+      response = partner_client.get_accounts()
+      response.should_not be_nil
+      response["totalResults"].should eq(1)
+  end
+
+  it "should work through config update flow" do
+    stub_request(:put, /https:\/\/.*\@partner\.siftscience\.com\/v3\/accounts\/#{partner_id}\/config/).
+      with { |request|
+        parsed_body = JSON.parse(request.body)
+        parsed_body.should include("http_notification_threshold" => 0.1)
+        parsed_body.should include("http_notification_url" => "https://api.partners.com/notify?account=%s")
+      }.to_return({:status => 200, :headers => {},
+          :body => {
+            "email_notifiction_threshold" => 0.899,
+            "http_notification_url" => "https://api.partners.com/notify?account=%s",
+            "http_notification_threshold" => 0.1,
+            "is_production" => true,
+            "enable_sor_by_expected_loss" => false
+          }.to_json
+      })
+      partner_client = SiftPartner::Client.new(partner_api_key, partner_id)
+      cfg = {
+        "http_notification_url" => "https://api.partners.com/notify?account=%s",
+        "http_notification_threshold" => 0.1
+      }
+      response = partner_client.update_notification_config(cfg)
+      response.should_not be_nil
+      epsilon = 1e-6
+      response["http_notification_url"].should eq(cfg["http_notification_url"])
+      response["http_notification_threshold"].should < cfg["http_notification_threshold"] + epsilon
+      response["http_notification_threshold"].should > cfg["http_notification_threshold"] - epsilon
+
+  end
+
+end

metadata

@@ -0,0 +1,141 @@
+--- !ruby/object:Gem::Specification
+name: sift-partner
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Aaron Beppu
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-22 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
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.11.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.11.0
+- !ruby/object:Gem::Dependency
+  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: sift
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.1.6.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.1.6.2
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Sift Science Ruby Partner API. Please see http://siftscience.com for
+  more details.
+email:
+- support@siftscience.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.rdoc
+- Rakefile
+- lib/sift-partner.rb
+- lib/sift-partner/client.rb
+- lib/sift-partner/version.rb
+- sift-partner.gemspec
+- spec/spec_helper.rb
+- spec/unit/client_spec.rb
+homepage: http://siftscience.com
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: sift-partner
+rubygems_version: 2.1.11
+signing_key: 
+specification_version: 4
+summary: Sift Science Ruby Partner API Gem
+test_files:
+- spec/spec_helper.rb
+- spec/unit/client_spec.rb