flickr_sync 0.0.1

data/HISTORY.rdoc

@@ -0,0 +1,9 @@
+== 0.0.1
+
+First release.
+
+Issues:
+
+* Relies on 'find' rather than a pure ruby path iteration 
+* Paths are not dealt with very well at all.
+* Everything works but cli is a massive and awful class.

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Mark Ryall
+ 
+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,27 @@
+= flickr sync
+
+This is a command line utility to synchronise a folder containing images with flickr.
+
+= Usage
+
+Here you sit expectantly in front of a computer at the command line.
+
+== Install
+
+  gem install flickr_synch_
+
+== Launch
+
+  flickr_sync --help
+
+By default, this will check whether a photo with the same title already exists.  If you specify the --optimistic flag, the duplicate check will be skipped.
+
+All photos will be uploaded with visibility limited to family and titles will be the same as the file name.
+
+The past uploads will be stored in a file called written.txt and any duplicates (ie. more than one copy of the same image found on flickr) will be stored in a file called duplicates.txt.
+
+= Future plans for world domination
+
+* Perhaps use absolute paths for file names 
+* Replace hideous find command with a path iterator
+* Handle videos

data/Rakefile

@@ -0,0 +1,10 @@
+begin
+  require 'gemesis/rake'
+rescue Exception
+  puts "gemesis related tasks will only be available if you 'gem install gemesis'"
+end
+
+desc 'execute specifications'
+task :test do
+  sh 'rspec spec'
+end

data/bin/flickr_sync

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH << File.dirname(__FILE__)+'/../lib'
+require 'flickr_sync'
+FlickrSync::Cli.run

data/lib/flickr_sync.rb

@@ -0,0 +1,6 @@
+module FlickrSync
+end
+
+require 'flickr_sync/preferences'
+require 'flickr_sync/prompt'
+require 'flickr_sync/cli'

data/lib/flickr_sync/cli.rb

@@ -0,0 +1,75 @@
+require 'clamp'
+require 'fleakr'
+require 'pathname'
+require 'splat'
+
+module FlickrSync
+  class Cli < Clamp::Command
+    option "--optimistic", :flag, "assume there are no duplicates"
+    parameter "DIRECTORY_PATH", "the folder containing images"
+
+    def execute
+      preferences = FlickrSync::Preferences.new
+      prompt = FlickrSync::Prompt.new STDIN, STDOUT
+
+      preferences[:api_key] ||= prompt.answer 'What is your Flickr API key'
+      preferences[:shared_secret] ||= prompt.answer 'What is your Flickr Shared Secret'
+      preferences[:auth_token] ||= prompt.answer 'What is your Flickr Auth'
+      preferences[:username] ||= prompt.answer 'What is your Flickr username'      
+
+      Fleakr.api_key = preferences[:api_key]
+      Fleakr.shared_secret =  preferences[:shared_secret]
+      Fleakr.auth_token = preferences[:auth_token]
+      user = Fleakr.user preferences[:username]
+
+      written_path = File.join directory_path, 'written.txt'
+      duplicates_path = File.join directory_path, 'duplicates.txt'
+
+      allfiles = `find #{directory_path}/*`.split("\n").select {|p| ['.jpg', '.gif'].include? File.extname(p).downcase}
+      puts "Found #{allfiles.count} image files"
+      writtenfiles = load_list written_path
+      puts "Found #{writtenfiles.count} previously sent files"
+      newfiles = allfiles - writtenfiles
+      puts "Found #{newfiles.count} files to send"
+
+      newfiles.each_with_index do |file, index|
+        path = Pathname.new file
+        puts "#{path} (#{index+1}/#{newfiles.count})"
+        unless optimistic?
+          results = Fleakr.search :user_id => user.id, :text => path.basename.to_s.split('.').first
+          skip_upload = false
+          unless results.empty?
+            ids = results.map {|r| r.id }.join ','
+            puts "Found #{results.size} results on flickr: #{ids}"
+            results.each {|r| r.small.url.to_launcher }
+            file.to_launcher
+            if prompt.ask('Had the photo already been uploaded', true)
+              skip_upload = true
+              if results.size > 1
+                File.open(duplicates_path, 'a') {|f| f.puts "#{file},#{ids}"} if prompt.ask('Are these all duplicates', true)
+              end
+            end
+          end
+        end
+        if skip_upload
+          puts "skipping upload"
+        else
+          puts "uploading photo"
+          Fleakr.upload file, :viewable_by => :family, :hide? => true
+        end
+        File.open(written_path, 'a') {|f| f.puts file }
+      end
+    end
+private
+    def load_list path
+      return [] unless File.exist? path
+      lines = []
+      File.open path do |file|
+        while line = file.gets
+          lines << line.chomp
+        end
+      end 
+      lines
+    end
+  end
+end

data/lib/flickr_sync/preferences.rb

@@ -0,0 +1,31 @@
+require 'yaml'
+
+module FlickrSync
+  class Preferences
+    def initialize
+      @preference_path = home_path '.flickr_sync'
+      if File.exists? @preference_path
+        @preferences = YAML.load File.read(@preference_path)
+      else
+        @preferences = {}
+      end
+    end
+
+    def [] key
+      @preferences[key]
+    end
+
+    def []= key, value
+      @preferences[key] = value
+      persist
+    end
+private
+    def home_path *paths
+      File.join File.expand_path('~'), *paths
+    end
+
+    def persist
+      File.open(@preference_path, 'w') {|f| f.puts @preferences.to_yaml}
+    end
+  end
+end

data/lib/flickr_sync/prompt.rb

@@ -0,0 +1,19 @@
+module FlickrSync
+  class Prompt
+    def initialize inio, outio
+      @inio, @outio = inio, outio
+    end
+
+    def ask prompt, default
+      default_answer = default ? 'y' : 'n'
+      response = answer prompt, default_answer
+      response = default_answer if response.empty?
+      response.start_with? 'y'
+    end
+
+    def answer prompt, default=nil
+      @outio.print default ? "#{prompt} [#{default}] ? " : "#{prompt} ? "
+      @inio.gets.chomp.strip
+    end
+  end
+end

data/spec/flickr_sync/prompt_spec.rb

@@ -0,0 +1,39 @@
+require File.expand_path '../../spec_helper.rb', __FILE__
+
+describe FlickrSync::Prompt do
+  before do
+    @inio = stub 'inio', :gets => ''
+    @outio = stub 'outio', :print => nil
+    @prompt = FlickrSync::Prompt.new @inio, @outio
+  end
+
+  describe '#ask' do
+    it 'should write prompt with true default' do
+      @outio.should_receive(:print).with 'Is this it [y] ? '
+      @prompt.ask 'Is this it', true
+    end
+
+    it 'should write prompt with false default' do
+      @outio.should_receive(:print).with 'Is this it [n] ? '
+      @prompt.ask 'Is this it', false
+    end
+
+    it 'should return true when true is default and nothing is entered' do      
+      @prompt.ask('anything', true).should be_true
+    end
+
+    it 'should return false when false is default and nothing is entered' do
+      @prompt.ask('anything', false).should be_false
+    end
+
+    it 'should return false when true is default and n is entered' do
+      @inio.should_receive(:gets).and_return 'n'
+      @prompt.ask('anything', true).should be_false
+    end
+
+    it 'should return true when false is default and y is entered' do
+      @inio.should_receive(:gets).and_return 'y'
+      @prompt.ask('anything', true).should be_true
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require 'rubygems'
+require 'rspec'
+
+$LOAD_PATH << File.dirname(__FILE__)+'/../lib'
+
+require 'flickr_sync'

metadata

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification 
+name: flickr_sync
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Mark Ryall
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-06-05 00:00:00 +10:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: clamp
+  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: fleakr
+  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: splat
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "0.8"
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: gemesis
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "2"
+  type: :development
+  version_requirements: *id006
+description: |
+  Flickr is a very effective way to backup lots of images but the upload tools are all pretty awful.
+  
+  Hopefully this is marginally less painful
+
+email: mark@ryall.name
+executables: 
+- flickr_sync
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/flickr_sync/cli.rb
+- lib/flickr_sync/preferences.rb
+- lib/flickr_sync/prompt.rb
+- lib/flickr_sync.rb
+- spec/flickr_sync/prompt_spec.rb
+- spec/spec_helper.rb
+- bin/flickr_sync
+- README.rdoc
+- MIT-LICENSE
+- HISTORY.rdoc
+- Rakefile
+- .gemtest
+has_rdoc: true
+homepage: http://github.com/markryall/flickr_sync
+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: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.5.2
+signing_key: 
+specification_version: 3
+summary: command line utility to synch a folder with flickr
+test_files: []
+