rack-deduce-ingest 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 92c703107085e3dc141c2d612613ec728fd9478c
+  data.tar.gz: 8266ed0df3c04529f199f8befb3cfcb50690a801
+SHA512:
+  metadata.gz: b7fcc373308d4257eea3873a3d730e2dfa7d3a3df078940fa7d573cc807cfc97ec5c0eff6c14d029f73809ded755d7cf4037e93a4014a988015ac5b3963108d9
+  data.tar.gz: dbb86d40fc0ab16b52b88d4d52204f131acb20018666ebc814903e1c51664e4bb96395a0789af1fcbded6f6e49a56f95f5c57618bb27e892d7666f27d8ce074b

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rack-deduce-ingest.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Solve Media Inc.
+
+MIT License
+
+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.md

@@ -0,0 +1,82 @@
+# Rack::Deduce::Ingest
+
+Rack middleware for Deduce's data ingestion API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rack-deduce-ingest'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rack-deduce-ingest
+
+## Usage
+
+### Configuration
+
+`Rack::Deduce::Ingest` requires a Site ID and apikey, provided by Deduce. If you
+have not been given one, please contact Deduce for more information.
+
+#### Rails
+
+A Railtie is included in this gem which will load the middleware automatically.
+You will need to set the middleware parameters in your app configuration:
+
+```ruby
+config.deduce_ingest.site_id = "your site id here"
+config.deduce_ingest.apikey  = "your apikey here"
+```
+
+#### Sinatra, etc.
+
+```ruby
+use Rack::Deduce::Ingest, "your site id here", { :ssl => false }
+helpers Rack::Deduce::Ingest::Helpers
+```
+
+### Sending Data to Deduce
+
+Within your view, use the helper +deduce_ingest_html+ to include the Javascript
+collection code.
+
+```ruby
+deduce_ingest_html("user@example.com")
+```
+
+You may send an options hash if you need to override any of the configuration
+options.
+
+```ruby
+deduce_ingest_html("user@example.com", ssl: false)
+```
+
+For a Rails site, be sure to mark the output as html safe.
+
+### Sending Events to Deduce
+
+Within your controller, use the helper +deduce_event_post+ to notify Deduce of events.
+
+```ruby
+deduce_event_post('marzelize', "user@example.com")
+```
+
+Depending on the event type, additional data be send by passing an additional hash.
+You should consult with Deduce support for specific parameters and event types.
+
+```ruby
+deduce_event_post('marzelize', "user@example.com", {weather: 'cloudy'})
+```
+
+
+### Best Practices
+
+ * Only pass information that you have already verified to be valid.
+
+ * Work closely with your Deduce support representative.
+

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/rack-deduce-ingest.rb

@@ -0,0 +1,2 @@
+require 'rack/deduce/ingest'
+require 'rack/deduce/ingest/railtie' if defined?(Rails::Railtie)

data/lib/rack/deduce/ingest.rb

@@ -0,0 +1,215 @@
+# -*- mode: ruby; coding: utf-8 -*-
+# Copyright (c) 2019
+# Author: Tyler Cunnion
+# Created: 2019-May-08 17:14 (EDT)
+# Function: Deduce Ingest API
+
+require "rack/deduce/ingest/version"
+require "rack/deduce/ingest/helpers"
+
+require 'json'
+require 'digest'
+require 'net/http'
+require 'openssl'
+
+module Rack
+  module Deduce
+    class Ingest
+
+      URL            = "//lore.deduce.com/p/collect"
+      EVENT_URL      = "https://event.deduce.com/p/event"    # only https
+      TIMEOUT        = 1.1
+      VERHASH        = Digest::SHA1.hexdigest("ruby/#{VERSION}")[0..16]
+
+      class << self
+        attr_accessor :site_id, :apikey, :ssl, :testmode
+
+        # @param [String] site_id The site ID provided to you by Deduce
+        # @param [String] apikey  The apikey provided to you by Deduce
+        # @param [Hash] options
+        # @option options [Boolean] :ssl (true) Use SSL?
+        def init(app, site_id, apikey, options = {})
+          @app = app
+
+          self.site_id      = site_id
+          self.apikey       = apikey
+          self.ssl          = options[:ssl]
+          self.testmode     = options[:testmode]
+          self.ssl          = ssl
+        end
+
+        def html(email, options = {})
+
+          site_id = options[:site_id] || @site_id
+          use_ssl = @ssl
+          use_ssl = options[:ssl] if options.include? :ssl
+
+          user_data = {site: site_id, vers: VERHASH}
+          user_data[:testmode] = true if options[:testmode] || @testmode
+
+          if email_valid?(email)
+            email = email.strip
+            email_lc = email.downcase
+            email_uc = email.upcase
+            user_data[:ehls1] = Digest::SHA1.hexdigest(email_lc)
+            user_data[:ehus1] = Digest::SHA1.hexdigest(email_uc)
+            user_data[:ehlm5] = Digest::MD5.hexdigest(email_lc)
+            user_data[:ehum5] = Digest::MD5.hexdigest(email_uc)
+            user_data[:ehls2] = Digest::SHA256.hexdigest(email_lc)
+            user_data[:ehus2] = Digest::SHA256.hexdigest(email_uc)
+          end
+
+          url = options[:url]
+
+          if !url
+            if use_ssl.nil?
+              url = URL
+            elsif use_ssl
+              url = 'https:' + URL
+            else
+              url = 'http:'  + URL
+            end
+          end
+
+          html = <<EOS
+<script type="text/javascript">
+var dd_info = #{JSON.pretty_generate(user_data)};
+</script>
+<script type="text/javascript" src="#{url}" async></script>
+EOS
+
+          return html
+        end
+
+        # @param [Array] event data
+        # @param [Hash] options
+        # @return [String] on error, returns an error message; or nothing on success
+        def events(evts, options = {})
+          return if limited?
+
+          site_id = @site_id
+          apikey  = @apikey
+          timeout = options[:timeout] || (TIMEOUT + evts.length / 10)
+
+          post_data  = { site: site_id, apikey: apikey, vers: VERHASH }
+          post_data[:backfill] = true if options[:backfill]
+          post_data[:testmode] = true if options[:testmode] || @testmode
+          post_data[:events]   = evts.map{ |e| fixup_event( e.dup ) }
+
+          uri  = URI(options[:url] || EVENT_URL)
+          http = Net::HTTP.new(uri.host, uri.port)
+
+          http.use_ssl = (uri.scheme == 'https')
+          http.open_timeout = timeout
+          http.read_timeout = timeout
+          http.ssl_timeout  = timeout
+
+          hreq = Net::HTTP::Post.new(uri, 'Content-Type' => 'application/json')
+          hreq.body = post_data.to_json
+
+          p post_data.to_json
+
+          begin
+            res = http.request(hreq)
+            if res.code != '200'
+              raise "#{res.code} - #{res.body}"
+            end
+          rescue => e
+            adjust_fail
+            return e
+          end
+          adjust_ok
+          # return nil on success, else return the error
+          return nil
+        end
+
+        # @param [String] email The user's email address
+        # @param [String] ip  The user's ip address
+        # @param [String] event The event type
+        # @param [Hash] additional Additional data to send
+        # @param [Hash] options
+        # @return [String] on error, returns an error message; or nothing on success
+        def event(email, ip, event, additional = {}, options = {})
+          return if limited?
+          return "invalid email" unless email_valid? email
+
+          event_data = additional.dup
+          event_data[:email] = email  # fixup will hash the email
+          event_data[:ip]    = ip
+          event_data[:event] = event
+
+          events [event_data], options
+        end
+
+        ################
+        private
+
+        def email_valid?(email)
+          return unless email
+          return if email.nil? || email.empty?
+          return email.match /.+@.+/
+        end
+
+        def fixup_event(evt)
+          # send the hash of the email, not the actual email
+          email = evt[:email]
+
+          if email_valid? email
+            email = email.strip.downcase
+            evt[:ehls1] = Digest::SHA1.hexdigest(email)
+            unless evt.has_key? :email_provider
+              # pass in an empty value for email_provider to not send
+              evt[:email_provider] = email.split(/@/)[1]
+            end
+            evt.delete :email
+          end
+
+          if email_valid? evt[:email_prev]
+            evt[:ehls1_prev] = Digest::SHA1.hexdigest(evt[:email_prev].strip.downcase)
+            evt.delete :email_prev
+          end
+
+          # hash + remove any CC
+          if evt[:cc]
+            cc = evt[:cc].gsub /[^0-9]/, ''
+            evt[:ccs1]       = Digest::SHA1.hexdigest(cc)
+            evt.delete :cc
+          end
+          return evt
+        end
+
+        # if the event post is failing - slow down
+        def adjust_ok
+          @limit -= 5.0
+          @limit = 0.0  if @limit < 0.0
+        end
+        def adjust_fail
+          @limit = (9 * @limit + 100.0) / 10
+          @limit = 100.0 if @limit > 100.0
+        end
+        def limited?
+          now = Time.now
+          @limit ||= 0.0
+          @lastt ||= now
+          dt = now - @lastt
+          @lastt = now
+          @limit *= 0.999 ** dt
+          Random.rand(100.0) < @limit
+        end
+
+      end
+
+      # @param [String] site_id The site ID provided to you by Deduce
+      # @param [String] apikey  The apikey provided to you by Deduce
+      # @param [Hash] options
+      # @option options [Boolean] :ssl (true) Use SSL?
+      def initialize(app, site_id, apikey, options = {})
+        self.class.init(app, site_id, apikey, options)
+        self.class
+      end
+
+    end
+  end
+end
+
+

data/lib/rack/deduce/ingest/helpers.rb

@@ -0,0 +1,46 @@
+# -*- mode: ruby; coding: utf-8 -*-
+# Copyright (c) 2019
+# Author: Tyler Cunnion
+# Created: 2019-May-08 17:14 (EDT)
+# Function: Deduce Ingest API
+
+
+module Rack
+  module Deduce
+    class Ingest
+      module Helpers
+
+        # Outputs the Deduce ingest Javascript code. A cookie is
+        # set indicating the user has been collected from
+        #
+        # As this helper outputs HTML tags, when used in Rails it must be
+        # marked HTML safe before being written to the page.
+        #
+        # @param [String] email The user's email address
+        # @param [Hash] options
+        # @option options [String] :site_id
+        # @option options [Boolean] :ssl
+        def deduce_ingest_html(email, options = {})
+          Rack::Deduce::Ingest.html email, options
+        end
+
+        # Sends an event to Deduce
+        #
+        # @param [String] event The event type
+        # @param [String] email The user's email address
+        # @param [Hash] additional
+        # @param [Hash] options
+        def deduce_event_post(event, email, additional = {}, options = {})
+          additional[:session_id] = session.id unless additional.has_key? :session_id
+          additional[:url]        ||= request.original_url
+          additional[:user_agent] ||= request.headers['User-Agent']
+
+          html = Rack::Deduce::Ingest.event email, request.remote_ip, event, additional, options
+          html = html.html_safe if html.respond_to :html_safe
+          html
+        end
+
+      end
+    end
+  end
+end

data/lib/rack/deduce/ingest/railtie.rb

@@ -0,0 +1,33 @@
+# -*- mode: ruby; coding: utf-8 -*-
+# Copyright (c) 2019
+# Author: Tyler Cunnion
+# Created: 2019-May-08 17:14 (EDT)
+# Function: Deduce Ingest API
+
+module Rack
+  module Deduce
+    class Ingest::Railtie < Rails::Railtie
+      config.deduce_ingest = ActiveSupport::OrderedOptions.new
+
+      initializer "rack.deduce.ingest.initializer" do |app|
+        site_id     = app.config.deduce_ingest[:site_id]
+        apikey      = app.config.deduce_ingest[:apikey]
+        ssl         = app.config.deduce_ingest[:ssl]
+
+        raise "A unique site identifier is required to use the deduce ingest API.\nContact Deduce (http://www.deduce.com) if you do not have one." unless site_id && apikey
+
+        options = {}
+        options[:ssl]         = ssl
+        options[:testmode]    = app.config.deduce_ingest[:testmode]
+
+        Rack::Deduce::Ingest.new app, site_id, apikey, options
+      end
+
+      initializer "rack.deduce.ingest.helpers" do
+        ActionView::Base.send :include, Rack::Deduce::Ingest::Helpers
+        ActionController::Base.send :include, Rack::Deduce::Ingest::Helpers
+      end
+
+    end
+  end
+end

data/lib/rack/deduce/ingest/version.rb

@@ -0,0 +1,7 @@
+module Rack
+  module Deduce
+    class Ingest
+      VERSION = "0.0.1"
+    end
+  end
+end

data/rack-deduce-ingest.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rack/deduce/ingest/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rack-deduce-ingest"
+  spec.version       = Rack::Deduce::Ingest::VERSION
+  spec.authors       = ["Tyler Cunnion", "Jeff Weisberg"]
+  spec.email         = ["support@deduce.com"]
+  spec.description   = %q{Deduce Ingest API}
+  spec.summary       = %q{Rack middleware for Deduce's Ingest API}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+
+  spec.add_dependency 'multi_json', '~> 1.10'
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: rack-deduce-ingest
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Tyler Cunnion
+- Jeff Weisberg
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-10-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+description: Deduce Ingest API
+email:
+- support@deduce.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rack-deduce-ingest.rb
+- lib/rack/deduce/ingest.rb
+- lib/rack/deduce/ingest/helpers.rb
+- lib/rack/deduce/ingest/railtie.rb
+- lib/rack/deduce/ingest/version.rb
+- rack-deduce-ingest.gemspec
+homepage: ''
+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.3
+signing_key: 
+specification_version: 4
+summary: Rack middleware for Deduce's Ingest API
+test_files: []