talon_one 0.0.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9b748e096eec0b2f1b84371700e28198ccc8e94a
+  data.tar.gz: aa2cf8fb236f2d95a6fa7fc532f5e586866e118c
+SHA512:
+  metadata.gz: 7b7b29b00c77ed44c3709657be152324e03afbf620257a861585fab2b5ad0b025d7aae0146465f3401b8e33233e064380317f3090d5d81059c12bae832e4a6da
+  data.tar.gz: 907506fc01ee8489861ea820ff62c9449c9abae8122172f1cf5fbc1e8805f41f1061d5efd6d13fbf2cdc9b76d3f0173ba8e5ed05b83cf4e9aad54bf673d058da

data/.gitignore

@@ -0,0 +1,3 @@
+talon_one-*.gem
+secrets.yml
+Gemfile.lock

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+cache: bundler
+rvm:
+  - 2.2
+  - 2.3.3

data/CHANGELOG.md

@@ -0,0 +1,17 @@
+# 0.0.4 / 2016-08-25
+
+* [FEATURE] Use BigDecimal for all decimal numbers coming in/out of the
+  Integration API.
+
+# 0.0.3 / 2016-08-25
+
+* [CHORE] Renamed "Shop" to "Application"
+
+# 0.0.2 / 2016-08-04
+
+* [BUG] Constructor param for integration client is `:shop_key` not `:secret`.
+* [BUG] Strip trailing slashes from Talon.One endpoints.
+
+# 0.0.1 / 2016-08-04
+
+* [FEATURE] First sort-of useful release.

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/README.md

@@ -0,0 +1,71 @@
+# Talon.One Ruby SDK [![Build Status](https://travis-ci.org/talon-one/talon_one.rb.svg?branch=master)](https://travis-ci.org/talon-one/talon_one.rb)
+
+Talon.One enables marketers to create coupon, discount, loyalty, and referral
+marketing campaigns of virtually unlimited power and flexibility. This library
+provides 2 Ruby API clients:
+
+ - `TalonOne::Integration::Client` is used to feed customer activities (e.g.
+   purchasing items or referring friends) into the Talon.One platform so that
+   your marketing campaigns can react to these events. Authentication for the
+   Integration API is done with an Application ID and secret key.
+
+ - `TalonOne::Management::Client` is used to create and manipulate campaigns,
+   coupons, and user accounts on the Talon.One platform. Unlike the integration
+   client, the management client must authenticate with credentials for a
+   registered Talon.One user in your organization.
+   
+## Installation
+
+There is no gem release yet, for now we recommend pulling directly from GitHub
+in your Gemfile:
+
+```ruby
+gem 'talon_one', :git => 'https://github.com/talon-one/talon-one.rb'
+```
+
+## Getting started with the Integration API
+
+First, you will need to find your API endpoint, Application ID and Application Key in the Camapaign Manager by going to the "Settings" tab.
+
+With these 3 things we can set up the integration API client:
+
+```ruby
+client = TalonOne::Integration::Client.new :endpoint => 'https://mycompany.talon.one',
+                                           :application_id => 213,
+                                           :application_key => '5ea4583bfb81d2e9'
+``` 
+
+Defaults for these configuration parameters can also be set via the environment
+variables `TALONONE_ENDPOINT`, `TALONONE_APP_ID`, and `TALONONE_APP_KEY`. 
+
+Once the `client` has been created, you can start sending customer profiles,
+sessions, and events to Talon.One:
+
+```ruby
+# When the customer registers or updates their account
+client.update_customer_profile "my_unique_profile_id",
+  "name" => "Val Kust",
+  "billingAddress1" => "21 Jump St."
+
+# When the customer adds an item to their cart
+client.update_customer_session "my_unique_session_id",
+  "profileId" => "my_unique_profile_id",
+  "cartItems" => [{
+    "name" => "Shiny Red Shoes",
+    "sku" => "srs_1234",
+    "price" => 49.99,
+    "quantity" => 1,
+    "currency" => "USD"
+  }],
+  "attributes" => {
+    "ShippingCost" => 3.75
+  },
+  "total" => 53.74  # total is _not_ required to match up to item cost + shipping"
+
+# When the customer does something else interesting
+client.track_event "my_unique_session_id", "viewed_promo_page", "url" => "http://example.com/summer-shoes-2016" 
+```
+
+To view the full list of data that each of these API calls accepts, please consult our [API documentation][].
+
+[API documentation]: http://developers.talon.one/integration-api/reference/

data/Rakefile

@@ -0,0 +1,10 @@
+require 'rake/testtask'
+require 'bundler/gem_tasks'
+
+Rake::TestTask.new do |t|
+  t.libs << %w(test lib)
+  t.pattern = "test/test_*.rb"
+end
+
+desc "Run tests"
+task :default => :test

data/lib/integration/client.rb

@@ -0,0 +1,87 @@
+require 'openssl'
+require 'oj'
+
+require_relative './search_profiles_result'
+require_relative './rule_engine_result'
+require_relative './referral_code'
+
+module TalonOne
+  module Integration
+    # Basic REST client for the TalonOne integration API
+    class Client
+      def initialize(config = {})
+        @endpoint = URI(
+          config[:endpoint] || ENV["TALONONE_ENDPOINT"] || "https://example.talon.one"
+        )
+        @endpoint.path = @endpoint.path.sub(/\/+$/, '')
+        @http = Net::HTTP.new(@endpoint.host, @endpoint.port)
+        @http.use_ssl = @endpoint.scheme == "https"
+
+        @application_id = config[:application_id] || ENV["TALONONE_APP_ID"]
+        @application_key = [config[:application_key] || ENV["TALONONE_APP_KEY"]].pack('H*')
+      end
+
+      def request(method, path, payload = nil, result = TalonOne::Integration::RuleEngineResult)
+        req = Net::HTTP.const_get(method).new(@endpoint.path + path)
+        req.body = Oj.dump payload, oj_options(:compat)
+        signature = OpenSSL::HMAC.hexdigest(OpenSSL::Digest.new('md5'), @application_key, req.body)
+
+        req['Content-Type'] = 'application/json'
+        req['Content-Signature'] = "signer=#{@application_id}; signature=#{signature}"
+
+        res = @http.request(req)
+
+        if res.code[0] == '2'
+          result.new(Oj.load(res.body, oj_options(:strict)))
+        else
+          raise "#{method.upcase} #{path} -> #{res.code} #{res.body}"
+        end
+      end
+
+      def track_event(session_id, event_type, value)
+        request "Post", "/v1/events", { sessionId: session_id, type: event_type, attributes: value }
+      end
+
+      def update_customer_session(session_id, data)
+        request "Put", "/v1/customer_sessions/#{session_id}", data
+      end
+
+      def update_customer_profile(profile_id, data)
+        request "Put", "/v1/customer_profiles/#{profile_id}", data
+      end
+
+      def close_customer_session(session_id)
+        update_customer_session session_id, { state: "closed" }
+      end
+
+      def create_referral_code(campaign_id, advocate_profile_id, friend_id: "", start: nil, expire: nil)
+        newReferral = {
+          campaignId: campaign_id,
+          advocateProfileIntegrationId: advocate_profile_id,
+          friendProfileIntegrationId: friend_id,
+        }
+        if start
+          newReferral[:startDate] = start
+        end
+        if expire
+          newReferral[:expiryDate] = expire
+        end
+        request "Post", "/v1/referrals", newReferral, TalonOne::Integration::ReferralCode
+      end
+
+      def search_profiles_by_attributes(profileAttr)
+        request "Post", "/v1/customer_profiles_search", { attributes: profileAttr }, TalonOne::Integration::SearchProfilesResult
+      end
+
+      private
+
+      def oj_options(mode)
+        { :mode => mode,
+          :class_cache => false,
+          :escape_mode => :json,
+          :bigdecimal_as_decimal => true,
+          :bigdecimal_load => :bigdecimal }
+      end
+    end
+  end
+end

data/lib/integration/customer_profile.rb

@@ -0,0 +1,21 @@
+module TalonOne
+  module Integration
+    class CustomerProfile
+      def initialize(raw_data)
+        @raw = raw_data
+      end
+
+      def id
+        @raw["id"]
+      end
+
+      def created
+        @raw["created"]
+      end
+
+      def integration_id
+        @raw["integrationId"]
+      end
+    end
+  end
+end

data/lib/integration/effect.rb

@@ -0,0 +1,20 @@
+module TalonOne
+  module Integration
+    class Effect
+      def initialize(raw_array)
+        @campaign_id = raw_array[0]
+        @ruleset_id = raw_array[1]
+        @ruleset_index = raw_array[2]
+        @raw = raw_array[3]
+      end
+
+      def function
+        @raw[0]
+      end
+
+      def args
+        @raw[1..-1]
+      end
+    end
+  end
+end

data/lib/integration/event.rb

@@ -0,0 +1,45 @@
+require_relative './effect'
+
+module TalonOne
+  module Integration
+    class Event
+      def initialize(raw_data)
+        @raw = raw_data
+      end
+
+      def type
+        @raw["type"]
+      end
+
+      def session_id
+        @raw["sessionId"]
+      end
+
+      def attributes
+        @raw["attributes"]
+      end
+
+      def effects
+        @effects ||= @raw["effects"].map do |raw_array|
+          TalonOne::Integration::Effect.new raw_array
+        end
+      end
+
+      def accepted_coupon?
+        effects.any? {|e| e.function == "acceptCoupon"}
+      end
+
+      def rejected_coupon?
+        !accepted_coupon? && effects.any? {|e| e.function == "rejectCoupon"}
+      end
+
+      def accepted_referral?
+        effects.any? {|e| e.function == "acceptReferral"}
+      end
+
+      def rejected_referral?
+        !accepted_referral? && effects.any? {|e| e.function == "rejectReferral"}
+      end
+    end
+  end
+end

data/lib/integration/referral_code.rb

@@ -0,0 +1,49 @@
+module TalonOne
+  module Integration
+    class ReferralCode
+      def initialize(raw_data)
+        @raw = raw_data
+      end
+
+      def id
+        @raw["id"]
+      end
+
+      def campaign_id
+        @raw["campaignId"]
+      end
+
+      def created
+        @raw["created"]
+      end
+
+      def advocate_id
+        @raw["advocateProfileIntegrationId"]
+      end
+
+      def code
+        @raw["code"]
+      end
+
+      def friend_id
+        @raw["friendProfileIntegrationId"]
+      end
+
+      def start_date
+        @raw["startDate"]
+      end
+
+      def expiry_date
+        @raw["expiryDate"]
+      end
+
+      def usage_count
+        @raw["usageCount"]
+      end
+
+      def usage_limit
+        @raw["usageLimit"]
+      end
+    end
+  end
+end

data/lib/integration/rule_engine_result.rb

@@ -0,0 +1,23 @@
+require_relative './event'
+
+module TalonOne
+  module Integration
+    class RuleEngineResult
+      def initialize(raw_data)
+        @raw = raw_data
+      end
+
+      def session
+        @raw["session"]
+      end
+
+      def profile
+        @raw["profile"]
+      end
+
+      def event
+        @event ||= TalonOne::Integration::Event.new(@raw["event"])
+      end
+    end
+  end
+end

data/lib/integration/search_profiles_result.rb

@@ -0,0 +1,17 @@
+require_relative './customer_profile'
+
+module TalonOne
+  module Integration
+    class SearchProfilesResult
+      def initialize(raw_data)
+        @raw = raw_data
+      end
+
+      def profiles
+        @profiles ||= @raw["data"].map do |raw_array|
+          TalonOne::Integration::CustomerProfile.new raw_array
+        end
+      end
+    end
+  end
+end

data/lib/management/client.rb

@@ -0,0 +1,69 @@
+module TalonOne
+  module Management
+    # Basic REST client for the TalonOne management API
+    class Client
+      def initialize(config = {})
+        @endpoint = URI(
+          config[:endpoint] || ENV["TALONONE_ENDPOINT"] || "https://app.talon.one"
+        )
+        @endpoint.path = @endpoint.path.sub(/\/+$/, '')
+        @http = Net::HTTP.new(@endpoint.host, @endpoint.port)
+        @http.use_ssl = true
+        @token = ENV["TALONONE_SESSION_TOKEN"]
+        if !@token
+          email = config[:email] || ENV["TALONONE_EMAIL"]
+          password = config[:password] || ENV["TALONONE_PASSWORD"]
+          if email && password
+            login(email, password)
+          end
+        end
+      end
+
+      def login(email, password) 
+        res = request "Post", "/v1/sessions", {"email" => email, "password" => password}
+        @token = res["token"]
+      end
+
+      def request(method, path, payload = nil)
+        req = Net::HTTP.const_get(method).new(@endpoint.path + path)
+        if @token
+          req["Authorization"] = "Bearer #{@token}"
+        end
+        if payload
+          req.body = payload.to_json
+          req['Content-Type'] = 'application/json'
+        end
+        res = @http.request(req)
+        if res.code[0] == '2'
+          res.body && JSON.parse(res.body)
+        else
+          raise "#{method.upcase} #{path} -> #{res.code} #{res.body}"
+        end
+      end
+
+      def get(path)
+        request "Get", path
+      end
+
+      def put(path, payload)
+        request "Put", path, payload
+      end
+
+      def post(path, payload)
+        request "Post", path, payload
+      end
+
+      def delete(path)
+        request "Delete", path
+      end
+
+      def create_application(params)
+        post "/v1/applications", params
+      end
+
+      def delete_application(application)
+        delete "/v1/applications/#{application["id"]}"
+      end
+    end
+  end
+end

data/lib/talon_one.rb

@@ -0,0 +1,7 @@
+require 'net/http'
+require 'json'
+require_relative './management/client.rb'
+require_relative './integration/client.rb'
+
+module TalonOne
+end

data/talon_one.gemspec

@@ -0,0 +1,16 @@
+Gem::Specification.new do |s|
+  s.name = 'talon_one'
+  s.version = '0.0.5'
+  s.date = '2017-03-06'
+  s.summary = 'Client for the Talon.One API'
+  s.description = 'A simple client for using the Talon.One API'
+  s.authors = ['Stephen Sugden']
+  s.email = 'stephen@talon.one'
+  s.files = `git ls-files`.split("\n")
+  s.require_paths = ['lib']
+  s.homepage = 'https://github.com/talon-one/talon-one.rb'
+  s.license = 'MIT'
+  s.add_runtime_dependency 'oj', '~> 2.17'
+  s.add_development_dependency 'rake', '~> 12.0.0'
+  s.add_development_dependency 'minitest', '~> 5.10.1'
+end

data/test/test_helper.rb

@@ -0,0 +1,20 @@
+require 'minitest/autorun'
+require 'talon_one'
+
+class LiveApiTest < Minitest::Test
+  def integration_config
+    {}
+  end
+
+  def integration_client
+    @integration_client ||= TalonOne::Integration::Client.new integration_config
+  end
+
+  def management_config
+    {}
+  end
+
+  def management_client
+    @management_client ||= TalonOne::Management::Client.new management_config
+  end
+end

data/test/test_integration_api_live.rb

@@ -0,0 +1,52 @@
+class TestIntegrationApiLive < LiveApiTest
+  def setup
+    @app = management_client.create_application(
+      name: "Ruby SDK Test App",
+      key: "fefecafedeadbeef",
+      currency: "USD",
+      timezone: "UTC"
+    )
+    @campaign = management_client.post "/v1/applications/#{@app["id"]}/campaigns", { name: "Test Campaign", state: 'disabled', tags: [], limits: [] }
+    @ruleset = management_client.post "/v1/applications/#{@app["id"]}/campaigns/#{@campaign["id"]}/rulesets", rules: [{
+      title: "Free money for all!",
+      condition: ["and", true],
+      effects: [
+        ["setDiscount", "Free money", 45.55]
+      ]
+    }]
+    @campaign["activeRulesetId"] = @ruleset["id"]
+    @campaign["state"] = "enabled"
+    management_client.put "/v1/applications/#{@app["id"]}/campaigns/#{@campaign["id"]}", @campaign
+  end
+
+  def teardown
+    management_client.delete_application @app
+  end
+
+  def integration_config
+    { application_id: @app["id"], application_key: @app["key"] }
+  end
+
+  def test_track_event
+    res = integration_client.track_event "a-session", "Viewed Page", { URL: "http://example.com" }
+    assert res.profile
+    assert res.session
+    assert_instance_of TalonOne::Integration::Event, res.event
+    assert !res.event.rejected_coupon?, "No coupon -> no rejectCoupon effect"
+    assert !res.event.accepted_coupon?, "No coupon -> no acceptCoupon effect"
+    assert_equal 1, res.event.effects.length
+    assert_equal "setDiscount", res.event.effects[0].function
+    assert_equal "Viewed Page", res.event.type
+    assert_equal "a-session", res.event.session_id, "a-session"
+    assert_equal({ "URL" => "http://example.com" }, res.event.attributes)
+    assert_instance_of BigDecimal, res.session["discounts"]["Free money"]
+  end
+
+  def test_update_customer_session
+    res = integration_client.update_customer_session "new-session", {
+      coupon: "invalid coupon code",
+      total: BigDecimal.new("45.55"),
+    }
+    assert res.event.rejected_coupon?, "invalid coupon code was rejected"
+  end
+end

data/test/test_integration_params.rb

@@ -0,0 +1,23 @@
+class TestIntegrationParams < Minitest::Test
+  def setup
+    @old_env_vars = ENV.keys.grep(/^TALONONE/).reduce({}) {|h, k| h.update(k => ENV.delete(k))}
+  end
+
+  def teardown
+    ENV.update(@old_env_vars)
+  end
+
+  def test_initialize_parameter_normalization
+    client = TalonOne::Integration::Client.new(
+      endpoint: "https://this.will.have.no.trailing.slashes////",
+      application_id: "1234",
+      application_key: "blah"
+    )
+
+    normalized_endpoint = client.instance_eval do
+      @endpoint.to_s
+    end
+
+    assert_equal normalized_endpoint, "https://this.will.have.no.trailing.slashes"
+  end
+end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: talon_one
+version: !ruby/object:Gem::Version
+  version: 0.0.5
+platform: ruby
+authors:
+- Stephen Sugden
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-03-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: oj
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.17'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 12.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 12.0.0
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.10.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.10.1
+description: A simple client for using the Talon.One API
+email: stephen@talon.one
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- README.md
+- Rakefile
+- lib/integration/client.rb
+- lib/integration/customer_profile.rb
+- lib/integration/effect.rb
+- lib/integration/event.rb
+- lib/integration/referral_code.rb
+- lib/integration/rule_engine_result.rb
+- lib/integration/search_profiles_result.rb
+- lib/management/client.rb
+- lib/talon_one.rb
+- talon_one.gemspec
+- test/test_helper.rb
+- test/test_integration_api_live.rb
+- test/test_integration_params.rb
+homepage: https://github.com/talon-one/talon-one.rb
+licenses:
+- MIT
+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: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: Client for the Talon.One API
+test_files: []