data-hoover 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6796648846e392f27d8139921022fa96605fb377
+  data.tar.gz: 142dc60836f0f3e9c7a666fb539e9a03aa20f2b8
+SHA512:
+  metadata.gz: ff4ef64569a05bac68107ebba9f71548fcc9be90eb0f5c1b731e8defd200d7ffe041b8914409ad8211b05f908cb8b65205bbfa4e73a8ac977284f057520c433b
+  data.tar.gz: 19578664eee59bd57d51dfa229ec74080a413b2778bf90e6c96b56eaa5afa01e9f1b2708731da925e48128c22ec7283cbbd0c435804c2f1fd4ea3d36c42d8be1

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.14.6

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 JobTeaser
+
+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,108 @@
+# DataHoover
+
+This gem exposes a simple API to implement event sourcing in your app.
+It comes by default with a [Segment](https://segment.com/) adapter but you
+could very well inject your own (be it [Kafka](https://kafka.apache.org/) or
+anything you can come up with).
+
+Please refer to `lib/data_hoover/bags/segment_analytics.rb` for an example.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'data-hoover'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install data-hoover
+
+## Configuration
+
+First, you have to setup the gem a little bit:
+
+``` ruby
+DataHoover.logger = Logger.new(STDOUT)
+DataHoover.traits = ->(user) { ... }
+```
+
+If you want to silence the logging, just pass in `Logger.new(nil)`.
+
+The traits lambda is used to properly qualify your users. If you do not need
+this, you can skip the configuration, as a default lambda is setup by the gem
+(spoiler: it does nothing!).
+
+We also provide you with a helper method if you want to anonymize your data:
+
+``` ruby
+DataHoover.anonymize(...)
+
+# DataHoover.anonymize(nil) => nil
+# DataHoover.anonymize('foo') => Digest::SHA256.hexdigest('foo')
+# DataHoover.anonymize(1) => Digest::SHA256.hexdigest(1.to_s)
+```
+
+In a Rails environment, you might want to put this snippet in an
+[initializer](http://guides.rubyonrails.org/configuring.html#using-initializer-files).
+
+If you want to be able to use the provided Segment adapter, you will need to
+setup an env variable with your API key:
+
+``` ruby
+ENV['SEGMENT_KEY'] = 'YOUR_SEGMENT_KEY'
+```
+
+## Usage
+
+To instantiate the client, run:
+``` ruby
+DataHoover::Nozzle.new(trackee: trackee)
+```
+
+You can additionally provide your own adapter here:
+```
+nozzle = DataHoover::Nozzle.new(trackee: trackee, bag: CustomKafkaAdapter)
+```
+
+And you can then start to send events:
+``` ruby
+event_payload = {
+  field_1: 'foo',
+  field_2: { bar: 'baz' }
+}
+nozzle.absorb('event_name', event_payload)
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run
+`rake spec` to run the tests. You can also run `bin/console` for an interactive
+prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To
+release a new version, update the version number in `version.rb`, and then run
+`bundle exec rake release`, which will create a git tag for the version, push
+git commits and tags, and push the `.gem` file to
+[rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/jobteaser/data-hoover.
+
+
+## License
+
+The gem is available as open source under the terms of the
+[MIT License](http://opensource.org/licenses/MIT).
+
+## TODO
+
+- [ ] Expose a mean to choose the anonymization implementation (and use it
+  internally as well)

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'data_hoover'
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/data-hoover.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'data_hoover/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'data-hoover'
+  spec.version       = DataHoover::VERSION
+  spec.authors       = ['Thomas Larrieu', 'Bryan Frimin']
+  spec.email         = %w(thomas.larrieu@gmail.com friminb@gmail.com)
+
+  spec.summary       = 'Event sourcing for human beings'
+  spec.description   = 'This gem exposes a simple API to implement event' \
+    'sourcing in your app.'
+  spec.homepage      = 'https://github.com/jobteaser/data-hoover'
+  spec.license       = 'MIT'
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = %w(lib)
+
+  spec.add_development_dependency 'bundler', '~> 1.14'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.5'
+  # TODO: this should be an optional dependency (segment)
+  spec.add_dependency 'analytics-ruby'
+end

data/lib/data_hoover.rb

@@ -0,0 +1,27 @@
+require 'data_hoover/version'
+
+require 'digest'
+require 'logger'
+
+require 'segment/analytics'
+
+require 'data_hoover/nozzle'
+require 'data_hoover/bags/segment_analytics'
+
+module DataHoover
+  class << self
+
+    attr_accessor :logger, :traits
+
+    def anonymize(entry)
+      return if entry.nil?
+      Digest::SHA256.hexdigest(entry.to_s)
+    end
+
+    alias anon anonymize
+
+  end
+
+  self.logger = Logger.new(STDOUT)
+  self.traits = ->(_) { {} }
+end

data/lib/data_hoover/bags/segment_analytics.rb

@@ -0,0 +1,35 @@
+module DataHoover
+  module Bags
+    class SegmentAnalytics
+
+      class << self
+
+        def tag(trackee_id:, traits:)
+          client.identify(
+            user_id: trackee_id,
+            traits: traits
+          )
+        end
+
+        def wrap(trackee_id:, event:, properties:)
+          client.track(
+            user_id: trackee_id,
+            event: event,
+            properties: properties
+          )
+        end
+
+        private
+
+        def client
+          Segment::Analytics.new(
+            write_key: ENV.fetch('SEGMENT_KEY'),
+            on_error: ->(_status, msg) { DataHoover.logger.error(msg) }
+          )
+        end
+
+      end
+
+    end
+  end
+end

data/lib/data_hoover/nozzle.rb

@@ -0,0 +1,29 @@
+module DataHoover
+  class Nozzle
+
+    def initialize(trackee:, bag: DataHoover::Bags::SegmentAnalytics)
+      @trackee = trackee
+      @bag = bag
+    end
+
+    def absorb(event, props={})
+      @bag.tag(
+        trackee_id: DataHoover.anon(@trackee.id),
+        traits: traits
+      )
+      @bag.wrap(
+        trackee_id: DataHoover.anon(@trackee.id),
+        event: event,
+        properties: props
+      )
+    end
+
+    private
+
+    def traits
+      trackee_traits = DataHoover.traits.call(@trackee)
+      Hash(trackee_traits).reject { |_key, value| value.nil? }
+    end
+
+  end
+end

data/lib/data_hoover/version.rb

@@ -0,0 +1,3 @@
+module DataHoover
+  VERSION = '0.1.0'.freeze
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: data-hoover
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Thomas Larrieu
+- Bryan Frimin
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-05-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.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: analytics-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: This gem exposes a simple API to implement eventsourcing in your app.
+email:
+- thomas.larrieu@gmail.com
+- friminb@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- data-hoover.gemspec
+- lib/data_hoover.rb
+- lib/data_hoover/bags/segment_analytics.rb
+- lib/data_hoover/nozzle.rb
+- lib/data_hoover/version.rb
+homepage: https://github.com/jobteaser/data-hoover
+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.4.5.1
+signing_key: 
+specification_version: 4
+summary: Event sourcing for human beings
+test_files: []