webandy-ruby-clicky 0.1.3

data/.document

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

data/.gitignore

@@ -0,0 +1,6 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg
+lib/config.yml

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Andy Atkinson
+
+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,21 @@
+= ruby-clicky
+
+Ruby access to the Clicky web analytics tool. http://getclicky.com/
+For usage see the test file.
+More details are here: http://getclicky.com/forums/?id=2668
+
+
+== 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) 2009 Andy Atkinson. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,56 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "ruby-clicky"
+    gem.summary = %Q{clicky stats for ruby}
+    gem.description = %Q{log traffic to the clicky web analytics stat app}
+    gem.email = "andy@webandy.com"
+    gem.homepage = "http://github.com/webandy/ruby-clicky"
+    gem.authors = ["Andy Atkinson"]
+    gem.add_development_dependency "thoughtbot-shoulda"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo 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|
+  if File.exist?('VERSION')
+    version = File.read('VERSION')
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "ruby-clicky #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.3

data/lib/clicky.sample.yml

@@ -0,0 +1,6 @@
+SITE_ID:
+  364926
+SITEKEY_ADMIN:
+  e59ff97941044f85df5297e1c302d260
+DATABASE_SERVER:
+  db11

data/lib/ruby-clicky.rb

@@ -0,0 +1,98 @@
+# RubyClicky A ruby library to access the GetClicky.com API
+# Copyright (C) 2009 John Nagro
+# Converted to ruby-clicky gem and modified by Andy Atkinson September 2009
+# 
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License
+# as published by the Free Software Foundation; either version 2
+# of the License, or (at your option) any later version.
+# 
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+# 
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+  
+# Basically a straight port of GetClicky official PHP API function
+# http://getclicky.com/clicky_log.phps
+ 
+require 'uri'
+require 'open-uri'
+require 'yaml'
+
+class GetClicky
+ 
+  begin
+    # place a clicky.yml file in the config directory of your Rails app
+    config = YAML::load_file("config/clicky.yml")
+  rescue
+    # sample config used by test
+    config = YAML::load_file("lib/clicky.sample.yml")
+  end
+  SITE_ID = config['SITE_ID']
+  SITEKEY_ADMIN = config['SITEKEY_ADMIN']
+  DATABASE_SERVER = config['DATABASE_SERVER']
+ 
+  VALID_TYPES = ["pageview", "download", "outbound", "click", "custom", "goal"]
+ 
+  def self.log(args)
+ 
+    type = args[:type]
+    type = "pageview" unless VALID_TYPES.include?(type)
+ 
+    base_uri = "http://static.getclicky.com/in.php?site_id=#{SITE_ID}&srv=#{DATABASE_SERVER}&sitekey_admin=#{SITEKEY_ADMIN}&type=#{type}"
+ 
+    # we need either a session_id or an ip_address...
+    if(args[:session_id].is_a?(Numeric))
+      base_uri += "&session_id=#{args[:session_id.to_i]}"
+    elsif( (args[:ip_address] =~ /^[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}$/) != nil )
+      base_uri += "&ip_address=#{args[:ip_address]}"
+    else
+      return false
+    end
+ 
+    # goals can come in as integer or array, for convenience
+    if(args[:goal].is_a?(Numeric))
+      base_uri += "&goal=#{args[:goal]}"
+    elsif(args[:goal].is_a?(Hash) && args[:goal][:id].is_a?(Numeric))
+      args[:goal].each do |key,value|
+        base_uri += "&goal[#{URI.escape(key)}]=#{URI.escape(value)}"
+      end
+    end
+ 
+    # custom data, must come in as array of key=>values
+    if(args[:custom].is_a?(Hash))
+      args[:custom].each do |key,value|
+        base_uri += "&custom[#{URI.escape(key)}]=#{URI.escape(value)}"
+      end
+    end
+ 
+    case args[:type]
+    when "outbound"
+      return false unless (args[:href] =~ /^(https?|telnet|ftp)/) != nil
+    else
+      # all other action types must start with either a / or a #
+      args[:href] = "/#{args[:href]}" if((args[:href] =~ /^(\/|\#)/) == nil)
+    end
+ 
+    base_uri += "&href=#{URI.escape(args[:href])}"
+ 
+    if(args[:title])
+      base_uri += "&title=#{URI.escape(args[:tite])}"
+    end
+ 
+    if(args[:ref])
+      base_uri += "&ref=#{URI.escape(args[:ref])}"
+    end
+ 
+    if(args[:ua])
+      base_uri += "&ua=#{URI.escape(args[:ua])}"
+    end
+ 
+    return open(base_uri) ? true : false
+  end
+ 
+end

data/ruby-clicky.gemspec

@@ -0,0 +1,55 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{ruby-clicky}
+  s.version = "0.1.3"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Andy Atkinson"]
+  s.date = %q{2009-09-06}
+  s.description = %q{log traffic to the clicky web analytics stat app}
+  s.email = %q{andy@webandy.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "lib/clicky.sample.yml",
+     "lib/ruby-clicky.rb",
+     "ruby-clicky.gemspec",
+     "test/ruby-clicky_test.rb",
+     "test/test_helper.rb"
+  ]
+  s.has_rdoc = true
+  s.homepage = %q{http://github.com/webandy/ruby-clicky}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.2}
+  s.summary = %q{clicky stats for ruby}
+  s.test_files = [
+    "test/ruby-clicky_test.rb",
+     "test/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_development_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    else
+      s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+  end
+end

data/test/ruby-clicky_test.rb

@@ -0,0 +1,13 @@
+require 'test_helper'
+
+class RubyClickyTest < Test::Unit::TestCase
+  should "return true for a valid Clicky log invocation" do
+    assert GetClicky.log(:href => "http://www.google.com", :ip_address => "127.0.0.1")
+  end
+  
+  should "raise ArgumentError if passing invalid parameters to method" do
+    assert_raises ArgumentError do
+      assert GetClicky.log
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'ruby-clicky'
+
+class Test::Unit::TestCase
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification 
+name: webandy-ruby-clicky
+version: !ruby/object:Gem::Version 
+  version: 0.1.3
+platform: ruby
+authors: 
+- Andy Atkinson
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-09-06 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: log traffic to the clicky web analytics stat app
+email: andy@webandy.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/clicky.sample.yml
+- lib/ruby-clicky.rb
+- ruby-clicky.gemspec
+- test/ruby-clicky_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/webandy/ruby-clicky
+licenses: 
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: clicky stats for ruby
+test_files: 
+- test/ruby-clicky_test.rb
+- test/test_helper.rb