astronomer 2.0.14

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d463274a2d9c4d0a44f928244d36bbe6f6ace22f
+  data.tar.gz: 10244ef783c53eb830d8a207869a5f262b0dbbfb
+SHA512:
+  metadata.gz: fa6df4f342b81e25dd8393965224cb33b14e419e118ffc072c095b3e0f66befcfb70a45cbe1eb9141b0bd47b91cdad325478a090eeaed0254390360f92fd5ff2
+  data.tar.gz: 67c26e707743e9081f28e13da25d3fb7fbeadcbfb63f4ad9abcf2ebf1b0a35a5cd693b160b528300ee97c8dcefe3bb16d024ea864ed9f6d3cd5c3dc5a15f29f6

data/Gemfile

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

data/History.md

@@ -0,0 +1,160 @@
+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,8 @@
+
+test:
+	rake spec
+
+build:
+	gem build ./analytics-ruby.gemspec
+
+.PHONY: test

data/README.md

@@ -0,0 +1,91 @@
+analytics-ruby
+==============
+
+[![Build Status](https://travis-ci.org/segmentio/analytics-ruby.png?branch=master)](https://travis-ci.org/segmentio/analytics-ruby)
+
+analytics-ruby is a ruby client for [Segment](https://segment.com)
+
+## Install
+
+Into Gemfile from rubygems.org:
+```
+gem 'analytics-ruby', :require => "segment"
+```
+
+Into environment gems from rubygems.org:
+```
+gem install 'analytics-ruby'
+```
+
+## Usage
+
+Create an instance of the Analytics object:
+```
+analytics = Segment::Analytics.new({
+  write_key: 'YOUR_WRITE_KEY'
+})
+```
+
+Sample usage:
+```
+user = User.last
+
+# Identify the user for the people section
+analytics.identify(
+	{
+		user_id: user.id,
+		traits: {
+			email: user.email,
+			first_name: user.first_name,
+			last_name: user.last_name
+		}
+	}
+)
+
+# Track a user event
+analytics.track(
+	{
+		user_id: user.id,
+		event: 'Created Account'
+	}
+)
+```
+
+Refer to the section below for documenation on individual available calls.
+
+## Documentation
+
+Documentation is available at [segment.com/libraries/ruby](https://segment.com/libraries/ruby)
+
+## Testing
+
+You can use the `stub` option to Segment::Analytics.new to cause all requests to be stubbed, making it easier to test with this library.
+
+## License
+
+```
+WWWWWW||WWWWWW
+ W W W||W W W
+      ||
+    ( OO )__________
+     /  |           \
+    /o o|    MIT     \
+    \___/||_||__||_|| *
+         || ||  || ||
+        _||_|| _||_||
+       (__|__|(__|__|
+```
+
+(The MIT License)
+
+Copyright (c) 2013 Segment Inc. <friends@segment.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.
+
+
+[![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/segmentio/analytics-ruby/trend.png)](https://bitdeli.com/free "Bitdeli Badge")
+

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/analytics-ruby.gemspec

@@ -0,0 +1,23 @@
+require File.expand_path('../lib/segment/analytics/version', __FILE__)
+
+Gem::Specification.new do |spec|
+  spec.name    = 'astronomer'
+  spec.version = '2.0.14'
+  spec.files   = Dir.glob('**/*')
+  spec.require_paths = ['lib']
+  spec.summary = 'Segment.io analytics library, adapted by Astronomer.io'
+  spec.description = 'The Segment.io ruby analytics library, adapted by Astronomer.io'
+  spec.authors = ['Segment.io', 'Astronomer.io']
+  spec.email = 'greg@astronomer.io'
+  spec.homepage = 'https://github.com/astronomerio/analytics-ruby.git'
+  spec.license = 'MIT'
+
+  # Ruby 1.8 requires json
+  spec.add_dependency 'json', ['~> 1.7'] if RUBY_VERSION < "1.9"
+
+  spec.add_development_dependency 'rake', '~> 10.3'
+  spec.add_development_dependency 'wrong', '~> 0.0'
+  spec.add_development_dependency 'rspec', '~> 2.0'
+  spec.add_development_dependency 'tzinfo', '1.2.1'
+  spec.add_development_dependency 'activesupport', '>= 3.0.0', '<4.0.0'
+end

data/lib/segment.rb

@@ -0,0 +1 @@
+require 'segment/analytics'

data/lib/segment/analytics.rb

@@ -0,0 +1,31 @@
+require 'segment/analytics/defaults'
+require 'segment/analytics/utils'
+require 'segment/analytics/version'
+require 'segment/analytics/client'
+require 'segment/analytics/worker'
+require 'segment/analytics/request'
+require 'segment/analytics/response'
+require 'segment/analytics/logging'
+
+module Segment
+  class Analytics
+    def initialize options = {}
+      Request.stub = options[:stub]
+      @client = Segment::Analytics::Client.new options
+    end
+
+    def method_missing message, *args, &block
+      if @client.respond_to? message
+        @client.send message, *args, &block
+      else
+        super
+      end
+    end
+
+    def respond_to? method_name, include_private = false
+      @client.respond_to?(method_name) || super
+    end
+
+    include Logging
+  end
+end

data/lib/segment/analytics/client.rb

@@ -0,0 +1,359 @@
+require 'thread'
+require 'time'
+require 'segment/analytics/utils'
+require 'segment/analytics/worker'
+require 'segment/analytics/defaults'
+
+module Segment
+  class Analytics
+    class Client
+      include Segment::Analytics::Utils
+
+      # public: Creates a new client
+      #
+      # attrs - Hash
+      #           :app_id         - String of your project's app_id
+      #           :max_queue_size - Fixnum of the max calls to remain queued (optional)
+      #           :on_error       - Proc which handles error calls from the API
+      def initialize attrs = {}
+        symbolize_keys! attrs
+
+        @queue = Queue.new
+        @app_id = attrs[:app_id]
+        @max_queue_size = attrs[:max_queue_size] || Defaults::Queue::MAX_SIZE
+        @options = attrs
+        @worker_mutex = Mutex.new
+        @worker = Worker.new @queue, @app_id, @options
+
+        check_app_id!
+
+        at_exit { @worker_thread && @worker_thread[:should_exit] = true }
+      end
+
+      # public: Synchronously waits until the worker has flushed the queue.
+      #         Use only for scripts which are not long-running, and will
+      #         specifically exit
+      #
+      def flush
+        while !@queue.empty? || @worker.is_requesting?
+          ensure_worker_running
+          sleep(0.1)
+        end
+      end
+
+      # public: Tracks an event
+      #
+      # attrs - Hash
+      #           :anonymous_id - String of the user's id when you don't know who they are yet. (optional but you must provide either an anonymous_id or user_id. See: https://segment.io/docs/tracking - api/track/#user - id)
+      #           :context      - Hash of context. (optional)
+      #           :event        - String of event name.
+      #           :integrations - Hash specifying what integrations this event goes to. (optional)
+      #           :options      - Hash specifying options such as user traits. (optional)
+      #           :properties   - Hash of event properties. (optional)
+      #           :timestamp    - Time of when the event occurred. (optional)
+      #           :user_id      - String of the user id.
+      def track attrs
+        symbolize_keys! attrs
+        check_user_id! attrs
+
+        event = attrs[:event]
+        properties = attrs[:properties] || {}
+        timestamp = attrs[:timestamp] || Time.new
+        context = attrs[:context] || {}
+
+        check_timestamp! timestamp
+
+        if event.nil? || event.empty?
+          fail ArgumentError, 'Must supply event as a non-empty string'
+        end
+
+        fail ArgumentError, 'Properties must be a Hash' unless properties.is_a? Hash
+        isoify_dates! properties
+
+        add_context context
+
+        enqueue({
+          :event => event,
+          :userId => attrs[:user_id],
+          :anonymousId => attrs[:anonymous_id],
+          :context =>  context,
+          :options => attrs[:options],
+          :integrations => attrs[:integrations],
+          :properties => properties,
+          :timestamp => datetime_in_iso8601(timestamp),
+          :type => 'track'
+        })
+      end
+
+      # public: Identifies a user
+      #
+      # attrs - Hash
+      #           :anonymous_id - String of the user's id when you don't know who they are yet. (optional but you must provide either an anonymous_id or user_id. See: https://segment.io/docs/tracking - api/track/#user - id)
+      #           :context      - Hash of context. (optional)
+      #           :integrations - Hash specifying what integrations this event goes to. (optional)
+      #           :options      - Hash specifying options such as user traits. (optional)
+      #           :timestamp    - Time of when the event occurred. (optional)
+      #           :traits       - Hash of user traits. (optional)
+      #           :user_id      - String of the user id
+      def identify attrs
+        symbolize_keys! attrs
+        check_user_id! attrs
+
+        traits = attrs[:traits] || {}
+        timestamp = attrs[:timestamp] || Time.new
+        context = attrs[:context] || {}
+
+        check_timestamp! timestamp
+
+        fail ArgumentError, 'Must supply traits as a hash' unless traits.is_a? Hash
+        isoify_dates! traits
+
+        add_context context
+
+        enqueue({
+          :userId => attrs[:user_id],
+          :anonymousId => attrs[:anonymous_id],
+          :integrations => attrs[:integrations],
+          :context => context,
+          :traits => traits,
+          :options => attrs[:options],
+          :timestamp => datetime_in_iso8601(timestamp),
+          :type => 'identify'
+        })
+      end
+
+      # public: Aliases a user from one id to another
+      #
+      # attrs - Hash
+      #           :context     - Hash of context (optional)
+      #           :integrations - Hash specifying what integrations this event goes to. (optional)
+      #           :options      - Hash specifying options such as user traits. (optional)
+      #           :previous_id - String of the id to alias from
+      #           :timestamp   - Time of when the alias occured (optional)
+      #           :user_id     - String of the id to alias to
+      def alias(attrs)
+        symbolize_keys! attrs
+
+        from = attrs[:previous_id]
+        to = attrs[:user_id]
+        timestamp = attrs[:timestamp] || Time.new
+        context = attrs[:context] || {}
+
+        check_presence! from, 'previous_id'
+        check_presence! to, 'user_id'
+        check_timestamp! timestamp
+        add_context context
+
+        enqueue({
+          :previousId => from,
+          :userId => to,
+          :integrations => attrs[:integrations],
+          :context => context,
+          :options => attrs[:options],
+          :timestamp => datetime_in_iso8601(timestamp),
+          :type => 'alias'
+        })
+      end
+
+      # public: Associates a user identity with a group.
+      #
+      # attrs - Hash
+      #           :context      - Hash of context (optional)
+      #           :integrations - Hash specifying what integrations this event goes to. (optional)
+      #           :options      - Hash specifying options such as user traits. (optional)
+      #           :previous_id  - String of the id to alias from
+      #           :timestamp    - Time of when the alias occured (optional)
+      #           :user_id      - String of the id to alias to
+      def group(attrs)
+        symbolize_keys! attrs
+        check_user_id! attrs
+
+        group_id = attrs[:group_id]
+        user_id = attrs[:user_id]
+        traits = attrs[:traits] || {}
+        timestamp = attrs[:timestamp] || Time.new
+        context = attrs[:context] || {}
+
+        fail ArgumentError, '.traits must be a hash' unless traits.is_a? Hash
+        isoify_dates! traits
+
+        check_presence! group_id, 'group_id'
+        check_timestamp! timestamp
+        add_context context
+
+        enqueue({
+          :groupId => group_id,
+          :userId => user_id,
+          :traits => traits,
+          :integrations => attrs[:integrations],
+          :options => attrs[:options],
+          :context => context,
+          :timestamp => datetime_in_iso8601(timestamp),
+          :type => 'group'
+        })
+      end
+
+      # public: Records a page view
+      #
+      # attrs - Hash
+      #           :anonymous_id - String of the user's id when you don't know who they are yet. (optional but you must provide either an anonymous_id or user_id. See: https://segment.io/docs/tracking - api/track/#user - id)
+      #           :category     - String of the page category (optional)
+      #           :context      - Hash of context (optional)
+      #           :integrations - Hash specifying what integrations this event goes to. (optional)
+      #           :name         - String name of the page
+      #           :options      - Hash specifying options such as user traits. (optional)
+      #           :properties   - Hash of page properties (optional)
+      #           :timestamp    - Time of when the pageview occured (optional)
+      #           :user_id      - String of the id to alias from
+      def page(attrs)
+        symbolize_keys! attrs
+        check_user_id! attrs
+
+        name = attrs[:name].to_s
+        properties = attrs[:properties] || {}
+        timestamp = attrs[:timestamp] || Time.new
+        context = attrs[:context] || {}
+
+        fail ArgumentError, '.properties must be a hash' unless properties.is_a? Hash
+        isoify_dates! properties
+
+        check_timestamp! timestamp
+        add_context context
+
+        enqueue({
+          :userId => attrs[:user_id],
+          :anonymousId => attrs[:anonymous_id],
+          :name => name,
+          :category => attrs[:category],
+          :properties => properties,
+          :integrations => attrs[:integrations],
+          :options => attrs[:options],
+          :context => context,
+          :timestamp => datetime_in_iso8601(timestamp),
+          :type => 'page'
+        })
+      end
+      # public: Records a screen view (for a mobile app)
+      #
+      # attrs - Hash
+      #           :anonymous_id - String of the user's id when you don't know who they are yet. (optional but you must provide either an anonymous_id or user_id. See: https://segment.io/docs/tracking - api/track/#user - id)
+      #           :category     - String screen category (optional)
+      #           :context      - Hash of context (optional)
+      #           :integrations - Hash specifying what integrations this event goes to. (optional)
+      #           :name         - String name of the screen
+      #           :options      - Hash specifying options such as user traits. (optional)
+      #           :properties   - Hash of screen properties (optional)
+      #           :timestamp    - Time of when the screen occured (optional)
+      #           :user_id      - String of the id to alias from
+      def screen(attrs)
+        symbolize_keys! attrs
+        check_user_id! attrs
+
+        name = attrs[:name].to_s
+        properties = attrs[:properties] || {}
+        timestamp = attrs[:timestamp] || Time.new
+        context = attrs[:context] || {}
+
+        fail ArgumentError, '.properties must be a hash' unless properties.is_a? Hash
+        isoify_dates! properties
+
+        check_timestamp! timestamp
+        add_context context
+
+        enqueue({
+          :userId => attrs[:user_id],
+          :anonymousId => attrs[:anonymous_id],
+          :name => name,
+          :properties => properties,
+          :category => attrs[:category],
+          :options => attrs[:options],
+          :integrations => attrs[:integrations],
+          :context => context,
+          :timestamp => timestamp.iso8601,
+          :type => 'screen'
+        })
+      end
+
+      # public: Returns the number of queued messages
+      #
+      # returns Fixnum of messages in the queue
+      def queued_messages
+        @queue.length
+      end
+
+      private
+
+      # private: Enqueues the action.
+      #
+      # returns Boolean of whether the item was added to the queue.
+      def enqueue(action)
+        # add our request id for tracing purposes
+        action[:messageId] = uid
+        unless queue_full = @queue.length >= @max_queue_size
+          ensure_worker_running
+          @queue << action
+        end
+        !queue_full
+      end
+
+      # private: Ensures that a string is non-empty
+      #
+      # obj    - String|Number that must be non-blank
+      # name   - Name of the validated value
+      #
+      def check_presence!(obj, name)
+        if obj.nil? || (obj.is_a?(String) && obj.empty?)
+          fail ArgumentError, "#{name} must be given"
+        end
+      end
+
+      # private: Adds contextual information to the call
+      #
+      # context - Hash of call context
+      def add_context(context)
+        context[:library] =  { :name => "analytics-ruby", :version => Segment::Analytics::VERSION.to_s }
+      end
+
+      # private: Checks that the app_id is properly initialized
+      def check_app_id!
+        fail ArgumentError, 'App id must be initialized' if @app_id.nil?
+      end
+
+      # private: Checks the timstamp option to make sure it is a Time.
+      def check_timestamp!(timestamp)
+        fail ArgumentError, 'Timestamp must be a Time' unless timestamp.is_a? Time
+      end
+
+      def event attrs
+        symbolize_keys! attrs
+
+        {
+          :userId => user_id,
+          :name => name,
+          :properties => properties,
+          :context => context,
+          :timestamp => datetime_in_iso8601(timestamp),
+          :type => 'screen'
+        }
+      end
+
+      def check_user_id! attrs
+        fail ArgumentError, 'Must supply either user_id or anonymous_id' unless attrs[:user_id] || attrs[:anonymous_id]
+      end
+
+      def ensure_worker_running
+        return if worker_running?
+        @worker_mutex.synchronize do
+          return if worker_running?
+          @worker_thread = Thread.new do
+            @worker.run
+          end
+        end
+      end
+
+      def worker_running?
+        @worker_thread && @worker_thread.alive?
+      end
+    end
+  end
+end