rflickr 2006.02.01

data/lib/flickr/blogs.rb

@@ -0,0 +1,30 @@
+require 'flickr/base'
+
+class Flickr::Blogs < Flickr::APIBase
+
+	def getList()
+		return @flickr.blog_cache_lookup if @flickr.blog_cache_lookup
+		res = @flickr.call_method('flickr.blogs.getList')
+		list = []
+		res.elements['/blogs'].each_element do |e|
+			att = e.attributes
+			list << Flickr::Blog.new(att['id'], att['name'],
+				att['needspassword'].to_i == 1, att['url'])
+		end
+		@flickr.blog_cache_store(list)
+		return list
+	end
+
+	# blog can be either an integer blog ID or a Blog object
+	# photo can be either an integer photo ID or a Photo object
+	def postPhoto(blog, photo, title, description, blog_password=nil)
+		blog = blog.id if blog.class == Flickr::Blog
+		photo = photo.id if photo.class == Flickr::Photo
+
+		args={'blog'=>blog,'photo'=>photo,'title'=>title,
+			description=>'description'}
+		args['blogs_password'] = blog_password if blog_password
+
+		@flickr.call_method('flickr.blogs.postPhoto',args)
+	end
+end

data/lib/flickr/contacts.rb

@@ -0,0 +1,48 @@
+require 'flickr/base'
+
+class Flickr::Contacts < Flickr::APIBase
+	def getList(filter=nil)
+		res = filter ?
+			@flickr.call_method('flickr.contacts.getList') :
+			@flickr.call_method('flickr.contacts.getList',
+				'filter'=>filter)
+		list = []
+		res.elements['/contacts'].each_element do |e|
+			att = e.attributes
+			nsid = att['nsid']
+
+			person = @flickr.person_cache_lookup(nsid)
+			person ||= Flickr::Person.new(nsid,att['username'])
+
+			person.realname = att['realname']
+			person.friend = (att['friend'].to_i == 1)
+			person.family = (att['family'].to_i == 1)
+			person.ignored = (att['ignored'].to_i == 1)
+
+			list << person
+
+			@flickr.person_cache_store(person)
+		end
+		return list
+	end
+
+	# User can be either the NSID String or a Contact
+	def getPublicList(user)
+		user = user.nsid if user.class == Flickr::Person
+		res = @flickr.call_method('flickr.contacts.getPublicList',
+				'user_id'=>user)
+		list = []
+		res.elements['/contacts'].each_element do |e|
+			att = e.attributes
+			nsid = att['nsid']
+
+			person = @flickr.person_cache_lookup(nsid)
+			person ||= Flickr::Person.new(nsid,att['username'])
+
+			person.ignored = (att['ignored'].to_i == 1)
+			@flickr.person_cache_store(person)
+			list << person
+		end
+		return list
+	end
+end

data/lib/flickr/favorites.rb

@@ -0,0 +1,59 @@
+require 'flickr/base'
+
+class Flickr::Favorites < Flickr::APIBase
+	# photo can be either a Photo or numeric id
+	def add(photo)
+		photo = photo.id if photo.class == Flickr::Photo
+		return @flickr.call_method('flickr.favorites.add',
+			'photo_id' => photo)
+	end
+
+	# photo can be either a Photo or numeric id
+	def remove(photo)
+		photo = photo.id if photo.class == Flickr::Photo
+		return @flickr.call_method('flickr.favorites.remove',
+			'photo_id' => photo)
+	end
+
+	# This is a little weird because all the parametrs are optional,
+	# let's go with it, ok?
+	# user can be a Person or a user NSID
+	# No caching because it's just too hard.
+	def getList(user=nil,extras=nil,per_page=nil,page=nil)
+		args = {}
+
+		user = user.nsid if user.class == Flickr::Person
+		args['user_id'] = user if user
+		args['extras'] = extras.join(',') if extras.class == Array
+		args['per_page'] = per_page if per_page
+		args['page'] = page if page
+
+		res = @flickr.call_method('flickr.favorites.getList',args)
+		att = res.root.attributes
+		return Flickr::PhotoList.from_xml(res,@flickr)
+	end
+
+	# This is a little weird because all the parametrs are optional,
+	# let's go with it, ok?
+	# user can be a Person or a user NSID
+	# No caching because it's just too hard.
+	def getPublicList(user,extras=nil,per_page=nil,page=nil)
+		args = {}
+
+		user = user.nsid if user.class == Flickr::Person
+
+		args['user_id'] = user if user
+		args['extras'] = extras.join(',') if extras.class == Array
+		args['per_page'] = per_page if per_page
+		args['page'] = page if page
+
+		res = @flickr.call_method('flickr.favorites.getPublicList',args)
+		att = res.root.attributes
+		list = Flickr::PhotoList.new(att['page'].to_i,att['pages'].to_i,
+			att['perpage'].to_i,att['total'].to_i)
+		res.elements['/photos'].each_element do |e|
+			list << Flick::Photo.from_xml(e,@flickr)
+		end
+		return list
+	end
+end

data/lib/flickr/groups.rb

@@ -0,0 +1,82 @@
+require 'flickr/base'
+
+class Flickr::Groups < Flickr::APIBase
+	def pools() @pools ||= Flickr::Pools.new(@flickr,self) end
+
+	# category can be a Category or nsid string
+	def browse(category=nil)
+		category=category.id if (category.class == Flickr::Category ||
+			category.class == Flickr::SubCategory )
+
+		args = category ?  {'cat_id' => category } : {}
+		res = @flickr.call_method('flickr.groups.browse',args)
+		att = res.root.attributes
+		cat=Flickr::Category.new(att['name'],att['path'],att['pathids'])
+		res.elements['/category'].each_element('subcat') do |e|
+			att = e.attributes
+			cat.subcats << Flickr::SubCategory.new(att['name'],
+				att['id'],att['count'].to_i)
+		end
+		res.elements['/category'].each_element('group') do |e|
+			att = e.attributes
+			nsid = att['nsid']
+
+			g = @flickr.group_cache_lookup(nsid)
+			g ||= Flickr::Group.new(@flickr,nsid)
+
+			g.name = att['name']
+			g.members = att['members'].to_i
+			g.online = att['online'].to_i
+			g.chatnsid = att['chatnsid']
+			g.inchat = att['inchat'].to_i
+
+			@flickr.group_cache_store(g)
+			cat.groups << g
+		end
+
+		return cat
+	end
+
+	# group can be a Group or group nsid
+	def getInfo(group)
+		group = group.nsid if group.class == Flickr::Group
+		g = @flickr.group_cache_lookup(group)
+		return g if g && g.fully_fetched
+
+		res = @flickr.call_method('flickr.groups.getInfo',
+			'group_id' => group)
+		group = res.elements['/group'].attributes['id']
+		g ||= Flickr::Group.new(@flickr,nsid)
+		g.name = res.elements['/group/name'].text
+		g.description = res.elements['/group/description'].text
+		g.members = res.elements['/group/members'].text.to_i
+		g.privacy = res.elements['/group/privacy'].text.to_i
+		g.fully_fetched = true
+
+		@flickr.group_cache_store(g)
+		return g
+	end
+
+	def search(text,per_page=nil,page=nil)
+		args = { 'text' => text }
+		args['per_page'] = per_page if per_page
+		args['page'] = page if page
+		res = @flickr.call_method('flickr.groups.search',args)
+		att = res.root.attributes
+		list = Flickr::GroupList.new(att['page'].to_i,att['pages'].to_i,
+			att['perpage'].to_i,att['total'].to_i)
+		res.elements['/groups'].each_element('group') do |e|
+			att = e.attributes
+			nsid = att['nsid']
+			g = @flickr.group_cache_lookup(nsid) ||
+				Flickr::Group.new(@flickr,nsid)
+			g.name = att['name']
+			g.eighteenplus = att['eighteenplus'].to_i == 1
+
+			@flickr.group_cache_store(g)
+			list << g
+		end
+		return list
+	end
+
+end

data/lib/flickr/interestingness.rb

@@ -0,0 +1,19 @@
+require 'flickr/base'
+
+class Flickr::Interestingness < Flickr::APIBase
+	def getList(date=nil,extras=nil,per_page=nil,page=nil)
+		args = {}
+		if date
+			args['date'] = date if date.is_a?(String)
+			args['date'] = date.to_s if date.is_a?(Date)
+			args['date'] = @flickr.mysql_date(date) if
+				date.is_a?(Time)
+		end
+		extras = extras.join(',') if extras.class == Array
+		args['extras'] = extras if extras
+		args['per_page'] = per_page if per_page
+		args['page'] = page if page
+                res = @flickr.call_method('flickr.interestingness.getList',args)
+		return Flickr::PhotoSet.from_xml(res.root,@flickr)
+	end
+end

data/lib/flickr/licenses.rb

@@ -0,0 +1,23 @@
+require 'flickr/base'
+
+class Flickr::Licenses < Flickr::APIBase
+	def getInfo
+		return @flickr.license_cache_lookup if
+			@flickr.license_cache_lookup
+		list = {}
+		res = @flickr.call_method('flickr.photos.licenses.getInfo')
+		res.elements['/licenses'].each_element do |el|
+			lic = Flickr::License.from_xml(el)
+			list[lic.id] = lic
+		end
+		@flickr.license_cache_store(list)
+		return list
+	end
+	
+	def setLicense(photo,license)
+		photo = photo.id if photo.class == Flickr::Photo
+		license = license.id if license.class == Flickr::License
+		@flickr.call_method('flickr.photos.licenses.setLicense',
+			'photo_id' => photo, 'license_id' => license)
+	end
+end

data/lib/flickr/notes.rb

@@ -0,0 +1,24 @@
+require 'flickr/base'
+
+class Flickr::Notes < Flickr::APIBase
+	def add(photo,x,y,w,h,text)
+		photo = photo.id if photo.class == Flickr::Photo
+		res = @flickr.call_method('flickr.photos.notes.add',
+			'photo_id' => photo, 'note_x' => x, 'note_y' => y,
+			'note_w' => w, 'note_h' => h, 'note_text' => text)
+		return res.elements['/note'].attributes['id']
+	end
+
+	def delete(note)
+		note = note.id if note.class == Flickr::Note
+		res = @flickr.call_method('flickr.photos.notes.delete',
+			'note_id' => note)
+	end
+
+	def edit(note,x,y,w,h,text)
+		note = note.id if note.class == Flickr::Note
+		res = @flickr.call_method('flickr.photos.notes.edit',
+			'note_id' => note, 'note_x' => x, 'note_y' => y,
+			'note_w' => w, 'note_h' => h, 'note_text' => text)
+	end
+end

data/lib/flickr/people.rb

@@ -0,0 +1,79 @@
+require 'flickr/base'
+
+class Flickr::People < Flickr::APIBase
+	def findByEmail(find_email)
+		res = @flickr.call_method('flickr.people.findByEmail',
+			'find_email' => find_email)
+		p = Flickr::Person.from_xml(res,@flickr)
+		return p
+	end
+
+	def findByUsername(username)
+		res = @flickr.call_method('flickr.people.findByUsername',
+			'username' => username)
+		p = Flickr::Person.from_xml(res,@flickr)
+		return p
+	end
+
+	# user can be a Person or an nsid
+	def getInfo(user)
+		user = user.nsid if user.class == Flickr::Person
+		res = @flickr.call_method('flickr.people.getInfo',
+				'user_id'=>user)
+		person = Flickr::Person.from_xml(res,@flickr)
+		return person
+	end
+
+	# user can be a Person or an nsid
+	def getPublicGroups(user)
+	require 'flickr/groups'
+		groups = @flickr.groups
+		user = user.nsid if user.class == Flickr::Person
+		res = @flickr.call_method('flickr.people.getPublicGroups',
+			'user_id' => user)
+		list = []
+		res.elements['/groups'].each_element('group') do |e|
+			att = e.attributes
+			nsid = att['nsid']
+
+			g = @flickr.group_cache_lookup(nsid) ||
+				Flickr::Group.new(@flickr,nsid)
+
+			g.name = att['name']
+			g.eighteenplus = att['eighteenplus'].to_i == 1
+
+			@flickr.group_cache_store(g)
+			list << g
+		end
+		return list
+	end
+
+	def getPublicPhotos(user,extras=nil,per_page=nil,page=nil)
+		args = {}
+
+		user = user.nsid if user.class == Flickr::Person
+
+		args['user_id'] = user if user
+		args['extras'] = extras.join(',') if extras.class == Array
+		args['per_page'] = per_page if per_page
+		args['page'] = page if page
+
+		res = @flickr.call_method('flickr.people.getPublicPhotos',args)
+		att = res.root.attributes
+		list = Flickr::PhotoList.new(att['page'].to_i,att['pages'].to_i,
+			att['perpage'].to_i,att['total'].to_i)
+		res.elements['/photos'].each_element do |e|
+			list << Flickr::Photo.from_xml(e,@flickr)
+		end
+		return list
+	end
+
+	# user can be a Person or an nsid
+	def getUploadStatus(user)
+		user = user.nsid if user.class == Flickr::Person
+		res = @flickr.call_method('flickr.people.getUploadStatus',
+				'user_id'=>user)
+		person = Flickr::Person.from_xml(res,@flickr)
+		return person
+	end
+end

data/lib/flickr/photos.rb

@@ -0,0 +1,285 @@
+require 'flickr/base'
+
+class Flickr::Photos < Flickr::APIBase
+	def upload
+	require 'flickr/upload'
+		@upload ||= Flickr::Upload.new(@flickr)
+	end
+
+	def licenses
+	require 'flickr/licenses'
+		@licenses ||= Flickr::Licenses.new(@flickr)
+	end
+
+	def notes
+	require 'flickr/notes'
+		@notes ||= Flickr::Notes.new(@flickr)
+	end
+
+	def transform
+	require 'flickr/transform'
+		@transform ||= Flickr::Transform.new(@flickr)
+	end
+
+	# photo can be a Photo or a photo id
+	# tags is an array of tags
+	def addTags(photo,tags)
+		photo = photo.id if photo.class == Flickr::Photo
+		tstr = tags.join(',')
+		@flickr.call_method('flickr.photos.addTags',
+			'photo' => photo, 'tags' => tstr)
+	end
+
+	def removeTag(tag)
+		tag = tag.id if tag.class == Flickr::Tag
+		@flickr.call_method('flickr.photos.removeTag', 'tag_id' => tag)
+	end
+
+	def setTags(tags)
+		tags=tags.map{|t| (t.class == Flickr::Tag) ? t.id : t}.join(' ')
+		photo = photo.id if photo.class == Flickr::Photo
+		@flickr.call_method('flickr.photos.setTags',
+			'photo_id' => photo, 'tags' => tags)
+	end
+
+	# photo can be a Photo or photo id string/number
+	def delete(photo)
+		photo = photo.id if photo.class == Flickr::Photo
+		res = @flickr.call_method('flickr.photos.delete',
+		    'photo_id'=>photo)
+	end
+
+	# photo can be a Photo or photo id string/number
+	def getAllContexts(photo)
+		photo = photo.id if photo.class == Flickr::Photo
+		res @flickr.call_method('flickr.photos.getAllContexts',
+		    'photo_id'=>photo)
+		list = []
+		res.each_element('set') do |set|
+			att = set.attributes
+			psid = att['id']
+			set = @flickr.photoset_cache_lookup(psid) ||
+				Flickr::PhotoSet.new(att['id'],@flickr)
+			set.title = att['title']
+
+			@flickr.photoset_cache_store(set)
+			list << set
+		end
+		res.each_element('pool') do |set|
+			att = set.attributes
+			ppid = att['id']
+
+			p = @flickr.photopool_cache_lookup(ppid) ||
+				Flickr::PhotoPool.new(ppid,@flickr)
+			p.title = att['title']
+			@flickr.photopool_cache_store(ppid)
+			list << p
+		end
+		return list
+	end
+
+	def getPerms(photo)
+		photo = photo.id if photo.class == Flickr::Photo
+		res = @flickr.call_method('flickr.photos.getPerms',
+			'photo_id' => photo)
+		perms = res.elements['/perms']
+		att = perms.attributes
+		phid = att['id']
+		photo = (photo.class == Flickr::Photo) ? photo :
+			(@flickr.photo_cache_lookup(phid) ||
+			 	Flickr::Photo.new(@flickr,phid))
+		photo.ispublic = (att['ispublic'].to_i == 1)
+		photo.isfriend = (att['isfriend'].to_i == 1)
+		photo.isfamily = (att['isfamily'].to_i == 1)
+		photo.permcomment = att['permcomment'].to_i 
+		photo.permaddmeta = att['permaddmeta'].to_i
+		return photo
+	end
+
+	def setPerms(photo,is_public,is_friend,is_family,perm_comment,
+			perm_addmeta)
+		photo = photo.id if photo.class == Flickr::Photo
+		args = {
+		'photo_id' => photo,
+		'is_public' => (is_public == true || is_public == 1) ? 1 : 0,
+		'is_friend' => (is_friend == true || is_friend == 1) ? 1 : 0,
+		'is_family' => (is_family == true || is_family == 1) ? 1 : 0,
+		'perm_comment' => perm_comment,
+		'perm_addmeta' => perm_addmeta
+		}
+		res = @flickr.call_method('flickr.photos.setPerms',args)
+	end
+
+	def getContactsPhotos(count=nil,just_friends=nil,single_photo=nil,
+			include_self=nil)
+		args = {}
+		args['count'] = count if count
+		args['just_friends'] = just_friends ? '1' : '0' if
+			just_friends != nil
+		args['single_photo'] = single_photo ? '1' : '0' if
+			single_photo != nil
+		args['include_self'] = include_self ? '1' : '0' if
+			include_self != nil
+		res= @flickr.call_method('flickr.photos.getContactsPhotos',args)
+		return Flickr::PhotoList.from_xml(res,@flickr)
+	end
+
+	# Person can be a string nsid or anything that responds to the
+	# nsid method.
+	def getContactsPublicPhotos(user, count=nil,just_friends=nil,
+			single_photo=nil, include_self=nil)
+		user = user.nsid if user.respond_to?(:nsid)
+		args = {}
+		args['count'] = count if count
+		args['user_id'] = user
+		args['just_friends'] = just_friends ? '1' : '0' if
+			just_friends != nil
+		args['single_photo'] = single_photo ? '1' : '0' if
+			single_photo != nil
+		args['include_self'] = include_self ? '1' : '0' if
+			include_self != nil
+		res=@flickr.call_method('flickr.photos.getContactsPublicPhotos',
+		                        args)
+		 return Flickr::PhotoList.from_xml(res,@flickr)
+	end
+
+	def getContext(photo)
+		photo = photo.id if photo.class == Flickr::Photo
+		res = @flickr.call_method('flickr.photos.getContext',
+			'photo_id' => photo)
+		return Flickr::Context.from_xml(res)
+	end
+
+	def getCounts(dates=nil,taken_dates=nil)
+		args = {}
+		args['dates'] = dates.map{|d| d.to_i}.join(',') if dates
+		args['taken_dates'] = taken_dates.map{|d| d.to_i}.join(',') if
+			taken_dates
+		res = @flickr.call_method('flickr.photos.getCounts',args)
+		list = []
+		res.elements['/photocounts'].each_element('photocount') do |el|
+			list << Flickr::Count.from_xml(el)
+		end
+		return list
+	end
+
+	def getExif(photo,secret = nil)
+		photo = photo.id if photo.class == Flickr::Photo
+		args = {'photo_id' => photo}
+		args['secret'] = secret if secret
+		res = @flickr.call_method('flickr.photos.getExif',args)
+		return Flickr::Photo.from_xml(res.elements['/photo'],@flickr)
+	end
+
+	def getInfo(photo,secret = nil)
+		photo = (photo.class == Flickr::Photo) ? photo.id : photo
+		args= {'photo_id' => photo}
+		args['secret'] = secret if secret
+		res = @flickr.call_method('flickr.photos.getInfo',args)
+		return Flickr::Photo.from_xml(res.elements['photo'],@flickr)
+	end
+	
+	def getNotInSet(extras=nil,per_page = nil, page = nil)
+		args = {}
+		extras = extras.join(',') if extras.class == Array
+		args['extras'] = extras if extras
+		args['per_page'] = per_page if per_page
+		args['page'] = page if page
+		res = @flickr.call_method('flickr.photos.getNotInSet',args)
+		return Flickr::PhotoList.from_xml(res,@flickr)
+	end
+	
+	def getRecent(extras=nil,per_page = nil, page = nil)
+		args = {}
+		extras = extras.join(',') if extras.class == Array
+		args['extras'] = extras if extras
+		args['per_page'] = per_page if per_page
+		args['page'] = page if page
+		res = @flickr.call_method('flickr.photos.getRecent',args)
+		return Flickr::PhotoList.from_xml(res,@flickr)
+	end
+	
+	def getUntagged(extras=nil,per_page = nil, page = nil)
+		args = {}
+		extras = extras.join(',') if extras.class == Array
+		args['extras'] = extras if extras
+		args['per_page'] = per_page if per_page
+		args['page'] = page if page
+		res = @flickr.call_method('flickr.photos.getUntagged',args)
+		return Flickr::PhotoList.from_xml(res,@flickr)
+	end
+
+	def getSizes(photo)
+		photo_id = (photo.class == Flickr::Photo) ? photo.id : photo
+		photo = (photo.class == Flickr::Photo) ? photo :
+			(@flickr.photo_cache_lookup(photo_id) ||
+			 	Flickr::Photo.new(@flickr,photo_id))
+		res = @flickr.call_method('flickr.photos.getSizes',
+			'photo_id' => photo_id )
+		photo.sizes = {}
+		res.elements['/sizes'].each_element do |el|
+			size = Flickr::Size.from_xml(el)
+			photo.sizes[size.label.intern] = size
+		end
+		@flickr.photo_cache_store(photo)
+		return photo
+	end
+
+	def setDates(photo,date_posted=nil,date_taken=nil,
+			date_taken_granularity=nil)
+		photo = photo.id if photo.class == Flickr::Photo
+		date_posted = date_posted.to_i if date_posted.class == Time
+		date_taken = @flickr.mysql_datetime(date_taken) if
+			date_taken.class == Time
+		args = {'photo_id' => photo}
+		args['date_posted'] = date_posted if date_posted
+		args['date_taken'] = date_taken if date_taken
+		args['date_taken_granularity'] = date_taken_granularity if
+			date_taken_granularity
+		@flickr.call_method('flickr.photos.setDates',args)
+	end
+
+	def setMeta(photo,title,description)
+		photo = photo.id if photo.class == Flickr::Photo
+		args = {'photo_id' => photo,
+			'title' => title,
+			'description' => description}
+		@flickr.call_method('flickr.photos.setMeta',args)
+	end
+
+	def search(user=nil,tags=nil,tag_mode=nil,text=nil,min_upload_date=nil,
+		max_upload_date=nil,min_taken_date=nil,max_taken_date=nil,
+		license=nil,extras=nil,per_page=nil,page=nil,sort=nil)
+	
+		user = user.nsid if user.respond_to?(:nsid)
+		tags = tags.join(',') if tags.class == Array
+		min_upload_date = min_upload_date.to_i if
+			min_upload_date.class == Time
+		max_upload_date = max_upload_date.to_i if
+			max_upload_date.class == Time
+		min_taken_date = @flickr.mysql_datetime(min_taken_date) if
+			min_taken_date.class == Time
+		max_taken_date = @flickr.mysql_datetime(max_taken_date) if
+			max_taken_date.class == Time
+		license = license.id if license.class == Flickr::License
+		extras = extras.join(',') if extras.class == Array
+
+		args = {}
+		args['user_id'] = user if user
+		args['tags'] = tags if tags
+		args['tag_mode'] = tag_mode if tag_mode
+		args['text'] = text if text
+		args['min_upload_date'] = min_upload_date if min_upload_date
+		args['max_upload_date'] = max_upload_date if max_upload_date
+		args['min_taken_date'] = min_taken_date if min_taken_date
+		args['max_taken_date'] = max_taken_date if max_taken_date
+		args['license'] = license if license
+		args['extras'] = extras if extras
+		args['per_page'] = per_page if per_page
+		args['page'] = page if page
+		args['sort'] = sort if sort
+
+		res = @flickr.call_method('flickr.photos.search',args)
+		return Flickr::PhotoList.from_xml(res,@flickr)
+	end
+end