digitalpardoe-rflickr 1.0.0.0

data/lib/flickr/blogs.rb

@@ -0,0 +1,50 @@
+# rFlickr: A Ruby based Flickr API implementation.
+# Copyright (C) 2009, Alex Pardoe (digital:pardoe)
+#
+# Derrived from work by Trevor Schroeder, see here:
+# http://rubyforge.org/projects/rflickr/.
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License
+# as published by the Free Software Foundation; either version 2
+# of the License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+
+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,68 @@
+# rFlickr: A Ruby based Flickr API implementation.
+# Copyright (C) 2009, Alex Pardoe (digital:pardoe)
+#
+# Derrived from work by Trevor Schroeder, see here:
+# http://rubyforge.org/projects/rflickr/.
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License
+# as published by the Free Software Foundation; either version 2
+# of the License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+
+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,79 @@
+# rFlickr: A Ruby based Flickr API implementation.
+# Copyright (C) 2009, Alex Pardoe (digital:pardoe)
+#
+# Derrived from work by Trevor Schroeder, see here:
+# http://rubyforge.org/projects/rflickr/.
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License
+# as published by the Free Software Foundation; either version 2
+# of the License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+
+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,102 @@
+# rFlickr: A Ruby based Flickr API implementation.
+# Copyright (C) 2009, Alex Pardoe (digital:pardoe)
+#
+# Derrived from work by Trevor Schroeder, see here:
+# http://rubyforge.org/projects/rflickr/.
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License
+# as published by the Free Software Foundation; either version 2
+# of the License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+
+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,39 @@
+# rFlickr: A Ruby based Flickr API implementation.
+# Copyright (C) 2009, Alex Pardoe (digital:pardoe)
+#
+# Derrived from work by Trevor Schroeder, see here:
+# http://rubyforge.org/projects/rflickr/.
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License
+# as published by the Free Software Foundation; either version 2
+# of the License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+
+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,43 @@
+# rFlickr: A Ruby based Flickr API implementation.
+# Copyright (C) 2009, Alex Pardoe (digital:pardoe)
+#
+# Derrived from work by Trevor Schroeder, see here:
+# http://rubyforge.org/projects/rflickr/.
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License
+# as published by the Free Software Foundation; either version 2
+# of the License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+
+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,44 @@
+# rFlickr: A Ruby based Flickr API implementation.
+# Copyright (C) 2009, Alex Pardoe (digital:pardoe)
+#
+# Derrived from work by Trevor Schroeder, see here:
+# http://rubyforge.org/projects/rflickr/.
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License
+# as published by the Free Software Foundation; either version 2
+# of the License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+
+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,99 @@
+# rFlickr: A Ruby based Flickr API implementation.
+# Copyright (C) 2009, Alex Pardoe (digital:pardoe)
+#
+# Derrived from work by Trevor Schroeder, see here:
+# http://rubyforge.org/projects/rflickr/.
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License
+# as published by the Free Software Foundation; either version 2
+# of the License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+
+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