.DS_Store @@ -1,3 +1,15 @@ +== 1.0.7 2008-11-26 +* 1 major enhancement + * When a collection of photos is fetched (e.g. by Flickr#search), a PhotoCollection object is now returned, a type of array, which allows easy access to the pagination information returned by Flickr (e.g. total items, pages, etc). Previously this info was lost +* Minor enhancements: + * Refactored parsing of response when getting info about photo (public API is not changed). + * All returned info is now parsed and stored (previously only some attributes were) + * A record is kept of whether info has been previously fetched from Flickr (avoids unnecessary extra calls) + * Improved User#getInfo. No longer makes API call for pretty_url (which was in addition to main getInfo call) or photos_url +* Bugfixes + * Fixed Photo#source not to make unnecessary API call + * Fixed User#url not to make unnecessary API call + == 1.0.6 2008-07-30 * Bugfixes: * fixed Flickr#photos when used for searching @@ -40,4 +52,3 @@ * Removed call to flickr.people.getOnlineList in Flickr#users as that call is no longer in the Flickr API * Performance improvements: * Url and image source uri now generated without a call to the Flickr API, as per the Flickr API docs - \ No newline at end of file History.txt @@ -192,12 +192,10 @@ class Flickr response end - # acts like request but returns a list of Photo objects + # acts like request but returns a PhotoCollection (a list of Photo objects) def photos_request(method, params={}) photos = request(method, params) - collection = photos['photos']['photo'] || [] - collection = [collection] if collection.is_a? Hash - collection.collect { |photo| Photo.new(photo.delete('id'), @api_key, photo) } + PhotoCollection.new(photos, @api_key) end # Builds url for Flickr API REST request from given the flickr method name @@ -218,6 +216,22 @@ class Flickr return Digest::MD5.hexdigest("#{@shared_secret}#{request_str}") end + # A collection of photos is returned as a PhotoCollection, a subclass of Array. + # This allows us to retain the pagination info returned by Flickr and make it + # accessible in a friendly way + class PhotoCollection < Array + attr_reader :page, :pages, :perpage, :total + + # builds a PhotoCollection from given params, such as those returned from + # photos.search API call + def initialize(photos_api_response={}, api_key=nil) + [ "page", "pages", "perpage", "total" ].each { |i| instance_variable_set("@#{i}", photos_api_response["photos"][i])} + collection = photos_api_response['photos']['photo'] || [] + collection = [collection] if collection.is_a? Hash + collection.each { |photo| self << Photo.new(photo.delete('id'), api_key, photo) } + end + end + # Todo: # logged_in? # if logged in: @@ -281,13 +295,23 @@ class Flickr def firstdatetaken @firstdatetaken.nil? ? getInfo.firstdatetaken : @firstdatetaken end + + # Builds url for user's photos page as per + # http://www.flickr.com/services/api/misc.urls.html def photos_url - @photos_url.nil? ? getInfo.photos_url : @photos_url + "http://www.flickr.com/photos/#{id}/" end + + # Builds url for user's profile page as per + # http://www.flickr.com/services/api/misc.urls.html def url - @url.nil? ? getInfo.url : @url + "http://www.flickr.com/people/#{id}/" end - + + def pretty_url + @pretty_url ||= @client.urls_getUserProfile('user_id'=>@id)['user']['url'] + end + # Implements flickr.people.getPublicGroups def groups collection = @client.people_getPublicGroups('user_id'=>@id)['groups']['group'] @@ -352,8 +376,6 @@ class Flickr @count = info['photos']['count'] @firstdate = info['photos']['firstdate'] @firstdatetaken = info['photos']['firstdatetaken'] - @photos_url = @client.urls_getUserPhotos('user_id'=>@id)['user']['url'] - @url = @client.urls_getUserProfile('user_id'=>@id)['user']['url'] self end @@ -381,7 +403,7 @@ class Flickr end def title - @title.nil? ? getInfo.title : @title + @title.nil? ? getInfo("title") : @title end # Returns the owner of the photo as a Flickr::User. If we have no info @@ -395,32 +417,32 @@ class Flickr when String @owner = Flickr::User.new(@owner, nil, nil, nil, @api_key) else - getInfo.owner + getInfo("owner") end end def server - @server.nil? ? getInfo.server : @server + @server.nil? ? getInfo("server") : @server end def isfavorite - @isfavorite.nil? ? getInfo.isfavorite : @isfavorite + @isfavorite.nil? ? getInfo("isfavorite") : @isfavorite end def license - @license.nil? ? getInfo.license : @license + @license.nil? ? getInfo("license") : @license end def rotation - @rotation.nil? ? getInfo.rotation : @rotation + @rotation.nil? ? getInfo("rotation") : @rotation end def description - @description.nil? ? getInfo.description : @description + @description || getInfo("description") end def notes - @notes.nil? ? getInfo.notes : @notes + @notes.nil? ? getInfo("notes") : @notes end # Returns the URL for the photo size page @@ -454,7 +476,7 @@ class Flickr # eg, http://flickr.com/photos/granth/2584402507/ instead of # http://flickr.com/photos/23386158@N00/2584402507/ def pretty_url - @url || getInfo.pretty_url + @url || getInfo("pretty_url") end # Returns the URL for the image (default or any specified size) @@ -558,18 +580,16 @@ class Flickr private # Implements flickr.photos.getInfo - def getInfo + def getInfo(attrib="") + return instance_variable_get("@#{attrib}") if @got_info info = @client.photos_getInfo('photo_id'=>@id)['photo'] - @title = info['title'] + @got_info = true + info.each { |k,v| instance_variable_set("@#{k}", v)} @owner = User.new(info['owner']['nsid'], info['owner']['username'], nil, nil, @api_key) - @server = info['server'] - @isfavorite = info['isfavorite'] - @license = info['license'] - @rotation = info['rotation'] - @description = info['description'] + @tags = info['tags']['tag'] @notes = info['notes']['note']#.collect { |note| Note.new(note.id) } @url = info['urls']['url']['content'] # assumes only one url - self + instance_variable_get("@#{attrib}") end # Builds source uri of image from params (often returned from other lib/flickr.rb @@ -145,8 +145,25 @@ class TestFlickr < Test::Unit::TestCase "some_api_key", { "key3" => "value3"}) photos = f.photos_request('some_method') end - - def test_should_return_list_of_photos + + def test_should_parse_photos_response_into_flickr_photo_collection + f = flickr_client + f.expects(:request).returns(dummy_photos_response) + assert_kind_of Flickr::PhotoCollection, f.photos_request('some_method') + end + + def test_should_store_pagination_info_in_photo_collection + f = flickr_client + f.expects(:request).returns(dummy_photos_response) + photos = f.photos_request('some_method') + + assert_equal "3", photos.page + assert_equal "5", photos.pages + assert_equal "10", photos.perpage + assert_equal "42", photos.total + end + + def test_should_return_collection_of_photos f = flickr_client f.expects(:request).returns(dummy_photos_response) photos = f.photos_request('some_method') @@ -349,6 +366,32 @@ class TestFlickr < Test::Unit::TestCase assert_nil user.client end + def test_should_build_url_for_users_profile_page_using_user_id + Flickr.any_instance.expects(:http_get).never + assert_equal "http://www.flickr.com/people/foo123/", new_user.url + end + + def test_should_build_url_for_users_photos_page_using_user_id + Flickr.any_instance.expects(:http_get).never + assert_equal "http://www.flickr.com/photos/foo123/", new_user.photos_url + end + + def test_should_get_pretty_url_for_users_profile_page + f = flickr_client + f.expects(:urls_getUserProfile).returns({"user" => {"nsid" => "bar456", "url" => "http://www.flickr.com/people/killer_bob/"}}) + + assert_equal "http://www.flickr.com/people/killer_bob/", new_user( 'client' => f ).pretty_url + end + + def test_should_cache_pretty_url_for_users_profile_page + f = flickr_client + user = new_user( 'client' => f ) + f.expects(:urls_getUserProfile).returns({"user" => {"nsid" => "bar456", "url" => "http://www.flickr.com/people/killer_bob/"}}) # expects only one call + + user.pretty_url + user.pretty_url + end + def test_should_get_users_public_groups f = flickr_client f.expects(:request).with("people.getPublicGroups", anything).returns(dummy_groups_response) @@ -458,6 +501,59 @@ class TestFlickr < Test::Unit::TestCase assert_nil photo['key2'] end + def test_should_get_and_store_other_info_for_photo + Flickr.any_instance.stubs(:http_get).returns(photo_info_xml_response) + photo = Flickr::Photo.new('foo123', 'some_api_key') + + assert_equal "1964 120 amazon estate", photo.title # calling #title method triggers getting of info + assert_equal "1964 120 amazon estate", photo.instance_variable_get(:@title) + assert_equal "3142", photo.instance_variable_get(:@server) + assert_equal "ae75bd3111", photo.instance_variable_get(:@secret) + assert_equal "4", photo.instance_variable_get(:@farm) + assert_equal "1204145093", photo.instance_variable_get(:@dateuploaded) + assert_equal "photo", photo.instance_variable_get(:@media) + assert_equal "0", photo.instance_variable_get(:@isfavorite) + assert_equal "0", photo.instance_variable_get(:@license) + assert_equal "0", photo.instance_variable_get(:@rotation) + assert_equal "1964 Volvo 120 amazon estate spotted in derbyshire.", photo.instance_variable_get(:@description) + assert_equal( { "w" => "50", + "x" => "10", + "y" => "10", + "authorname" => "Bees", + "author" => "12037949754@N01", + "id" => "313", + "content" => "foo", + "h" => "50" }, photo.instance_variable_get(:@notes)) + assert_equal "http://www.flickr.com/photos/rootes_arrow/2296968304/", photo.instance_variable_get(:@url) + assert_equal [ { "id" => "9377979-2296968304-2228", "author" => "9383319@N05", "raw" => "volvo", "machine_tag" => "0", "content" => "volvo" }, + { "id" => "9377979-2296968304-2229", "author" => "9383319@N06", "raw" => "amazon", "machine_tag" => "0", "content" => "amazon" + } ], photo.instance_variable_get(:@tags) + assert_equal "1", photo.instance_variable_get(:@comments) + assert_kind_of Flickr::User, owner = photo.instance_variable_get(:@owner) + assert_equal "Rootes_arrow_1725", owner.username + end + + def test_should_get_and_other_info_for_photo_when_some_attributes_missing + Flickr.any_instance.stubs(:http_get).returns(sparse_photo_info_xml_response) + photo = Flickr::Photo.new('foo123', 'some_api_key') + + assert_equal "1964 120 amazon estate", photo.title # calling #title method triggers getting of info + assert_equal "1964 120 amazon estate", photo.instance_variable_get(:@title) + assert_equal( {}, photo.instance_variable_get(:@description)) + assert_nil photo.instance_variable_get(:@notes) + assert_nil photo.instance_variable_get(:@tags) + assert_equal "1", photo.instance_variable_get(:@comments) + end + + def test_should_not_get_info_more_than_once + Flickr.any_instance.expects(:http_get).returns(photo_info_xml_response) # expects only one call + photo = Flickr::Photo.new('foo123', 'some_api_key') + + photo.description # calling #description method triggers getting of info + photo.instance_variable_set(:@description, nil) # set description to nil + photo.description # call #description method again + end + # # owner tests def test_should_return_owner_when_flickr_user @@ -471,7 +567,7 @@ class TestFlickr < Test::Unit::TestCase photo = new_photo("owner" => nil) # stubbing private methods causes problems so we mock client method, which is what Photo#getInfo users to make API call Flickr.any_instance.expects(:photos_getInfo).returns('photo' => { 'owner'=>{'nsid'=>'abc123', 'username'=>'SomeUserName', 'realname'=>"", 'location'=>''}, - 'notes' => {}, 'urls' => {'url' => {'content' => 'http://prettyurl'}}}) + 'notes' => {}, 'tags' => {}, 'urls' => {'url' => {'content' => 'http://prettyurl'}}}) owner = photo.owner assert_kind_of Flickr::User, owner @@ -788,6 +884,41 @@ class TestFlickr < Test::Unit::TestCase assert_equal f.related_tags('monkey'), %w(zoo animal) end + # ##### Flickr::PhotoCollection tests + # + def test_should_subclass_array_as_photo_collection + assert_equal Array, Flickr::PhotoCollection.superclass + end + + def test_should_make_page_a_reader_method + assert_equal "3", dummy_photo_collection.page + end + + def test_should_make_pages_a_reader_method + assert_equal "5", dummy_photo_collection.pages + end + + def test_should_make_perpage_a_reader_method + assert_equal "10", dummy_photo_collection.perpage + end + + def test_should_make_total_a_reader_method + assert_equal "42", dummy_photo_collection.total + end + + def test_should_instantiate_photo_collection_from_photos_hash + pc = Flickr::PhotoCollection.new(dummy_photos_response) + assert_kind_of Flickr::PhotoCollection, pc + assert_equal 2, pc.size + assert_kind_of Flickr::Photo, pc.first + assert_equal "foo123", pc.first["id"] + end + + def test_should_instantiate_photo_collection_using_given_api_key + photo = Flickr::PhotoCollection.new(dummy_photos_response, "some_api_key").first + assert_equal "some_api_key", photo.instance_variable_get(:@api_key) + end + private def flickr_client Flickr.new("some_api_key") @@ -816,6 +947,10 @@ class TestFlickr < Test::Unit::TestCase "owner" => Flickr::User.new("abc123", "some_user", nil, nil, "some_api_key") }.merge(options)) end + def dummy_photo_collection + Flickr::PhotoCollection.new(dummy_photos_response) + end + def dummy_photos_response { "photos" => { "photo" => @@ -823,7 +958,11 @@ class TestFlickr < Test::Unit::TestCase "key1" => "value1", "key2" => "value2" }, { "id" => "bar456", - "key3" => "value3"}] } } + "key3" => "value3"}], + "page"=>"3", + "pages"=>"5", + "perpage"=>"10", + "total"=>"42" } } end def dummy_single_photo_response @@ -889,4 +1028,55 @@ class TestFlickr < Test::Unit::TestCase EOF end + def photo_info_xml_response + <<-EOF + <?xml version="1.0" encoding="utf-8" ?> + <rsp stat="ok"> + <photo id="22527834" secret="ae75bd3111" server="3142" farm="4" dateuploaded="1204145093" isfavorite="0" license="0" rotation="0" media="photo"> + <owner nsid="9383319@N05" username="Rootes_arrow_1725" realname="John" location="U.K" /> + <title>1964 120 amazon estate</title> + <description>1964 Volvo 120 amazon estate spotted in derbyshire.</description> + <visibility ispublic="1" isfriend="0" isfamily="0" /> + <dates posted="1204145093" taken="2007-06-10 13:18:27" takengranularity="0" lastupdate="1204166772" /> + <editability cancomment="0" canaddmeta="0" /> + <usage candownload="0" canblog="0" canprint="0" /> + <comments>1</comments> + <notes> + <note id="313" author="12037949754@N01" authorname="Bees" x="10" y="10" w="50" h="50">foo</note> + </notes> + <tags> + <tag id="9377979-2296968304-2228" author="9383319@N05" raw="volvo" machine_tag="0">volvo</tag> + <tag id="9377979-2296968304-2229" author="9383319@N06" raw="amazon" machine_tag="0">amazon</tag> + </tags> + <urls> + <url type="photopage">http://www.flickr.com/photos/rootes_arrow/2296968304/</url> + </urls> + </photo> + </rsp> + EOF + end + + def sparse_photo_info_xml_response + <<-EOF + <?xml version="1.0" encoding="utf-8" ?> + <rsp stat="ok"> + <photo id="22527834" secret="ae75bd3111" server="3142" farm="4" dateuploaded="1204145093" isfavorite="0" license="0" rotation="0" media="photo"> + <owner nsid="9383319@N05" username="Rootes_arrow_1725" realname="John" location="U.K" /> + <title>1964 120 amazon estate</title> + <description/> + <visibility ispublic="1" isfriend="0" isfamily="0" /> + <dates posted="1204145093" taken="2007-06-10 13:18:27" takengranularity="0" lastupdate="1204166772" /> + <editability cancomment="0" canaddmeta="0" /> + <usage candownload="0" canblog="0" canprint="0" /> + <comments>1</comments> + <notes/> + <tags/> + <urls> + <url type="photopage">http://www.flickr.com/photos/rootes_arrow/2296968304/</url> + </urls> + </photo> + </rsp> + EOF + end + end \ No newline at end of file test/test_flickr.rb 6746ae9ca11c28675505fe7e8f17562db5d8cd71 Chris Taggart chris@windowsxponmac.home http://github.com/ctagg/flickr/commit/3ffc1586176e2e473949ffc231abfac202266a66 3ffc1586176e2e473949ffc231abfac202266a66 2008-11-28T05:14:07-08:00 2008-11-28T05:14:07-08:00 * Collection of photos returned by Flickr is now a PhotoCollection rather than array, allowing us to keep other info returned by Flickr (e.g. pagination) * Numerous minor enhancements, performance improvements and bugfixes. See HIstory.txt for details 7dc3848779ba39a78019d2bb1d8d1da5e7cd5b20 Chris Taggart chris@windowsxponmac.home