totango 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cfe4fccbf204ce62c45abc038ec31cd4120cd4e6
+  data.tar.gz: 39463cc28e8e70a2e3f088498d3b58659cec7bce
+SHA512:
+  metadata.gz: 400053aba95ccdcd2efa29dc61ed3dda30a21726f0b872b895a00bac1a1b657d0414e6702b9e6d44b2e6585cd3e6ff4f008e20f13c83c6e3969300141f2e0c3e
+  data.tar.gz: fbfe539ebcc2cdec0a3a67cc70dd60509a12144dd8531f59f47ec61b32d06dfad3ca6443ec7f2667b77e92fe0121cd5f59ed8af0013c2dd7e1d5f61f191dbbd2

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/.rspec

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

data/.ruby-version

@@ -0,0 +1 @@
+2.0.0-p247

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Matt Gillooly
+
+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,29 @@
+# Totango
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'totango'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install totango
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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,6 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/totango.rb

@@ -0,0 +1,27 @@
+require "totango/version"
+require "totango/configuration"
+require "totango/event"
+require 'excon'
+
+module Totango
+
+  class << self
+    attr_accessor :configuration
+
+    def configure
+      self.configuration ||= Configuration.new
+      yield(configuration)
+    end
+
+    def track(event_attributes)
+      Excon.get(build_event(event_attributes).to_url)
+    end
+
+    def build_event(event_attributes)
+      event = Event.new(event_attributes)
+      event.service_id = configuration.service_id if configuration
+      event
+    end
+  end
+
+end

data/lib/totango/configuration.rb

@@ -0,0 +1,7 @@
+module Totango
+
+  class Configuration
+    attr_accessor :service_id
+  end
+
+end

data/lib/totango/event.rb

@@ -0,0 +1,41 @@
+module Totango
+
+  class Event
+
+    # http://help.totango.com/installing-totango/quick-start-http-api-server-side-integration/
+    #
+    # Sending an event to Totango
+    #
+    # The HTTP API can be used to track user-activity from anywhere in your web-app.
+    # Simply send the following parametrized HTTP request every time a user performs an important user-action.
+
+    attr_accessor :service_id, :username, :account_id, :account_name, :activity, :module
+
+    def initialize(options)
+      options.each do |option_name, option_value|
+        self.send("#{option_name}=", option_value)
+      end
+    end
+
+    def query_options
+      {
+        :sdr_s => service_id, # API identifier of your account on Totango
+        :sdr_u => username, # Email address of the username performing the action
+        :sdr_o => account_id, # Unique ID of the end-user’s account on your application
+        :sdr_odn => account_name, # A human readable name for the account (will be used on Totango’s UI and reports)
+        :sdr_a => activity, # Name of the activity the user performed
+        :sdr_m => self.module, # Name of the module the user is using within the application
+      }
+    end
+
+    def to_url
+      URI::HTTP.build({
+        :host => 'sdr.totango.com',
+        :path => '/pixel.gif/',
+        :query => URI.encode_www_form(query_options)
+      }).to_s
+    end
+
+  end
+
+end

data/lib/totango/version.rb

@@ -0,0 +1,3 @@
+module Totango
+  VERSION = "0.0.1"
+end

data/spec/spec_helper.rb

@@ -0,0 +1,20 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+
+require 'totango'
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

data/spec/totango/event_spec.rb

@@ -0,0 +1,49 @@
+require 'spec_helper'
+
+describe Totango::Event do
+
+  subject {
+    described_class.new({
+      :service_id => "SP-xxxxyy",
+      :account_id => "u12214",
+      :account_name => "Barksdale+Industries",
+      :username => "avon@barksdale.com",
+      :activity => "Login",
+      :module => "Application"
+    })
+  }
+
+  describe "#query_options" do
+    it "builds a query hash for a Totango pixel URL" do
+      expect( subject.query_options ).to eq({
+        :sdr_s => "SP-xxxxyy",
+        :sdr_o => "u12214",
+        :sdr_odn => "Barksdale+Industries",
+        :sdr_u => "avon@barksdale.com",
+        :sdr_a => "Login",
+        :sdr_m => "Application"
+      })
+    end
+  end
+
+  describe "#to_url" do
+    it "builds a Totango pixel URL" do
+      url = URI.parse( subject.to_url )
+
+      expect( url.host ).to eq( 'sdr.totango.com' )
+      expect( url.path ).to eq( "/pixel.gif/" )
+
+      query_options = Hash[URI.decode_www_form(url.query)]
+      expect( query_options ).to eq({
+        "sdr_s" => "SP-xxxxyy",
+        "sdr_o" => "u12214",
+        "sdr_odn" => "Barksdale+Industries",
+        "sdr_u" => "avon@barksdale.com",
+        "sdr_a" => "Login",
+        "sdr_m" => "Application"
+      })
+    end
+  end
+
+end
+

data/spec/totango_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+
+describe Totango do
+
+  describe '.configure' do
+    let(:service_id) { 'my-service-id' }
+
+    it "sets service_id" do
+      expect( described_class.configuration ).to be_nil
+
+      described_class.configure do |config|
+        config.service_id = service_id
+      end
+
+      expect( described_class.configuration.service_id ).to eq( service_id )
+    end
+  end
+
+  describe '.track(event_attributes)' do
+    let(:event_attributes) { double }
+    let(:url) { double }
+
+    let(:event) { double(Totango::Event, to_url: url) }
+
+    before do
+      subject.stub(:build_event).with(event_attributes) { event }
+    end
+
+    it 'builds and posts an event' do
+      Excon.should_receive(:post).with(url)
+      subject.track(event_attributes)
+    end
+  end
+
+end

data/totango.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'totango/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "totango"
+  spec.version       = Totango::VERSION
+  spec.authors       = ["Matt Gillooly"]
+  spec.email         = ["matt@swipely.com"]
+  spec.description   = %q{Ruby client for sending events to Totango}
+  spec.summary       = %q{Sends events from your application to Totango}
+  spec.homepage      = "http://github.com/swipely/totango"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "excon"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: totango
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Matt Gillooly
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: excon
+  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'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Ruby client for sending events to Totango
+email:
+- matt@swipely.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .ruby-version
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/totango.rb
+- lib/totango/configuration.rb
+- lib/totango/event.rb
+- lib/totango/version.rb
+- spec/spec_helper.rb
+- spec/totango/event_spec.rb
+- spec/totango_spec.rb
+- totango.gemspec
+homepage: http://github.com/swipely/totango
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Sends events from your application to Totango
+test_files:
+- spec/spec_helper.rb
+- spec/totango/event_spec.rb
+- spec/totango_spec.rb