flickr-folder 0.1.0

data/.document

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

data/.gitignore

@@ -0,0 +1,22 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC
+config/flickr.yml

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Ryan Alyn Porter
+
+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,17 @@
+= flickr-folder
+
+Uses the Flickr API (through flickr_fu) to fill a folder with images that match a specified search string and quantity.
+
+== 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) 2010 Ryan Alyn Porter. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,55 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "flickr-folder"
+    gem.summary = %Q{Fill a folder with images from Flickr.}
+    gem.description = %Q{Uses the Flickr API (through flickr_fu) to fill a folder with images that match a specified search string and quantity.}
+    gem.homepage = "http://github.com/endymion/flickr-folder"
+    gem.authors = ["Ryan Alyn Porter"]
+    gem.add_development_dependency "shoulda", ">= 0"
+    gem.add_development_dependency "flickr_fu", ">= 0"
+    gem.add_development_dependency "sqlite3-ruby", ">= 0"
+    gem.add_development_dependency "sequel", ">= 0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: 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|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "flickr-folder #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/flickr-folder.gemspec

@@ -0,0 +1,62 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{flickr-folder}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Ryan Alyn Porter"]
+  s.date = %q{2010-01-10}
+  s.description = %q{Uses the Flickr API (through flickr_fu) to fill a folder with images that match a specified search string and quantity.}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "flickr-folder.gemspec",
+     "lib/flickr-folder.rb",
+     "test/helper.rb",
+     "test/test_flickr-folder.rb"
+  ]
+  s.homepage = %q{http://github.com/endymion/flickr-folder}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Fill a folder with images from Flickr.}
+  s.test_files = [
+    "test/helper.rb",
+     "test/test_flickr-folder.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<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<flickr_fu>, [">= 0"])
+      s.add_development_dependency(%q<sqlite3-ruby>, [">= 0"])
+      s.add_development_dependency(%q<sequel>, [">= 0"])
+    else
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<flickr_fu>, [">= 0"])
+      s.add_dependency(%q<sqlite3-ruby>, [">= 0"])
+      s.add_dependency(%q<sequel>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<flickr_fu>, [">= 0"])
+    s.add_dependency(%q<sqlite3-ruby>, [">= 0"])
+    s.add_dependency(%q<sequel>, [">= 0"])
+  end
+end
+

data/lib/flickr-folder.rb

@@ -0,0 +1,123 @@
+require 'uri'
+require 'net/http'
+require 'FileUtils'
+require 'flickr_fu'
+require 'sqlite3'
+require 'sequel'
+
+class FlickrFolder
+
+  DB_FILE_NAME = '.flickr-folder.db'
+  attr :config, true
+  attr :flickr, true
+  
+  def initialize(config)
+    if !config or
+      [:search, :folder, :config].any? {|either| config[either].nil?}
+      raise ArgumentError, 'Configuration hash required with :search, :folder and :config parameters.'
+    end
+    @config = config
+    @flickr = Flickr.new(@config[:config])
+  end
+
+  def update
+    data_setup
+    photos = []
+
+    # Count existing photo files to figure out how many new ones are needed.
+    return photos.size unless (files_needed_count = @config[:folder][:number] - photo_count) > 0
+
+    page = 1
+    while true do
+
+      # Get a list of matching images from Flikr.
+      (unfiltered_photos = (@flickr.photos.search @config[:search].merge({:page => page}))).each do |photo|
+      
+        # Filter results.
+        next unless @config[:filter].nil? or @config[:filter].call(photo)
+      
+        # Skip known photos.
+        cached_photos = @data[:photos]
+        next if cached_photos.filter(:id => photo.id).count > 0
+      
+        puts "New photo: #{photo.id}, \"#{photo.title}\", max #{photo.sizes.last.width.to_s}px wide" if @config[:verbose]
+
+        # Pick the first photo that's above the minimum size, if specified.  Otherwise grab the largest size.
+        selected_size = photo.sizes.last
+        minimum = @config[:folder][:minimum_resolution]
+        next if minimum and
+          photo.sizes.last.width.to_i < minimum and photo.sizes.last.height.to_i < minimum
+        photo.sizes.each do |size|
+          if size.width.to_i > minimum or size.height.to_i > minimum
+            selected_size = size
+            break
+          end
+        end if minimum
+
+        puts "Downloading size: #{selected_size.width} x #{selected_size.height}" if @config[:verbose]
+        url = URI.parse(selected_size.source)
+        request = Net::HTTP::Get.new(url.path)
+        response = Net::HTTP.start(url.host, url.port) do |http|
+          http.request(request)
+        end
+        format = photo.original_format || (photo.sizes.first.source =~ /\.(\w+)$/; $1)
+        open(File.join(@config[:folder][:path], "#{photo.id}.#{format}"), "wb") do |file|
+            file.write(response.body)
+        end
+
+        photos << photo
+        cached_photos.insert(:id => photo.id)      
+
+        return photos.size if photos.size >= files_needed_count
+        
+      end
+
+      page += 1
+            
+    end
+
+  end
+
+  def photo_files
+    Dir.new(@config[:folder][:path]).entries.reject do |file|
+      file.eql? '.' or file.eql? '..' or file.eql? DB_FILE_NAME
+    end
+  end
+
+  def photo_count
+    photo_files.size
+  end
+
+  def purge_photos(count)
+    photo_files.sort {|x,y|
+        File.new(photo_path(x)).mtime <=>
+        File.new(photo_path(y)).mtime
+      }.slice(0, count).each do |file|
+      FileUtils.rm(photo_path(file))
+    end
+  end
+  
+  private
+
+  def data_path
+    photo_path(DB_FILE_NAME)
+  end
+
+  def photo_path(file)
+    File.join(@config[:folder][:path], file)
+  end
+    
+  def data_setup
+    create_table = false
+    unless File.file?(data_path)
+      FileUtils::mkpath(@config[:folder][:path])
+      SQLite3::Database.new(data_path)
+      create_table = true
+    end
+    @data = Sequel.sqlite(data_path)
+    @data.create_table :photos do
+      primary_key :id
+    end if create_table    
+  end
+
+end

data/test/helper.rb

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

data/test/test_flickr-folder.rb

@@ -0,0 +1,87 @@
+require 'helper'
+
+class TestFlickrFolder < Test::Unit::TestCase
+
+  context "The creation of a FlikrFolder" do
+    should "fail if there is no option hash specified." do
+      assert_raise ArgumentError do
+        FlickrFolder.new
+      end
+    end
+    should "fail if there is no :search option specified" do
+      assert_raise ArgumentError do
+        FlickrFolder.new({ :folder => 'tmp/photos' })
+      end
+    end
+    should "fail if there is no :folder option specified" do
+      assert_raise ArgumentError do
+        FlickrFolder.new({ :search => 'miami beach' })
+      end
+    end
+  end
+
+  @@purged_once = false
+  context "A FlickrFolder" do
+    setup do
+      FileUtils::rm_rf('tmp') unless @@purged_once; @@purged_once = true
+      @folder = FlickrFolder.new({
+        :config => 'config/flickr.yml',
+        :folder => {
+          :path => 'tmp/photos',
+          :number => 3,
+          :minimum_resolution => 1000
+        },
+        :search => {
+          :tags => 'miami beach',
+          :sort => 'interestingness-desc'
+        }
+      })
+    end
+    should "00 find photos after a search for a known positive" do
+      assert_not_nil @folder
+      @folder.update
+      assert_equal 3, @folder.photo_count
+    end
+    should "01 purge photos" do
+      assert_not_nil @folder
+      assert_equal 3, @folder.photo_count
+      @folder.purge_photos 2
+      assert_equal 1, @folder.photo_count
+    end
+    should "02 find more photos after a few are deleted" do
+      assert_not_nil @folder
+      assert_equal 1, @folder.photo_count
+      @folder.update
+      assert_equal 3, @folder.photo_count
+    end
+  end
+
+  context "A filtered FlickrFolder" do
+    setup do
+      FileUtils::rm_rf('tmp')
+      @folder = FlickrFolder.new({
+        :config => 'config/flickr.yml',
+        :folder => {
+          :path => 'tmp/photos',
+          :number => 3,
+          :minimum_resolution => 100
+        },
+        :search => {
+          :tags => 'miami beach',
+          :sort => 'interestingness-desc'
+        },
+        :filter => Proc.new do |photo|
+          true if photo.id.slice(0,1).eql? '1'
+        end
+      })
+    end
+    should "only download files that match the filter" do
+      assert_not_nil @folder
+      @folder.update
+      assert_equal 3, @folder.photo_count
+      @folder.photo_files.each do |photo_file|
+        assert_equal '1', photo_file.slice(0,1)
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification 
+name: flickr-folder
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Ryan Alyn Porter
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-01-10 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: flickr_fu
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: sqlite3-ruby
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: sequel
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Uses the Flickr API (through flickr_fu) to fill a folder with images that match a specified search string and quantity.
+email: 
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- flickr-folder.gemspec
+- lib/flickr-folder.rb
+- test/helper.rb
+- test/test_flickr-folder.rb
+has_rdoc: true
+homepage: http://github.com/endymion/flickr-folder
+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: Fill a folder with images from Flickr.
+test_files: 
+- test/helper.rb
+- test/test_flickr-folder.rb