forwardlytics 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 33b629b94546b4d59f6c2c9c06a4b185313e424f
+  data.tar.gz: 6b8e1abdb7023b0e39ad150f2dc90c2dc00ba45e
+SHA512:
+  metadata.gz: 88a1a72f85edc82013574cb4edfafc9fd9708ad05d4db2861f5d1368e27fb0d8e8d200fe3dee70a2e43762bf9fbfcd7aeed105bb8ac6339dbc231bc07ee2964d
+  data.tar.gz: 97f8ea860f5be91931dfdfdd842a36bf6c31676a9a5fe283e8cc12122be80a83ca5f90d8ca6273ef28dd269456a4dbd75f23da305cb697dcb3d471aaf2c69def

data/.gitignore

@@ -0,0 +1,37 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+/Gemfile.lock
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 2.3.1
+  - 2.2
+  - 2.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in forwardlytics.gemspec
+gemspec
+
+gem 'pry'

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Jean-Philippe Boily
+
+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,97 @@
+# Forwardlytics: the Ruby client
+
+<p align="center">
+  <img src="https://s3.amazonaws.com/forwardlytics-assets/logo-color.svg">
+</p>
+
+Sends stuff to [Forwardlytics](https://github.com/jipiboily/forwardlytics).
+
+Where are we at? What needs to be done and what's in the pipeline? See [Forawrdlytics on waffle.io][forwardlytics-ruby-on-waffle]
+
+[![Build Status](https://travis-ci.org/jipiboily/forwardlytics-ruby.svg?branch=master)](https://travis-ci.org/jipiboily/forwardlytics-ruby)
+[![Stories in Progress](https://badge.waffle.io/jipiboily/forwardlytics-ruby.svg?label=In%20Progress&title=In%20Progress)](http://waffle.io/jipiboily/forwardlytics-ruby)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'forwardlytics'
+```
+
+And then execute:
+
+    $ bundle
+
+## How to use it?
+
+
+### Setup
+
+You need to set both `FORWARDLYTICS_API_KEY` and `FORWARDLYTICS_URL` environment variables.
+
+`FORWARDLYTICS_API_KEY` is the API key you configured on [Forwardlytics](https://github.com/jipiboily/forwardlytics).
+
+`FORWARDLYTICS_URL` is the URL to reach your instance of [Forwardlytics](https://github.com/jipiboily/forwardlytics).
+
+Example:
+
+```
+FORWARDLYTICS_API_KEY=123ma
+FORWARDLYTICS_URL=http://localhost:3000
+```
+
+### Exception handler
+
+Forwardlytics will do its work in threads, so if any exception is raised, it will be silent. We don't want that, so we made an exception handler. Here is how you could configure it in your project:
+
+```ruby
+Forwardlytics.exception_handler = -> (ex) {
+  puts "Exception in Forwardlytics caught by exception_handler: #{ex}"
+  Bugsnag.notify(ex)
+}
+```
+
+### Dispatch events and identifications
+
+For user identification:
+
+```ruby
+Forwardlytics.identify(
+  user_id: 42,
+  traits: {
+    email: 'john@example.com',
+    created_at: 1462183499,
+    some: 'thing?'
+  }
+)
+```
+
+For event tracking:
+
+```ruby
+Forwardlytics.track(
+  event: 'Updated Alert',
+  user_id: 42,
+  properties: {
+    some_id: 123,
+    some_other_prop: "",
+})
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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/jipiboily/forwardlytics. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+[forwardlytics-ruby-on-waffle]: https://waffle.io/jipiboily/forwardlytics-ruby

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+
+begin
+  require 'rspec/core/rake_task'
+  # Set default Rake task to spec
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError => ex
+  # That's ok, it just means we don't have RSpec loaded
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "forwardlytics"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+require "pry"
+Pry.start
+
+# require "irb"
+# IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/forwardlytics.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'forwardlytics/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "forwardlytics"
+  spec.version       = Forwardlytics::VERSION
+  spec.authors       = ["JP Boily"]
+  spec.email         = ["j@jipi.ca"]
+
+  spec.summary       = %q{This is a client for Forwardlytics.}
+  spec.description   = %q{This is a client for Forwardlytics (https://github.com/jipiboily/forwardlytics). Takes event in and forwards them to various providers, mostly analytics providers.}
+  spec.homepage      = "https://github.com/jipiboily/forwardlytics"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", ">= 3.4.0"
+  spec.add_development_dependency "webmock", ">= 2.0.0"
+  spec.add_development_dependency "timecop", ">= 0.8.0"
+end

data/lib/forwardlytics.rb

@@ -0,0 +1,49 @@
+require 'forwardlytics/version'
+require 'forwardlytics/identify'
+require 'forwardlytics/track'
+require 'json'
+
+FORWARDLYTICS_API_KEY = ENV.fetch('FORWARDLYTICS_API_KEY')
+FORWARDLYTICS_URL = ENV.fetch('FORWARDLYTICS_URL')
+
+module Forwardlytics
+  class NetException < StandardError
+  end
+
+  def self.post(uri, params)
+    begin
+      # Forces the user_id to be a string, which is the expected format by Forwardlytics (the server part)
+      params[:userID] = params[:userID].to_s unless params[:userID].nil?
+
+      full_url = URI("#{FORWARDLYTICS_URL}#{uri}")
+      http = Net::HTTP.new(full_url.host, full_url.port)
+      if full_url.port == 443
+        http.use_ssl = true
+        http.verify_mode = OpenSSL::SSL::VERIFY_PEER
+      end
+      req = Net::HTTP::Post.new(full_url, initheader = {'Content-Type' =>'application/json'})
+      req['Forwardlytics-Api-Key'] = FORWARDLYTICS_API_KEY
+      req.body = params.to_json
+      res = http.request(req)
+
+      case res
+      when Net::HTTPSuccess, Net::HTTPRedirection
+        # OK
+      else
+        raise NetException, "Potential problem posting to Forwardlytics (#{full_url}) - #{res.inspect} - #{res.code} - #{res.body}"
+      end
+    rescue Exception => ex
+      exception_handler(ex)
+    end
+  end
+
+  def self.exception_handler=(handler)
+    @exception_handler = handler
+  end
+
+  def self.exception_handler(ex)
+    if @exception_handler
+      @exception_handler.call(ex)
+    end
+  end
+end

data/lib/forwardlytics/identify.rb

@@ -0,0 +1,11 @@
+module Forwardlytics
+  def self.identify(user_id:, traits: {})
+    params = {
+      userID: user_id,
+      userTraits: traits,
+      timestamp: Time.now().to_i
+    }
+
+    t = Thread.new { post('/identify', params) }
+  end
+end

data/lib/forwardlytics/track.rb

@@ -0,0 +1,12 @@
+module Forwardlytics
+  def self.track(event:, user_id:, properties: {})
+    params = {
+      name: event,
+      userID: user_id,
+      properties: properties,
+      timestamp: Time.now().to_i
+    }
+
+    t = Thread.new { post('/track', params) }
+  end
+end

data/lib/forwardlytics/version.rb

@@ -0,0 +1,3 @@
+module Forwardlytics
+  VERSION = "1.0.0"
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: forwardlytics
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- JP Boily
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-03-23 00:00:00.000000000 Z
+dependencies:
+- !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.4.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.4.0
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+description: This is a client for Forwardlytics (https://github.com/jipiboily/forwardlytics).
+  Takes event in and forwards them to various providers, mostly analytics providers.
+email:
+- j@jipi.ca
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- forwardlytics.gemspec
+- lib/forwardlytics.rb
+- lib/forwardlytics/identify.rb
+- lib/forwardlytics/track.rb
+- lib/forwardlytics/version.rb
+homepage: https://github.com/jipiboily/forwardlytics
+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.6.8
+signing_key: 
+specification_version: 4
+summary: This is a client for Forwardlytics.
+test_files: []
+has_rdoc: