catptcha 0.0.2 → 0.0.3

data/{README → README.markdown}

@@ -9,20 +9,29 @@ This is still experimental and incomplete. Don't use it.
 
 ## Installation
 
-Add the gem to your Gemfile and optionally require the rake task.
+From within your Rails application:
 
-   load 'tasks/catptcha.rake'
+Add the gem to your Gemfile and load the rake tasks.
+
+   echo "gem 'catptcha'" >> Gemfile
+   echo "load 'tasks/catptcha.rake'" >> Rakefile
 
 Put your flickr keys in config/flickr.yml, see flickr.example.yml.
 
-Generate the migration:
+Generate and run the migration.
 
-   ./script/generate catptcha_migration add_catptcha_tables
+   ruby script/generate catptcha_migration add_catptcha_tables
+   rake db:migrate
 
-Seed the images:
+Seed the images.
 
    rake catptcha:seed
 
+Run the tests.
+
+   rake db:test:prepare
+   rake catptcha:test
+
 ## Author
 
 Copyright (c) 2012 ENTP, released under the MIT license

data/Rakefile

@@ -1,23 +1,10 @@
-require 'rake'
-require 'rake/testtask'
-require 'rdoc/task'
 
-desc 'Default: run unit tests.'
-task :default => :test
+desc 'Default: build the gem'
+task :default => :gem
 
-desc 'Test the catptcha plugin.'
-Rake::TestTask.new(:test) do |t|
-  t.libs << 'lib'
-  t.libs << 'test'
-  t.pattern = 'test/**/*_test.rb'
-  t.verbose = true
+desc 'Build the gem'
+task :gem do
+  sh 'gem build catptcha.gemspec'
 end
 
-desc 'Generate documentation for the catptcha plugin.'
-RDoc::Task.new(:rdoc) do |rdoc|
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = 'Catptcha'
-  rdoc.options << '--line-numbers' << '--inline-source'
-  rdoc.rdoc_files.include('README')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
+

data/catptcha.gemspec

@@ -4,12 +4,13 @@ require 'catptcha'
 Gem::Specification.new do |s|
   s.name = "catptcha"
   s.version = Catptcha::VERSION
-  s.summary = 'Visual catptcha plugin for Rails 2.3'
+  s.summary = 'Visual captcha plugin for Rails 2.3'
   s.description = <<-EOD
     Choose the kitten!
   EOD
   s.add_dependency "commonthread-flickr_fu", "0.3.0"
   s.add_dependency "activerecord", "~>2.3"
+  s.add_development_dependency "rr"
   s.authors = ['Zack Hobson']
   s.files = `git ls-files`.split("\n")
   s.test_files = `git ls-files -- test/*`.split("\n")

data/generators/catptcha_migration/templates/migration.rb

@@ -2,18 +2,23 @@ class <%= class_name %> < ActiveRecord::Migration
   def self.up
     create_table :catptcha_photos do |t|
       t.belongs_to :photo_group
+      t.string :key
       t.string :url
-      t.index :catptcha_group_id
     end
+    add_index :catptcha_photos, :photo_group_id
+    add_index :catptcha_photos, :key, :unique => true
+
     create_table :catptcha_photo_groups do |t|
       t.string :name
       t.string :flickr_group_id
       t.timestamp :photos_updated_at
       t.integer :photos_count
       t.boolean :kittens
-      t.index :kittens
     end
+    add_index :catptcha_photo_groups, :flickr_group_id, :unique => true
+    add_index :catptcha_photo_groups, :kittens
   end
+
   def self.down
     drop_table :catptcha_photos
     drop_table :catptcha_photo_groups

data/lib/catptcha/photo.rb

@@ -2,4 +2,12 @@
 class Catptcha::Photo < ActiveRecord::Base
   set_table_name "catptcha_photos"
   belongs_to :photo_group, :counter_cache => :photos_count, :class_name => 'Catptcha::PhotoGroup'
+
+  before_validation_on_create :generate_key
+  validates_uniqueness_of :key, :on => :create
+  validates_presence_of :photo_group_id
+
+  def generate_key
+    self.key = Digest::SHA1.hexdigest(url)
+  end
 end

data/lib/catptcha/photo_group.rb

@@ -4,62 +4,24 @@
 class Catptcha::PhotoGroup < ActiveRecord::Base
   set_table_name 'catptcha_photo_groups'
 
+  validates_presence_of :name, :flickr_group_id
   validates_uniqueness_of :name
-  validates_uniqueness_of :flickr_group_id
 
   has_many :photos, :class_name => 'Catptcha::Photo'
   named_scope :kittens, :conditions => {:kittens => true}
   named_scope :not_kittens, :conditions => {:kittens => false}
 
   def self.photos_count
-    all.inject(0) {|a,g| a += (g.photos_count || 0) }
+    sum(:photos_count)
   end
 
   def self.random count
-    # TODO use a single query
-    results = []
-    count.times do
-      conditions = ['photo_group_id in (?)', all.map(&:id)]
-      if results.any?
-        conditions.first << ' and catptcha_photos.id not in (?)'
-        conditions << results.map(&:id)
-      end
-      results << Photo.first(
-        :conditions => conditions,
-        :offset => rand(photos_count).to_i
-      )
-    end
-    results
-  end
-
-  def update_images flickr
-    get_photos(flickr) do |photo|
-      photos.create(:url => photo.url(:square))
-    end
-    update_attributes(:photos_updated_at => DateTime.now.utc)
-  end
-
-  # fetches up to 2000 photos
-  def get_photos flickr
-    params = {
-      :group_id => flickr_group_id, :safe_search => 1, :content_type => 1,
-      :per_page => 500, :page => 1
-    }
-    params[:min_upload_date] = photos_updated_at if photos_updated_at
-
-    total_pages = nil
-    loop do
-      result = flickr.photos.search(params)
-      result.each do |photo|
-        yield photo
-      end
-      if total_pages.nil?
-        total_pages = [result.pages, 4].min
-      else
-        params[:page] += 1
-        break if params[:page] > total_pages
-      end
-    end
+    # TODO generate an identity/key column that isn't easy to guess
+    Catptcha::Photo.all(
+      :conditions => ['photo_group_id in (?)', all.map(&:id)],
+      :offset => rand(photos_count-count).to_i,
+      :limit => count
+    )
   end
 
 end

data/lib/catptcha/seed.rb

@@ -14,7 +14,7 @@ module Catptcha::Seed
       @flickr ||= Flickr.new(Rails.root.join("config/flickr.yml").to_s)
     end
 
-    def update
+    def update silent=false
       SEED_GROUP_KITTENS.each do |name, id|
         Catptcha::PhotoGroup.create(:name => name.to_s, :flickr_group_id => id, :kittens => true)
       end
@@ -22,8 +22,37 @@ module Catptcha::Seed
         Catptcha::PhotoGroup.create(:name => name.to_s, :flickr_group_id => id, :kittens => false)
       end
       Catptcha::PhotoGroup.all.each do |group|
-        group.update_images flickr
+        puts "updating photos for `#{group.name}`..." unless silent
+        count = update_photos group
+        puts "...done, #{count} photos imported" unless silent
       end
     end
+
+    # fetches up to 2500 photos
+    def update_photos group
+      params = {
+        :group_id => group.flickr_group_id, :safe_search => 1, :content_type => 1,
+        :per_page => 500, :page => 1
+      }
+      params[:min_upload_date] = group.photos_updated_at if group.photos_updated_at
+
+      total_pages = nil
+      photo_count = 0
+      loop do
+        result = flickr.photos.search(params)
+        result.each do |photo|
+          group.photos.create(:url => photo.url(:square))
+          photo_count += 1
+        end
+        if total_pages.nil?
+          total_pages = [result.pages, 5].min
+        else
+          params[:page] += 1
+        end
+        break if params[:page] >= total_pages
+      end
+      group.update_attributes(:photos_updated_at => DateTime.now.utc)
+      photo_count
+    end
   end
 end

data/lib/catptcha.rb

@@ -1,5 +1,5 @@
 module Catptcha
-  VERSION = '0.0.2'
+  VERSION = '0.0.3'
 
   class << self
     # Get a list of 3 kitten photos
@@ -11,9 +11,20 @@ module Catptcha
     def not_kittens
       PhotoGroup.not_kittens.random(6)
     end
+
+    def check_guesses *ids
+      guesses = ids.flatten.compact
+      if guesses.size != 3
+        return false
+      end
+      3 == Photo.count(:include => 'photo_group', :conditions => [
+        'catptcha_photos.id in (?) and kittens = ?', guesses, true
+      ])
+    end
   end
 
   autoload :Photo, 'catptcha/photo'
   autoload :PhotoGroup, 'catptcha/photo_group'
   autoload :Seed, 'catptcha/seed'
+
 end

data/lib/tasks/catptcha.rake

@@ -3,5 +3,11 @@ namespace :catptcha do
   task :seed => :environment do
     Catptcha::Seed.update
   end
+    
+  desc 'run catptcha plugin tests'
+  Rake::TestTask.new do |t|
+    t.test_files = FileList[File.dirname(__FILE__)+'/../../test/**/*_test.rb']
+    t.verbose = true
+  end
 end
 

data/test/catptcha_seed_test.rb

@@ -0,0 +1,24 @@
+require File.dirname(__FILE__)+'/test_helper.rb'
+
+class CatptchaSeedTest < Test::Unit::TestCase
+  def setup
+    Catptcha::PhotoGroup.delete_all
+    Catptcha::Photo.delete_all
+  end
+
+  def test_seed_with_no_photos
+    stub(Catptcha::Seed).flickr { build_flickr_stub [] }
+    Catptcha::Seed.update :silent
+    assert_equal 3, Catptcha::PhotoGroup.count
+    assert_equal 0, Catptcha::Photo.count
+    # doesn't recreate groups
+    Catptcha::Seed.update :silent
+    assert_equal 3, Catptcha::PhotoGroup.count
+  end
+
+  def test_seed_with_photos
+    stub(Catptcha::Seed).flickr { build_flickr_stub { [ build_flickr_photo_stub ] } }
+    Catptcha::Seed.update :silent
+    assert_equal 3, Catptcha::Photo.count
+  end
+end

data/test/catptcha_test.rb

@@ -0,0 +1,21 @@
+require File.dirname(__FILE__)+'/test_helper.rb'
+
+class CatptchaTest < Test::Unit::TestCase
+
+  def setup
+    Catptcha::Photo.delete_all
+    Catptcha::PhotoGroup.delete_all
+    kittens = Catptcha::PhotoGroup.create!(:name => 'kittens', :flickr_group_id => 'x', :kittens => true)
+    3.times {|i| kittens.photos.create!(:url => "http://#{i}") }
+    not_kittens = Catptcha::PhotoGroup.create!(:name => 'not_kittens', :flickr_group_id => 'y', :kittens => false)
+    6.times {|i| not_kittens.photos.create!(:url => "http://#{i+3}") }
+  end
+
+  def test_kittens
+    assert Catptcha.check_guesses(Catptcha.kittens.map(&:id))
+  end
+
+  def test_not_kittens
+    assert !Catptcha.check_guesses(Catptcha.not_kittens.map(&:id)[0,3])
+  end
+end

data/test/photo_group_test.rb

@@ -0,0 +1,27 @@
+require File.dirname(__FILE__)+'/test_helper.rb'
+
+class PhotoGroupTest < Test::Unit::TestCase
+
+  def setup
+    Catptcha::Photo.delete_all
+    Catptcha::PhotoGroup.delete_all
+    kittens = Catptcha::PhotoGroup.create!(:name => 'kittens', :flickr_group_id => 'x', :kittens => true)
+    3.times {|i| kittens.photos.create!(:url => "http://#{i}") }
+    kittens = Catptcha::PhotoGroup.create!(:name => 'more_kittens', :flickr_group_id => 'a', :kittens => true)
+    3.times {|i| kittens.photos.create!(:url => "http://#{i+3}") }
+    not_kittens = Catptcha::PhotoGroup.create!(:name => 'tacos', :flickr_group_id => 'y', :kittens => false)
+    6.times {|i| not_kittens.photos.create!(:url => "http://#{i+6}") }
+    not_kittens = Catptcha::PhotoGroup.create!(:name => 'yaks', :flickr_group_id => 'b', :kittens => false)
+    6.times {|i| not_kittens.photos.create!(:url => "http://#{i+12}") }
+  end
+
+  def test_photo_count
+    assert_equal 6, Catptcha::PhotoGroup.kittens.photos_count
+    assert_equal 12, Catptcha::PhotoGroup.not_kittens.photos_count
+  end
+
+  def test_random
+    assert_equal 3, Catptcha::PhotoGroup.kittens.random(3).size
+    assert_equal 6, Catptcha::PhotoGroup.not_kittens.random(6).size
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,28 @@
+ENV['RAILS_ENV'] = 'test'
+require "./config/environment"
+require 'test/unit'
+require 'rr'
+
+class Test::Unit::TestCase
+  include RR::Adapters::RRMethods
+
+  # Stub out a flickr photo with a unique url
+  def build_flickr_photo_stub
+    @index ||= 0
+    @index += 1
+    Object.new.tap do |photo|
+      stub(photo).url { "http://#{@index}" }
+    end
+  end
+
+  # Stub out a flickr search query using the provided photos,
+  # for lazy evaluation pass the photos in a block instead
+  def build_flickr_stub value=nil
+    Object.new.tap do |flickr|
+      photos = Object.new
+      stub(flickr).photos { stub(photos).search {
+        (value || yield).tap {|result| stub(result).pages { 1 } }
+      }}
+    end
+  end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: catptcha
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: 
   segments: 
   - 0
   - 0
-  - 2
-  version: 0.0.2
+  - 3
+  version: 0.0.3
 platform: ruby
 authors: 
 - Zack Hobson
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-05-16 00:00:00 -07:00
+date: 2012-05-17 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -49,6 +49,20 @@ dependencies:
         version: "2.3"
   type: :runtime
   version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rr
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
 description: "    Choose the kitten!\n"
 email: 
 executables: []
@@ -60,7 +74,7 @@ extra_rdoc_files: []
 files: 
 - .gitignore
 - MIT-LICENSE
-- README
+- README.markdown
 - Rakefile
 - catptcha.gemspec
 - generators/catptcha_migration/catptcha_migration_generator.rb
@@ -72,6 +86,10 @@ files:
 - lib/catptcha/seed.rb
 - lib/tasks/catptcha.rake
 - rails/init.rb
+- test/catptcha_seed_test.rb
+- test/catptcha_test.rb
+- test/photo_group_test.rb
+- test/test_helper.rb
 - uninstall.rb
 has_rdoc: true
 homepage: 
@@ -106,6 +124,9 @@ rubyforge_project:
 rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
-summary: Visual catptcha plugin for Rails 2.3
-test_files: []
-
+summary: Visual captcha plugin for Rails 2.3
+test_files: 
+- test/catptcha_seed_test.rb
+- test/catptcha_test.rb
+- test/photo_group_test.rb
+- test/test_helper.rb