totangorb 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f039355a75921528c7c46461541f1397835675cb
+  data.tar.gz: fc2eb1910e192b193d3f86b65135659ccc8e8733
+SHA512:
+  metadata.gz: 62d22eea99ae1fd2a777e5bf930ef233069a67967af279ea6aaa3e4161bc40b44a02cda9ceff698a570fbf19972c3c9ac85c3fbb3fefa0b409ad74c911b39342
+  data.tar.gz: 7a6439741a8f4f2e9ba843394894bcb22328f6d838add2f1f50f2b652f1add2d91beaa38987e67337c861749c7b38ae351b6a3ecca27177c838647865eeafbcb

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/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Michał Darda
+
+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,71 @@
+# Totangorb
+
+Lightweight Ruby wrapper for [Totango](http:/http://www.totango.com/).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'totangorb'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install totangorb
+
+## Usage
+
+Type:
+
+    $ rails g totangorb:install
+
+It will generate an initializer for you
+
+```ruby
+unless defined?($totango)
+  $totango = if Rails.env.production?
+    Totangorb::Tracker.new('1234xxxx')
+  else
+    Totangorb::Tracker.new('1234xxxx', debug: true, logger: Rails.logger)
+  end
+end
+```
+
+`debug: true` - do not make real HTTP requests - useful in development environment
+
+You can also set your custom `logger`, such as `Rails.logger` to log every request made to Totango.
+
+These parameters are totally optional.
+
+Replace `1234xxxx` with your Totango API service id. From now you can make requests to Totango within your application:
+
+```ruby
+$totango.track do |t|
+  t.username     "Username"
+  t.account_id   "1234"
+  t.account_name "Account name"
+  t.activity     "Sample event"
+  t.module       "Event module within application"
+  t.attributes   {}
+end
+```
+
+Account attributes is optional - its a hash of custom attributes, you can really put whatever you want there, but remember to also set them in your Totango account.
+
+For more informations, please visit [Totango Quick Start: HTTP API (Server side integration)](http://help.totango.com/installing-totango/quick-start-http-api-server-side-integration/)
+
+## 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
+
+## Author
+Michał Darda &copy; 2013 <michaldarda@gmail.com>

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+desc "Open an irb session preloaded with this library"
+task :console do
+  sh "irb -rubygems -I lib -I extra -r ./lib/totangorb"
+end

data/ext/hash.rb

@@ -0,0 +1,5 @@
+class Hash
+  def to_h
+    self
+  end
+end

data/ext/nil_class.rb

@@ -0,0 +1,5 @@
+class NilClass
+  def to_h
+    {}
+  end
+end

data/ext/open_struct.rb

@@ -0,0 +1,5 @@
+class OpenStruct
+  def to_h
+    @table.dup
+  end
+end

data/lib/generators/templates/totangorb.rb

@@ -0,0 +1,7 @@
+unless defined?($totango)
+  $totango = if Rails.env.production?
+    Totangorb::Tracker.new('1234xxxx')
+  else
+    Totangorb::Tracker.new('1234xxxx', debug: true, logger: Rails.logger)
+  end
+end

data/lib/generators/totangorb/install_generator.rb

@@ -0,0 +1,12 @@
+module Totangorb
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path("../../templates", __FILE__)
+
+      desc "Creates a Totangorb initializer."
+      def copy_initializer
+        template "totangorb.rb", "config/initializers/totangorb.rb"
+      end
+    end
+  end
+end

data/lib/totangorb.rb

@@ -0,0 +1,7 @@
+require_relative '../ext/nil_class'
+require_relative '../ext/open_struct'
+require_relative '../ext/hash'
+
+require "totangorb/version"
+require 'totangorb/tracker'
+require 'totangorb/errors'

data/lib/totangorb/errors.rb

@@ -0,0 +1,3 @@
+module Totangorb
+  class Error < StandardError; end
+end

data/lib/totangorb/tracker.rb

@@ -0,0 +1,61 @@
+require 'ostruct'
+require 'net/http'
+require 'logger'
+
+module Totangorb
+  class NullLogger
+    def info(msg) end
+  end
+
+  class Tracker
+    BASE_URL = 'http://sdr.totango.com/pixel.gif/?'
+
+    def initialize(service_id = nil, options = {})
+      raise(::Error, 'You must provide your private API key.') unless service_id
+      @service_id = service_id
+      @debug      = options.fetch(:debug, false)
+      @logger     = options.fetch(:logger) { NullLogger.new }
+
+      yield(self) if block_given?
+    end
+
+    def track(params = nil)
+      params ||= OpenStruct.new
+
+      yield(params) if block_given?
+
+      perform_request(params.to_h)
+    end
+
+    private
+
+    attr_reader :service_id, :debug, :logger
+
+    def perform_request(params = {})
+      uri = URI(BASE_URL)
+      uri.query = URI.encode_www_form(translate_params(params))
+
+      logger.info "Performing request to #{uri}"
+      Net::HTTP.get(uri) unless debug
+    end
+
+    # Translate params to names that totango understands
+    def translate_params(params = {})
+      {
+        sdr_s:   service_id,
+        sdr_u:   params[:username],
+        sdr_o:   params[:account_id],
+        sdr_odn: params[:account_name],
+        sdr_a:   params[:activity],
+        sdr_m:   params[:module]
+      }.merge(parse_attributes(params.fetch(:attributes, {}))).delete_if { |k, v| v.nil? }
+    end
+
+    # Prepends every optional account attribute hash key with 'sdr_u.<key>'
+    def parse_attributes(attributes = {})
+      attributes.each.reduce({}) do |r, (k, v)|
+        r.merge("sdr_o.#{k}" => v)
+      end
+    end
+  end
+end

data/lib/totangorb/version.rb

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

data/spec/spec_helper.rb

@@ -0,0 +1,19 @@
+# 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
+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
+
+require_relative '../lib/totangorb'

data/spec/tracker_spec.rb

@@ -0,0 +1,92 @@
+require 'spec_helper'
+
+describe Totangorb::Tracker do
+  describe '#initialize' do
+    it 'fails when service_id not provided' do
+      expect { Totangorb::Tracker.new }.to raise_error
+    end
+  end
+
+  describe '#track' do
+    before { @totango = Totangorb::Tracker.new("fake1234") }
+
+    describe 'invocation with block and hash' do
+      before do
+        @totango.should_receive(:perform_request).with({
+          username:     'Sample User',
+          account_id:   1,
+          account_name: 'Sample Account',
+          activity:     'Sample Activity',
+          module:       'Sample Module',
+          })
+      end
+
+      it 'takes a hash of params and passes it to perform_request' do
+        @totango.track({
+          username:     'Sample User',
+          account_id:   1,
+          account_name: 'Sample Account',
+          activity:     'Sample Activity',
+          module:       'Sample Module'
+          })
+      end
+
+      it 'takes a block, converts it to hash, and passes to perform_request' do
+        @totango.track do |t|
+          t.username     = 'Sample User'
+          t.account_id   = 1
+          t.account_name = 'Sample Account'
+          t.activity     = 'Sample Activity'
+          t.module       = 'Sample Module'
+        end
+      end
+    end
+
+    describe 'performing request' do
+      it 'decodes basic attributes' do
+        Net::HTTP.should_receive(:get).with(URI('http://sdr.totango.com/pixel.gif/?sdr_s=fake1234&sdr_u=Sample+User&sdr_o=1&sdr_odn=Sample+Account&sdr_a=Sample+Activity&sdr_m=Sample+Module'))
+
+        @totango.track do |t|
+          t.username     = 'Sample User'
+          t.account_id   = 1
+          t.account_name = 'Sample Account'
+          t.activity     = 'Sample Activity'
+          t.module       = 'Sample Module'
+        end
+      end
+
+      it 'decodes extra optional attributes' do
+        Net::HTTP.should_receive(:get).with(URI('http://sdr.totango.com/pixel.gif/?sdr_s=fake1234&sdr_u=Sample+User&sdr_o=1&sdr_odn=Sample+Account&sdr_a=Sample+Activity&sdr_m=Sample+Module&sdr_o.Sample+Attribute+1=Sample+Value+1&sdr_o.Sample+Attribute+2=Sample+Attribute+2'))
+
+        @totango.track do |t|
+          t.username     = 'Sample User'
+          t.account_id   = 1
+          t.account_name = 'Sample Account'
+          t.activity     = 'Sample Activity'
+          t.module       = 'Sample Module'
+          t.attributes   = {
+            'Sample Attribute 1' => 'Sample Value 1',
+            'Sample Attribute 2' => 'Sample Attribute 2'
+          }
+        end
+      end
+    end
+
+    describe 'logging and debugging' do
+      it 'should log the output url and never make real http request' do
+        logger = double()
+        logger.should_receive(:info)
+        Net::HTTP.should_receive(:get).never
+        @totango = Totangorb::Tracker.new("fake1234", debug: true, logger: logger)
+
+        @totango.track do |t|
+          t.username     = 'Sample User'
+          t.account_id   = 1
+          t.account_name = 'Sample Account'
+          t.activity     = 'Sample Activity'
+          t.module       = 'Sample Module'
+        end
+      end
+    end
+  end
+end

data/totangorb.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'totangorb/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "totangorb"
+  spec.version       = Totangorb::VERSION
+  spec.authors       = ["Michał Darda"]
+  spec.email         = ["michaldarda@gmail.com"]
+  spec.description   = %q{Lightweight Ruby wrapper for Totango.}
+  spec.summary       = %q{Lightweight Ruby wrapper for Totango.}
+  spec.homepage      = ""
+  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_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: totangorb
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Michał Darda
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-02 00:00:00.000000000 Z
+dependencies:
+- !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: Lightweight Ruby wrapper for Totango.
+email:
+- michaldarda@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- ext/hash.rb
+- ext/nil_class.rb
+- ext/open_struct.rb
+- lib/generators/templates/totangorb.rb
+- lib/generators/totangorb/install_generator.rb
+- lib/totangorb.rb
+- lib/totangorb/errors.rb
+- lib/totangorb/tracker.rb
+- lib/totangorb/version.rb
+- spec/spec_helper.rb
+- spec/tracker_spec.rb
+- totangorb.gemspec
+homepage: ''
+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.14
+signing_key: 
+specification_version: 4
+summary: Lightweight Ruby wrapper for Totango.
+test_files:
+- spec/spec_helper.rb
+- spec/tracker_spec.rb