squarepusher 0.0.4 → 0.0.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5af95a1bb91651737acad0bd3c7bdbc9da54f32a
+  data.tar.gz: 0f0a0b49404d9c572cb9409c8ad85be2078691de
+SHA512:
+  metadata.gz: 26dce1e4adf0be47f7e9be0588c898841d55faa009295102c411aee30928b02a7726586686003d88f2f1c952837b8fd281625d56f21532fb602c96ffc18892f4
+  data.tar.gz: 3d4f3a7853e96ef738a595830157ac32610bbf4bd550137b59dbb81772a39bc68f01e12e1dde18da6125b364984ebe33dfdbbd7475a29f66b9930da557bc20aa

data/bin/squarepusher

@@ -3,118 +3,4 @@
 require 'rubygems'
 require 'squarepusher'
 
-Squarepusher::CLI.main
-
-# require 'rubygems'
-# require 'squarepusher'
-# 
-# def error_msg(msg)
-#   $stderr.puts "ERROR - #{msg}"
-# end
-# 
-# def fail(msg, code=1)
-#   error_msg(msg)
-#   exit code
-# end
-# 
-# 
-# actions = {}
-# 
-# actions[:list_sets] = lambda do |client, args|
-#   client.each_photoset do |pset|
-#     puts Squarepusher.describe_photoset(pset)
-#   end
-# end
-# 
-# actions[:grab_all_sets] = lambda do |client, args|
-#   if args.size != 1
-#     fail("expected: <output_dir>")
-#   end
-#   
-#   output_dir = args[0]
-#   
-#   total_results = {}
-#   client.each_photoset do |pset|
-#     pset_description = Squarepusher.describe_photoset(pset)
-#     puts "[set] #{pset_description}"
-#     pset_results = client.download_photoset(pset, output_dir)
-#     puts "[results] #{pset_description} #{pset_results.inspect}"
-#     total_results[pset_description] = pset_results
-#     puts
-#   end
-#   
-#   total_results.each_pair do |k, v|
-#     puts "#{k}: #{v.inspect}"
-#   end
-# end
-# 
-# actions[:grab_set] = lambda do |client, args|
-#   if args.size != 2
-#     fail("expected: <photoset_id> <output_dir>")
-#   end
-#   
-#   pset_id, output_dir = args
-#   pset = client.get_photoset(pset_id)
-#   results = client.download_photoset(pset, output_dir)
-#   puts results.inspect
-# end
-# 
-# actions[:find_set] = lambda do |client, args|
-#   if args.size != 1
-#     fail("expected: <photoset_id>")
-#   end
-#   
-#   pset_id, output_dir = args
-#   pset = client.get_photoset(pset_id)
-#   puts Squarepusher.describe_photoset(pset)
-# end
-# 
-# 
-# def action_str(actions)
-#   actions.keys.join(",")
-# end
-# 
-# def size_str
-#   Squarepusher.sizes.join(",")
-# end
-# 
-# 
-# options = { :size => :original }
-# args = nil
-# action = nil
-# client = nil
-# OptionParser.new do |opts|
-#   opts.banner = "USAGE: squarepusher [options] <api-key> <api-secret> <token> <action:(#{action_str(actions)})> [args]"
-# 
-#   opts.on("-o", "--overwrite", "overwrite already downloaded files") do |v|
-#     options[:overwrite] = v
-#   end
-# 
-#   opts.on("-s", "--size SIZE", "size of photos to download (#{size_str()})") do |v|
-#     options[:size] = v.to_sym
-#   end
-#   
-#   opts.on("-v", "--verbose", "log verbosely") do |v|
-#     options[:verbose] = v
-#   end
-#   
-#   opts.parse!(ARGV)
-#   
-#   if ARGV.size < 4
-#     $stderr.puts opts
-#     exit 1
-#   end
-#   
-#   key, secret, token, action = ARGV.slice!(0...4)
-#   args = ARGV
-#   
-#   action = action.to_sym
-#   if not actions.has_key?(action)
-#     $stderr.puts opts
-#     exit 2
-#   end
-#   
-#   client = Squarepusher::Client.new(key, secret, token, options)
-# end
-# 
-# actions[action].call(client, args || [])
+Squarepusher::CLI.main

data/lib/squarepusher.rb

@@ -1,210 +1,3 @@
 require 'squarepusher/cli'
 require 'squarepusher/core'
-require 'squarepusher/version'
-
-# require 'fileutils'
-# require 'optparse'
-# 
-# FlickRawOptions = {}
-# 
-# $fileutils = FileUtils::Verbose
-# 
-# # TODO: detect "photo unavailable" and don't download image
-# UNAVAILABLE_URL = 'http://l.yimg.com/g/images/photo_unavailable.gif'
-# 
-# # TODO: keep track of failures
-# 
-# module Squarepusher
-#   
-#   class << self
-#     
-#     def describe_photoset(pset)
-#       "#{pset.id} '#{pset.title}'"
-#     end
-#     
-#     def normalize(name)
-#       name.gsub(/[^a-zA-Z0-9_+\.=-]+/, '-')
-#     end
-#     
-#     def sizes
-#        return [:original, :large, :medium_640, :medium_500, :small, :thumb, :small_square]
-#     end
-#         
-#   end
-# 
-#   class Client
-#     
-#     def initialize(key, secret, token, args={})
-#       @overwrite = args[:overwrite] || false
-#       @verbose = args[:verbose] || false
-#       
-#       FlickRawOptions['timeout'] = args[:timeout] || 5
-#       
-#       require 'flickraw'
-#       
-#       FlickRaw.api_key = key
-#       FlickRaw.shared_secret = secret
-#       
-#       flickr.auth.checkToken(:auth_token => token)
-#       
-#       size = args[:size] || :small_square
-#       
-#       @url_for_photo = case size
-#           when :original
-#             lambda { |p| FlickRaw.url_o(p) }
-#           when :large
-#             lambda { |p| FlickRaw.url_b(p) }
-#           when :medium_640
-#             lambda { |p| FlickRaw.url_z(p) }
-#           when :medium_500
-#             lambda { |p| FlickRaw.url(p) }
-#           when :small
-#             lambda { |p| FlickRaw.url_m(p) }
-#           when :thumb
-#             lambda { |p| FlickRaw.url_t(p) }
-#           when :small_square
-#             lambda { |p| FlickRaw.url_s(p) }
-#           else
-#             raise Exception("unrecognized size: #{size}")
-#       end
-#     end
-#     
-#     def get_photoset(pset_id)
-#       flickr.photosets.getInfo(:photoset_id => pset_id)
-#     end
-#     
-#     def each_photoset
-#       flickr.photosets.getList.each do |pset|
-#         yield pset
-#       end
-#     end
-#     
-#     def download_photoset(photoset, output_dir)
-#       dirname = Squarepusher.normalize(photoset.title)
-#       set_dir = File.join(output_dir, dirname)
-#       $fileutils.mkdir_p set_dir
-#       
-#       # handles socket timeout when loading photoset info
-#       results = {}
-#       status, photoset_result = handle_error { flickr.photosets.getPhotos(:photoset_id => photoset.id, :extras => "original_format,url_o")["photo"] }
-#       if status == :error
-#         error photoset_result
-#         results[status] = 1
-#         return results
-#       else
-#         photos = photoset_result
-#       end
-#       
-#       photos.each do |p|
-#         # puts p.inspect
-#         
-#         # TODO: use name of file in url since titles can be duplicate
-#         # copies string?
-#         name = "#{p.id}"
-#         if not p.title.empty?
-#           normalized_title = Squarepusher.normalize(p.title)
-#           name << "-#{normalized_title}"
-#         end
-#         
-#         url = @url_for_photo[p]
-#         
-#         # TODO: only add .jpg suffix if it's not in the image name already
-#         path = File.join(set_dir, name)
-#         path << ".jpg" if not path =~ /.jpg$/
-#         
-#         if not @overwrite and File.exists?(path)
-#           puts "#{path} exists; skipping"
-#           result = :exists
-#         else
-#           result = download_image(url, path)
-#         end
-#         
-#         if results.has_key?(result)
-#           results[result] = results[result] + 1
-#         else
-#           results[result] = 1
-#         end
-#       end
-#       results
-#     end
-#  
-#     private
-#     
-#       # was originally sending this to stderr, but the difference in flushing between
-#       # stdout and stderr was creating logging confusion
-#       def error(msg)
-#         puts "ERROR: #{msg}"
-#       end
-#     
-#       def download_image(url, path, args={})
-#         if url == UNAVAILABLE_URL
-#           redirects = args[:redirects]
-#           msg = "#{url} unavailable"
-#           msg << "; redirects: #{redirects}" if not redirects.nil?
-#           puts msg
-#           return :unavailable
-#         end
-#         
-#         result = :unknown
-#         uri = URI.parse(url)
-#         begin
-#           Net::HTTP.start(uri.host, uri.port) do |http|
-#             full_path = uri.request_uri
-#             response = http.get(full_path)
-#       
-#             # puts response.inspect
-#             case response
-#               when Net::HTTPError
-#                 result = :error
-#               when Net::HTTPFound
-#                 redirects = args[:redirects] || []
-#                 redirects << url
-#                 location = response["location"]
-#                 if not location =~ /^http.*/
-#                   location = "#{uri.scheme}://#{uri.host}:#{uri.port}#{location}"
-#                 end
-#                 result = download_image(location, path, :redirects => redirects)
-#               else
-#                 puts "#{url} -> #{path}"
-#                 if @verbose
-#                   response.each_header do |k, v|
-#                     puts "#{k}: #{v}"
-#                   end
-#                   puts
-#                 end
-#                 
-#                 # detects weird 404 or 504 responses included in body but not HTTP status
-#                 content_type = response["content-type"]
-#                 if not (content_type =~ /text\/\w+/).nil?
-#                   error "unexpected content type: #{content_type}"
-#                   result = :error
-#                 else
-#                   open(path, 'w') do |out|
-#                     out << response.body
-#                   end
-#                   result = :success
-#                 end
-#             end
-#           end
-#         rescue Exception => e
-#           error e
-#           result = :error
-#         end
-#         
-#         return result
-#       end
-#       
-#       def handle_error
-#         raise Exception("block required") if not block_given?
-#         begin
-#           block_result = yield
-#           result = [:success, block_result]
-#         rescue
-#           result = [:error, $!]
-#         end
-#         return result
-#       end
-#       
-#   end
-#   
-# end
+require 'squarepusher/version'

data/lib/squarepusher/cli.rb

@@ -18,35 +18,13 @@ class CLI
       exit code
     end
 
-    def parse_config(path)
-      parsed = nil
-      open(path) do |stream|
-        parsed = YAML.load(stream)
-      end
-      if not parsed.respond_to?(:has_key?)
-        raise Exception.new("invalid YAML in #{path}; parsed #{parsed.inspect}")
-      end
-      puts "parsed config: #{parsed.inspect}"
-      required_keys = ['key', 'secret', 'token', 'token_secret']
-      missing_keys = []
-      vals = []
-      required_keys.each do |k|
-        v = parsed.fetch(k, nil)
-        if not v.nil?
-          vals << v
-        else
-          missing_keys << k 
-        end
-      end
-      if not missing_keys.empty?
-        raise Exception.new("missing keys in #{path}: #{missing_keys.inspect}")
-      end
-      vals
-    end
-
     def main
       actions = {}
 
+      actions[:get_full_token] = lambda do |client, args|
+        puts "hi"
+      end
+      
       actions[:list_sets] = lambda do |client, args|
         client.each_photoset do |pset|
           puts Squarepusher.describe_photoset(pset)
@@ -113,7 +91,7 @@ class CLI
       OptionParser.new do |opts|
         opts.banner = "USAGE: squarepusher [options] <action:(#{action_str(actions)})> [args]"
 
-        opts.on("-c", "--config", "path to config file (defaults to #{config_path})") do |v|
+        opts.on("-c", "--config PATH", "path to config file (defaults to #{config_path})") do |v|
           options[:config] = v
         end
 
@@ -121,6 +99,10 @@ class CLI
           options[:overwrite] = v
         end
 
+        opts.on("-p", "--privacy-filter LEVEL", "privacy level of photos to download") do |v|
+          options[:privacy] = v
+        end
+
         opts.on("-s", "--size SIZE", "size of photos to download (#{size_str()})") do |v|
           options[:size] = v.to_sym
         end
@@ -152,8 +134,8 @@ class CLI
           puts "parsing #{config_path}"
         end
         
-        key, secret, token, token_secret = parse_config(config_path)
-        client = Squarepusher::Client.new(key, secret, token, token_secret, options)
+        # client = Squarepusher::Client.from_config_path(key, secret, token, token_secret, options)
+        client = Squarepusher::Client.from_config_path(config_path, options)
       end
       
       puts "args: #{args.inspect}"

data/lib/squarepusher/core.rb

@@ -21,18 +21,113 @@ module Squarepusher
     def normalize(name)
       name.gsub(/[^a-zA-Z0-9_+\.=-]+/, '-')
     end
+
+    def owner_page_url(p)
+      # TODO: maybe abstract this to allow ownername to be passed in as a parameter
+      if p.respond_to?(:owner)
+        owner = p.owner
+        if owner.respond_to?(:username)
+          ownername = p.owner.username
+        else
+          ownername = owner
+        end
+      else
+        raise Exception("photo does not contain 'owner' attribute: #{p.inspect}")
+      end
+      
+      "http://flickr.com/photos/#{ownername}"
+    end
+    
+    def photo_page_url(p)
+      owner_page_url = Squarepusher::owner_page_url(p)
+      "#{owner_page_url}/#{p.id}"
+    end
     
     def sizes
        return [:original, :large, :medium_640, :medium_500, :small, :thumb, :small_square]
     end
+    
+    def url_for(photo, size)
+      case size
+          when :original
+            FlickRaw.url_o(photo)
+          when :large
+            FlickRaw.url_b(photo)
+          when :medium_640
+            FlickRaw.url_z(photo)
+          when :medium_500
+            FlickRaw.url(photo)
+          when :small
+            FlickRaw.url_m(photo)
+          when :thumb
+            FlickRaw.url_t(photo)
+          when :small_square
+            FlickRaw.url_s(photo)
+      end
+    end
         
   end
 
   class Client
     
+    class << self
+      
+      def from_config_path(path, args={})
+        open(path) do |stream|
+          from_config_stream(stream, args)
+        end
+      end
+    
+      def from_config_stream(stream, args={})
+        key, secret, token, token_secret = parse_config_stream(stream)
+        Squarepusher::Client.new(key, secret, token, token_secret, args)
+      end
+      
+      def parse_config_stream(stream)
+        parsed = YAML.load(stream)
+        if not parsed.respond_to?(:has_key?)
+          raise Exception.new("invalid YAML in #{path}; parsed #{parsed.inspect}")
+        end
+        puts "parsed config: #{parsed.inspect}"
+        required_keys = ['key', 'secret', 'token', 'token_secret']
+        missing_keys = []
+        vals = []
+        required_keys.each do |k|
+          v = parsed.fetch(k, nil)
+          if not v.nil?
+            vals << v
+          else
+            missing_keys << k 
+          end
+        end
+        if not missing_keys.empty?
+          raise Exception.new("missing keys in #{path}: #{missing_keys.inspect}")
+        end
+        vals
+      end
+      
+    end # end class << self
+  
+    # optional items for args:
+    # :overwrite - overwrite local files
+    # :verbose - verbose logging
+    # :privacy - privacy level for requests
+    # :event_listener - listener object that must provide "event" method
     def initialize(key, secret, token, token_secret, args={})
       @overwrite = args[:overwrite] || false
       @verbose = args[:verbose] || false
+      @privacy = args[:privacy] || 5
+
+      @event_listener = args[:event_listener] || nil
+
+      if not @event_listener.nil?
+        if not @event_listener.respond_to?(:event)
+          puts "ignoring event listener #{@event_listener}; does not provide :event method"
+          @event_listener = nil
+        else
+          puts "using event listener #{@event_listener}"
+        end
+      end
       
       FlickRawOptions['timeout'] = args[:timeout] || 5
       
@@ -47,6 +142,7 @@ module Squarepusher
       
       size = args[:size] || :small_square
       
+      # TODO: use url_for() method
       @url_for_photo = case size
           when :original
             lambda { |p| FlickRaw.url_o(p) }
@@ -66,17 +162,67 @@ module Squarepusher
             raise Exception("unrecognized size: #{size}")
       end
     end
+    
+    def get_photo(photo_id)
+      flickr.photos.getInfo(:photo_id => photo_id)
+    end
         
     def get_photoset(pset_id)
       flickr.photosets.getInfo(:photoset_id => pset_id)
     end
     
+    def get_photos_for_set(pset_id, params = {})
+      params[:photoset_id] = pset_id
+      flickr.photosets.getPhotos(params)
+    end
+    
     def each_photoset
       flickr.photosets.getList.each do |pset|
         yield pset
       end
     end
     
+    def search_by_tags(user_id, tags, args={})
+      args[:user_id] = user_id
+      args[:tags] = tags
+      return flickr.photos.search(args)
+    end
+    
+    def random_favorite_of_mine(args={})
+      # TODO: find a clean way to select a random page
+      # may need to allow client to pass in context object to store
+      # page count, which could be persisted by client to disk, cache, db, etc. 
+      faves = flickr.favorites.getList(args)
+      raise Exception.new("no favorites found") if faves.size == 0
+
+      faves_hash = faves.to_hash
+      # puts "hash: #{faves_hash.inspect}"
+      photos = faves_hash["photo"]
+      pages = faves_hash["pages"]
+
+      fire_event(:domain => :flickr, :user => :self, :favorite_page_count => pages)
+
+      choice = photos[rand(photos.size)]
+
+      choice
+    end
+
+    def download_favorites(output_dir, page=1, &photo_call)
+      puts "page: #{page}"
+      count = 0
+      flickr.favorites.getList(:page => page, :extras => 'owner_name, original_format').each do |p|
+        ext = if p.respond_to?(:original_format) then p.originalformat else "jpg" end
+        path = "#{output_dir}/#{p.owner}-#{p.id}.#{ext}"
+        count += 1
+        next if not @overwrite and File.exists?(path)
+        u = Squarepusher.url_for(p, :medium_640)
+        download_image(u, path)
+        if block_given? then photo_call.call(p, u, path) end
+      end
+      puts "count: #{count}"
+      if count == 100 then download_favorites(output_dir, page+1, &photo_call) end
+    end
+    
     def download_photoset(photoset, output_dir)
       dirname = Squarepusher.normalize(photoset.title)
       set_dir = File.join(output_dir, dirname)
@@ -84,7 +230,9 @@ module Squarepusher
       
       # handles socket timeout when loading photoset info
       results = {}
-      status, photoset_result = handle_error { flickr.photosets.getPhotos(:photoset_id => photoset.id, :extras => "original_format,url_o")["photo"] }
+      status, photoset_result = handle_error { flickr.photosets.getPhotos(:photoset_id => photoset.id,
+        :privacy_filter => @privacy,
+        :extras => "original_format,url_o")["photo"] }
       if status == :error
         error photoset_result
         results[status] = 1
@@ -126,6 +274,10 @@ module Squarepusher
  
     private
     
+      def fire_event(args={})
+        @event_listener.event(args) unless @event_listener.nil?
+      end
+
       # was originally sending this to stderr, but the difference in flushing between
       # stdout and stderr was creating logging confusion
       def error(msg)

data/lib/squarepusher/version.rb

@@ -1,3 +1,3 @@
 module Squarepusher
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

metadata

@@ -1,45 +1,37 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: squarepusher
-version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 0
-  - 4
-  version: 0.0.4
+version: !ruby/object:Gem::Version
+  version: 0.0.5
 platform: ruby
-authors: 
+authors:
 - mhawthorne
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-10-24 00:00:00 -07:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2013-09-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: flickraw
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
     - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        version: "0"
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id001
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 
 email: mhawthorne@gmail.com
-executables: 
+executables:
 - squarepusher
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
-- .gitignore
+files:
+- ".gitignore"
 - Gemfile
 - README.md
 - Rakefile
@@ -49,37 +41,27 @@ files:
 - lib/squarepusher/core.rb
 - lib/squarepusher/version.rb
 - squarepusher.gemspec
-has_rdoc: true
 homepage: https://github.com/mhawthorne/squarepusher
 licenses: []
-
+metadata: {}
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: nowarning
-rubygems_version: 1.3.7
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: downloads photos from flickr
 test_files: []
-