plainflow 2.2.3.pre.p1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b6e2315b3be8977b60b4d7d243a036dd8c63ed26
+  data.tar.gz: dc97871f225b43d807381038a4eacd35f241fa74
+SHA512:
+  metadata.gz: 7a58bc89eeaa8d56162e22275ef0e783413a7acb8f13a0e603c78cd8085a3273d045ebc6dd9efbe0bdd689bb449c4651902b632aff47a22906cc8ec36067847d
+  data.tar.gz: 512272c46c847efc3947528def02990e22a1c8cc2b25db5e53e2ba17fde0252a09f91e96c6e595adec32e4c2cc810d2fed1e1f896848c4ff61a04ab5ae044473

data/Gemfile

@@ -0,0 +1,2 @@
+source 'http://rubygems.org'
+gemspec

data/History.md

@@ -0,0 +1,200 @@
+2.2.3.pre.p1 / 2017-10-24
+==================
+
+  * The library has been forked to work with Plainflow.
+
+2.2.3.pre / 2017-09-14
+==================
+
+  * [Fix](https://github.com/segmentio/analytics-ruby/pull/120): Override `respond_to_missing` instead of `respond_to?` to facilitate mock the library in tests.
+
+
+2.2.2 / 2016-08-03
+==================
+
+  * adding commander as dep (for CLI)
+
+2.2.1 / 2016-08-03
+==================
+
+  * add executables to spec
+
+2.2.0 / 2016-08-03
+==================
+
+ * Adding an (experimental) CLI
+
+2.1.0 / 2016-06-17
+==================
+
+ * Fix: Ensure error handler is called before Client#flush finishes.
+ * Feature: Support setting a custom message ID.
+
+2.0.13 / 2015-09-15
+==================
+
+ * readme: updated install docs
+ * fix: page/screen to allow no name
+ * git: ignore ruby version
+ * travis-ci: remove old rubys
+
+2.0.12 / 2015-01-10
+==================
+
+ * Fix batch being cleared and causing duplicates
+
+2.0.11 / 2014-09-22
+==================
+
+ * fix: don't clear batch if request failed
+
+2.0.10 / 2014-09-22
+==================
+
+ * Move timeout retry above output
+
+2.0.9 / 2014-09-22
+==================
+
+ * Fix rescuing timeouts
+
+2.0.8 / 2014-09-11
+==================
+* fix: add 3 ms to timestamp
+
+2.0.7 / 2014-08-27
+==================
+* fix: include optional options hash in calls
+
+2.0.6 / 2014-08-12
+==================
+* fix: category param on #page and #screen
+
+2.0.5 / 2014-05-26
+==================
+* fix: datetime conversions
+
+2.0.4 / 2014-06-11
+==================
+* fix: isofying trait dates in #group
+
+2.0.3 / 2014-06-04
+==================
+* fix: undefined method `is_requesting?' for nil:NilClass when calling flush (#51)
+
+2.0.2 / 2014-05-30
+==================
+* fix: formatting ios dates
+* fix: respond_to? implementation
+* add: able to stub requests by setting STUB env var
+
+2.0.1 / 2014-05-15
+==================
+* add: namespace under Segment::Analytics
+* add: can create multiple instances with creator method (rather than
+    having a singleton)
+* add: logging with Logger instance or Rails.logger if available
+* add: able to stub requests so they just log and don't hit the server
+* fix: worker continues running across forked processes
+* fix: removed usage of ActiveSupport methods since its not a dependency
+* fix: sending data that matches segment's new api spec
+
+(there is no v2.0.0)
+
+1.1.0 / 2014-04-17
+==================
+* adding .initialized? by [@lumberj](https://github.com/lumberj)
+
+1.0.0 / 2014-03-12
+==================
+* removing faraday dependency
+
+0.6.0 / 2014-02-19
+==================
+* adding .group(), .page(), and .screen() calls
+* relaxing faraday dependency, fixes #31
+
+0.5.4 / 2013-12-31
+==================
+* Add `requestId` fields to all requests for tracing.
+
+0.5.3 / 2013-12-31
+==================
+* Allow the consumer thread to shut down so it won't remain live in hot deploy scenarios. This fixes the jruby memory leak by [@nirvdrum](https://github.com/nirvdrum)
+
+0.5.2 / 2013-12-02
+==================
+* adding `sleep` backoff between connection retries
+
+0.5.1 / 2013-11-22
+==================
+* adding retries for connection hangups
+
+0.5.0 / 2013-10-03
+==================
+* Removing global Analytics constant in favor of adding it to our config. NOTE: If you are upgrading from a previous version and want to continue using the `Analytics` namespace, you'll have to add `Analytics = AnalyticsRuby` to your config. Otherwise you WILL NOT be sending analytics data. See the [setup docs for more info](https://segment.io/libraries/ruby)
+
+0.4.0 / 2013-08-30
+==================
+* Adding support and tests for 1.8.7
+
+0.3.4 / 2013-08-26
+==================
+* Pass `Time` values as iso8601 timestamp strings
+
+0.3.3 / 2013-08-02
+==================
+* Allow init/track/identify/alias to accept strings as keys. by [@shipstar](https://github.com/shipstar)
+
+0.3.2 / 2013-05-28
+==================
+* Adding faraday timeout by [@yanchenyun](https://github.com/yangchenyun)
+
+0.3.1 / 2013-04-29
+==================
+* Adding check for properties to be a Hash
+
+0.3.0 / 2013-04-05
+==================
+* Adding alias call
+
+0.2.0 / 2013-03-21
+==================
+* Adding flush method
+
+0.1.4 / 2013-03-19
+==================
+* Adding ClassMethods for more extensibility by [arronmabrey](https://github.com/arronmabrey)
+
+0.1.3 / 2013-03-19
+==================
+* Fixing user_id.to_s semantics, reported by [arronmabrey](https://github.com/arronmabrey)
+* Reduced faraday requirements by [arronmabrey](https://github.com/arronmabrey)
+
+0.1.2 / 2013-03-11
+==================
+* Fixing thrown exception on non-initialized tracks thanks to [sbellity](https://github.com/sbellity)
+
+0.1.1 / 2013-02-11
+==================
+* Updating dependencies
+* Adding actual support for MultiJson 1.0
+
+0.1.0 / 2013-01-22
+==================
+* Updated docs to point at segment.io
+
+0.0.5 / 2013-01-21
+==================
+* Renaming of all the files for proper bundling usage
+
+0.0.4 / 2013-01-17
+==================
+* Updated readme and install instruction courtesy of [@zeke](https://github.com/zeke)
+* Removed typhoeus and reverted to default adapter
+* Removing session_id in favor of a single user_id
+
+0.0.3 / 2013-01-16
+==================
+* Rakefile and renaming courtesy of [@kiennt](https://github.com/kiennt)
+* Updated tests with mocks

data/Makefile

@@ -0,0 +1,11 @@
+
+clean:
+	rm -f plainflow*.gem
+
+test:
+	rake spec
+
+build:
+	gem build ./plainflow-ruby.gemspec
+
+.PHONY: test build

data/README.md

@@ -0,0 +1,66 @@
+Plainflow-ruby
+==============
+
+[![Build Status](https://travis-ci.org/plainflow-dcp/plainflow-ruby.png?branch=master)](https://travis-ci.org/plainflow-dcp/plainflow-ruby)
+
+Plainflow-ruby is a ruby client for [Plainflow](https://www.plainflow.com)
+
+## Install
+
+Into Gemfile from rubygems.org:
+```ruby
+gem 'plainflow', require: "plainflow"
+```
+
+Into environment gems from rubygems.org:
+```ruby
+gem install 'plainflow'
+```
+
+## Usage
+
+Create an instance of the Plainflow Analytics object:
+```ruby
+plainflow = Plainflow::Analytics.new(secret_key: 'YOUR_SECRET_KEY')
+```
+
+Identify the user for the people section:
+```ruby
+plainflow.identify(user_id: 42,
+                   traits: {
+                     email: 'name@example.com',
+                     first_name: 'Foo',
+                     last_name: 'Bar'
+                   })
+```
+
+Track a user event.
+```ruby
+plainflow.track(user_id: 42, event: 'Created Account')
+```
+
+There are a few calls available, please check the documentation section.
+
+## Documentation
+
+Documentation is available at [www.plainflow.com/docs/developers/sdk/ruby](https://www.plainflow.com/docs/developers/sdk/ruby)
+
+## Testing
+
+You can use the `stub` option to Plainflow::Analytics.new to cause all requests to be stubbed, making it easier to test with this library.
+
+## License
+
+
+(The MIT License)
+
+Copyright (c) 2013 Segment Inc. <friends@segment.com>
+
+Copyright (c) 2017 Plainflow, Inc. <friends@plainflow.com>
+
+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/RELEASING.md

@@ -0,0 +1,10 @@
+Releasing
+=========
+
+ 1. Verify everything works with `make test build`.
+ 2. Bump version in [`version.rb`](https://github.com/plainflow-dcp/plainflow-ruby/blob/master/lib/plainflow/analytics/version.rb).
+ 3. Update [`History.md`](https://github.com/segmentio/analytics-ruby/blob/master/History.md).
+ 4. Commit and tag `git commit -am "Release {version}" && git tag -a {version} -m "Version {version}"`.
+ 5. Build the gem with the tagged version `make build`.
+ 6. Upload to RubyGems with `gem push analytics-ruby-{version}.gem`.
+ 7. Upload to Github with `git push -u origin master && git push --tags`.

data/Rakefile

@@ -0,0 +1,7 @@
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+end
+
+task :default => :spec

data/bin/plainflow

@@ -0,0 +1,152 @@
+#!/usr/bin/env ruby
+
+require 'plainflow/analytics'
+require 'rubygems'
+require 'commander/import'
+require 'time'
+require 'json'
+
+program :name, 'simulator.rb'
+program :version, '0.0.1'
+program :description, 'scripting simulator'
+
+# use an env var for write key, instead of a flag
+Analytics = Segment::Analytics.new({
+  secret_key: ENV['PLAINFLOW_SECRET_KEY'],
+  on_error: Proc.new { |status, msg| print msg }
+})
+
+def toObject(str)
+  return JSON.parse(str)
+end
+
+# high level
+# analytics <method> [options]
+# PLAINFLOW_SECRET_KEY=<secret_key> ./analytics.rb <method> [options]
+# PLAINFLOW_SECRET_KEY=<secret_key> ./analytics.rb track --event testing --user 1234 --anonymous 567 --properties '{"hello": "goodbye"}' --context '{"slow":"poke"}'
+
+
+
+# track
+command :track do |c|
+  c.description = 'track a user event'
+  c.option '--user <id>', String, 'the user id to send the event as'
+  c.option '--event <event>', String, 'the event name to send with the event'
+  c.option '--anonymous <id>', String, 'the anonymous user id to send the event as'
+  c.option '--properties <data>', 'the event properties to send (JSON-encoded)'
+  c.option '--context <data>', 'additional context for the event (JSON-encoded)'
+
+  c.action do |args, options|
+    Analytics.track({
+      user_id: options.user,
+      event: options.event,
+      anonymous_id: options.anonymous,
+      properties: toObject(options.properties),
+      context: toObject(options.context)
+       })
+    Analytics.flush
+  end
+
+end
+
+# page
+command :page do |c|
+  c.description = 'track a page view'
+  c.option '--user <id>', String, 'the user id to send the event as'
+  c.option '--anonymous <id>', String, 'the anonymous user id to send the event as'
+  c.option '--name <name>', String, 'the page name'
+  c.option '--properties <data>', 'the event properties to send (JSON-encoded)'
+  c.option '--context <data>', 'additional context for the event (JSON-encoded)'
+  c.option '--category <category>', 'the category of the page'
+  c.action do |args, options|
+    Analytics.page({
+      user_id: options.user,
+      anonymous_id: options.anonymous,
+      name: options.name,
+      properties: toObject(options.properties),
+      context: toObject(options.context),
+      category: options.category
+       })
+    Analytics.flush
+  end
+
+end
+
+# identify
+command :identify do |c|
+  c.description = 'identify a user'
+  c.option '--user <id>', String, 'the user id to send the event as'
+  c.option '--anonymous <id>', String, 'the anonymous user id to send the event as'
+  c.option '--traits <data>', String, 'the user traits to send (JSON-encoded)'
+  c.option '--context <data>', 'additional context for the event (JSON-encoded)'
+  c.action do |args, options|
+    Analytics.identify({
+      user_id: options.user,
+      anonymous_id: options.anonymous,
+      traits: toObject(options.traits),
+      context: toObject(options.context)
+       })
+    Analytics.flush
+  end
+
+end
+
+# screen
+command :screen do |c|
+  c.description = 'track a screen view'
+  c.option '--user <id>', String, 'the user id to send the event as'
+  c.option '--anonymous <id>', String, 'the anonymous user id to send the event as'
+  c.option '--name <name>', String, 'the screen name'
+  c.option '--properties <data>', String, 'the event properties to send (JSON-encoded)'
+  c.option '--context <data>', 'additional context for the event (JSON-encoded)'
+  c.action do |args, options|
+    Analytics.identify({
+      user_id: options.user,
+      anonymous_id: options.anonymous,
+      name: option.name,
+      traits: toObject(options.traits),
+      properties: toObject(option.properties),
+      context: toObject(options.context)
+       })
+    Analytics.flush
+  end
+
+end
+
+
+# group
+command :group do |c|
+  c.description = 'identify a group of users'
+  c.option '--user <id>', String, 'the user id to send the event as'
+  c.option '--anonymous <id>', String, 'the anonymous user id to send the event as'
+  c.option '--group <id>', String, 'the group id to associate this user with'
+  c.option '--traits <data>', String, 'attributes about the group (JSON-encoded)'
+  c.option '--context <data>', 'additional context for the event (JSON-encoded)'
+  c.action do |args, options|
+    Analytics.group({
+      user_id: options.user,
+      anonymous_id: options.anonymous,
+      group_id: options.group,
+      traits: toObject(options.traits),
+      context: toObject(options.context)
+       })
+    Analytics.flush
+  end
+
+end
+
+# alias
+command :alias do |c|
+  c.description = 'remap a user to a new id'
+  c.option '--user <id>', String, 'the user id to send the event as'
+  c.option '--previous <id>', String, 'the previous user id (to add the alias for)'
+  c.action do |args, options|
+    Analytics.alias({
+      user_id: options.user,
+      previous_id: options.previous
+       })
+    Analytics.flush
+  end
+
+end
+