metrixapp 0.1.1

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Keith McDonnell
+
+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.rdoc

@@ -0,0 +1,39 @@
+= MetrixApp gem
+
+A gem to send your data to MetrixApp.
+
+You'll need to a signup for an account before you send your data.
+
+== Installation
+
+sudo gem install metrixapp
+
+== Usage
+
+Firstly, you'll need your account code. You can get this from your MetrixApp 
+account by logging in and clicking the "Send your data" link.
+
+m = MetrixApp.new 'abc123'
+
+That's it - you're good to go! Just send your data using the log method, e.g.
+
+m.log 'Signup'
+
+You can also store any ruby data which can be convered to json.
+
+m.log 'Login', :user => 'foo@example.org'
+
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Keith McDonnell. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,54 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "metrixapp"
+    gem.summary = %Q{MetrixApp Ruby API}
+    gem.description = %Q{MetrixApp Ruby API: send data to MetrixApp}
+    gem.email = "keith@dancingtext.com"
+    gem.homepage = "http://github.com/kmcd/metrixapp"
+    gem.authors = ["Keith McDonnell"]
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+    gem.add_dependency "net-http-persistent"
+    gem.add_dependency "json"
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "metrixapp #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.1

data/lib/metrixapp.rb

@@ -0,0 +1,38 @@
+require 'cgi'
+require 'json'
+require 'net/http/persistent'
+
+class MetrixApp
+  ##
+  # Creates a new MetrixApp instance used to send data to your account.
+  # You MUST pass your account code
+  # 
+  # === Usage:
+  #  m = MetrixApp.new 'abc123'
+  #
+  def initialize(account_code)
+    raise ArgumentError.new 'You MUST specify your account code' unless account_code.match /[A-Za-z0-9]{32}/
+    @account_code = account_code
+    @http = Net::HTTP::Persistent.new
+  end
+  
+  ##
+  # Send your data to MetrixApp. Any optional data is stored as JSON and avaiable 
+  # by logging into your account and dowloading your data as CSV.
+  #
+  # The following options are available:
+  # <tt>:event_name</tt>::  The event name, eg Signup. *MANDATORY* argument
+  # <tt>:data</tt>:: Any extra data you wish to store for further analysis.
+  #
+  # === Usage:
+  #  m = MetrixApp.new 'abc123'
+  #  m.log 'Singup'
+  #  m.log 'Login', :user => 'foo@example.org'
+  #  m.log 'Upgrade', ['foo@example.org', 'Premium']
+  #
+  def log(event_name, data={})
+    raise ArgumentError.new 'You MUST give your event a name' unless event_name.match /.+/
+    
+    @http.request URI.parse("http://www.metrixapp.com/log?name=#{CGI::escape(event_name)}&data=#{CGI::escape(data.to_json)}&account_code=#{@account_code}")
+  end
+end

data/metrixapp.gemspec

@@ -0,0 +1,57 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{metrixapp}
+  s.version = "0.1.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Keith McDonnell"]
+  s.date = %q{2010-05-20}
+  s.description = %q{MetrixApp Ruby API: send data to MetrixApp}
+  s.email = %q{keith@dancingtext.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "lib/metrixapp.rb",
+     "metrixapp.gemspec",
+     "test/helper.rb",
+     "test/test_metrixapp.rb"
+  ]
+  s.homepage = %q{http://github.com/kmcd/metrixapp}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{MetrixApp Ruby API}
+  s.test_files = [
+    "test/test_metrixapp.rb",
+     "test/helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<net-http-persistent>, [">= 0"])
+      s.add_runtime_dependency(%q<json>, [">= 0"])
+    else
+      s.add_dependency(%q<net-http-persistent>, [">= 0"])
+      s.add_dependency(%q<json>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<net-http-persistent>, [">= 0"])
+    s.add_dependency(%q<json>, [">= 0"])
+  end
+end
+

data/test/helper.rb

@@ -0,0 +1,13 @@
+require 'rubygems'
+require 'test/unit'
+require 'redgreen'
+require 'active_support/testing/declarative'
+require 'mocha'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'metrixapp'
+
+class Test::Unit::TestCase
+  extend ActiveSupport::Testing::Declarative
+end

data/test/test_metrixapp.rb

@@ -0,0 +1,40 @@
+require 'helper'
+
+class TestMetrixapp < Test::Unit::TestCase
+  test "should require an account code" do
+    assert_raise(ArgumentError) { MetrixApp.new }
+    assert_raise(ArgumentError) { MetrixApp.new '123' }
+    assert_nothing_raised { MetrixApp.new '1z'*16 }
+  end
+  
+  test "should require a log event name" do
+    m = MetrixApp.new '1'*32
+    assert_raise(ArgumentError) { m.log }
+    assert_nothing_raised { m.log 'foo' }
+  end
+  
+  test "should send data to MetrixApp API endpoint" do
+    Net::HTTP::Persistent.any_instance.expects(:request)
+    MetrixApp.new('1'*32).log 'foo'
+  end
+  
+  test "should log extra data as JSON" do
+    mock_log_request 'foo', 'foo'
+    MetrixApp.new(account_code).log 'foo', 'foo'
+  end
+  
+  def mock_log_request(name, data)
+    event_name = CGI::escape name
+    event_data = CGI::escape data.to_json
+    
+    uri = URI.expects(:parse).
+      with("http://www.metrixapp.com/log?name=#{event_name}&data=#{event_data}&account_code=#{account_code}").
+      returns URI.parse 'http://example.org'
+      
+    Net::HTTP::Persistent.any_instance.expects(:request).with uri
+  end
+  
+  def account_code
+    @account_code ||= '1'*32
+  end
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification 
+name: metrixapp
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 1
+  version: 0.1.1
+platform: ruby
+authors: 
+- Keith McDonnell
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-05-20 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: net-http-persistent
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: json
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+description: "MetrixApp Ruby API: send data to MetrixApp"
+email: keith@dancingtext.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/metrixapp.rb
+- metrixapp.gemspec
+- test/helper.rb
+- test/test_metrixapp.rb
+has_rdoc: true
+homepage: http://github.com/kmcd/metrixapp
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: MetrixApp Ruby API
+test_files: 
+- test/test_metrixapp.rb
+- test/helper.rb