sift 4.2.0 → 4.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cf4d6cd2e8ea54d5ea80fdca8b5668a1f86aa2639eaa1b69a105e8e81dd31222
-  data.tar.gz: cd087556fba6bbfd8269366fb8a7ae1c4727841a184056f09406a9c6d78658f5
+  metadata.gz: e538e799471ba36d0c73d8b6bdea81f56e5928ef018a01a8aa0d1d376151ba97
+  data.tar.gz: 7ba73b5ea722594550ce5fb2b9259c8728b6658ac393206f991ac182e6216fd1
 SHA512:
-  metadata.gz: 66a74c28328b082be3b0f492f0f001c998a7bc99bd95ede179a4c950974b332b4b55158cf418677ce4b904307464912f3248a56b200b88bb76038fd38cdff281
-  data.tar.gz: e6bb108cbcbf692266ff6d87a0a426476e8ad0a4523a2436a9f3d6f201ceeab63baad1121466e6a1ef7ec16df7135a577e59e532fe3d463ea47c6c7f47955576
+  metadata.gz: d6a650d190c215fa627b364e134e51d35012edd1b40682c8d24e8ea446e7bbbcfc2121189d9ef1335a5f67ee5aeb4472c42823e99737bd5879ea14a51c4f0e2c
+  data.tar.gz: 1569ecf84bf4bfee1991a7664922293a24ab6993ac56766b28a10183cd8cc593641ff301c3e68fbdc1e8f2f51b3425b1ad64131332c12c4ded51489e54703eb3

data/.github/workflows/publishing_sift_ruby.yml

@@ -0,0 +1,50 @@
+name: Build and Publish Gem
+on:
+  release:
+    types: [published]
+
+env:
+  GH_TOKEN: ${{ github.token }}
+
+jobs:
+  build_and_publish:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+        
+          
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 2.7
+
+      - name: Install Bundler
+        run: |
+          sudo gem install bundler
+          bundle install
+
+      - name: Build and push gem
+        run: |
+          mkdir -p $HOME/.gem
+          touch $HOME/.gem/credentials
+          chmod 0600 $HOME/.gem/credentials
+          printf -- "---\n:rubygems_api_key: ${{ secrets.GH_RGEMS_KEY }}\n" > $HOME/.gem/credentials
+          version=$(awk -F'"' '/ VERSION = / {print $2}' < lib/sift/version.rb)
+          all_versions=$(gem list -r -e --all sift --no-verbose)
+          if [[ $all_versions != *"$version"* ]]; then
+              echo "Gem version does not exist on RubyGems. Building and pushing!"
+              gem build sift.gemspec
+              gem push sift-$version.gem
+              rm -rf $HOME/.gem
+              ls -la $HOME/
+          else
+              echo "Gem version $version exists on RubyGems"
+          fi
+
+      - name: Run Rake tasks
+        run: |
+          bundle exec rake -T
+          bundle exec rake build
+          bundle exec rake install
+          bundle exec rake release

data/.gitignore

@@ -3,3 +3,4 @@
 .bundle
 Gemfile.lock
 pkg/*
+.idea

data/HISTORY

@@ -1,3 +1,6 @@
+=== 4.3.0 2023-08-21
+- PSP Merchant Management API
+
 === 4.2.0 2023-06-20
 - Verification API support [Verification API](https://sift.com/developers/docs/curl/verification-api/overview)
 - Support for score percentiles (only applicable for the accounts with the feature enabled)

data/README.md

@@ -217,6 +217,72 @@ response = client.get_session_decisions('example_user_id', 'example_session_id')
 response = client.get_content_decisions('example_user_id', 'example_order_id')
 ```
 
+## PSP Merchant Management API
+
+To learn more about the decisions endpoint visit our [developer docs](https://sift.com/developers/docs/ruby/psp-merchant-management-api).
+
+```ruby
+# On-board a PSP merchant summary to Sift Platform.
+# Sample psp_merchant_profile
+  properties = {
+    "id": "merchant_id_01000",
+    "name": "Wonderful Payments Inc.",
+    "description": "Wonderful Payments payment provider.",
+    "address": {
+      "name": "Alany",
+      "address_1": "Big Payment blvd, 22",
+      "address_2": "apt, 8",
+      "city": "New Orleans",
+      "region": "NA",
+      "country": "US",
+      "zipcode": "76830",
+      "phone": "0394888320"
+    },
+    "category": "1002",
+    "service_level": "Platinum",
+    "status": "active",
+    "risk_profile": {
+      "level": "low",
+      "score": 10
+    }
+  }
+response = client.create_psp_merchant_profile(properties)
+
+# Update a merchant summary to reflect changes in the status or service level or address etc.
+  properties = {
+    "id": "merchant_id_01000",
+    "name": "Wonderful Payments Inc.",
+    "description": "Wonderful Payments payment provider.",
+    "address": {
+      "name": "Alany",
+      "address_1": "Big Payment blvd, 22",
+      "address_2": "apt, 8",
+      "city": "New Orleans",
+      "region": "NA",
+      "country": "US",
+      "zipcode": "76830",
+      "phone": "0394888320"
+    },
+    "category": "1002",
+    "service_level": "Platinum",
+    "status": "active",
+    "risk_profile": {
+      "level": "low",
+      "score": 10
+    }
+  }
+response = client.update_psp_merchant_profile('merchant_id', properties)
+
+# Get the existing PSP merchant summaries.
+response = client.get_a_psp_merchant_profile('merchant_id')
+
+# Get all PSP merchant summaries
+response = client.get_psp_merchant_profiles()
+
+# Get PSP merchant summaries paginated 
+response = client.get_psp_merchant_profiles('batch_size', 'batch_token')
+```
+
 ## Response Object
 
 All requests to our apis will return a `Response` instance.

data/examples/psp_merchant_management_apis.rb

@@ -0,0 +1,105 @@
+require 'rubygems'
+require 'sift'
+require 'multi_json'
+
+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
+
+def handle_response(response)
+  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
+    puts 'response body                      : ' + response.body.to_s
+  end
+end
+
+Sift.logger = MyLogger.new
+
+$api_key = 'put-valid-api-key'
+$account_id = 'put-valid-account-id'
+
+def post_merchant_properties
+  # Sample psp_merchant_profile
+  {
+    "id": "merchant_id_01004",
+    "name": "Wonderful Payments Inc.",
+    "description": "Wonderful Payments payment provider.",
+    "address": {
+      "name": "Alany",
+      "address_1": "Big Payment blvd, 22",
+      "address_2": "apt, 8",
+      "city": "New Orleans",
+      "region": "NA",
+      "country": "US",
+      "zipcode": "76830",
+      "phone": "0394888320"
+    },
+    "category": "1002",
+    "service_level": "Platinum",
+    "status": "active",
+    "risk_profile": {
+      "level": "low",
+      "score": 10
+    }
+  }
+end
+
+def put_merchant_properties
+  # Sample update psp_merchant_profile
+  {
+    "id": "merchant_id_01004",
+    "name": "Wonderful Payments Inc. update",
+    "description": "Wonderful Payments payment provider. update",
+    "address": {
+      "name": "Alany",
+      "address_1": "Big Payment blvd, 22",
+      "address_2": "apt, 8",
+      "city": "New Orleans",
+      "region": "NA",
+      "country": "US",
+      "zipcode": "76830",
+      "phone": "0394888320"
+    },
+    "category": "1002",
+    "service_level": "Platinum",
+    "status": "active",
+    "risk_profile": {
+      "level": "low",
+      "score": 10
+    }
+  }
+end
+
+# handle_response Sift::Client.new(:api_key => $api_key, :account_id => $account_id).create_psp_merchant_profile(post_merchant_properties)
+
+# handle_response Sift::Client.new(:api_key => $api_key, :account_id => $account_id).update_psp_merchant_profile("merchant_id_01004", put_merchant_properties)
+
+# handle_response Sift::Client.new(:api_key => $api_key, :account_id => $account_id).get_a_psp_merchant_profile("merchant_id_01004")
+
+# handle_response Sift::Client.new(:api_key => $api_key, :account_id => $account_id).get_psp_merchant_profiles()
+
+# handle_response Sift::Client.new(:api_key => $api_key, :account_id => $account_id).get_psp_merchant_profiles(2)
+
+handle_response Sift::Client.new(:api_key => $api_key, :account_id => $account_id).get_psp_merchant_profiles(5, "next_ref")
+
+puts "request completed"

data/lib/sift/client.rb

@@ -785,6 +785,111 @@ module Sift
       Response.new(response.body, response.code, response.response)
     end
 
+    def create_psp_merchant_profile(properties = {}, opts = {})
+      # Create a new PSP Merchant profile
+      # Args:
+      #   properties: A dict of merchant profile data.
+      # Returns
+      #   A sift.client.Response object if the call succeeded, else raises an ApiException
+
+      account_id = opts[:account_id] || @account_id
+      api_key = opts[:api_key] || @api_key
+      timeout = opts[:timeout] || @timeout
+
+      raise("api_key cannot be empty") if api_key.empty?
+      raise("account_id cannot be empty") if account_id.empty?
+      raise("properties cannot be empty") if properties.empty?
+
+      options = {
+        :body => MultiJson.dump(delete_nils(properties)),
+        :headers => { "User-Agent" => user_agent, "Content-Type" => "application/json" },
+        :basic_auth => { :username => api_key, :password => "" }
+      }
+      options.merge!(:timeout => timeout) unless timeout.nil?
+      response = self.class.post(API_ENDPOINT + Sift.psp_merchant_api_path(account_id), options)
+      Response.new(response.body, response.code, response.response)
+    end
+
+    def update_psp_merchant_profile(merchant_id, properties = {}, opts = {})
+      # Update an existing PSP Merchant profile
+      #  Args:
+      #      merchant_id: id of merchant
+      #      properties: A dict of merchant profile data.
+      #  Returns
+      #      A sift.client.Response object if the call succeeded, else raises an ApiException
+
+      account_id = opts[:account_id] || @account_id
+      api_key = opts[:api_key] || @api_key
+      timeout = opts[:timeout] || @timeout
+
+      raise("api_key cannot be empty") if api_key.empty?
+      raise("account_id cannot be empty") if account_id.empty?
+      raise("merchant_id cannot be empty") if merchant_id.empty?
+      raise("properties cannot be empty") if properties.empty?
+
+      options = {
+        :body => MultiJson.dump(delete_nils(properties)),
+        :headers => { "User-Agent" => user_agent, "Content-Type" => "application/json" },
+        :basic_auth => { :username => api_key, :password => "" }
+      }
+      options.merge!(:timeout => timeout) unless timeout.nil?
+      response = self.class.put(API_ENDPOINT + Sift.psp_merchant_id_api_path(account_id, merchant_id), options)
+      Response.new(response.body, response.code, response.response)
+    end
+
+  def get_a_psp_merchant_profile(merchant_id, opts = {})
+    # Gets a PSP merchant profile using merchant id.
+    #  Args:
+    #      merchant_id: id of merchant
+    #  Returns
+    #      A sift.client.Response object if the call succeeded, else raises an ApiException
+
+    account_id = opts[:account_id] || @account_id
+    api_key = opts[:api_key] || @api_key
+    timeout = opts[:timeout] || @timeout
+    
+    raise("api_key cannot be empty") if api_key.empty?
+    raise("account_id cannot be empty") if account_id.empty?
+    raise("merchant_id cannot be empty") if merchant_id.empty?
+
+    options = {
+      :headers => { "User-Agent" => user_agent, "Content-Type" => "application/json" },
+      :basic_auth => { :username => api_key, :password => "" }
+    }
+    options.merge!(:timeout => timeout) unless timeout.nil?
+    response = self.class.get(API_ENDPOINT + Sift.psp_merchant_id_api_path(account_id, merchant_id), options)
+    Response.new(response.body, response.code, response.response)
+  end
+
+  def get_psp_merchant_profiles(batch_size = nil, batch_token = nil, opts = {})
+    # Get all PSP merchant profiles.
+    # Args:
+    #  batch_size : Batch or page size of the paginated sequence.
+    #  batch_token : Batch or page position of the paginated sequence.
+    #  Returns
+    #      A sift.client.Response object if the call succeeded, else raises an ApiException
+
+    account_id = opts[:account_id] || @account_id
+    api_key = opts[:api_key] || @api_key
+    timeout = opts[:timeout] || @timeout
+
+    raise("api_key cannot be empty") if api_key.empty?
+    raise("account_id cannot be empty") if account_id.empty?
+
+    query = {}
+    query["batch_size"] = batch_size if batch_size
+    query["batch_token"] = batch_token if batch_token
+
+    options = {
+      :headers => { "User-Agent" => user_agent, "Content-Type" => "application/json" },
+      :basic_auth => { :username => api_key, :password => "" },
+      :query => query
+    }
+    options.merge!(:timeout => timeout) unless timeout.nil?
+    response = self.class.get(API_ENDPOINT + Sift.psp_merchant_api_path(account_id), options)
+    Response.new(response.body, response.code, response.response)
+  end
+
     private
 
     def handle_response(response)

data/lib/sift/version.rb

@@ -1,4 +1,4 @@
 module Sift
-  VERSION = "4.2.0"
+  VERSION = "4.3.0"
   API_VERSION = "205"
 end

data/lib/sift.rb

@@ -71,6 +71,18 @@ module Sift
       "/content/#{ERB::Util.url_encode(content_id)}/decisions"
   end
 
+  # Returns the path for psp Merchant API
+  def self.psp_merchant_api_path(account_id)
+    "/v3/accounts/#{ERB::Util.url_encode(account_id)}" \
+    "/psp_management/merchants"
+  end
+
+  # Returns the path for psp Merchant with id
+  def self.psp_merchant_id_api_path(account_id, merchant_id)
+    "/v3/accounts/#{ERB::Util.url_encode(account_id)}" \
+    "/psp_management/merchants/#{ERB::Util.url_encode(merchant_id)}"
+  end
+
   # Module-scoped public API key
   class << self
     attr_accessor :api_key

data/spec/unit/client_psp_merchant_spec.rb

@@ -0,0 +1,133 @@
+require_relative "../spec_helper"
+require "sift"
+
+describe Sift::Client do
+
+  before :each do
+    Sift.api_key = nil
+  end
+
+  def post_psp_merchant_properties
+    {
+      "id": "api-key1-6",
+      "name": "Wonderful Payments Inc.",
+      "description": "Wonderful Payments payment provider.",
+      "address": {
+          "name": "Alany",
+          "address_1": "Big Payment blvd, 22",
+          "address_2": "apt, 8",
+          "city": "New Orleans",
+          "region": "NA",
+          "country": "US",
+          "zipcode": "76830",
+          "phone": "0394888320"
+      },
+      "category": "1002",
+      "service_level": "Platinum",
+      "status": "active",
+      "risk_profile": {
+          "level": "low",
+          "score": 10
+      }
+    }
+  end
+
+  def put_psp_merchant_properties
+    {
+      "id": "api-key1-7",
+      "name": "Wonderful Payments Inc.",
+      "description": "Wonderful Payments payment provider.",
+      "address": {
+          "name": "Alany",
+          "address_1": "Big Payment blvd, 22",
+          "address_2": "apt, 8",
+          "city": "New Orleans",
+          "region": "NA",
+          "country": "US",
+          "zipcode": "76830",
+          "phone": "0394888320"
+      },
+      "category": "1002",
+      "service_level": "Platinum",
+      "status": "active",
+      "risk_profile": {
+          "level": "low",
+          "score": 10
+      }
+    }
+  end
+
+  it "Successfully sumit create psp merchant" do
+    api_key = "foobar1"
+
+    response_json = { :status => 0, :error_message => "OK" }
+
+    stub_request(:post, "https://foobar1:@api.siftscience.com/v3/accounts/ACCT/psp_management/merchants")
+      .to_return(:status => 200, :body => MultiJson.dump(response_json))
+
+    response = Sift::Client.new(:api_key => api_key, :account_id => "ACCT").create_psp_merchant_profile(post_psp_merchant_properties)
+    expect(response.ok?).to eq(true)
+    expect(response.api_status).to eq(0)
+    expect(response.api_error_message).to eq("OK")
+  end
+
+  it "Successfully submit update psp merchant" do
+    api_key = "foobar1"
+    merchant_id = "api-key1-7"
+
+    response_json = { :status => 0, :error_message => "OK"}
+
+    stub_request(:put, "https://foobar1:@api.siftscience.com/v3/accounts/ACCT/psp_management/merchants/api-key1-7")
+      .to_return(:status => 200, :body => MultiJson.dump(response_json))
+
+    response = Sift::Client.new(:api_key => api_key, :account_id => "ACCT").update_psp_merchant_profile(merchant_id, put_psp_merchant_properties)
+    expect(response.ok?).to eq(true)
+    expect(response.api_status).to eq(0)
+    expect(response.api_error_message).to eq("OK")
+  end
+
+  it "Successfully get a psp merchant profile" do
+    api_key = "foobar1"
+    merchant_id = "api-key1-7"
+
+    response_json = { :status => 0, :error_message => "OK"}
+
+    stub_request(:get, "https://foobar1:@api.siftscience.com/v3/accounts/ACCT/psp_management/merchants/api-key1-7")
+      .to_return(:status => 200, :body => MultiJson.dump(response_json))
+
+    response = Sift::Client.new(:api_key => api_key, :account_id => "ACCT").get_a_psp_merchant_profile(merchant_id)
+    expect(response.ok?).to eq(true)
+    expect(response.api_status).to eq(0)
+    expect(response.api_error_message).to eq("OK")
+  end
+
+  it "Successfully get all psp merchant profile with batch size" do
+    api_key = "foobar1"
+
+    response_json = { :status => 0, :error_message => "OK"}
+
+    stub_request(:get, "https://foobar1:@api.siftscience.com/v3/accounts/ACCT/psp_management/merchants?batch_size=2")
+      .to_return(:status => 200, :body => MultiJson.dump(response_json))
+
+    response = Sift::Client.new(:api_key => api_key, :account_id => "ACCT").get_psp_merchant_profiles(2)
+    expect(response.ok?).to eq(true)
+    expect(response.api_status).to eq(0)
+    expect(response.api_error_message).to eq("OK")
+  end
+
+  it "Successfully get all psp merchant profile with batch size and batch token" do
+    api_key = "foobar1"
+    batch_size =  2
+    batch_token = "batch_token"
+    response_json = { :status => 0, :error_message => "OK"}
+
+    stub_request(:get, "https://foobar1:@api.siftscience.com/v3/accounts/ACCT/psp_management/merchants?batch_size=2&batch_token=batch_token")
+      .to_return(:status => 200, :body => MultiJson.dump(response_json))
+
+    response = Sift::Client.new(:api_key => api_key, :account_id => "ACCT").get_psp_merchant_profiles(batch_size, batch_token)
+    expect(response.ok?).to eq(true)
+    expect(response.api_status).to eq(0)
+    expect(response.api_error_message).to eq("OK")
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sift
 version: !ruby/object:Gem::Version
-  version: 4.2.0
+  version: 4.3.0
 platform: ruby
 authors:
 - Fred Sadaghiani
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-07-07 00:00:00.000000000 Z
+date: 2023-08-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -125,12 +125,14 @@ extra_rdoc_files: []
 files:
 - ".circleci/config.yml"
 - ".github/pull_request_template.md"
+- ".github/workflows/publishing_sift_ruby.yml"
 - ".gitignore"
 - Gemfile
 - HISTORY
 - LICENSE
 - README.md
 - Rakefile
+- examples/psp_merchant_management_apis.rb
 - examples/simple.rb
 - examples/validation_apis.rb
 - lib/sift.rb
@@ -152,6 +154,7 @@ files:
 - spec/unit/client_203_spec.rb
 - spec/unit/client_205_spec.rb
 - spec/unit/client_label_spec.rb
+- spec/unit/client_psp_merchant_spec.rb
 - spec/unit/client_spec.rb
 - spec/unit/client_validationapi_spec.rb
 - spec/unit/router_spec.rb
@@ -175,21 +178,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3.1
+rubygems_version: 3.1.6
 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_205_spec.rb
-- spec/unit/client_label_spec.rb
-- spec/unit/client_spec.rb
-- spec/unit/client_validationapi_spec.rb
-- spec/unit/router_spec.rb
-- spec/unit/validate/decision_spec.rb
-- spec/unit/validate/primitive_spec.rb
+test_files: []