flickr-tools 0.0.2

data/LICENSE

@@ -0,0 +1,23 @@
+Copyright (c) 2010 Jens Krämer, jk@jkraemer.net
+
+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.md

@@ -0,0 +1,55 @@
+Flickr toolchain
+================
+
+Collection of simple command line tools I use to handle my flickr needs.
+
+Use at your own risk, ymmv.
+
+Authorization
+-------------
+
+First of all you need to get an API key at flickr.com. Put the key and the secret into ~/.flickr-tools/flickr.yml:
+
+    key: your-flickr-api-key
+    secret: your-flickr-secret
+    token_cache: token_cache.yml
+
+
+Now call
+
+    flickr-tools Auth username
+
+This will prompt you to visit an URL at flickr.com to authorize write access for the application. Do so and press Enter.
+The token received from flickr will be stored in ~/.flickr-tools/username.yml for further use.
+
+
+
+Listing sets
+------------
+
+    flickr-tools GetSet username
+
+will list all sets in your flickr account.
+  
+
+Download whole set
+------------------
+
+    flickr-tools GetSet username setname
+  
+Use this command to download all pictures (in 'original' size) of the named set. The result is a single zip file containing all images.
+You can use the set id (as printed out by the set listing from above) or a fragment/regexp matching the set title. The first matching 
+set will be exported.
+
+
+Upload Picture
+--------------
+
+    flickr-tools Upload username /path/to/picture
+  
+I intend to use this command to directly upload images to flickr from a batch output queue in [Bibble](http://bibblelabs.com/).
+Flickr metadata (privacy, tags, title, description) is extracted from iptc metadata contained in the picture. See lib/flickr-tools/upload.rb
+for how it's mapped (and modify to suit your needs).
+
+NOTE: Upload doesn't work, seems I'll have to fix flickr_fu first to make it work...
+

data/bin/flickr-tools

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'flickr-tools'
+include FlickrTools
+
+cmd = ARGV.shift
+app = FlickrTools::const_get(cmd).new ARGV
+
+# puts "running #{app.inspect}"
+unless cmd == 'Auth'
+  FlickrTools::Auth.new(ARGV).check_token
+end
+app.run
+

data/doc/flickr-upload.sh

@@ -0,0 +1,9 @@
+#!/bin/bash
+
+# sample shell script to be called from asset management programs like bibble
+# takes the filename as argument
+
+source $HOME/.rvm/scripts/rvm
+rvm use 1.9.2 
+flickr-tools Upload jk $1 >> /Users/jk/Pictures/flickr_upload/log 2>&1
+

data/doc/flickr.yml.example

@@ -0,0 +1,3 @@
+key: your-flickr-api-key
+secret: your-flickr-secret
+token_cache: token_cache.yml

data/lib/flickr-tools.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+gem 'bundler'
+require 'bundler'
+
+
+require 'flickr_fu_ext'
+require 'flickr-tools/core_ext'
+require 'flickr-tools/auth'
+require 'flickr-tools/get_set'
+require 'flickr-tools/upload'

data/lib/flickr-tools/auth.rb

@@ -0,0 +1,49 @@
+require 'flickr-tools/command'
+
+module FlickrTools
+  
+  # USAGE:
+  # flickr-tools Auth username
+  # 
+  # the username argument is just a shorthand to identify the same user in further calls to other flickr-tools commands, must not equal your flickr username.
+  class Auth < Command
+    
+    def run
+      authorize
+    end
+        
+    def check_token(required_perms = :write)
+      res = flickr.auth.check_token
+      allowed_perms = case required_perms
+      when :read
+        %w(read write delete)
+      when :write
+        %w(write delete)
+      when :delete
+        %w(delete)
+      end
+      perm = res.auth.perms.to_s
+      if allowed_perms.include?(perm)
+        true
+      else
+        puts "insufficient permissions: #{perm}, required was: #{required_perms}"
+        false
+      end
+    rescue Exception
+      puts "check_token failed: #{$!}\n#{$!.backtrace.join("\n")}"
+      # authorize
+    end
+    
+    
+    def authorize
+      @flickr = nil
+      FileUtils.rm_f @token_cache
+      puts "please visit the following url, then press <enter> once you have authorized:"
+      # request permissions
+      puts flickr.auth.url(:delete)
+      STDIN.gets
+      flickr.auth.cache_token
+    end
+    
+  end
+end

data/lib/flickr-tools/command.rb

@@ -0,0 +1,38 @@
+module FlickrTools
+  
+  class Command
+    
+    def self.find_config_dir
+      config_dir = File.expand_path('../../../config', __FILE__)
+      unless File.directory?(config_dir)
+        config_dir = File.join(ENV['HOME'], '.flickr-tools')
+        FileUtils.mkdir_p config_dir
+      end
+      return config_dir
+    end
+
+
+    def initialize(argv)
+      @config_dir = self.class.find_config_dir
+      @args = argv.dup
+      @name = @args.shift
+      @token_cache = File.join(@config_dir, "#{@name}.yml")
+      @flickr_yml = File.join @config_dir, 'flickr.yml'
+      unless File.readable?(@flickr_yml)
+        FileUtils.cp File.expand_path('../../../doc/flickr.yml.example', __FILE__), @flickr_yml
+        puts "Please get a flickr API key and secret from flickr.com and edit #{@flickr_yml} accordingly."
+        exit 1
+      end
+    end
+    
+    protected
+    
+    def flickr
+      @flickr ||= Flickr.new(@flickr_yml, :token_cache => @token_cache)
+    end
+    
+
+    
+  end
+  
+end

data/lib/flickr-tools/core_ext.rb

@@ -0,0 +1,5 @@
+class String
+  def to_filename
+    gsub /\W+/, '_'
+  end
+end

data/lib/flickr-tools/get_set.rb

@@ -0,0 +1,103 @@
+require 'flickr_fu'
+require 'zip/zipfilesystem'
+require 'open-uri'
+
+require 'flickr-tools/command'
+
+# USAGE:
+# flickr-tools GetSet jk
+# flickr-tools GetSet jk setname
+module FlickrTools
+  class GetSet < Command
+  
+    def run
+      set = @args.shift
+
+      if set.nil? || set.blank?
+        show_sets
+      else
+        get_set set
+      end
+      
+    end
+    
+    def show_sets
+      puts "getting sets for #{@name}"
+      flickr.photosets.get_list.each do |set|
+        puts set_description(set)
+      end
+    end
+  
+    def get_set(id, size = :original)
+      if set = find_set(id)
+        puts "getting set #{set_description set}"
+        dir = set.title.to_filename
+        FileUtils.mkdir_p dir
+        puts "downloading to #{dir}/"
+        per_page = 200
+        @queue = Queue.new
+        1.upto((set.num_photos.to_i / per_page) + 1) do |page|
+          puts "."
+          set.get_photos(:page => page, :per_page => per_page).each do |p|
+            @queue.enq({ :url => p.url(size), :filename => "#{dir}/#{p.title.to_filename}.jpg" })
+          end
+        end
+        puts "found #{@queue.size} photos"
+        spawn_workers
+        wait_for_workers
+      else
+        puts "no set matching #{id} found."
+      end
+    end
+  
+    protected
+  
+    def find_set(id)
+      flickr.photosets.get_list.find{|set| set.id == id || set.title =~ /#{id}/i }
+    end
+  
+    def set_description(set)
+      "#{set.id} #{set.title} (#{set.num_photos} photos)"
+    end
+
+  
+    def spawn_workers(n = 5)
+      @workers = []
+      n.times do
+        t = Thread.new do
+          while !@stop && p = @queue.deq
+            begin
+              puts "downloading #{p[:url]}"
+              open( p[:url] ){ |f| (File.open(p[:filename], "w") << f.read).close }
+            rescue Exception
+              retries = (p[:retries] || 0) + 1
+              if retries < 3
+                @queue.enq p
+              else
+                puts "giving up downloading #{p.inspect}:\n#{$!}.message"
+              end
+            end
+          end
+        end
+        @workers << t
+      end
+    end
+  
+    def wait_for_workers
+      while !@queue.empty?
+        puts "#{@queue.size} items left..."
+        sleep 30
+      end
+      puts "killing workers..."
+      @stop = true
+      @workers.each { |w| w.join }
+      puts "Done."
+    end
+  
+  end
+  
+end
+
+
+
+

data/lib/flickr-tools/upload.rb

@@ -0,0 +1,83 @@
+require 'flickr_fu'
+# require 'exifr'
+require 'iptc'
+require 'pp'
+
+require 'flickr-tools/command'
+
+module FlickrTools
+  
+  # Upload one or more image files to flickr.
+  #
+  # USAGE:
+  # flickr-tools Upload jk path/to/image ...
+  #
+  # Flickr metadata is determined from the picture's IPTC metadata:
+  # title       - iptc/Headline
+  # description - iptc/Caption
+  # tags        - iptc/Keywords minus IGNORE_KEYWORDS and PRIVACY_KEYWORDS
+  # privacy     - privacy level is set to the given PRIVACY_KEYWORD if also the 'privacy' keyword is present in iptc keywords, public otherwise.
+  #
+  # The keyword-to-tags treatment might seem strange, the reason is that Bibble uses hierarchical keyword trees which get flattened when written 
+  # to IPTC meta data. That's why my pictures have these abstract first level keywords like 'place' and 'year' which I don't want to appear on flickr.
+  class Upload < Command
+  
+    # list of keywords not to be used as flickr tags
+    IGNORE_KEYWORDS  = %w(place year privacy subject)
+    
+    # list of keywords used to determine the flickr privacy level. Photos are public by default.
+    PRIVACY_KEYWORDS = %w(private friends family friends_and_family)
+    
+    def run
+      @uploader = Flickr::Uploader.new flickr      
+      @args.each { |f| upload_file f }
+      puts "done."
+    end
+    
+    protected
+
+    def upload_file(file)
+      if File.readable?(file)
+        meta = { :content_type => :photo, :safety_level => :safe, :hidden => false }.merge(metadata_for(file))
+        puts "uploading #{file} with\n#{meta.inspect}"
+        response = @uploader.upload file, meta
+        
+        puts response.photoid
+        options = { :photo_id => response.photoid, :tags => meta[:tags] }
+        flickr.send_request('flickr.photos.setTags', options, :post)
+      else
+        puts "file not found: #{file}" 
+      end
+    rescue Exception
+      puts "Error uploading #{file}: #{$!}\n#{$!.backtrace.join("\n")}"
+    end
+    
+    def metadata_for(file)
+      iptc = iptc(file)
+      keywords = iptc["iptc/Keywords"].value rescue ''
+      {
+        :title       => (iptc["iptc/Headline"].value.first rescue File.basename(file)),
+        :description => (iptc["iptc/Caption"].value.first rescue ''),
+        :tags        => keywords_to_tags(keywords).join(' '),
+        :privacy     => privacy(keywords)
+      }
+    end
+    
+    def privacy(keywords)
+      privacy = ((keywords.include?('privacy') ? (keywords & PRIVACY_KEYWORDS).first : nil ) || 'public').to_sym
+    end
+    
+    def keywords_to_tags(keywords)
+      keywords.map(&:downcase) - IGNORE_KEYWORDS - PRIVACY_KEYWORDS
+    end
+    
+    def iptc(file)
+      IPTC::JPEG::Image.new(file).values
+    end
+    
+    # def exif(file)
+    #   pp EXIFR::JPEG.new(file).exif
+    # end
+      
+  end
+end

data/lib/flickr-tools/version.rb

@@ -0,0 +1,3 @@
+module FlickrTools
+  VERSION = "0.0.2"
+end

data/lib/flickr_fu_ext.rb

@@ -0,0 +1,14 @@
+require 'flickr_fu'
+
+module Flickr
+  class Auth
+    def check_token
+      rsp = @flickr.send_request('flickr.auth.checkToken')
+      if rsp[:stat] == 'ok'
+        rsp
+      else
+        raise "#{rsp.err[:code]}: #{rsp.err[:msg]}"
+      end
+    end
+  end
+end

data/lib/tempdir.rb

@@ -0,0 +1,132 @@
+=begin rdoc
+
+== tempdir.rb - provides class Tempdir
+
+=== Synopsis
+In order to
+
+1. create a temporary directory with a name starting with "hoge", 
+2. show the name of that directory, and
+3. show its properties with the system "ls -dl" command:
+
+  require 'tempdir'
+
+  d = Tempdir.new("hoge")
+  p d.to_s
+  system("ls", "-dl", d.to_s)
+
+After the run, the directory will appear to be removed. That is: if you
+are not running inside it, which may provide you a means to create a
+directory with a unique name that will be available after the run.
+
+=== Description
+<i>tempdir.rb</i> provides the Tempdir class, which is analogous to the
+Tempfile class, but manipulates temporary directories. Derived from a
+proposal of nobu.nokada@softhome.net. He added the class to
+tempfile.rb, but since it does not seem to appear in cvs, I'll keep
+it apart in tempdir.rb.
+
+=end
+
+require 'tmpdir'
+
+module AutoRemoval #:nodoc: all
+  MAX_TRY = 10
+  @@cleanlist = []
+
+  private
+
+  def make_tmpname(basename, n)
+    sprintf('%s%d.%d', basename, $$, n)
+  end
+  private :make_tmpname
+
+  def createtmp(basename, tmpdir=Dir::tmpdir)	# :nodoc:
+    if $SAFE > 0 and tmpdir.tainted?
+      tmpdir = '/tmp'
+    end
+
+    lock = nil
+    n = failure = 0
+
+    begin
+      Thread.critical = true
+      begin
+        tmpname = File.join(tmpdir, make_tmpname(basename, n))
+        n += 1
+      end until !@@cleanlist.include?(tmpname) and yield(tmpname)
+    rescue
+      p $!
+      failure += 1
+      retry if failure < MAX_TRY
+      raise "cannot generate tempfile `%s'" % tmpname
+    ensure
+      Thread.critical = false
+    end
+
+    tmpname
+  end
+
+  def self.callback(path, clear)	# :nodoc:
+    @@cleanlist << path
+    data = [path]
+    pid = $$
+    return Proc.new {
+      if pid == $$ 
+        path, tmpfile = *data
+
+        print "removing ", path, "..." if $DEBUG
+
+        tmpfile.close if tmpfile
+
+        # keep this order for thread safeness
+        if File.exist?(path)
+          clear.call(path)
+        end
+        @@cleanlist.delete(path)
+
+        print "done\n" if $DEBUG
+      end
+    }, data
+  end
+
+  def self.unregister(path)
+    @@cleanlist.delete(path)
+  end
+end
+
+require 'pathname'
+class Tempdir < Pathname #:nodoc: all
+  include AutoRemoval
+
+  def initialize(*args)
+    require 'fileutils'
+
+    tmpname = createtmp(*args) do |tmpname|
+      unless File.exist?(tmpname)
+        Dir.mkdir(tmpname, 0700)
+      end
+    end
+
+    super(tmpname)
+    @clean_proc, = AutoRemoval.callback(tmpname, FileUtils.method(:rm_rf))
+    ObjectSpace.define_finalizer(self, @clean_proc)  end
+
+  def open(basename, *modes, &block)
+    File.open(self+basename, *modes, &block)
+  end
+
+  def clear
+    FileUtils.rm_rf(@tmpname)
+    @clean_proc.call
+    ObjectSpace.undefine_finalizer(self)
+  end
+end
+
+if __FILE__ == $0
+#  $DEBUG = true
+  d = Tempdir.new("hoge")
+  p d.to_s
+  system("ls", "-dl", d.to_s)
+  p d
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification 
+name: flickr-tools
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.2
+platform: ruby
+authors: 
+- Jens Kraemer
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-04-27 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rubyzip
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: xml-magic
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: tomk32-flickr_fu
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.3.4
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: iptc
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.0.2
+  type: :runtime
+  version_requirements: *id004
+description: You're definitely going to want to replace a lot of this
+email: 
+- jk@jkraemer.net
+executables: 
+- flickr-tools
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/flickr-tools/auth.rb
+- lib/flickr-tools/command.rb
+- lib/flickr-tools/core_ext.rb
+- lib/flickr-tools/get_set.rb
+- lib/flickr-tools/upload.rb
+- lib/flickr-tools/version.rb
+- lib/flickr-tools.rb
+- lib/flickr_fu_ext.rb
+- lib/tempdir.rb
+- bin/flickr-tools
+- LICENSE
+- README.md
+- doc/flickr-upload.sh
+- doc/flickr.yml.example
+has_rdoc: true
+homepage: http://github.com/carlhuda/newgem
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+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: 1.3.6
+requirements: []
+
+rubyforge_project: newgem
+rubygems_version: 1.5.3
+signing_key: 
+specification_version: 3
+summary: flickr utitlity library
+test_files: []
+