metrixapp 0.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
data/.document ADDED
@@ -0,0 +1,5 @@
1
+ README.rdoc
2
+ lib/**/*.rb
3
+ bin/*
4
+ features/**/*.feature
5
+ LICENSE
data/.gitignore ADDED
@@ -0,0 +1,21 @@
1
+ ## MAC OS
2
+ .DS_Store
3
+
4
+ ## TEXTMATE
5
+ *.tmproj
6
+ tmtags
7
+
8
+ ## EMACS
9
+ *~
10
+ \#*
11
+ .\#*
12
+
13
+ ## VIM
14
+ *.swp
15
+
16
+ ## PROJECT::GENERAL
17
+ coverage
18
+ rdoc
19
+ pkg
20
+
21
+ ## PROJECT::SPECIFIC
data/LICENSE ADDED
@@ -0,0 +1,20 @@
1
+ Copyright (c) 2009 Keith McDonnell
2
+
3
+ Permission is hereby granted, free of charge, to any person obtaining
4
+ a copy of this software and associated documentation files (the
5
+ "Software"), to deal in the Software without restriction, including
6
+ without limitation the rights to use, copy, modify, merge, publish,
7
+ distribute, sublicense, and/or sell copies of the Software, and to
8
+ permit persons to whom the Software is furnished to do so, subject to
9
+ the following conditions:
10
+
11
+ The above copyright notice and this permission notice shall be
12
+ included in all copies or substantial portions of the Software.
13
+
14
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
15
+ EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
16
+ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
17
+ NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
18
+ LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
19
+ OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
20
+ WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
data/README.rdoc ADDED
@@ -0,0 +1,39 @@
1
+ = MetrixApp gem
2
+
3
+ A gem to send your data to MetrixApp.
4
+
5
+ You'll need to a signup for an account before you send your data.
6
+
7
+ == Installation
8
+
9
+ sudo gem install metrixapp
10
+
11
+ == Usage
12
+
13
+ Firstly, you'll need your account code. You can get this from your MetrixApp
14
+ account by logging in and clicking the "Send your data" link.
15
+
16
+ m = MetrixApp.new 'abc123'
17
+
18
+ That's it - you're good to go! Just send your data using the log method, e.g.
19
+
20
+ m.log 'Signup'
21
+
22
+ You can also store any ruby data which can be convered to json.
23
+
24
+ m.log 'Login', :user => 'foo@example.org'
25
+
26
+
27
+ == Note on Patches/Pull Requests
28
+
29
+ * Fork the project.
30
+ * Make your feature addition or bug fix.
31
+ * Add tests for it. This is important so I don't break it in a
32
+ future version unintentionally.
33
+ * Commit, do not mess with rakefile, version, or history.
34
+ (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)
35
+ * Send me a pull request. Bonus points for topic branches.
36
+
37
+ == Copyright
38
+
39
+ Copyright (c) 2010 Keith McDonnell. See LICENSE for details.
data/Rakefile ADDED
@@ -0,0 +1,54 @@
1
+ require 'rubygems'
2
+ require 'rake'
3
+
4
+ begin
5
+ require 'jeweler'
6
+ Jeweler::Tasks.new do |gem|
7
+ gem.name = "metrixapp"
8
+ gem.summary = %Q{MetrixApp Ruby API}
9
+ gem.description = %Q{MetrixApp Ruby API: send data to MetrixApp}
10
+ gem.email = "keith@dancingtext.com"
11
+ gem.homepage = "http://github.com/kmcd/metrixapp"
12
+ gem.authors = ["Keith McDonnell"]
13
+ # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
14
+ gem.add_dependency "net-http-persistent"
15
+ gem.add_dependency "json"
16
+ end
17
+ Jeweler::GemcutterTasks.new
18
+ rescue LoadError
19
+ puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
20
+ end
21
+
22
+ require 'rake/testtask'
23
+ Rake::TestTask.new(:test) do |test|
24
+ test.libs << 'lib' << 'test'
25
+ test.pattern = 'test/**/test_*.rb'
26
+ test.verbose = true
27
+ end
28
+
29
+ begin
30
+ require 'rcov/rcovtask'
31
+ Rcov::RcovTask.new do |test|
32
+ test.libs << 'test'
33
+ test.pattern = 'test/**/test_*.rb'
34
+ test.verbose = true
35
+ end
36
+ rescue LoadError
37
+ task :rcov do
38
+ abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
39
+ end
40
+ end
41
+
42
+ task :test => :check_dependencies
43
+
44
+ task :default => :test
45
+
46
+ require 'rake/rdoctask'
47
+ Rake::RDocTask.new do |rdoc|
48
+ version = File.exist?('VERSION') ? File.read('VERSION') : ""
49
+
50
+ rdoc.rdoc_dir = 'rdoc'
51
+ rdoc.title = "metrixapp #{version}"
52
+ rdoc.rdoc_files.include('README*')
53
+ rdoc.rdoc_files.include('lib/**/*.rb')
54
+ end
data/VERSION ADDED
@@ -0,0 +1 @@
1
+ 0.1.1
data/lib/metrixapp.rb ADDED
@@ -0,0 +1,38 @@
1
+ require 'cgi'
2
+ require 'json'
3
+ require 'net/http/persistent'
4
+
5
+ class MetrixApp
6
+ ##
7
+ # Creates a new MetrixApp instance used to send data to your account.
8
+ # You MUST pass your account code
9
+ #
10
+ # === Usage:
11
+ # m = MetrixApp.new 'abc123'
12
+ #
13
+ def initialize(account_code)
14
+ raise ArgumentError.new 'You MUST specify your account code' unless account_code.match /[A-Za-z0-9]{32}/
15
+ @account_code = account_code
16
+ @http = Net::HTTP::Persistent.new
17
+ end
18
+
19
+ ##
20
+ # Send your data to MetrixApp. Any optional data is stored as JSON and avaiable
21
+ # by logging into your account and dowloading your data as CSV.
22
+ #
23
+ # The following options are available:
24
+ # <tt>:event_name</tt>:: The event name, eg Signup. *MANDATORY* argument
25
+ # <tt>:data</tt>:: Any extra data you wish to store for further analysis.
26
+ #
27
+ # === Usage:
28
+ # m = MetrixApp.new 'abc123'
29
+ # m.log 'Singup'
30
+ # m.log 'Login', :user => 'foo@example.org'
31
+ # m.log 'Upgrade', ['foo@example.org', 'Premium']
32
+ #
33
+ def log(event_name, data={})
34
+ raise ArgumentError.new 'You MUST give your event a name' unless event_name.match /.+/
35
+
36
+ @http.request URI.parse("http://www.metrixapp.com/log?name=#{CGI::escape(event_name)}&data=#{CGI::escape(data.to_json)}&account_code=#{@account_code}")
37
+ end
38
+ end
data/metrixapp.gemspec ADDED
@@ -0,0 +1,57 @@
1
+ # Generated by jeweler
2
+ # DO NOT EDIT THIS FILE DIRECTLY
3
+ # Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
4
+ # -*- encoding: utf-8 -*-
5
+
6
+ Gem::Specification.new do |s|
7
+ s.name = %q{metrixapp}
8
+ s.version = "0.1.1"
9
+
10
+ s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
11
+ s.authors = ["Keith McDonnell"]
12
+ s.date = %q{2010-05-20}
13
+ s.description = %q{MetrixApp Ruby API: send data to MetrixApp}
14
+ s.email = %q{keith@dancingtext.com}
15
+ s.extra_rdoc_files = [
16
+ "LICENSE",
17
+ "README.rdoc"
18
+ ]
19
+ s.files = [
20
+ ".document",
21
+ ".gitignore",
22
+ "LICENSE",
23
+ "README.rdoc",
24
+ "Rakefile",
25
+ "VERSION",
26
+ "lib/metrixapp.rb",
27
+ "metrixapp.gemspec",
28
+ "test/helper.rb",
29
+ "test/test_metrixapp.rb"
30
+ ]
31
+ s.homepage = %q{http://github.com/kmcd/metrixapp}
32
+ s.rdoc_options = ["--charset=UTF-8"]
33
+ s.require_paths = ["lib"]
34
+ s.rubygems_version = %q{1.3.6}
35
+ s.summary = %q{MetrixApp Ruby API}
36
+ s.test_files = [
37
+ "test/test_metrixapp.rb",
38
+ "test/helper.rb"
39
+ ]
40
+
41
+ if s.respond_to? :specification_version then
42
+ current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
43
+ s.specification_version = 3
44
+
45
+ if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
46
+ s.add_runtime_dependency(%q<net-http-persistent>, [">= 0"])
47
+ s.add_runtime_dependency(%q<json>, [">= 0"])
48
+ else
49
+ s.add_dependency(%q<net-http-persistent>, [">= 0"])
50
+ s.add_dependency(%q<json>, [">= 0"])
51
+ end
52
+ else
53
+ s.add_dependency(%q<net-http-persistent>, [">= 0"])
54
+ s.add_dependency(%q<json>, [">= 0"])
55
+ end
56
+ end
57
+
data/test/helper.rb ADDED
@@ -0,0 +1,13 @@
1
+ require 'rubygems'
2
+ require 'test/unit'
3
+ require 'redgreen'
4
+ require 'active_support/testing/declarative'
5
+ require 'mocha'
6
+
7
+ $LOAD_PATH.unshift(File.dirname(__FILE__))
8
+ $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
9
+ require 'metrixapp'
10
+
11
+ class Test::Unit::TestCase
12
+ extend ActiveSupport::Testing::Declarative
13
+ end
@@ -0,0 +1,40 @@
1
+ require 'helper'
2
+
3
+ class TestMetrixapp < Test::Unit::TestCase
4
+ test "should require an account code" do
5
+ assert_raise(ArgumentError) { MetrixApp.new }
6
+ assert_raise(ArgumentError) { MetrixApp.new '123' }
7
+ assert_nothing_raised { MetrixApp.new '1z'*16 }
8
+ end
9
+
10
+ test "should require a log event name" do
11
+ m = MetrixApp.new '1'*32
12
+ assert_raise(ArgumentError) { m.log }
13
+ assert_nothing_raised { m.log 'foo' }
14
+ end
15
+
16
+ test "should send data to MetrixApp API endpoint" do
17
+ Net::HTTP::Persistent.any_instance.expects(:request)
18
+ MetrixApp.new('1'*32).log 'foo'
19
+ end
20
+
21
+ test "should log extra data as JSON" do
22
+ mock_log_request 'foo', 'foo'
23
+ MetrixApp.new(account_code).log 'foo', 'foo'
24
+ end
25
+
26
+ def mock_log_request(name, data)
27
+ event_name = CGI::escape name
28
+ event_data = CGI::escape data.to_json
29
+
30
+ uri = URI.expects(:parse).
31
+ with("http://www.metrixapp.com/log?name=#{event_name}&data=#{event_data}&account_code=#{account_code}").
32
+ returns URI.parse 'http://example.org'
33
+
34
+ Net::HTTP::Persistent.any_instance.expects(:request).with uri
35
+ end
36
+
37
+ def account_code
38
+ @account_code ||= '1'*32
39
+ end
40
+ end
metadata ADDED
@@ -0,0 +1,96 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: metrixapp
3
+ version: !ruby/object:Gem::Version
4
+ prerelease: false
5
+ segments:
6
+ - 0
7
+ - 1
8
+ - 1
9
+ version: 0.1.1
10
+ platform: ruby
11
+ authors:
12
+ - Keith McDonnell
13
+ autorequire:
14
+ bindir: bin
15
+ cert_chain: []
16
+
17
+ date: 2010-05-20 00:00:00 +01:00
18
+ default_executable:
19
+ dependencies:
20
+ - !ruby/object:Gem::Dependency
21
+ name: net-http-persistent
22
+ prerelease: false
23
+ requirement: &id001 !ruby/object:Gem::Requirement
24
+ requirements:
25
+ - - ">="
26
+ - !ruby/object:Gem::Version
27
+ segments:
28
+ - 0
29
+ version: "0"
30
+ type: :runtime
31
+ version_requirements: *id001
32
+ - !ruby/object:Gem::Dependency
33
+ name: json
34
+ prerelease: false
35
+ requirement: &id002 !ruby/object:Gem::Requirement
36
+ requirements:
37
+ - - ">="
38
+ - !ruby/object:Gem::Version
39
+ segments:
40
+ - 0
41
+ version: "0"
42
+ type: :runtime
43
+ version_requirements: *id002
44
+ description: "MetrixApp Ruby API: send data to MetrixApp"
45
+ email: keith@dancingtext.com
46
+ executables: []
47
+
48
+ extensions: []
49
+
50
+ extra_rdoc_files:
51
+ - LICENSE
52
+ - README.rdoc
53
+ files:
54
+ - .document
55
+ - .gitignore
56
+ - LICENSE
57
+ - README.rdoc
58
+ - Rakefile
59
+ - VERSION
60
+ - lib/metrixapp.rb
61
+ - metrixapp.gemspec
62
+ - test/helper.rb
63
+ - test/test_metrixapp.rb
64
+ has_rdoc: true
65
+ homepage: http://github.com/kmcd/metrixapp
66
+ licenses: []
67
+
68
+ post_install_message:
69
+ rdoc_options:
70
+ - --charset=UTF-8
71
+ require_paths:
72
+ - lib
73
+ required_ruby_version: !ruby/object:Gem::Requirement
74
+ requirements:
75
+ - - ">="
76
+ - !ruby/object:Gem::Version
77
+ segments:
78
+ - 0
79
+ version: "0"
80
+ required_rubygems_version: !ruby/object:Gem::Requirement
81
+ requirements:
82
+ - - ">="
83
+ - !ruby/object:Gem::Version
84
+ segments:
85
+ - 0
86
+ version: "0"
87
+ requirements: []
88
+
89
+ rubyforge_project:
90
+ rubygems_version: 1.3.6
91
+ signing_key:
92
+ specification_version: 3
93
+ summary: MetrixApp Ruby API
94
+ test_files:
95
+ - test/test_metrixapp.rb
96
+ - test/helper.rb