compete 0.2.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Simplificator GmbH
+
+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 @@
+= compete
+
+A wrapper for compete.com API.
+Can be used to look up information (trust level, rankings, visitors) for a domain.
+
+
+
+= Requirements
+You'll need an account at http://developer.compete.com/
+Depending on number of requests you make you'll need to pay.
+We (Simplificator) have no connection with compete.com!
+
+
+= Usage
+Sign up at http://developer.compete.com/ and get an API key
+Install the simplificator-compete gem. 
+
+Look at compete.rb to see available information (i.e. metrics_ranking, metrics_link, ...)
+
+
+
+----
+  require 'rubygems'
+  require 'simplificator-compete'
+  COMPETE_API_KEY = 'your api key'
+
+  info = Compete.for_domain('simplificator.com')
+  if info.data_available?
+    puts "Ranking is: #{info.metrics_ranking}"
+  else 
+    puts "no data"
+  end
+----
+
+
+
+== Copyright
+
+Copyright (c) 2009 Simplificator GmbH. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,57 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "compete"
+    gem.summary = %Q{API for http://developer.compete.com/}
+    gem.email = "info@simplificator.com"
+    gem.homepage = "http://github.com/simplificator/compete"
+    gem.authors = ["simplificator"]
+    gem.add_dependency('httparty', '>= 0.4.3')
+
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+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 :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION.yml')
+    config = YAML.load(File.read('VERSION.yml'))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "compete #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:major: 0
+:minor: 2
+:patch: 0

data/lib/compete.rb

@@ -0,0 +1,80 @@
+require 'httparty'
+class Compete
+  include HTTParty
+  format :xml
+  # Valid size arguments for the for_domain call
+  VALID_SIZES = ['small', 'large']
+  API_URL = 'http://api.compete.com/fast-cgi/MI'
+  API_VERSION = 3
+  
+  # readers for trust data
+  attr_reader(:trust_level_value, :trust_level_link, :trust_level_icon)
+  # readers for metric data
+  attr_reader(:metrics_link, :metrics_icon, :metrics_count, :metrics_ranking, :metrics_date_range)
+  # other readers
+  attr_reader(:domain, :xml)
+  
+  # 
+  # Creates a new Compete Object from the XML response of the compete API (as parsed by httparty).
+  # Details see http://developer.compete.com/
+  #  
+  def initialize(xml)
+    @xml = xml
+    @domain =  @xml['ci']['dmn']['nm']
+
+    # metrics
+    @metrics_ranking = to_integer(@xml['ci']['dmn']['metrics']['val']['uv']['ranking'])
+    if data_available?
+      @metrics_date_range = build_metrics_date_range()
+    end
+    
+    # metrics
+    @metrics_count = to_integer(@xml['ci']['dmn']['metrics']['val']['uv']['count'])
+    @metrics_link = @xml['ci']['dmn']['metrics']['link']
+    @metrics_icon = @xml['ci']['dmn']['metrics']['icon']
+
+    # trust
+    @trust_level_value = @xml['ci']['dmn']['trust']['val']
+    @trust_level_link = @xml['ci']['dmn']['trust']['link']
+    @trust_level_icon = @xml['ci']['dmn']['trust']['icon']
+
+  end
+  
+  # Lookup the compete info for a domain.
+  # the size argument is for the icon urls. VALID_SIZES specifies what you can give here.
+  # Make sure COMPETE_API_KEY is set before you call this method.
+  def self.for_domain(domain, size = 'small')
+    raise 'COMPETE_API_KEY is not defined' unless defined?(COMPETE_API_KEY)
+    raise "Unknown size '#{size}'" unless VALID_SIZES.include?(size)
+    info = get(API_URL, :query => {:d => domain, :ver => API_VERSION, :apikey => COMPETE_API_KEY, :size => size})
+    Compete.new(info)
+  end
+  
+  # Is data available for this domain?
+  # If this method returns true
+  def data_available?
+    !!self.metrics_ranking
+  end
+  
+  private
+  
+  # Build a date range according to the year/month specified in the XML
+  # Assuming month is 0 indexed (rubys month is 1 indexed) but there is nothing in the deco about it...
+  def build_metrics_date_range()
+    month = to_integer(@xml['ci']['dmn']['metrics']['val']['mth'])
+    year = to_integer(@xml['ci']['dmn']['metrics']['val']['yr'])
+    from = Date.new(year, month + 1)
+    to = (from >> 1) - 1
+    (from..to)
+  end
+  
+  # Metrics count contains ',' as separator... 
+  def to_integer(value)
+    strip(value).gsub(',', '').to_i if value
+  end
+  
+  # Strip all whitespace
+  def strip(value)
+    value.gsub(/\s/, '') if value
+  end
+end

data/test/compete_test.rb

@@ -0,0 +1,35 @@
+require 'test_helper'
+
+class CompeteTest < Test::Unit::TestCase
+  should 'deal with unknown domain' do
+    file = File.dirname(__FILE__) + '/data/unknown.yml'
+    info = YAML::load_file(file)
+    compete = Compete.new(info)
+    assert(!compete.data_available?)
+    assert_equal('yellow', compete.trust_level_value)
+    assert(compete.trust_level_link)
+    assert(compete.trust_level_icon)
+    assert(!compete.metrics_link)
+    assert(compete.metrics_icon)
+    assert(!compete.metrics_ranking)
+    assert(!compete.metrics_date_range)
+    assert(!compete.metrics_count)
+    assert_equal('unknowndomain.something.notknow', compete.domain)
+  end
+  
+  should 'find infos about known domain' do
+      file = File.dirname(__FILE__) + '/data/google.com.yml'
+      info = YAML::load_file(file)
+      compete = Compete.new(info)
+      assert(compete.data_available?)
+      assert_equal('green', compete.trust_level_value)
+      assert(compete.trust_level_link)
+      assert(compete.trust_level_icon)
+      assert(compete.metrics_link)
+      assert(compete.metrics_icon)
+      assert_equal(1, compete.metrics_ranking)
+      assert_equal(137630925, compete.metrics_count)
+      assert_equal((Date.new(2009, 4, 1)..Date.new(2009, 4, 30)), compete.metrics_date_range)
+      assert_equal('google.com', compete.domain)
+  end
+end

data/test/data/google.com.yml

@@ -0,0 +1,29 @@
+--- 
+ci: 
+  dmn: 
+    trust: 
+      val: green
+      icon: http://home.compete.com.edgesuite.net/site_media/images/icons/trust_green_16.gif
+      caption: Trust
+      link: http://toolbar.compete.com/trustgreen/google.com
+    rank: 
+      val: "1"
+      icon: http://home.compete.com.edgesuite.net/site_media/images/icons/profile_3_16.gif
+      caption: Profile
+      link: http://toolbar.compete.com/siteprofile/google.com
+    metrics: 
+      val: 
+        mth: "\n                    03\n                "
+        uv: 
+          ranking: "\n                        1\n                    "
+          count: "\n                       137,630,925\n                    "
+        yr: "\n                    2009\n                "
+      icon: http://home.compete.com.edgesuite.net/site_media/images/icons/profile_3_16.gif
+      caption: Profile
+      link: http://toolbar.compete.com/siteprofile/google.com
+    deals: 
+      val: "0"
+      icon: http://home.compete.com.edgesuite.net/site_media/images/icons/deals_off_16.gif
+      caption: Deals
+      link: 
+    nm: google.com

data/test/data/unknown.yml

@@ -0,0 +1,29 @@
+--- 
+ci: 
+  dmn: 
+    trust: 
+      val: yellow
+      icon: http://home.compete.com.edgesuite.net/site_media/images/icons/trust_yellow_16.gif
+      caption: Trust
+      link: http://toolbar.compete.com/trustyellow/unknowndomain.something.notknow
+    rank: 
+      val: 
+      icon: http://home.compete.com.edgesuite.net/site_media/images/icons/profile_0_16.gif
+      caption: Profile
+      link: 
+    metrics: 
+      val: 
+        mth: 
+        uv: 
+          ranking: 
+          count: 
+        yr: 
+      icon: http://home.compete.com.edgesuite.net/site_media/images/icons/profile_0_16.gif
+      caption: Profile
+      link: 
+    deals: 
+      val: "0"
+      icon: http://home.compete.com.edgesuite.net/site_media/images/icons/deals_off_16.gif
+      caption: Deals
+      link: 
+    nm: unknowndomain.something.notknow

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 'compete'
+
+class Test::Unit::TestCase
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification 
+name: compete
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.2.0
+platform: ruby
+authors: 
+- simplificator
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-05-03 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: httparty
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.4.3
+  type: :runtime
+  version_requirements: *id001
+description: 
+email: info@simplificator.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION.yml
+- lib/compete.rb
+- test/compete_test.rb
+- test/data/google.com.yml
+- test/data/unknown.yml
+- test/test_helper.rb
+homepage: http://github.com/simplificator/compete
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.7.2
+signing_key: 
+specification_version: 3
+summary: API for http://developer.compete.com/
+test_files: 
+- test/compete_test.rb
+- test/test_helper.rb
+has_rdoc: