trak-ruby 0.0.3

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,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Brian Sewell
+
+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,185 @@
+# trak.io Ruby API Wrapper
+
+[![Gem Version](https://badge.fury.io/rb/trak-ruby.png)](http://badge.fury.io/rb/trak-ruby)
+
+This is the gem that allows Ruby bindings for the trak.io V1 API.
+
+## Rails Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'trak-ruby'
+
+Create an initilizer `config/initializers/trak.rb` with the following code:
+
+```ruby
+Trak::API_KEY = "YOUR API KEY HERE"
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install 'trak-ruby'
+
+===
+
+## API Methods
+
+### Identify
+
+```ruby
+Trak.identify(distinct_id, properties)
+```
+
+Identify is how you send trak.io properties about a person like Email, Name, Account Type, Age, etc.
+
+Learn more about implementation of `identify` on trak.io's [API documentation](http://docs.trak.io/identify.html)
+
+```ruby
+# Initilaize Trak object
+t = Trak.new
+
+t.identify(1, {:name => 'John Smith', :email => 'john@test.com'})
+```
+
+The `identify` method will set the class variable `@distinct_id` to whatever you pass as your first parameter.
+
+### Alias
+
+```ruby
+Trak.alias(distinct_id, aliases)
+```
+
+Alias is how you set additional distinct ids for a person. This is useful if you initially use trak.io's automatically generated distinct id to identify or track a person but then they login or register and you want to identify them by their email address or your application's id for them. Doing this will allow you to identify users across sessions and devices. But of course you want to tie their activity before and after they logged in together, Trak.alias() will do this for you.
+
+Learn more about implementation of `alias` on trak.io's [API documentation](http://docs.trak.io/alias.html)
+
+```ruby
+# Initilaize Trak object
+t = Trak.new
+
+# Pass a string to add a new alias for a person with distinct_id = 1
+t.alias(1, 'Johnny')
+
+# Pass an array of aliases for a person with distinct_id = 1
+t.alias(1, ['Johnny', 'john'])
+```
+
+The `alias` method will set the class variable `@distinct_id` to whatever you pass as your first parameter.
+
+### Track
+
+```ruby
+Trak.track(event, opts = {})
+```
+
+Track is how you record the actions people perform. You can also record properties specific to those actions. For a "Purchased shirt" event, you might record properties like revenue, size, etc.
+
+Learn more about implementation of `track` on trak.io's [API documentation](http://docs.trak.io/track.html)
+
+```ruby
+# Initilaize Trak object
+t = Trak.new
+
+# Log the event 'played video'
+t.track('played video')
+
+# Log the event 'played video' for a person with distinct_id = 1
+t.track('played video', {:distinct_id => 1})
+
+# Log the event 'played video' on the 'Blog' channel
+t.track('played video', {:channel => 'Blog'})
+
+# Log an event with custom properties attached:
+# Log the event 'search' on the 'Web site' channel along with
+# any related properties you wish to track
+t.track('search', {
+  :channel => 'Web site',
+  :properties => {
+    :search_term => 'iPad Air',
+    :search_category => 'Electronics',
+  },
+})
+```
+
+The `track` method will set the class variable `@distinct_id` if you pass it a distinct_id in the `opts` hash.
+
+### Page View
+
+```ruby
+Trak.page_view(url, page_title, opts = {})
+```
+
+Page view is just a wrapper for: `Trak.track('Page View')`
+
+Learn more about implementation of `page_view` on trak.io's [API documentation](http://docs.trak.io/page_view.html)
+
+```ruby
+# Initilaize Trak object
+t = Trak.new
+
+# Log a user visiting the settings page
+t.page_view('http://mysite.com/settings', 'Settings')
+```
+
+The `page_view` method will set the class variable `@distinct_id` if you pass it a distinct_id in the `opts` hash.
+
+### Annotate
+
+```ruby
+Trak.annotate(event, opts = {})
+```
+
+Annotate is a way of recording system wide events that affect everyone. Annotations are similar to events except they are not associated with any one person.
+
+Learn more about implementation of `annotate` on trak.io's [API documentation](http://docs.trak.io/annotate.html)
+
+```ruby
+# Initilaize Trak object
+t = Trak.new
+
+# Annotate a deploy
+t.annotate('Deployed update')
+
+# Annotate a deploy for a specific channel
+t.annotate('Deployed update', {:channel => 'Web site'})
+```
+
+### Distinct ID
+
+```ruby
+# Initilaize Trak object
+t = Trak.new
+
+# Returns the current distinct id
+t.distinct_id
+
+# Sets the current distinct_id
+t.distinct_id = 1
+```
+
+### Channel
+
+```ruby
+# Initilaize Trak object
+t = Trak.new
+
+# Returns the current channel
+t.channel
+
+# Sets the current channel
+t.channel = 'Web site'
+```
+
+===
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

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

data/VERSION

@@ -0,0 +1 @@
+0.0.3

data/lib/trak.rb

@@ -0,0 +1,174 @@
+require 'net/http'
+require 'json'
+
+class Trak
+
+  VERSION = '0.0.3'
+  HEADERS = { 'Content-Type' => 'application/json' }
+
+  attr_accessor :distinct_id, :channel
+
+  def initialize(api_key = nil)
+    raise "api_key required" unless api_key || defined? API_KEY
+    @api_key = api_key ? api_key : API_KEY
+    api_base = 'api.trak.io'
+    @http = Net::HTTP.new api_base
+  end
+
+  def execute_request(url, data)
+    response = @http.post(url, data, HEADERS)
+    JSON.parse(response.body)
+  end
+
+  # Identify is how you send trak.io properties about a person like Email, Name, Account Type, Age, etc.
+  #
+  # @param distinct_id [String] A unique identifier for a user (visitor)
+  # @param properties [Hash] A hash of properties about a person (example: `{:name => 'John Smith', :age => 40}`)
+  # @return [Object]
+  #
+  def identify(distinct_id, properties = {})
+    raise "distinct_id required" unless distinct_id
+    raise "properties must be a Hash" unless aliases.kind_of?(Hash)
+    data = {
+      :token => @api_key,
+      :data => {
+        :distinct_id => distinct_id,
+        :properties => properties,
+      },
+    }.to_json
+
+    # Set current session variable for distinct_id
+    self.distinct_id = distinct_id
+
+    execute_request('/v1/identify', data)
+  end
+
+  # Alias is how you set additional distinct ids for a person.
+  # This is useful if you initially use trak.io's automatically generated
+  # distinct id to identify or track a person but then they login or
+  # register and you want to identify them by their email address or your
+  # application's id for them. Doing this will allow you to identify users
+  # across sessions and devices.
+  #
+  # @param distinct_id [String] The unique identifier of a user
+  # @param aliases [String, Array] An array of distinct ids, you would like to add.
+  # @return [Object]
+  #
+  def alias(distinct_id, aliases)
+    raise "distinct_id required" unless distinct_id
+    raise "aliases cannot be empty" unless aliases
+    raise "aliases must be a String or an Array" unless aliases.kind_of?(Array) || aliases.kind_of?(String)
+    data = {
+      :token => @api_key,
+      :data => {
+        :distinct_id => distinct_id,
+        :alias => aliases,
+      },
+    }.to_json
+
+    # Set current session variable for distinct_id
+    self.distinct_id = distinct_id
+
+    execute_request('/v1/alias', data)
+  end
+
+  # Track is how you record the actions people perform. You can also record
+  # properties specific to those actions. For a "Purchased shirt" event,
+  # you might record properties like revenue, size, etc.
+  #
+  # @param event [String] The key for this event, this value will be standardized server side.
+  # @param opts [Hash] options to pass to track call (distinct_id [String], channel [String], properties [Hash])
+  # @return [Object]
+  #
+  def track(event, opts = {})
+    defaults = {
+      :distinct_id => self.distinct_id,
+      :channel => self.channel,
+      :properties => {},
+    }
+    opts = defaults.merge opts
+    raise "event is required" unless event
+    raise "properties must be a Hash" unless defaults[:properties].kind_of?(Hash)
+    raise "No distinct_id is set.  Use 'identify' or 'alias' to set current session distinct_id" if opts[:distinct_id].nil?
+    data = {
+      :token => @api_key,
+      :data => {
+        :distinct_id => opts[:distinct_id],
+        :event => event,
+        :channel => opts[:channel],
+        :properties => opts[:properties],
+      },
+    }.to_json
+
+    # Set current session variable for distinct_id
+    self.distinct_id = opts[:distinct_id]
+
+    execute_request('/v1/track', data)
+  end
+
+  # Page view is just a wrapper for: Trak.track('Page view')
+  #
+  # @param url [String] The key for this event, this value will be standardized server side.
+  # @param page_title [String] The distinct id of the person you wish to register this event against. When ommited the current session's distinct id is used.
+  # @param opts [Hash] options to pass to track call (distinct_id [String], channel [String])
+  # @return [Object]
+  #
+  def page_view(url, page_title, opts = {})
+    defaults = {
+      :event => 'Page view',
+      :distinct_id => self.distinct_id,
+      :channel => self.channel,
+      :properties => {
+        :url => url,
+        :page_title => page_title,
+      },
+    }
+    opts = defaults.merge opts
+    raise "url" unless url
+    raise "page_title" unless page_title
+    raise "properties must be a Hash" unless defaults[:properties].kind_of?(Hash)
+    raise "No distinct_id is set.  Use 'identify' or 'alias' to set current session distinct_id" if opts[:distinct_id].nil?
+    data = {
+      :token => @api_key,
+      :data => {
+        :distinct_id => opts[:distinct_id],
+        :event => opts[:event],
+        :channel => opts[:channel],
+        :properties => opts[:properties],
+      },
+    }.to_json
+
+    # Set current session variable for distinct_id
+    self.distinct_id = opts[:distinct_id]
+
+    execute_request('/v1/track', data)
+  end
+
+  # Annotate is a way of recording system wide events that affect everyone.
+  # Annotations are similar to events except they are not associated with
+  # any one person.
+  #
+  # @param event [String] The key for this annotation, this value will be standardized server side.
+  # @param opts [Hash] options to pass to annotate call (channel [String], properties [Hash])
+  # @return [Object]
+  #
+  def annotate(event, opts = {})
+    defaults = {
+      :channel => channel,
+      :properties => {},
+    }
+    opts = defaults.merge opts
+    raise "event is required" unless event
+    raise "properties must be a Hash" unless defaults[:properties].kind_of?(Hash)
+    data = {
+      :token => @api_key,
+      :data => {
+        :event => event,
+        :channel => opts[:channel],
+        :properties => opts[:properties],
+      },
+    }.to_json
+
+    execute_request('/v1/annotate', data)
+  end
+end

data/trak-ruby.gemspec

@@ -0,0 +1,22 @@
+# coding: utf-8
+$:.unshift(File.join(File.dirname(__FILE__), 'lib'))
+
+Gem::Specification.new do |s|
+  s.name = %q{trak-ruby}
+  s.version = '0.0.3'
+  s.authors = ["Brian Sewell"]
+  s.email = ["bwsewell@gmail.com"]
+  s.description = %q{trak.io helps you track the metrics that actually matter to your startup}
+  s.summary = %q{Ruby bindings for the trak.io API}
+  s.homepage = %q{http://docs.trak.io/}
+  s.license = "MIT"
+  s.default_executable = %q{trak}
+
+  s.files = `git ls-files`.split($/)
+  s.executables = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  s.test_files = s.files.grep(%r{^(test|spec|features)/})
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency "bundler", "~> 1.3"
+  s.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification
+name: trak-ruby
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+  prerelease: 
+platform: ruby
+authors:
+- Brian Sewell
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &70310242273160 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: *70310242273160
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70310242848120 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70310242848120
+description: trak.io helps you track the metrics that actually matter to your startup
+email:
+- bwsewell@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .DS_Store
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- lib/.DS_Store
+- lib/trak.rb
+- trak-ruby.gemspec
+homepage: http://docs.trak.io/
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: Ruby bindings for the trak.io API
+test_files: []