benschwarz-flickr-wrapper 0.1.0

data/README

@@ -0,0 +1,7 @@
+A grassroots readonly flickr wrapper - Strictly for convenience
+Not a full API, no groups, no community, who needs friends anyway?
+
+If you want a full API, use the `flickr` gem hosted on Rubyforge, its 
+old but it was nailed with its 1.0 release.
+
+Check the specs for usage

data/flickr-wrapper.gemspec

@@ -0,0 +1,15 @@
+Gem::Specification.new do |s|
+  s.name = "flickr-wrapper"
+  s.version = "0.1.0"
+  s.date = "2008-05-10"
+  s.summary = "A grassroots wrapper for flickr"
+  s.email = "ben@germanforblack.com"
+  s.homepage = "http://github.com/benschwarz/flickr-wrapper"
+  s.description = "A grassroots wrapper around flickr - Strictly for convenience"
+  s.authors = ["Ben Schwarz"]
+  s.files = ["README", "flickr-wrapper.gemspec", "lib/flickr-wrapper.rb", "lib/flickr-wrapper/base.rb", "lib/flickr-wrapper/machine_tag.rb", "lib/flickr-wrapper/photo.rb", "lib/flickr-wrapper/photoset.rb", "lib/flickr-wrapper/tag.rb", "lib/flickr-wrapper/user.rb"]
+  s.require_path = "lib"
+  
+  # Deps
+  s.add_dependency("flickr-rest", ">= 0.0.1")
+end

data/lib/flickr-wrapper/base.rb

@@ -0,0 +1,30 @@
+class Flickr::Base
+  attr_reader :user_id
+  
+  def initialize(user_id)
+    @user_id = user_id
+  end
+
+  # Add some convenience class methods, lovley and general; sets, photos, tags and machine tags
+  
+  # List all photo sets
+  def sets
+    Flickr::PhotoSet.list(self.user_id)
+  end
+  
+  # This is a cheat, we're just going to search with no params.
+  # Maximum amount of photos flickr will let me return is 500
+  def photos
+    Flickr::Photo.list(self.user_id)
+  end
+  
+  # List all tags
+  def tags
+    Flickr::Tag.list(self.user_id)
+  end
+  
+  # List all machine tags
+  def machine_tags
+    Flickr::MachineTag.list(self.user_id)
+  end
+end

data/lib/flickr-wrapper/machine_tag.rb

@@ -0,0 +1,24 @@
+class Flickr::MachineTag < Flickr::Base #:nodoc
+  class Invalid < StandardError; end;
+  
+  include Validatable
+  validates_presence_of :namespace, :predicate, :value
+  
+  attr_accessor :namespace, :predicate, :value
+  
+  def initialize(namespace, predicate, value)
+    @namespace, @predicate, @value = namespace, predicate, value
+  end
+  
+  def self.list(user_id)
+    (Flickr::Query.new(user_id).execute('flickr.tags.getListUser')/:tag).map {|tag| self.from_s tag.inner_text.to_s }.compact
+  end
+  
+  def self.from_s(string)
+    new($1, $2, $3) if string =~ /(.*)\:(.*)\=(.*)/
+  end
+  
+  def to_s
+    "#{namespace}:#{predicate}=#{value}"
+  end
+end

data/lib/flickr-wrapper/photo.rb

@@ -0,0 +1,52 @@
+class Flickr::Photo < Flickr::Base
+  class Size < Struct.new :width, :height, :source, :url; end
+  
+  attr_accessor :id, :title, :description, :tags, :machine_tags, :taken, :posted, :caller
+  
+  def initialize(id, title, description)
+    @id, @title, @description = id, title, description
+  end
+
+  def self.list(user_id)
+    search(user_id)
+  end
+  
+  # Find will grab all sizes of images, process the tags and standard attributes of a photo
+  def self.find(user_id, id)
+    photo_call = Flickr::Query.new(user_id).execute('flickr.photos.getInfo', :photo_id => id)
+      
+    # Set basic attributes
+    photo = self.new(id, *%w(title description).map {|a| (photo_call/a).inner_text })
+    photo.taken = Time.parse(photo_call.at(:dates)['taken'])
+    photo.posted = Time.at(photo_call.at(:dates)['posted'].to_i)
+
+    # Set tags for photo
+    photo.tags = (photo_call/"tag[@machine_tag=0]").map{|tag| Flickr::Tag.new tag['raw'] }
+    photo.machine_tags = (photo_call/"tag[@machine_tag=1]").map{|tag| Flickr::MachineTag.from_s tag['raw'] }
+
+    return photo
+  end
+  
+  # Find a collection of photos by text
+  # Search options should be hashes with string values or arrays for multiple values
+  def self.search(user_id, search_options={})
+    parse(user_id, Flickr::Query.new(user_id).execute('flickr.photos.search', search_options))
+  end
+  
+  def sizes
+    hash = {}
+    (Flickr::Query.new(user_id).execute('flickr.photos.getSizes', :photo_id => id)/:size).each do |size|
+      hash[size['label'].downcase.to_sym] = Size.new(*%w(width height source url).map{|a| size[a]})
+    end
+    hash
+  end
+  
+  private
+  # Parse applies Hpricot to the photos and maps them to a Photo class instance
+  def self.parse(user_id, collection)
+    photos = (collection/:photo)
+    photos.empty? ? [] : photos.map do |photo|
+      self.find(user_id, photo[:id])
+    end
+  end
+end

data/lib/flickr-wrapper/photoset.rb

@@ -0,0 +1,78 @@
+class Flickr::PhotoSet < Flickr::Base
+  attr_accessor :id, :title, :description, :photo_count
+  
+  def initialize id, title, description, photo_count
+    @id, @title, @description, @photo_count = id, title, description, photo_count
+  end
+  
+  # Class methods require scope of the user, it is to be sent into the method
+  def self.list user_id
+    query = Flickr::Query.new user_id
+    parse(query.execute('flickr.photosets.getList'))
+  end
+  
+  # Get information regarding set by searching with the set's ID
+  def self.find user_id, id
+    # Keep scope of the user that made the call
+    @user_id = user_id
+    
+    query = Flickr::Query.new(@user_id).execute('flickr.photosets.getInfo', :photoset_id => id)
+    # Find should return a single entity
+    parse(query).first
+  end
+  
+  # Get the photos within a set 
+  # Queries:
+  # > photosets.getPhotos (1 call)
+  # > Photo.find ID (n calls)
+  def photos
+    (Flickr::Query.new(user_id).execute('flickr.photosets.getPhotos', :photoset_id => id)/:photo).map do |photo|
+      Flickr::Photo.find user_id, photo[:id]
+    end
+  end
+  
+  # Return a list of tags for the set
+  # Queries:
+  # > photosets.getPhotos (1 call)
+  # > Photo.find ID (n calls)
+  def tags
+    tags = []
+    photos.each do |photo|
+      photo.tags.each do |tag|
+        tags << tag.value
+      end
+    end
+    tags.uniq
+  end
+  
+  # Return a list of machine_tags for the set
+  # Queries:
+  # > photosets.getPhotos (1 call)
+  # > Photo.find ID (n calls)
+  def machine_tags
+    tags = []
+    photos.each do |photo|
+      photo.machine_tags.each do |tag|
+        tags << tag
+      end
+    end
+    tags.uniq
+  end
+  
+  # Search for photosets that have similar tags
+  def similar
+    sets = []
+    Flickr::PhotoSet.list(user_id).each do |set|
+      sets << set unless (self.tags & set.tags).empty? or set == self
+    end
+    sets.uniq
+  end
+  
+  private 
+  def self.parse collection
+    photosets = (collection/:photoset)
+    photosets.empty? ? [] : photosets.map do |set|
+      new(set[:id], (set/:title).inner_text, (set/:description).inner_text, set[:photos])
+    end
+  end
+end

data/lib/flickr-wrapper/tag.rb

@@ -0,0 +1,13 @@
+class Flickr::Tag < Flickr::Base
+  attr_accessor :value
+  
+  def initialize(tag)
+    @value = tag
+  end
+  
+  def self.list(user_id)
+    (Flickr::Query.new(user_id).execute('flickr.tags.getListUser')/:tag).map { |tag| 
+      self.new(tag.inner_text.to_s) if tag.inner_text.to_s =~ /^([a-zA-Z0-9_-]+)$/
+    }.compact
+  end
+end

data/lib/flickr-wrapper/user.rb

@@ -0,0 +1,40 @@
+class Flickr::User < Flickr::Base
+  attr_accessor :username, :nsid
+  
+  def initialize username, nsid
+    @username, @nsid = username, nsid
+  end
+  
+  #
+  # ==== Class methods
+  #
+  
+  def self.find_by_email email
+    result = Flickr::Query.new('').execute('flickr.people.findByEmail', :find_email => email)
+    return Flickr::User.new(result.at(:username).inner_text, result.at(:user)['nsid'])
+  end
+  
+  #
+  # ==== Instance methods
+  #
+  
+  def realname
+    get_info.at(:realname).inner_text
+  end
+  
+  # The psyical location string as entered in flickr
+  def location
+    get_info.at(:location).inner_text || "Unknown"
+  end
+  
+  #
+  # ==== Private methods
+  #
+  
+  private 
+    # Get info for the user, once and once only
+    def get_info
+      @info = Flickr::Query.new(@nsid).execute('flickr.people.getInfo', :user_id => nsid) unless @info
+      @info
+    end
+end

data/lib/flickr-wrapper.rb

@@ -0,0 +1,11 @@
+# Dependencies
+require 'rubygems'
+require 'flickr-rest'
+require 'time'
+require 'validatable'
+
+# Namespace junkie
+module Flickr; end
+
+# Classes
+%w(base photoset photo tag machine_tag user).each {|r| require File.join(File.dirname(__FILE__), 'flickr-wrapper', r)}

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification 
+name: benschwarz-flickr-wrapper
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Ben Schwarz
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-05-10 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: flickr-rest
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.0.1
+    version: 
+description: A grassroots wrapper around flickr - Strictly for convenience
+email: ben@germanforblack.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README
+- flickr-wrapper.gemspec
+- lib/flickr-wrapper.rb
+- lib/flickr-wrapper/base.rb
+- lib/flickr-wrapper/machine_tag.rb
+- lib/flickr-wrapper/photo.rb
+- lib/flickr-wrapper/photoset.rb
+- lib/flickr-wrapper/tag.rb
+- lib/flickr-wrapper/user.rb
+has_rdoc: false
+homepage: http://github.com/benschwarz/flickr-wrapper
+post_install_message: 
+rdoc_options: []
+
+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.0.1
+signing_key: 
+specification_version: 2
+summary: A grassroots wrapper for flickr
+test_files: []
+