fotonauts-flickr_fu 0.3.4 → 0.3.6

data/.gitignore

@@ -1,13 +1,19 @@
 rdoc
+doc
 .DS_Store
 *.gem
 demo*
 *~
 *.sw*
 .specification
-nbproject/
+.bundle
+
 doc/rspec_report.html
 doc/rspec_profile.txt
 spec/spec.local.opts
 coverage/
 pkg/
+
+# IDEs 
+nbproject/
+.idea

data/README.md

@@ -0,0 +1,146 @@
+# flickr-fu
+
+## Contact
+
+  Author: Ben Wyrosdick
+  Email: ben [at] commonthread.com
+  Issue tracker: https://github.com/commonthread/flickr_fu/issues
+  Code Repository: http://github.com/commonthread/flickr_fu/tree/master
+
+## Getting Started
+
+  You need to first get an API key as detailed here:
+
+  http://www.flickr.com/services/api/misc.api_keys.html
+  
+## Installation
+
+  <code>sudo gem install flickr-fu</code>
+
+## Documentation
+
+  Documentation can be found here:
+  http://rubydoc.info/gems/flickr_fu/
+
+### Example flickr.yml
+<pre>
+--- !map:HashWithIndifferentAccess
+key: "YOUR KEY"
+secret: "YOUR SECRET"
+token_cache: "token_cache.yml"
+</pre>
+
+### Authorization
+
+To authorise your application to access Flickr using your API key you will need to access a specific URL.
+  
+To generate this URL run the following and when presented with the URL access it from your browser. Confirm the application has permission at the level you have specified.
+  
+Note that flickr has different types of keys. If you use one for a webapplication, which is most likely, you need to define a callback and somehow make sure that you connect the parameter :frob that flickr send via the callback is assigned  to the right user account. The best way to do this is to loop over all the current user's flickr accounts and try flickr.auth.token with the :frob.
+  
+Finally, cache the token (this will create the token cache file)
+  
+If you have an invalid API key you will see errors such as:
+  
+<code>"100: Invalid API Key"</code>
+  
+If you don't follow the process below to authorise your application you will see errors such as:
+  
+<pre>
+"98: Login failed / Invalid auth token" or 
+"99: User not logged in / Insufficient permissions"
+</pre>
+  
+### Authorization Example for non-webapplication
+
+<pre>
+require 'flickr_fu'
+ 
+flickr = Flickr.new('flickr.yml')
+  
+puts "visit the following url, then click <enter> once you have authorized:"
+
+ # request write permissions
+puts flickr.auth.url(:write)
+  
+gets
+  
+flickr.auth.cache_token
+</pre>
+
+### Authorization Example for a webapplication
+
+flickr.auth.token also contains the nsid and username, this example only stores the token and no other userdata.
+
+<pre>
+require 'flickr_fu'
+  class FlickrController < ActionController::Base
+    def create
+      flickr = Flickr.new('flickr.yml')
+      redirect_to flickr.auth.url(:write)
+    end
+    def flickr_callback
+      flickr = Flickr.new('flickr.yml')
+      flickr.auth.frob = params[:frob]
+      current_user.update_attribute :flickr_token, flickr.auth.token.token
+    end
+    def something_else_with_flickr
+      flickr = Flickr.new(YAML.load_file('flickr.yml').merge(:token => current_user.flickr_token))
+      # now you have full access on the user's data :)
+    end
+end
+</pre>
+
+### Search Example
+
+<pre>
+require 'flickr_fu'
+
+flickr = Flickr.new('flickr.yml')
+
+photos = flickr.photos.search(:tags => 'ruby-flickr')
+
+puts "found #{photos.size} photo(s)"
+
+photos.each do |photo|
+    puts photo.title
+    puts photo.description unless [nil, ''].include?(photo.description)
+    [:square, :thumbnail, :small, :medium, :large, :original].each do |size|
+      puts "#{size}: #{photo.url(size)}"
+    end
+    puts "comments: #{photo.comments.size}"
+    photo.comments.each do |comment|
+      intro = "#{comment.author_name} says - "
+      puts "#{intro}\"#{comment.comment.gsub("\n", "\n"+(" "*intro.length))}\""
+    end
+    puts "notes: #{photo.notes.size}"
+    photo.notes.each do |note|
+      puts "[#{note.x},#{note.y} ~ #{note.width}x#{note.height}] - \"#{note.note}\""
+    end
+    puts
+    puts
+  end
+</pre>
+  
+### Another Search Example
+
+If searching for photos by user id then you need to specify the 'alias' - without intervention this is usually set by Flickr and is an alphanumeric string. 
+  
+To find out the user id for a given user, you can use the tool at:
+
+http://idgettr.com/
+
+And replace the line in the above sample to query on user id:
+  
+<code>photos = flickr.photos.search(:user_id => 'your_user_id_here')</code>
+
+## Patch Contributers
+
+- Chris Ledet
+- Maciej Biłas
+- Mike Perham
+- Chris Anderton
+- Luke Francl
+- Thomas R. Koll
+- P. Mark Anderson
+- Josh Nichols

data/VERSION.yml

@@ -1,4 +1,4 @@
---- 
+---
 :major: 0
 :minor: 3
-:patch: 5
+:patch: 6

data/flickr_fu.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{fotonauts-flickr_fu}
-  s.version = "0.3.4"
+  s.version = "0.3.6"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Ben Wyrosdick", "Maciej Bilas", "Fotonauts"]
@@ -10,12 +10,12 @@ Gem::Specification.new do |s|
   s.description = %q{Provides a ruby interface to flickr via the REST api}
   s.email = %q{ben@commonthread.com}
   s.extra_rdoc_files = [
-    "README"
+    "README.md"
   ]
   s.files = [
     ".gitignore",
      "LICENSE",
-     "README",
+     "README.md",
      "Rakefile",
      "VERSION.yml",
      "flickr_fu.gemspec",
@@ -82,7 +82,7 @@ Gem::Specification.new do |s|
      "spec/spec_helper.rb"
   ]
   s.homepage = %q{http://github.com/commonthread/flickr_fu}
-  s.rdoc_options = ["--main", "README"]
+  s.rdoc_options = ["--main", "README.md"]
   s.require_paths = ["lib"]
   s.rubygems_version = %q{1.3.3}
   s.summary = %q{Provides a ruby interface to flickr via the REST api}

data/lib/flickr/auth.rb

@@ -7,43 +7,47 @@ class Flickr::Auth < Flickr::Base
   def frob
     @frob ||= get_frob
   end
-  
+
   # set the frob
   def frob= frob
     @frob=frob
   end
 
   # generates the authorization url to allow access to a flickr account.
-  # 
+  #
   # Params
   # * perms (Optional)
   #     sets the permision level to grant on the flickr account.
   #       :read - permission to read private information (DEFAULT)
   #       :write - permission to add, edit and delete photo metadata (includes 'read')
   #       :delete - permission to delete photos (includes 'write' and 'read')
-  # 
-  def url(perms = :read)
-    options = {:api_key => @flickr.api_key, :perms => perms, :frob => self.frob}
+  # * options (Optional)
+  #     additional parameters to pass to flickr.  The most common use-case for
+  #     this is to pass the (undocumented) :extra parameter that is returned
+  #     back from flickr during the callback.
+  #
+  def url(perms = :read, options = {})
+    options.merge!(:api_key => @flickr.api_key, :perms => perms, :frob => self.frob)
     @flickr.sign_request(options)
-    Flickr::Base::AUTH_ENDPOINT + "?" + options.collect{|k,v| "#{k}=#{v}"}.join('&')
+    Flickr::Base::AUTH_ENDPOINT + "?" + options.collect{|k,v| "#{k}=#{CGI.escape(v.to_s)}"}.join('&')
   end
 
   # gets the token object for the current frob
-  # 
+  #
   # Params
   # * pass_through (Optional)
   #     Boolean value that determines if a call will be made to flickr to find a taken for the current frob if empty
-  # 
+  #
   def token(pass_through = true)
     @token ||= get_token(pass_through) rescue nil
   end
 
   # saves the current token to the cache file if token exists
-  # 
+  #
   # Param
   # * filename (Optional)
   #     filename of the cache file. defaults to the file passed into Flickr.new
-  # 
+  #
   def cache_token(filename = @flickr.token_cache)
     if filename and self.token
       cache_file = File.open(filename, 'w+')
@@ -73,4 +77,4 @@ class Flickr::Auth < Flickr::Base
       Token.new(:token => rsp.auth.token.to_s, :permisions => rsp.auth.perms.to_s, :user_id => rsp.auth.user[:nsid], :username => rsp.auth.user[:username], :user_real_name => rsp.auth.user[:fullname])
     end
   end
-end
+end

data/lib/flickr/photo.rb

@@ -30,9 +30,13 @@ class Flickr::Photos::Photo
   #  * size (Optional)
   #    the size of the size instance to return.  Optional sizes are:
   #       :square - square 75x75
+  #       :large_square - square 150x150
   #       :thumbnail - 100 on longest side
   #       :small - 240 on longest side
+  #       :small_320 - 320 on longest side
   #       :medium - 500 on longest side
+  #       :medium_640 - 640 on longest side
+  #       :medium_800 - 800 on longest side
   #       :large - 1024 on longest side (only exists for very large original images)
   #       :original - original image, either a jpg, gif or png, depending on source format
   # Examples
@@ -48,9 +52,13 @@ class Flickr::Photos::Photo
   # * size (Optional)
   #     the size of the image to return. Optional sizes are:
   #       :square - square 75x75
+  #       :large_square - square 150x150
   #       :thumbnail - 100 on longest side
   #       :small - 240 on longest side
+  #       :small_320 - 320 on longest side
   #       :medium - 500 on longest side
+  #       :medium_640 - 640 on longest side
+  #       :medium_800 - 800 on longest side
   #       :large - 1024 on longest side (only exists for very large original images)
   #       :original - original image, either a jpg, gif or png, depending on source format
   #
@@ -86,10 +94,14 @@ class Flickr::Photos::Photo
   #     name of the new file omiting the extention (ex. photo_1)
   # * size (Optional)
   #     the size of the image to return. Optional sizes are:
-  #       :small - square 75x75
+  #       :square - square 75x75
+  #       :large_square - square 150x150
   #       :thumbnail - 100 on longest side
   #       :small - 240 on longest side
+  #       :small_320 - 320 on longest side
   #       :medium - 500 on longest side
+  #       :medium_640 - 640 on longest side
+  #       :medium_800 - 800 on longest side
   #       :large - 1024 on longest side (only exists for very large original images)
   #       :original - original image, either a jpg, gif or png, depending on source format
   # 
@@ -106,7 +118,14 @@ class Flickr::Photos::Photo
       f
     end
   end
-  
+ 
+  # Delete this photo
+  #
+  def delete()
+    @flickr.send_request('flickr.photos.delete', {:photo_id => self.id}, :post)
+    true
+  end
+ 
   # Add tags to a photo.
   # 
   # Params
@@ -282,9 +301,13 @@ class Flickr::Photos::Photo
   def size_key(size)
     case size.to_sym
     when :square then 's'
+    when :large_square then 'q'
     when :thumb, :thumbnail then 't'
     when :small then 'm'
+    when :small_320 then 'n'
     when :medium then ''
+    when :medium_640 then 'z'
+    when :medium_800 then 'c'
     when :large then 'b'
     when :original then 'o'
     else ''

data/lib/flickr/photoset.rb

@@ -1,19 +1,23 @@
 class Flickr::Photosets::Photoset
-  attr_accessor :id,:num_photos,:title,:description
-  
+  attr_accessor :id,:num_photos,:title,:description,:primary_photo_id
+
   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
-  
+
+   def add_photo(photo_id)
+     rsp = @flickr.send_request('flickr.photosets.addPhoto', {:photo_id=>photo_id, :photoset_id => id})
+   end
+
   protected
     def collect_photos(rsp)
       photos = []
@@ -26,11 +30,11 @@ class Flickr::Photosets::Photoset
       end
       return photos
     end
-    
+
     def create_attributes(photo)
       {:id => photo[:id],
-       :secret => photo[:secret], 
-       :server => photo[:server], 
+       :secret => photo[:secret],
+       :server => photo[:server],
        :farm => photo[:farm],
        :title => photo[:title]}
     end

data/lib/flickr/photosets.rb

@@ -2,15 +2,24 @@ 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  
+
+  #required:
+  # title
+  # primary_photo_id
+  #
+  def create(title, primary_photo_id, options={})
+    options.merge!({:title => title, :primary_photo_id => primary_photo_id})
+    @flickr.send_request('flickr.photosets.create', options)
+  end
+
+  protected
     def collect_photosets(rsp)
       photosets = []
       return photosets unless rsp
@@ -22,18 +31,18 @@ class Flickr::Photosets < Flickr::Base
       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], 
+        :id => photoset[:id],
         :num_photos => photoset[:photos],
         :title => photoset.title.to_s,
         :description => photoset.description.to_s
        }
     end
-  
-end
+
+end

data/spec/flickr/photo_spec.rb

@@ -1,93 +1,109 @@
+# encoding: utf-8
+
 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
+        :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."
+      @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 ".photo_size" do
+
+    before :each do
+      sizes_xml = File.read(File.dirname(__FILE__) + "/../fixtures/flickr/photos/get_sizes-0.xml")
+      @flickr.stub!(:request_over_http).and_return(sizes_xml)
+    end
+
     it "should return the appropriate Flickr::Photos::Size instance when requested by symbol" do
-	  @photo.photo_size(:square).class.should == Flickr::Photos::Size
-	  @photo.photo_size(:square).label.should == "Square"
+      @photo.photo_size(:square).class.should == Flickr::Photos::Size
+      @photo.photo_size(:square).label.should == "Square"
     end
 
     it "should return the appropriate Flickr::Photos::Size instance when requested by string" do
-	  @photo.photo_size('square').class.should == Flickr::Photos::Size
-	  @photo.photo_size('square').label.should == "Square"
+      @photo.photo_size('square').class.should == Flickr::Photos::Size
+      @photo.photo_size('square').label.should == "Square"
     end
 
     it "should return the :medium Flickr::Photos::Size instance invalidly requested" do
-	  @photo.photo_size(:doubleplusbig).class.should == Flickr::Photos::Size
-	  @photo.photo_size(:doubleplusbig).label.should == "Medium"
+      @photo.photo_size(:doubleplusbig).class.should == Flickr::Photos::Size
+      @photo.photo_size(:doubleplusbig).label.should == "Medium"
     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(:square).should == "http://farm4.static.flickr.com/3180/2984637736_9e5762e027_s.jpg"
+      @photo.image_url(:large_square).should == "http://farm4.static.flickr.com/3180/2984637736_9e5762e027_q.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
+      @photo.image_url(:small_320).should == "http://farm4.static.flickr.com/3180/2984637736_9e5762e027_n.jpg"
+      @photo.image_url(:medium).should == "http://farm4.static.flickr.com/3180/2984637736_9e5762e027.jpg"
+      @photo.image_url(:medium_640).should == "http://farm4.static.flickr.com/3180/2984637736_9e5762e027_z.jpg"
+      @photo.image_url(:medium_800).should == "http://farm4.static.flickr.com/3180/2984637736_9e5762e027_c.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 :large_square
+      @photo.image_url :thumbnail
+      @photo.image_url :small
+      @photo.image_url :small_320
+      @photo.image_url :medium
+      @photo.image_url :medium_640
+      @photo.image_url :medium_800
+      @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
@@ -118,12 +134,12 @@ describe Flickr::Photos::Photo do
   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)

data/spec/flickr/photosets_spec.rb

@@ -6,44 +6,67 @@ describe Flickr::Photosets do
         "/../fixtures/flickr/photosets/get_list-0.xml")
     @get_photos_xml = File.read(File.dirname(__FILE__) +
         "/../fixtures/flickr/photosets/get_photos-0.xml")
+    @create_xml = File.read(File.dirname(__FILE__) +
+        "/../fixtures/flickr/photosets/create-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.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)  
+      @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].should be_an_instance_of(Flickr::Photosets::Photoset)
       photosets[0].title.should == 'Test'
     end
   end
-  
+
+  describe ".create" do
+    subject { Flickr::Photosets.new(@flickr) }
+    it "should call flick.photosets.create" do
+      @flickr.should_receive(:send_request).with("flickr.photosets.create",
+                                                 { :title => "new photoset", :primary_photo_id => 42 })
+      @flickr.stub!(:request_over_http).and_return(@create_xml)
+      subject.create("new photoset", 42)
+    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})       
+      @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)  
+      @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)    
+      photos[0].should be_an_instance_of(Flickr::Photos::Photo)
     end
   end
-end
+
+  describe ".add_photo" do
+     subject { Flickr::Photosets::Photoset.new(@flickr, {:id=>4}) }
+
+     it "should call flickr.photosets.addPhoto" do
+       @flickr.should_receive(:send_request).with("flickr.photosets.addPhoto",
+                                                 { :photo_id => 43, :photoset_id => 4 })
+       @flickr.stub!(:request_over_http).and_return("")
+       subject.add_photo(43)
+     end
+  end
+end

data/spec/flickr/urls_spec.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 require File.dirname(__FILE__) + '/../spec_helper'
 
 describe Flickr::Urls do

data/spec/spec_helper.rb

@@ -1,6 +1,4 @@
-require 'rubygems'
-gem 'rspec'
-require 'spec'
+require 'rspec'
  
 $:.unshift(File.dirname(__FILE__) + '/../lib')
 require 'flickr_fu'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fotonauts-flickr_fu
 version: !ruby/object:Gem::Version
-  version: 0.3.4
+  version: 0.3.6
   prerelease: 
 platform: ruby
 authors:
@@ -34,11 +34,11 @@ email: ben@commonthread.com
 executables: []
 extensions: []
 extra_rdoc_files:
-- README
+- README.md
 files:
 - .gitignore
 - LICENSE
-- README
+- README.md
 - Rakefile
 - VERSION.yml
 - flickr_fu.gemspec
@@ -108,7 +108,7 @@ licenses: []
 post_install_message: 
 rdoc_options:
 - --main
-- README
+- README.md
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement

data/README

@@ -1,147 +0,0 @@
-= flickr-fu
-
-== Contact
-
-  Author: Ben Wyrosdick
-  Email: ben [at] commonthread.com
-  Lighthouse: http://commonthread.lighthouseapp.com/projects/12069-flickr_fu/overview
-  Main Repository: http://github.com/commonthread/flickr_fu/tree/master
-
-== Getting Started
-
-  You need to first get an API key as detailed here:
-
-  http://www.flickr.com/services/api/misc.api_keys.html
-  
-== Installation
-
-  sudo gem install flickr-fu
-
-== Documentation
-
-  RDoc Documentation can be found here:
-
-  http://www.commonthread.com/projects/flickr_fu/rdoc/
-
-== Example flickr.yml
---- !map:HashWithIndifferentAccess
-key: "YOUR KEY"
-secret: "YOUR SECRET"
-token_cache: "token_cache.yml"
-
-== Authorization
-
-  To authorise your application to access Flickr using your API key you will
-  need to access a specific URL.
-  
-  To generate this URL run the following and when presented with the URL 
-  access it from your browser. Confirm the application has permission at 
-  the level you have specified.
-  
-  Note that flickr has different types of keys. If you use one for a webapplication,
-  which is most likely, you need to define a callback and somehow make sure that
-  you connect the parameter :frob that flickr send via the callback is assigned
-  to the right user account. The best way to do this is to loop over all the current
-  user's flickr accounts and try flickr.auth.token with the :frob.
-  
-  Finally, cache the token (this will create the token cache file)
-  
-  If you have an invalid API key you will see errors such as:
-  
-  "100: Invalid API Key"
-  
-  If you don't follow the process below to authorise your application
-  you will see errors such as:
-  
-  "98: Login failed / Invalid auth token" or 
-  "99: User not logged in / Insufficient permissions"
-  
-== Authorization Example for non-webapplication
-
-  require 'flickr_fu'
-  
-  flickr = Flickr.new('flickr.yml')
-  
-  puts "visit the following url, then click <enter> once you have authorized:"
-
-  # request write permissions
-  puts flickr.auth.url(:write)
-  
-  gets
-  
-  flickr.auth.cache_token
-
-== Authorization Example for a webapplication
-
-  flickr.auth.token also contains the nsid and username, this
-  example only stores the token and no other userdata.
-
-  require 'flickr_fu'
-  class FlickrController < ActionController::Base
-    def create
-      flickr = Flickr.new('flickr.yml')
-      redirect_to flickr.auth.url(:write)
-    end
-    def flickr_callback
-      flickr = Flickr.new('flickr.yml')
-      flickr.auth.frob = params[:frob]
-      current_user.update_attribute :flickr_token, flickr.auth.token.token
-    end
-    def something_else_with_flickr
-      flickr = Flickr.new(YAML.load_file('flickr.yml').merge(:token => current_user.flickr_token))
-      # now you have full access on the user's data :)
-    end
-  end
-
-== Search Example
-
-  require 'flickr_fu'
-
-  flickr = Flickr.new('flickr.yml')
-
-  photos = flickr.photos.search(:tags => 'ruby-flickr')
-
-  puts "found #{photos.size} photo(s)"
-
-  photos.each do |photo|
-    puts photo.title
-    puts photo.description unless [nil, ''].include?(photo.description)
-    [:square, :thumbnail, :small, :medium, :large, :original].each do |size|
-      puts "#{size}: #{photo.url(size)}"
-    end
-    puts "comments: #{photo.comments.size}"
-    photo.comments.each do |comment|
-      intro = "#{comment.author_name} says - "
-      puts "#{intro}\"#{comment.comment.gsub("\n", "\n"+(" "*intro.length))}\""
-    end
-    puts "notes: #{photo.notes.size}"
-    photo.notes.each do |note|
-      puts "[#{note.x},#{note.y} ~ #{note.width}x#{note.height}] - \"#{note.note}\""
-    end
-    puts
-    puts
-  end
-  
-== Another Search Example
-
-  If searching for photos by user id then you need to specify the 'alias' - without
-  intervention this is usually set by Flickr and is an alphanumeric string. 
-  
-  To find out the user id for a given user, you can use the tool at:
-  
-  http://idgettr.com/
-  
-  And replace the line in the above sample to query on user id:
-  
-  photos = flickr.photos.search(:user_id => 'your_user_id_here')
-
-== Patch Contributers
-
-  Chris Ledet
-  Maciej Biłas
-  Mike Perham
-  Chris Anderton
-  Luke Francl
-  Thomas R. Koll
-  P. Mark Anderson
-  Josh Nichols