flickr_fu 0.1.6 → 0.3.0

data/lib/flickr/photos.rb

@@ -111,6 +111,8 @@ class Flickr::Photos < Flickr::Base
   #     Number of photos to return per page. If this argument is omitted, it defaults to 100. The maximum allowed value is 500.
   # * page (Optional)
   #     The page of results to return. If this argument is omitted, it defaults to 1.
+  # * media (Optional)
+  #     The type of media to search for. 'photo', 'video', or 'both' are allowed arguments, with 'both' being the default.
   # 
   def search(options)
     options.merge!({:extras => "license,date_upload,date_taken,owner_name,icon_server,original_format,last_update,geo,tags,machine_tags,o_dims,views,media"})
@@ -143,8 +145,10 @@ class Flickr::Photos < Flickr::Base
   #     Number of photos to return per page. If this argument is omitted, it defaults to 100. The maximum allowed value is 500.
   # * page (Optional)
   #     The page of results to return. If this argument is omitted, it defaults to 1.
+  # * media (Optional)
+  #     The type of media to search for. 'photo', 'video', or 'both' are allowed arguments, with 'both' being the default.
   # 
-  def get_recent(options)
+  def get_recent(options = {})
     options.merge!({:extras => "license,date_upload,date_taken,owner_name,icon_server,original_format,last_update,geo,tags,machine_tags,o_dims,views,media"})
 
     rsp = @flickr.send_request('flickr.photos.getRecent', options)
@@ -187,7 +191,30 @@ class Flickr::Photos < Flickr::Base
   end
   
   def licenses
-    @licenses ||= get_licenses
+    @licenses ||= begin
+      rsp = @flickr.send_request('flickr.photos.licenses.getInfo')
+      
+      returning Hash.new do |licenses|
+        rsp.licenses.license.each do |license|
+          licenses[license[:id].to_i] = Flickr::Photos::License.new(:id => license[:id].to_i, :name => license[:name], :url => license[:url])
+        end
+      end
+    end
+  end
+
+  # creates and/or returns the Flickr::Photos::Geo object
+  def geo
+    @geo ||= Flickr::Photos::Geo.new(@flickr)
+  end
+  
+  # Returns a Flickr::Photos::Photo object of the given id.
+  # Raises an error if photo not found
+  def find_by_id(photo_id)
+    rsp = @flickr.send_request('flickr.photos.getInfo', :photo_id => photo_id)
+    Photo.new(@flickr, :id => rsp.photo[:id].to_i, :owner => rsp.photo.owner,
+      :secret => rsp.photo[:secret], :server => rsp.photo[:server].to_i, :farm => rsp.photo[:farm], 
+      :title => rsp.photo.title,
+      :is_public => rsp.photo.visibility[:public], :is_friend => rsp.photo.visibility[:is_friend], :is_family => rsp.photo.visibility[:is_family])
   end
   
   protected
@@ -216,13 +243,4 @@ class Flickr::Photos < Flickr::Base
      :media => photo[:media]}
   end
   
-  def get_licenses
-    rsp = @flickr.send_request('flickr.photos.licenses.getInfo')
-    
-    returning Hash.new do |licenses|
-      rsp.licenses.license.each do |license|
-        licenses[license[:id].to_i] = Flickr::Photos::License.new(:id => license[:id].to_i, :name => license[:name], :url => license[:url])
-      end
-    end
-  end
 end

data/lib/flickr/photoset.rb

@@ -0,0 +1,37 @@
+class Flickr::Photosets::Photoset
+  attr_accessor :id,:num_photos,:title,:description
+  
+  def initialize(flickr, attributes)
+    @flickr = flickr
+    attributes.each do |k,v|
+      send("#{k}=", v)
+    end
+  end
+  
+  def get_photos(options={})
+    options = options.merge(:photoset_id=>id)
+    rsp = @flickr.send_request('flickr.photosets.getPhotos', options)
+    collect_photos(rsp)
+  end
+  
+  protected
+    def collect_photos(rsp)
+      photos = []
+      return photos unless rsp
+      if rsp.photoset.photo
+        rsp.photoset.photo.each do |photo|
+          attributes = create_attributes(photo)
+          photos << Flickr::Photos::Photo.new(@flickr,attributes)
+        end
+      end
+      return photos
+    end
+    
+    def create_attributes(photo)
+      {:id => photo[:id],
+       :secret => photo[:secret], 
+       :server => photo[:server], 
+       :farm => photo[:farm],
+       :title => photo[:title]}
+    end
+end

data/lib/flickr/photosets.rb

@@ -0,0 +1,39 @@
+class Flickr::Photosets < Flickr::Base
+  def initialize(flickr)
+    @flickr = flickr
+  end
+  
+  # Get the authorized user's contact list.
+  # 
+  def get_list(options={})
+    rsp = @flickr.send_request('flickr.photosets.getList', options)
+    collect_photosets(rsp)
+  end
+    
+  protected  
+    def collect_photosets(rsp)
+      photosets = []
+      return photosets unless rsp
+      if rsp.photosets.photoset
+        rsp.photosets.photoset.each do |photoset|
+          attributes = create_attributes(photoset)
+          photosets << Photoset.new(@flickr, attributes)
+        end
+      end
+      return photosets
+    end
+  
+    def create_attributes(photoset)
+      # comment by : smeevil
+      #
+      # for some reason it was needed to call to_s on photoset.title and photoset.description
+      # without this it will not set the value correctly
+      {
+        :id => photoset[:id], 
+        :num_photos => photoset[:photos],
+        :title => photoset.title.to_s,
+        :description => photoset.description.to_s
+       }
+    end
+  
+end

data/lib/flickr/token.rb

@@ -10,7 +10,7 @@ class Flickr::Auth::Token
   #     a hash of attributes used to set the initial values of the token object
   def initialize(attributes)
     attributes.each do |k,v|
-      send("#{k}=", v)
+      send("#{k}=", v) if respond_to?("#{k}=")
     end
   end
 

data/lib/flickr/urls.rb

@@ -0,0 +1,44 @@
+# Wrapping class that holds methods in the flickr.urls namespace
+class Flickr::Urls < Flickr::Base
+  def initialize(flickr)
+    @flickr = flickr
+  end
+
+  def get_group group_id
+    rsp = @flickr.send_request('flickr.urls.getGroup', {:group_id => group_id})
+    rsp.group[:url]
+  end
+
+  def get_user_photos user_id
+    rsp = @flickr.send_request('flickr.urls.getUserPhotos', {:user_id => user_id})
+    rsp.user[:url]
+  end
+
+  def get_user_profile user_id
+    rsp = @flickr.send_request('flickr.urls.getUserProfile', {:user_id => user_id})
+    rsp.user[:url]
+  end
+
+  def lookup_group url #, options = {}
+    #options.symbolize_keys!
+    #options.reverse_merge!({:include_groupname => false})
+    rsp = @flickr.send_request('flickr.urls.lookupGroup', {:url => url})
+    #if options[:include_groupname]
+    #[rsp.group[:id], {:groupname => rsp.group.groupname}]
+    #else
+    rsp.group[:id]
+    #end
+  end
+
+  def lookup_user url
+    rsp = @flickr.send_request('flickr.urls.lookupUser', {:url => url})
+    user_id = UserLookupResult.new(rsp.user[:id])
+    user_id.username = rsp.user.username
+    user_id
+  end
+
+  class UserLookupResult < String
+    attr_accessor :username
+  end
+  
+end

data/lib/flickr_fu.rb

@@ -3,6 +3,7 @@ require 'xml_magic'
 require 'net/http'
 require 'cgi'
 require 'uri'
+require 'open-uri'
 require 'mime/types'
 require 'digest/md5'
 require 'yaml'
@@ -10,7 +11,29 @@ require 'time'
 require 'date'
 
 # base must load first
-%w(base test auth token photos photo photo_response comment note size uploader status people person license).each do |file|
+[ "base",
+  "test",
+  "auth",
+  "token",
+  "photos",
+  "photo",
+  "photo_response",
+  "photosets",
+  "photoset",
+  "comment",
+  "note",
+  "size",
+  "uploader",
+  "status",
+  "people",
+  "person",
+  "license",
+  "errors",
+  "contacts",
+  "contact",
+  "geo",
+  "location",
+  "urls" ].each do |file|
   require File.join(File.dirname(__FILE__), 'flickr', file)
 end
 
@@ -22,4 +45,4 @@ class Object
     yield(value)
     value
   end
-end
+end

data/spec/fixtures/flickr/contacts/get_list-fail-99.xml

@@ -0,0 +1,4 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<rsp stat="fail">
+	<err code="99" msg="Insufficient permissions. Method requires read privileges; none granted."/>
+</rsp>

data/spec/fixtures/flickr/contacts/get_public_list-0.xml

@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<rsp stat="ok">
+<contacts page="1" pages="1" per_page="1000" perpage="1000" total="2">
+        <contact nsid="40718771@N00" username="kooop" iconserver="2" iconfarm="1" ignored="0" />
+        <contact nsid="20039881@N00" username="wayoutwest" iconserver="1" iconfarm="1" ignored="0" />
+</contacts>
+</rsp>

data/spec/fixtures/flickr/photos/geo/get_location-0.xml

@@ -0,0 +1,11 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<rsp stat="ok">
+	<photo id="2984637736">
+		<location latitude="50.041376" longitude="21.999006" accuracy="16" context="0" place_id="X.5ul_ucAJtJcT0" woeid="517126">
+			<locality place_id="X.5ul_ucAJtJcT0" woeid="517126">Rzeszów</locality>
+			<county place_id="gUrbqNqYA5n4kv.erw" woeid="12591341">Rzeszów</county>
+			<region place_id="acDFruGYA5lyOpcIVg" woeid="12577943">Subcarpathia</region>
+			<country place_id="0kV97TybAphIxvm14g" woeid="23424923">Poland</country>
+		</location>
+	</photo>
+</rsp>

data/spec/fixtures/flickr/photos/geo/get_location-fail-2.xml

@@ -0,0 +1,4 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<rsp stat="fail">
+	<err code="2" msg="Photo has no location information."/>
+</rsp>

data/spec/fixtures/flickr/photos/get_info-0.xml

@@ -0,0 +1,41 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<rsp stat="ok">
+	<photo id="2984637736" secret="9e5762e027" server="3180" farm="4" dateuploaded="1225297614" isfavorite="0" license="0" rotation="0" media="photo">
+		<owner nsid="80755658@N00" username="Maciej Biłas" realname="Maciej Biłas" location="Rzeszów, Poland"/>
+		<title>Demolition of Hotel Rzeszów</title>
+		<description>
+The last picture from a quite old event. The demolition of the best known hotel in Rzeszów called Hotel Rzeszów.
+		</description>
+		<visibility ispublic="1" isfriend="0" isfamily="0"/>
+		<dates posted="1225297614" taken="2007-04-20 17:56:06" takengranularity="0" lastupdate="1227358764"/>
+		<editability cancomment="0" canaddmeta="0"/>
+		<usage candownload="0" canblog="0" canprint="0"/>
+		<comments>0</comments>
+		<notes/>
+		<tags>
+			<tag id="4963651-2984637736-9769036" author="80755658@N00" raw="Hotel Rzeszów" machine_tag="0">hotelrzeszów
+			</tag>
+			<tag id="4963651-2984637736-9381" author="80755658@N00" raw="demolition" machine_tag="0">demolition
+			</tag>
+			<tag id="4963651-2984637736-1888184" author="80755658@N00" raw="Rzeszów" machine_tag="0">rzeszów
+			</tag>
+			<tag id="4963651-2984637736-8302" author="80755658@N00" raw="Poland" machine_tag="0">poland
+			</tag>
+		</tags>
+		<location latitude="50.041376" longitude="21.999006" accuracy="16" place_id="X.5ul_ucAJtJcT0" woeid="517126">
+			<locality place_id="X.5ul_ucAJtJcT0" woeid="517126">Rzeszów
+			</locality>
+			<county place_id="gUrbqNqYA5n4kv.erw" woeid="12591341">Rzeszów
+			</county>
+			<region place_id="acDFruGYA5lyOpcIVg" woeid="12577943">Subcarpathia
+			</region>
+			<country place_id="0kV97TybAphIxvm14g" woeid="23424923">Poland
+			</country>
+		</location>
+		<geoperms ispublic="1" iscontact="0" isfriend="0" isfamily="0"/>
+		<urls>
+			<url type="photopage">http://www.flickr.com/photos/lvizard/2984637736/
+			</url>
+		</urls>
+	</photo>
+</rsp>

data/spec/fixtures/flickr/photos/get_info-1.xml

@@ -0,0 +1,19 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<rsp stat="ok">
+	<photo id="3059178826" secret="951324cc9f" server="3008" farm="4" dateuploaded="1227628465" isfavorite="0" license="0" rotation="0" originalsecret="fdbf0e4ced" originalformat="jpg" views="0" media="photo">
+		<owner nsid="80755658@N00" username="Maciej Biłas" realname="Maciej Biłas" location="Rzeszów, Poland"/>
+		<title>test</title>
+		<description/>
+		<visibility ispublic="0" isfriend="0" isfamily="0"/>
+		<dates posted="1227628465" taken="2008-11-25 16:54:25" takengranularity="0" lastupdate="1227628476"/>
+		<permissions permcomment="3" permaddmeta="2"/>
+		<editability cancomment="1" canaddmeta="1"/>
+		<usage candownload="0" canblog="1" canprint="1"/>
+		<comments>0</comments>
+		<notes/>
+		<tags/>
+		<urls>
+			<url type="photopage">http://www.flickr.com/photos/lvizard/3059178826/</url>
+		</urls>
+	</photo>
+</rsp>

data/spec/fixtures/flickr/photos/get_sizes-0.xml

@@ -0,0 +1,10 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<rsp stat="ok">
+	<sizes canblog="0" canprint="0" candownload="0">
+		<size label="Square" width="75" height="75" source="http://farm4.static.flickr.com/3180/2984637736_9e5762e027_s.jpg" url="http://www.flickr.com/photos/lvizard/2984637736/sizes/sq/" media="photo"/>
+		<size label="Thumbnail" width="100" height="67" source="http://farm4.static.flickr.com/3180/2984637736_9e5762e027_t.jpg" url="http://www.flickr.com/photos/lvizard/2984637736/sizes/t/" media="photo"/>
+		<size label="Small" width="240" height="160" source="http://farm4.static.flickr.com/3180/2984637736_9e5762e027_m.jpg" url="http://www.flickr.com/photos/lvizard/2984637736/sizes/s/" media="photo"/>
+		<size label="Medium" width="500" height="333" source="http://farm4.static.flickr.com/3180/2984637736_9e5762e027.jpg" url="http://www.flickr.com/photos/lvizard/2984637736/sizes/m/" media="photo"/>
+		<size label="Large" width="1024" height="683" source="http://farm4.static.flickr.com/3180/2984637736_9e5762e027_b.jpg" url="http://www.flickr.com/photos/lvizard/2984637736/sizes/l/" media="photo"/>
+	</sizes>
+</rsp>

data/spec/fixtures/flickr/photos/get_sizes-1.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<rsp stat="ok">
+	<sizes canblog="1" canprint="1" candownload="0">
+		<size label="Square" width="75" height="75" source="http://farm4.static.flickr.com/3008/3059178826_951324cc9f_s.jpg" url="http://www.flickr.com/photos/lvizard/3059178826/sizes/sq/" media="photo"/>
+		<size label="Thumbnail" width="70" height="72" source="http://farm4.static.flickr.com/3008/3059178826_951324cc9f_t.jpg" url="http://www.flickr.com/photos/lvizard/3059178826/sizes/t/" media="photo"/>
+		<size label="Original" width="70" height="72" source="http://farm4.static.flickr.com/3008/3059178826_fdbf0e4ced_o.jpg" url="http://www.flickr.com/photos/lvizard/3059178826/sizes/o/" media="photo"/>
+	</sizes>
+</rsp>

data/spec/fixtures/flickr/photos/licenses/get_info.xml

@@ -0,0 +1,12 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<rsp stat="ok">
+	<licenses>
+		<license id="0" name="All Rights Reserved" url=""/>
+		<license id="4" name="Attribution License" url="http://creativecommons.org/licenses/by/2.0/"/>
+		<license id="6" name="Attribution-NoDerivs License" url="http://creativecommons.org/licenses/by-nd/2.0/"/>
+		<license id="3" name="Attribution-NonCommercial-NoDerivs License" url="http://creativecommons.org/licenses/by-nc-nd/2.0/"/>
+		<license id="2" name="Attribution-NonCommercial License" url="http://creativecommons.org/licenses/by-nc/2.0/"/>
+		<license id="1" name="Attribution-NonCommercial-ShareAlike License" url="http://creativecommons.org/licenses/by-nc-sa/2.0/"/>
+		<license id="5" name="Attribution-ShareAlike License" url="http://creativecommons.org/licenses/by-sa/2.0/"/>
+	</licenses>
+</rsp>

data/spec/fixtures/flickr/photosets/get_list-0.xml

@@ -0,0 +1,13 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<rsp stat="ok">
+  <photosets cancreate="1">
+  	<photoset id="5" primary="2483" secret="abcdef"	server="8" photos="4" farm="1">
+  		<title>Test</title>
+  		<description>foo</description>
+  	</photoset>
+  	<photoset id="4" primary="1234" secret="832659"	server="3" photos="12" farm="1">
+  		<title>My Set</title>
+  		<description>bar</description>
+  	</photoset>
+  </photosets>
+</rsp>

data/spec/fixtures/flickr/photosets/get_photos-0.xml

@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<rsp stat="ok">
+  <photoset id="4" primary="2483" page="1" perpage="500" pages="1" total="2">
+  	<photo id="2484" secret="123456" server="1"	title="my photo" isprimary="0" /> 
+  	<photo id="2483" secret="123456" server="1"	title="flickr rocks" isprimary="1" /> 
+  </photoset>
+</rsp>

data/spec/fixtures/flickr/test/echo-0.xml

@@ -0,0 +1,5 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<rsp stat="ok">
+	<method>flickr.test.echo</method>
+	<foo>bar</foo>
+</rsp>

data/spec/fixtures/flickr/test/null-fail-99.xml

@@ -0,0 +1,4 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<rsp stat="fail">
+	<err code="99" msg="Insufficient permissions. Method requires read privileges; none granted."/>
+</rsp>

data/spec/fixtures/flickr/urls/get_group-0.xml

@@ -0,0 +1,4 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<rsp stat="ok">
+	<group nsid="34427469792@N01" url="http://www.flickr.com/groups/central/"/>
+</rsp>

data/spec/fixtures/flickr/urls/get_group-fail-1.xml

@@ -0,0 +1,4 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<rsp stat="fail">
+	<err code="1" msg="Group not found"/>
+</rsp>

data/spec/fixtures/flickr/urls/get_user_photos-0.xml

@@ -0,0 +1,4 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<rsp stat="ok">
+	<user nsid="80755658@N00" url="http://www.flickr.com/photos/lvizard/"/>
+</rsp>

data/spec/fixtures/flickr/urls/get_user_photos-fail-1.xml

@@ -0,0 +1,4 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<rsp stat="fail">
+	<err code="1" msg="User not found"/>
+</rsp>

data/spec/fixtures/flickr/urls/get_user_photos-fail-2.xml

@@ -0,0 +1,4 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<rsp stat="fail">
+	<err code="2" msg="No user specified"/>
+</rsp>