hit_counter 0.0.0

data/.document

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

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,13 @@
+source 'http://rubygems.org'
+
+gem 'addressable'
+gem 'mongoid'
+gem 'rmagick', '2.12.2' # version compatible with heroku
+
+group :development do
+  gem 'jeweler'
+end
+
+group :test do
+  gem 'rspec'
+end

data/LICENSE.txt

@@ -0,0 +1,14 @@
+Copyright (c) 2011 Roderick Monje
+
+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 3 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, see <http://www.gnu.org/licenses/>.

data/README.rdoc

@@ -0,0 +1,53 @@
+= hit_counter
+
+Ruby version of that old 90s chestnut, the web-site hit counter.
+
+== How to Install
+
+1. Install the gem.
+
+   Gemfile:
+
+     gem 'hit_counter'
+
+2. Add a controller action to your app.
+
+   controller.rb:
+
+     def hit_counter
+       return if params[:url].blank?
+       hc = HitCounter.get params[:url]
+       hc.increment
+       send_data hc.image(params[:style]).to_blob, :disposition => 'inline', :filename => "#{hc.hits}.png", :type => :png
+     end
+
+   routes.rb:
+
+     get 'hit-counter' => 'webmaster_tools#hit_counter' # technically should be PUT, but GET makes integration simpler
+
+3. Add the hit-counter image tag to your site's HTML:
+
+   <img alt="Hit Counter" border="0" src="/hit-counter?url=http://cnn.com&style=1" />
+
+== How to Customize the Hit-Counter Image
+
+1. Create a GIF for each of the digits, 0.gif through 9.gif.
+
+2. Add the images to a folder named after your new style in public/images/digits.
+
+3. Add the folder name to HitCounter::STYLES. In your HTML, specify the new style with a params[:style] equal to its index in the array plus one.
+
+== Contributing to hit_counter
+
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2011 Roderick Monje. See LICENSE.txt for
+further details.

data/Rakefile

@@ -0,0 +1,48 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development, :test)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "hit_counter"
+  gem.homepage = "http://github.com/ivanoblomov/hit_counter"
+  gem.license = "MIT"
+  gem.summary = %Q{Ruby version of that old 90s chestnut, the web-site hit counter.}
+  gem.email = "rod@seologic.com"
+  gem.authors = ["Roderick Monje"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "hit_counter #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.0

data/lib/hit_counter.rb

@@ -0,0 +1,105 @@
+# Copyright (c) 2011 Roderick Monje
+#
+# 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 3 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, see <http://www.gnu.org/licenses/>.
+class HitCounter
+  include Mongoid::Document
+  include Mongoid::Timestamps
+
+  # Mongo Config ===================================================================================
+  field :url
+  field :hits, :type => Integer, :default => 0
+
+  # Validates the <code>HitCounter</code>'s URL.
+  #
+  # If the URI library can parse the value and the scheme is valid, then we assume the url is valid.
+  class UrlValidator < ActiveModel::EachValidator
+    def validate_each record, attribute, value
+      begin
+        uri = Addressable::URI.parse value
+
+        if !['http', 'https'].include? uri.scheme
+          raise Addressable::URI::InvalidURIError
+        end
+      rescue Addressable::URI::InvalidURIError
+        record.errors[attribute] << 'Invalid URL'
+      end
+    end
+  end
+
+  validates :url, :presence => true, :url => true, :uniqueness => true
+
+  # Class methods ==================================================================================
+
+  # Returns a <code>HitCounter</code> matching the specified URL. The HitCounter is created if no
+  # matching one is found.
+  #
+  # * *Args*
+  #   - +url+ -> the URL for the site being counted
+  # * *Returns*
+  #   - the site's HitCounter
+  def self.get url
+    self.find_or_create_by :url => HitCounter.normalize_url(url)
+  end
+
+  # Instance methods: Overrides ====================================================================
+
+  # Sets the URL to be tracked. The http prefix is optional.
+  #
+  # * *Args*
+  #   - +value+ -> the URL for the site being counted
+  # * *Returns*
+  #   - the value
+  def url= value
+    self[:url] = HitCounter.normalize_url value
+  end
+
+  # Instance methods ===============================================================================
+
+  # Returns the hit count as a PNG image, using the specified style:
+  #   1 odometer
+  #   2 scout
+  #   3 Celtic
+  #
+  # * *Args*
+  #   - +style_number+ -> the image style
+  # * *Returns*
+  #   - the current hit count as a PNG image
+  def image style_number = 0
+    image = HitCounter.cat_image self.hits.to_s, style_number.to_i - 1
+    image.format = 'png'
+    image
+  end
+
+  # Increments the hit count and saves the HitCounter.
+  #
+  # * *Returns*
+  #   - true if the save was successful
+  def increment
+    self.hits += 1
+    self.save
+  end
+
+  private
+
+  STYLES = ['odometer', 'scout', 'celtic']
+
+  def self.cat_image number = '0', style_index = 0, images = Magick::ImageList.new
+    return images.append(false) if number.blank?
+    HitCounter.cat_image number[1..-1], style_index, images << Magick::Image.read("#{Rails.root}/public/images/digits/#{STYLES[style_index]}/#{number[0..0]}.gif").first
+  end
+
+  def self.normalize_url value
+    value !~ %r{^http://} ? "http://#{value}" : value
+  end
+end

data/lib/tasks/install.rake

@@ -0,0 +1,7 @@
+namespace :hit_counter do
+  desc 'Install HitCounter into your app.'
+  task :install do
+    dir = Gem.searcher.find('hit_counter').full_gem_path
+    system "rsync -ruv #{dir}/public/images public/images"
+  end
+end

data/spec/lib/hit_counter_spec.rb

@@ -0,0 +1,53 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe HitCounter do
+  before :all do
+    HitCounter.delete_all
+    @hit_counter = HitCounter.get 'www.google.com'
+  end
+
+  describe '#get' do
+    context 'when existing URL' do
+      describe 'document count' do
+        specify { HitCounter.count.should == 1 }
+      end
+    end
+
+    context 'when new URL' do
+      before { HitCounter.get 'www.cnn.com' }
+
+      describe 'document count' do
+        specify { HitCounter.count.should == 2 }
+      end
+    end
+  end
+
+  describe '#hits' do
+    subject { @hit_counter.hits }
+
+    it { should == 0 }
+
+    context 'when incremented' do
+      before { @hit_counter.increment }
+
+      specify { @hit_counter.hits.should == 1 }
+    end
+  end
+
+  describe '#image' do
+    subject { @hit_counter.image }
+
+    it { should be_a Magick::Image }
+    pending 'should reflect hits'
+  end
+
+  describe '#normalize_url' do
+    context 'with "cnn.com"' do
+      specify { HitCounter.normalize_url('cnn.com').should == 'http://cnn.com' }
+    end
+
+    context 'with "http://www.nytimes.com"' do
+      specify { HitCounter.normalize_url('http://www.nytimes.com').should == 'http://www.nytimes.com' }
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'addressable/uri'
+require 'mongoid'
+require 'rmagick'
+require 'rspec'
+
+require 'hit_counter'
+
+Mongoid::Config.from_hash 'database' => 'hit_counter'
+Mongoid.logger = false
+
+# Stub Rails root during tests.
+module Rails
+  def self.root
+    '.'
+  end
+end

metadata

@@ -0,0 +1,163 @@
+--- !ruby/object:Gem::Specification 
+name: hit_counter
+version: !ruby/object:Gem::Version 
+  hash: 31
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 0
+  version: 0.0.0
+platform: ruby
+authors: 
+- Roderick Monje
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-09-17 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: addressable
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: mongoid
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rmagick
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 59
+        segments: 
+        - 2
+        - 12
+        - 2
+        version: 2.12.2
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
+description: 
+email: rod@seologic.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- .document
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/hit_counter.rb
+- lib/tasks/install.rake
+- public/images/digits/celtic/0.gif
+- public/images/digits/celtic/1.gif
+- public/images/digits/celtic/2.gif
+- public/images/digits/celtic/3.gif
+- public/images/digits/celtic/4.gif
+- public/images/digits/celtic/5.gif
+- public/images/digits/celtic/6.gif
+- public/images/digits/celtic/7.gif
+- public/images/digits/celtic/8.gif
+- public/images/digits/celtic/9.gif
+- public/images/digits/odometer/0.gif
+- public/images/digits/odometer/1.gif
+- public/images/digits/odometer/2.gif
+- public/images/digits/odometer/3.gif
+- public/images/digits/odometer/4.gif
+- public/images/digits/odometer/5.gif
+- public/images/digits/odometer/6.gif
+- public/images/digits/odometer/7.gif
+- public/images/digits/odometer/8.gif
+- public/images/digits/odometer/9.gif
+- public/images/digits/scout/0.gif
+- public/images/digits/scout/1.gif
+- public/images/digits/scout/2.gif
+- public/images/digits/scout/3.gif
+- public/images/digits/scout/4.gif
+- public/images/digits/scout/5.gif
+- public/images/digits/scout/6.gif
+- public/images/digits/scout/7.gif
+- public/images/digits/scout/8.gif
+- public/images/digits/scout/9.gif
+- spec/lib/hit_counter_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/ivanoblomov/hit_counter
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Ruby version of that old 90s chestnut, the web-site hit counter.
+test_files: []
+