commonthread-flickr_fu 0.2.2 → 0.3.0

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

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<rsp stat="ok">
+	<user id="80755658@N00">
+		<username>Maciej Biłas</username>
+	</user>
+</rsp>

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

@@ -0,0 +1,31 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<rsp stat="ok">
+<photo id="2729556270" secret="eee23fb14a" server="3207" farm="4" dateuploaded="1217794663" isfavorite="0" license="4" rotation="0" originalsecret="e940a69ebf" originalformat="png" media="video">
+	<owner nsid="24461004@N00" username="girl_named_fred" realname="Cynthia Donovan" location="Pawtucket, USA" />
+	<title>bust a move?</title>
+	<description />
+	<visibility ispublic="1" isfriend="0" isfamily="0" />
+	<dates posted="1217794663" taken="2008-08-03 13:17:43" takengranularity="0" lastupdate="1217859448" />
+	<editability cancomment="0" canaddmeta="0" />
+	<usage candownload="1" canblog="0" canprint="0" />
+
+	<comments>0</comments>
+	<notes />
+	<tags>
+		<tag id="251642-2729556270-6613225" author="24461004@N00" raw="babysquash" machine_tag="0">babysquash</tag>
+		<tag id="251642-2729556270-8754" author="24461004@N00" raw="august" machine_tag="0">august</tag>
+		<tag id="251642-2729556270-30529" author="24461004@N00" raw="anita" machine_tag="0">anita</tag>
+		<tag id="251642-2729556270-65815" author="24461004@N00" raw="waltham" machine_tag="0">waltham</tag>
+
+		<tag id="251642-2729556270-1853" author="24461004@N00" raw="liberty" machine_tag="0">liberty</tag>
+		<tag id="251642-2729556270-20506" author="24461004@N00" raw="cousin" machine_tag="0">cousin</tag>
+		<tag id="251642-2729556270-2079514" author="24461004@N00" raw="brucespringstein" machine_tag="0">brucespringstein</tag>
+	</tags>
+	<urls>
+		<url type="photopage">http://www.flickr.com/photos/girl_named_fred/2729556270/</url>
+	</urls>
+
+	<video ready="1" failed="0" pending="0" duration="" width="320" height="240" />
+</photo>
+</rsp>
+

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

@@ -0,0 +1,13 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<rsp stat="ok">
+<sizes canblog="0" canprint="0" candownload="1">
+	<size label="Square" width="75" height="75" source="http://farm4.static.flickr.com/3207/2729556270_eee23fb14a_s.jpg" url="http://www.flickr.com/photos/girl_named_fred/2729556270/sizes/sq/" media="photo" />
+	<size label="Thumbnail" width="100" height="75" source="http://farm4.static.flickr.com/3207/2729556270_eee23fb14a_t.jpg" url="http://www.flickr.com/photos/girl_named_fred/2729556270/sizes/t/" media="photo" />
+	<size label="Small" width="240" height="180" source="http://farm4.static.flickr.com/3207/2729556270_eee23fb14a_m.jpg" url="http://www.flickr.com/photos/girl_named_fred/2729556270/sizes/s/" media="photo" />
+	<size label="Medium" width="320" height="240" source="http://farm4.static.flickr.com/3207/2729556270_eee23fb14a.jpg" url="http://www.flickr.com/photos/girl_named_fred/2729556270/sizes/m/" media="photo" />
+	<size label="Original" width="320" height="240" source="http://farm4.static.flickr.com/3207/2729556270_e940a69ebf_o.png" url="http://www.flickr.com/photos/girl_named_fred/2729556270/sizes/o/" media="photo" />
+	<size label="Video Player" width="320" height="240" source="http://www.flickr.com/apps/video/stewart.swf?v=63881&amp;photo_id=2729556270&amp;photo_secret=eee23fb14a" url="http://www.flickr.com/photos/girl_named_fred/2729556270/" media="video" />
+</sizes>
+</rsp>
+
+

data/spec/flickr/base_spec.rb

@@ -0,0 +1,97 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe Flickr do
+
+  before :all do
+    @token = Flickr::Auth::Token.new(:permissions => "write", :token => "foo", :user_id => "80755658@N00",
+      :user_real_name => "Maciej Bilas", :username => "Maciej Bilas")
+    @api_key = "foo"
+    @api_secret = "bar"
+    @yaml_hash = {"key" => @api_key, "secret" => @api_secret}
+  end
+
+  describe ".new" do
+
+    describe "with no environment option specified" do
+      it "should inititialize Flickr from a Hash" do
+        # AFAIK there is no spec on how the key and secret look like
+        # so we can test with simple values
+        init_hash = {:key => @api_key, :secret => @api_secret}
+        flickr = Flickr.new(init_hash)
+        flickr.api_key.should == @api_key
+        flickr.api_secret.should == @api_secret
+
+        init_hash_with_token = init_hash.merge(:token => @token)
+        flickr = Flickr.new(init_hash_with_token)
+        flickr.token.should == @token
+      end
+
+      it "should initialize Flickr from a YAML file" do
+        YAML.should_receive(:load_file).once.and_return(@yaml_hash)
+        flickr = Flickr.new("flickr.yml")
+        flickr.api_key.should == @api_key
+        flickr.api_secret.should == @api_secret
+      end
+
+      it "should fail if API key or secret value is absent" do
+        invalid_hash = {:key => @api_key}
+        lambda { Flickr.new(invalid_hash) }.should raise_error
+        invalid_hash = {:secret => @api_secret}
+        lambda { Flickr.new(invalid_hash) }.should raise_error
+      end
+
+    end
+
+    describe "with an environment option specified" do
+      before :all do
+        @environment_specified = "development"
+      end
+
+      it "should initialize Flickr from a YAML file" do
+        yaml_hash = {@environment_specified => {"key" => @api_key, "secret" => @api_secret}}
+        YAML.should_receive(:load_file).once.and_return(yaml_hash)
+        flickr = Flickr.new("flickr.yml", :environment => @environment_specified)
+        flickr.api_key.should == @api_key
+        flickr.api_secret.should == @api_secret
+      end
+    end
+
+    describe "when token_cache is passed (only with a YAML file)" do
+
+      before :all do
+        @expected_token_cache = "token_cache.yml"
+      end
+
+      # For backward compatibility
+      it "should initialize Flickr with token_cache when passed as the second parameter" do
+        YAML.should_receive(:load_file).once.and_return(@yaml_hash)
+        flickr = Flickr.new("flickr.yml", @expected_token_cache)
+        flickr.token_cache.should == @expected_token_cache
+      end
+
+      it "should initialize Flickr with token_cache when passed as an option" do
+        YAML.should_receive(:load_file).once.and_return(@yaml_hash)
+        flickr = Flickr.new("flickr.yml", :token_cache => @expected_token_cache)
+        flickr.token_cache.should == @expected_token_cache
+      end
+    end
+
+    describe "when token is passed as an options (only with a YAML file)" do
+
+      it "should initialize Flickr with a token if passed" do
+        YAML.should_receive(:load_file).once.and_return(@yaml_hash)
+        flickr = Flickr.new("flickr.yml", :token => @token)
+        flickr.token.should == @token
+      end
+
+    end
+
+    describe "when both token and token_cache are passed" do
+      it "should raise an error" do
+        YAML.should_receive(:load_file).once.and_return(@yaml_hash)
+        lambda { Flickr.new("flickr.yml", {:token => @token, :token_cache => "token_cache.yml"})}.should raise_error
+      end
+    end
+    
+  end
+end

data/spec/flickr/contacts_spec.rb

@@ -0,0 +1,47 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe Flickr::Contacts do
+  
+  before :each do
+    @flickr = SpecHelper.flickr
+  end
+  
+  describe ".get_public_list" do
+    before :all do
+      @public_list_xml = File.read(File.dirname(__FILE__) +
+          "/../fixtures/flickr/contacts/get_public_list-0.xml")
+    end
+    
+    it "should call flickr.contacts.getPublicList" do
+      bogus_user_id = "12334@N00"
+      @flickr.should_receive(:send_request).with("flickr.contacts.getPublicList",
+                                                 {:user_id=>bogus_user_id})
+      @flickr.contacts.get_public_list(bogus_user_id)
+    end    
+    
+    it "should return public contacts for the given user" do
+      bogus_user_id = "12334@N00"
+      @flickr.stub!(:request_over_http).and_return(@public_list_xml)      
+      contacts = @flickr.contacts.get_public_list(bogus_user_id)
+      contacts.size.should == 2
+      contacts.first.username.should == "kooop"
+      contacts.first.nsid.should == "40718771@N00"
+      contacts.first.iconserver.should == "2"
+      contacts.first.iconfarm.should == "1"
+    end    
+  end
+    
+  describe ".get_list" do
+    it "should call flickr.contacts.getList" do
+      @flickr.should_receive(:send_request).with("flickr.contacts.getList", {})       
+      @flickr.contacts.get_list
+    end
+    
+    it "should raise flickr error 99: Insufficient permissions" do
+      xml = File.read(File.dirname(__FILE__) + "/../fixtures/flickr/contacts/get_list-fail-99.xml")
+      @flickr.stub!(:request_over_http).and_return(xml)
+      lambda { @flickr.contacts.get_list }.should raise_error(Flickr::Error, /^99:/)
+    end
+  end
+  
+end

data/spec/flickr/errors_spec.rb

@@ -0,0 +1,21 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe Flickr::Errors, ".error_for" do
+  it "should raise a RuntimeError with an \"Internal message\" message if either code or message is blank" do
+    lambda { Flickr::Errors.error_for(nil, nil) }.should raise_error(RuntimeError, /^Internal error/)
+    lambda { Flickr::Errors.error_for(20, nil) }.should raise_error(RuntimeError, /^Internal error/)
+    lambda { Flickr::Errors.error_for(nil, "foo") }.should raise_error(RuntimeError, /^Internal error/)
+  end
+  
+  it "should raise a RuntimeError with an \"Internal error\" message if code is not an integer" do
+    lambda { Flickr::Errors.error_for("a", "foo")}.should raise_error(RuntimeError, /^Internal error/)
+  end
+  
+  it "should raise a valid error if parameters are valid" do
+    lambda { Flickr::Errors.error_for(96, "Invalid signature")}.should raise_error(Flickr::Error)
+  end
+  
+  it "should return an error with a message starting with the error code" do
+    lambda { Flickr::Errors.error_for(97, "Missing signature")}.should raise_error(Flickr::Error, /^97/)
+  end
+end

data/spec/flickr/geo_spec.rb

@@ -0,0 +1,20 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe Flickr::Photos::Geo do
+
+  before :each do
+    @flickr = SpecHelper.flickr
+  end
+  
+  describe ".get_location" do
+    it "should return the geo data (latitude and longitude and the accuracy level) for a photo" do
+      location_xml = File.read(File.dirname(__FILE__) + "/../fixtures/flickr/photos/geo/get_location-0.xml")
+      @flickr.should_receive(:request_over_http).and_return(location_xml)
+      acctual_loc = @flickr.photos.geo.get_location(2984637736)
+      acctual_loc.latitude.should == 50.041376
+      acctual_loc.longitude.should == 21.999006
+      acctual_loc.accuracy.should == 16
+    end
+  end
+  
+end

data/spec/flickr/photo_spec.rb

@@ -0,0 +1,123 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+module PhotoSpecHelper
+  def valid_photo_attributes
+    {
+      :id => 2984637736,
+      :owner => "80755658@N00",
+      :secret => "9e5762e027",
+      :server => 3180,
+      :farm => 4,
+      :title => "Demolition of Hotel Rzeszów",
+      :is_public => 1,
+      :is_friend => 0,
+      :is_family => 0
+    }
+  end
+end
+
+describe Flickr::Photos::Photo do
+  
+  include PhotoSpecHelper
+  
+  before :all do
+    @info_xml = File.read(File.dirname(__FILE__) + "/../fixtures/flickr/photos/get_info-0.xml")
+    @sizes_xml = File.read(File.dirname(__FILE__) + "/../fixtures/flickr/photos/get_sizes-0.xml")
+  end
+  
+  before :each do
+    @flickr = SpecHelper.flickr
+    #@flickr.stub!(:request_over_http).and_return(info_xml)
+    @photo = Flickr::Photos::Photo.new(@flickr, valid_photo_attributes)
+  end
+  
+  describe ".description" do
+    it "should return the description" do
+      @flickr.should_receive(:request_over_http).and_return(@info_xml)
+      @photo.description.should == 
+        "The last picture from a quite old event. The demolition of the best known hotel in Rzeszów called Hotel Rzeszów."
+    end
+  end
+  
+  describe ".image_url" do
+    it "should return all standard sizes (thumbnail, square, small, medium and large) when requested" do
+	  @photo.image_url(:square).should == "http://farm4.static.flickr.com/3180/2984637736_9e5762e027_s.jpg"
+      @photo.image_url(:thumbnail).should == "http://farm4.static.flickr.com/3180/2984637736_9e5762e027_t.jpg"
+      @photo.image_url(:small).should == "http://farm4.static.flickr.com/3180/2984637736_9e5762e027_m.jpg"
+	  @photo.image_url(:medium).should == "http://farm4.static.flickr.com/3180/2984637736_9e5762e027.jpg"
+	  @photo.image_url(:large).should == "http://farm4.static.flickr.com/3180/2984637736_9e5762e027_b.jpg"
+    end
+
+	it "should return the same image even if you pass a string as an argument" do
+	  @photo.image_url("square").should == @photo.image_url(:square)
+	  @photo.image_url("large").should == @photo.image_url(:large)
+	end
+
+	it "should not call getSizes if not requested the url of the original image" do
+	  @flickr.should_not_receive(:request_over_http)
+	  @photo.image_url :square
+	  @photo.image_url :thumbnail
+	  @photo.image_url :small
+	  @photo.image_url :medium
+	  @photo.image_url :large
+	end
+
+	it "should call getSizes if requested the url of the original image" do
+	  @flickr.should_receive(:request_over_http).and_return(@sizes_xml)
+	  @photo.image_url :original
+	end
+
+	it "should return nil if original image url not available" do
+	  @flickr.should_receive(:request_over_http).and_return(@sizes_xml)
+	  @photo.image_url(:original).should == nil
+	end
+  end
+
+  describe ".video_url" do
+    it "should return nil, since it's not a video" do
+      @flickr.should_receive(:request_over_http).and_return(@sizes_xml)
+      @photo.video_url.should == nil
+    end
+  end
+
+  describe ".location" do
+    it "should return the picture location as specified in flickr.photos.geo.getLocation" do
+      location_xml = File.read(File.dirname(__FILE__) + "/../fixtures/flickr/photos/geo/get_location-0.xml")
+      @flickr.should_receive(:request_over_http).twice.and_return(location_xml)
+      expected_loc = @flickr.photos.geo.get_location(@photo.id)
+      acctual_loc = @photo.location
+      # Checking by latitude and longitude is enough for us
+      acctual_loc.latitude.should == expected_loc.latitude
+      acctual_loc.longitude.should == expected_loc.longitude
+    end
+
+    it "should return nil if picture is not geo-tagged" do
+      no_location_xml = File.read(File.dirname(__FILE__) + "/../fixtures/flickr/photos/geo/get_location-fail-2.xml")
+      @flickr.should_receive(:request_over_http).and_return(no_location_xml)
+      @photo.location.should be_nil
+    end
+  end
+
+  describe Flickr::Photos::Photo, "but it's really a video" do
+
+    include PhotoSpecHelper
+  
+    before :all do
+      @info_xml = File.read(File.dirname(__FILE__) + "/../fixtures/flickr/videos/get_info-0.xml")
+      @sizes_xml = File.read(File.dirname(__FILE__) + "/../fixtures/flickr/videos/get_sizes-0.xml")
+    end
+  
+    before :each do
+      @flickr = SpecHelper.flickr
+      #@flickr.stub!(:request_over_http).and_return(info_xml)
+      @photo = Flickr::Photos::Photo.new(@flickr, valid_photo_attributes)
+    end
+
+    describe ".video_url" do
+      it "should return something sane" do
+        @flickr.should_receive(:request_over_http).and_return(@sizes_xml)
+        @photo.video_url.should == "http://www.flickr.com/apps/video/stewart.swf?v=63881&photo_id=2729556270&photo_secret=eee23fb14a"
+      end
+    end
+  end
+end

data/spec/flickr/photos_spec.rb

@@ -0,0 +1,50 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe Flickr::Photos do
+  
+  before :each do
+    @flickr = SpecHelper.flickr
+  end
+  
+  describe ".licenses" do
+    before :all do
+      @licenses_xml = File.read(File.dirname(__FILE__) + "/../fixtures/flickr/photos/licenses/get_info.xml")
+      @valid_licenses = {
+        0 => Flickr::Photos::License.new(:id => 0, :name => "All Rights Reserved", :url => ""),
+        4 => Flickr::Photos::License.new(:id => 4, :name => "Attribution License", :url => "http://creativecommons.org/licenses/by/2.0/"),
+        6 => Flickr::Photos::License.new(:id => 6, :name => "Attribution-NoDerivs License", :url => "http://creativecommons.org/licenses/by-nd/2.0/"),
+        3 => Flickr::Photos::License.new(:id => 3, :name => "Attribution-NonCommercial-NoDerivs License", :url => "http://creativecommons.org/licenses/by-nc-nd/2.0/"),
+        2 => Flickr::Photos::License.new(:id => 2, :name => "Attribution-NonCommercial License", :url => "http://creativecommons.org/licenses/by-nc/2.0/"),
+        1 => Flickr::Photos::License.new(:id => 1, :name => "Attribution-NonCommercial-ShareAlike License", :url => "http://creativecommons.org/licenses/by-nc-sa/2.0/"),
+        5 => Flickr::Photos::License.new(:id => 5, :name => "Attribution-ShareAlike License", :url => "http://creativecommons.org/licenses/by-sa/2.0/")
+      }
+    end
+    
+    it "should return all valid licenses" do
+      @flickr.should_receive(:request_over_http).and_return(@licenses_xml)
+      @flickr.photos.licenses.should == @valid_licenses
+    end
+    
+    it "should not not call Flickr API more than once" do
+      @flickr.should_receive(:request_over_http).once.and_return(@licenses_xml)
+      @flickr.photos.licenses
+      @flickr.photos.licenses
+    end
+  end
+  
+  describe ".find_by_id" do
+    it "should return a photo when a valid id is given" do
+      photo_id = 2984637736
+      #photo_upload_date = 1225297614
+      info_xml = File.read(File.dirname(__FILE__) + "/../fixtures/flickr/photos/get_info-0.xml")
+      @flickr.should_receive(:request_over_http).and_return(info_xml)
+      
+      photo = @flickr.photos.find_by_id(photo_id)
+      photo.id.should == photo_id
+    end
+    
+    it "should raise an error when no id is given"
+    
+    it "should raise an error when the photo does not exist"
+  end
+end

data/spec/flickr/photosets_spec.rb

@@ -0,0 +1,49 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe Flickr::Photosets do
+  before :all do
+    @get_list_xml = File.read(File.dirname(__FILE__) +
+        "/../fixtures/flickr/photosets/get_list-0.xml")
+    @get_photos_xml = File.read(File.dirname(__FILE__) +
+        "/../fixtures/flickr/photosets/get_photos-0.xml")
+  end
+    
+  before :each do
+    @flickr = SpecHelper.flickr
+  end
+
+  
+  describe ".get_list" do
+    it "should call flickr.photosets.getList" do
+      @flickr.should_receive(:send_request).with("flickr.photosets.getList", {})       
+      @flickr.photosets.get_list
+    end
+    
+    it "should return an array of photoset objects" do
+      @flickr.stub!(:request_over_http).and_return(@get_list_xml)  
+      photosets = @flickr.photosets.get_list
+      
+      photosets[0].should be_an_instance_of(Flickr::Photosets::Photoset)      
+      photosets[0].title.should == 'Test'
+    end
+  end
+  
+  describe ".get_photos" do
+    before :each do
+      @photoset = Flickr::Photosets::Photoset.new(@flickr,{:id=>4})
+    end
+    
+    it "should call flickr.photosets.getPhotos" do
+      @flickr.should_receive(:send_request).with("flickr.photosets.getPhotos",{:photoset_id=>4})       
+      @photoset.get_photos
+    end
+    
+    it "should return an array of photo objects" do
+      @flickr.stub!(:request_over_http).and_return(@get_photos_xml)  
+      photos = @photoset.get_photos
+      
+      photos.should_not be_nil
+      photos[0].should be_an_instance_of(Flickr::Photos::Photo)    
+    end
+  end
+end