latompa-fleakr 0.5.1

data/lib/fleakr.rb

@@ -0,0 +1,171 @@
+$:.unshift(File.dirname(__FILE__))
+require 'rubygems'
+
+require 'uri'
+require 'cgi'
+require 'net/http'
+require 'hpricot'
+require 'forwardable'
+
+# Require only what we need from ActiveSupport
+require 'active_support/core_ext/array'
+require 'active_support/core_ext/module'
+require 'active_support/core_ext/blank'
+require 'active_support/core_ext/time'
+require 'active_support/inflector'
+require 'active_support/core_ext/string'
+
+require 'digest/md5'
+require 'fileutils'
+require 'loggable'
+
+require 'fleakr/api'
+require 'fleakr/core_ext'
+require 'fleakr/support'
+require 'fleakr/objects'
+
+# = Fleakr: A small, yet powerful, gem to interface with Flickr photostreams
+#
+# == Quick Start
+#
+# Getting started is easy, just make sure you have a valid API key from Flickr and you can
+# then start making any non-authenticated request to pull back data for yours and others' 
+# photostreams, sets, contacts, groups, etc...
+#
+# For now, all activity originates from a single user which you can find by username or
+# email address.
+#
+# Example:
+#
+#  require 'rubygems'
+#  require 'fleakr'
+#
+#  # Our API key is ABC123 (http://www.flickr.com/services/api/keys/apply/)
+#  Fleakr.api_key = 'ABC123'
+#  user = Fleakr.user('bees')
+#  user = Fleakr.user('user@host.com')
+#  # Grab a list of sets
+#  user.sets
+#  # Grab a list of the user's public groups
+#  user.groups
+#
+# To see what other associations and attributes are available, see the Fleakr::Objects::User class
+# 
+# == Authentication
+#
+# If you want to do something more than just retrieve public photos (like upload your own), 
+# you'll need to generate an authentication token to use across requests and sessions.
+#
+# Assuming you've already applied for a key, go back and make sure you have the right settings
+# to get your auth token.  Click on the 'Edit key details' link and ensure that:
+#
+# 1. Your application description and notes are up-to-date
+# 1. The value for 'Authentication Type' is set to 'Mobile Application'
+# 1. The value for 'Mobile Permissions' is set to either 'write' or 'delete'
+#
+# Once this is set, you'll see your Authentication URL on the key details page (it will look
+# something like http://www.flickr.com/auth-534525246245).  Paste this URL into your browser and 
+# confirm access to get your mini-token. Now you're ready to make authenticated requests:
+#
+#   require 'rubygems'
+#   require 'fleakr'
+#
+#   Fleakr.api_key       = 'ABC123'
+#   Fleakr.shared_secret = 'sekrit' # Available with your key details on the Flickr site
+#   Fleakr.mini_token    = '362-133-214'
+#
+#   Fleakr.upload('/path/to/my/photo.jpg')
+#   Fleakr.token.value # => "34132412341235-12341234ef34"
+# 
+# Once you use the mini-token once, it is no longer available.  To use the generated auth_token
+# for future requests, just set Fleakr.auth_token to the generated value.
+#
+module Fleakr
+
+  # Generic catch-all exception for any API errors
+  class ApiError < StandardError; end
+
+  mattr_accessor :api_key, :shared_secret, :mini_token, :auth_token, :frob
+
+  # Find a user based on some unique user data.  This method will try to find
+  # the user based on username and will fall back to email if that fails.  Example:
+  #
+  #  Fleakr.api_key = 'ABC123'
+  #  Fleakr.user('the decapitator') # => #<Fleakr::Objects::User:0x692648 @username="the decapitator", @id="21775151@N06">
+  #  Fleakr.user('user@host.com')   # => #<Fleakr::Objects::User:0x11f484c @username="bckspcr", @id="84481630@N00">
+  #
+  def self.user(user_data)
+    begin
+      Objects::User.find_by_username(user_data)
+    rescue ApiError
+      Objects::User.find_by_email(user_data)
+    end
+  end
+  
+  # Search all photos on the Flickr site.  By default, this searches based on text, but you can pass
+  # different search parameters (passed as hash keys):
+  #
+  # [tags] The list of tags to search on (either as an array or comma-separated)
+  # [user_id] Scope the search to this user
+  # [group_id] Scope the search to this group
+  #
+  # If you're interested in User- and Group-scoped searches, you may want to use User#search and Group#search
+  # instead.
+  #
+  def self.search(params)
+    params = {:text => params} unless params.is_a?(Hash)
+    Objects::Search.new(params).results
+  end
+  
+  # Upload one or more files to your Flickr account (requires authentication).  Simply provide
+  # a filename or a pattern to upload one or more files:
+  #
+  #  Fleakr.upload('/path/to/my/mug.jpg')
+  #  Fleakr.upload('/User/Pictures/Party/*.jpg')
+  #
+  # Additionally, options can be supplied as part of the upload that will apply to all files
+  # that are matched by the pattern passed to <tt>glob</tt>.  For a full list, see 
+  # Fleakr::Objects::Photo.
+  #
+  def self.upload(glob, options = {})
+    Dir[glob].map {|file| Fleakr::Objects::Photo.upload(file, options) }
+  end
+  
+  # Get all contacts for an authenticated account
+  # Pass in optional params
+  # [filter]=friends|family|both|neither
+  def self.contacts(params={})
+    Fleakr::Objects::Contact.find_all_contacts(params)
+  end
+
+  # Get the authentication token needed for authenticated requests.  Will either use
+  # a valid auth_token (if available) or a mini-token to generate the auth_token.
+  #
+  def self.token
+    @token ||= begin
+      if Fleakr.auth_token
+        Fleakr::Objects::AuthenticationToken.from_auth_token(Fleakr.auth_token)
+      elsif Fleakr.frob
+        Fleakr::Objects::AuthenticationToken.from_frob(Fleakr.frob)
+      elsif Fleakr.mini_token
+        Fleakr::Objects::AuthenticationToken.from_mini_token(Fleakr.mini_token)
+      end
+    end
+  end
+  
+  # Reset the cached token whenever setting a new value for the mini_token, auth_token, or frob
+  #
+  [:mini_token, :auth_token, :frob].each do |attribute|
+    class_eval <<-ACCESSOR
+      def self.#{attribute}=(#{attribute})
+        reset_token
+        @@#{attribute} = #{attribute}
+      end
+    ACCESSOR
+  end
+
+  def self.reset_token # :nodoc: #
+    @token = nil
+  end
+  
+end

data/test/fixtures/auth.checkToken.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="utf-8"?>
+<rsp stat="ok">
+<auth>
+	<token>abc-123</token>
+	<perms>delete</perms>
+	<user nsid="31066442@N69" fullname="Sir Froot Pants" username="frootpantz"></user>
+</auth>
+</rsp>

data/test/fixtures/auth.getFullToken.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="utf-8"?>
+<rsp stat="ok">
+<auth>
+	<token>abc-123</token>
+	<perms>delete</perms>
+	<user nsid="31066442@N69" fullname="Sir Froot Pants" username="frootpantz"></user>
+</auth>
+</rsp>

data/test/fixtures/auth.getToken.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="utf-8"?>
+<rsp stat="ok">
+<auth>
+	<token>abc-123</token>
+	<perms>delete</perms>
+	<user nsid="31066442@N69" fullname="Sir Froot Pants" username="frootpantz"></user>
+</auth>
+</rsp>

data/test/fixtures/contacts.getPublicList.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="17">
+	<contact nsid="9302864@N42" username="blinky" iconserver="2263" iconfarm="3" ignored="0" />
+	<contact nsid="63204625@N20" username="inky" iconserver="53" iconfarm="1" ignored="0" />
+</contacts>
+</rsp>

data/test/fixtures/groups.pools.getPhotos.xml

@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<rsp stat="ok">
+<photos page="1" pages="796" perpage="100" total="79509">
+	<photo id="3101830908" owner="64008250@N00" secret="e85e249e72" server="3042" farm="4" title="Canal Gate" ispublic="1" isfriend="0" isfamily="0" ownername="oakraidr" dateadded="1229049777" />
+	<photo id="3100780049" owner="98821864@N00" secret="f46fbe211b" server="3274" farm="4" title="2alarm" ispublic="1" isfriend="0" isfamily="0" ownername="LooknFeel" dateadded="1229042651" />
+</photos>
+</rsp>

data/test/fixtures/people.findByEmail.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<rsp stat="ok">
+  <user id="31066442@N69" nsid="31066442@N69">
+    <username>frootpantz</username>
+  </user>
+</rsp>

data/test/fixtures/people.findByUsername.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<rsp stat="ok">
+  <user id="31066442@N69" nsid="31066442@N69">
+    <username>frootpantz</username>
+  </user>
+</rsp>

data/test/fixtures/people.getInfo.xml

@@ -0,0 +1,18 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<rsp stat="ok">
+  <person id="31066442@N69" nsid="31066442@N69" isadmin="0" ispro="1" iconserver="30" iconfarm="1">
+  	<username>frootpantz</username>
+  	<realname>Sir Froot Pantz</realname>
+  	<mbox_sha1sum>e52ed1e5b91c763694995460e9796fc2adc02019</mbox_sha1sum>
+  	<location>The Moon</location>
+  	<photosurl>http://www.flickr.com/photos/frootpantz/</photosurl>
+  	<profileurl>http://www.flickr.com/people/frootpantz/</profileurl>
+  	<mobileurl>http://m.flickr.com/photostream.gne?id=34225</mobileurl>
+  	<photos>
+  		<firstdatetaken>2006-10-11 08:19:57</firstdatetaken>
+  		<firstdate>1160612247</firstdate>
+  		<count>3907</count>
+  		<views>9002</views>
+  	</photos>
+  </person>
+</rsp>

data/test/fixtures/people.getPublicGroups.xml

@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<rsp stat="ok">
+<groups>
+	<group nsid="13378274@N00" name="Group #1" admin="0" eighteenplus="1" />
+	<group nsid="52242140489@N01" name="Group #2" admin="1" eighteenplus="0" />
+</groups>
+</rsp>

data/test/fixtures/people.getPublicPhotos.xml

@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<rsp stat="ok">
+<photos page="1" pages="1" perpage="100" total="76">
+	<photo id="2924549350" owner="21775151@N06" secret="cbc1804258" server="3250" farm="4" title="Photo #1" ispublic="1" isfriend="0" isfamily="0" />
+	<photo id="2923697303" owner="21775151@N06" secret="649aa95f29" server="3208" farm="4" title="Photo #2" ispublic="1" isfriend="0" isfamily="0" />
+</photos>
+</rsp>

data/test/fixtures/photos.comments.getList.xml

@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<rsp stat="ok">
+<comments photo_id="1">
+	<comment id="1" author="10490170@N04" authorname="blip" datecreate="1239217523" permalink="http://www.flickr.com/photos/frootpantz/3422268412/#comment72157616515348062">comment one</comment>
+	<comment id="2" author="10490170@N02" authorname="bleep" datecreate="1239217222" permalink="http://www.flickr.com/photos/frootpantz/3422268413/#comment72157616515348063">comment two</comment>
+</comments>
+</rsp>

data/test/fixtures/photos.getContext.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<rsp stat="ok">
+<count>5584</count>
+<prevphoto id="12345" secret="abc234" server="3560" farm="4" title="Previous" url="/photos/frootpantz/12345/in/photostream/" thumb="http://farm4.static.flickr.com/3560/3369675369_d97d2b1345_s.jpg" media="photo" />
+<nextphoto id="12343" secret="abc123" server="3562" farm="4" title="Next" url="/photos/frootpantz/12343/in/photostream/" thumb="http://farm4.static.flickr.com/3562/3370497926_ba89f4343a_s.jpg" media="photo" />
+</rsp>

data/test/fixtures/photos.getInfo.xml

@@ -0,0 +1,20 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<rsp stat="ok">
+  <photo id="1" secret="secret" server="3085" farm="4" dateuploaded="1230274722" isfavorite="0" license="0" rotation="0" originalsecret="sekrit" originalformat="jpg" media="photo">
+    <owner nsid="31066442@N69" username="frootpantz" realname="" location="" />
+    <title>Tree</title>
+    <description>A Tree</description>
+    <visibility ispublic="1" isfriend="0" isfamily="0" />
+    <dates posted="1230274722" taken="2008-12-25 18:26:55" takengranularity="0" lastupdate="1230276652" />
+
+    <editability cancomment="0" canaddmeta="0" />
+    <usage candownload="1" canblog="0" canprint="0" />
+    <comments>0</comments>
+    <notes />
+    <tags />
+    <urls>
+      <url type="photopage">http://www.flickr.com/photos/yes/1</url>
+    </urls>
+
+  </photo>
+</rsp>

data/test/fixtures/photos.getSizes.xml

@@ -0,0 +1,10 @@
+<?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/3093/2409912100_71e14ed08a_s.jpg" url="http://www.flickr.com/photos/the_decapitator/2409912100/sizes/sq/" media="photo" />
+  	<size label="Thumbnail" width="100" height="67" source="http://farm4.static.flickr.com/3093/2409912100_71e14ed08a_t.jpg" url="http://www.flickr.com/photos/the_decapitator/2409912100/sizes/t/" media="photo" />
+  	<size label="Small" width="240" height="160" source="http://farm4.static.flickr.com/3093/2409912100_71e14ed08a_m.jpg" url="http://www.flickr.com/photos/the_decapitator/2409912100/sizes/s/" media="photo" />
+  	<size label="Medium" width="500" height="334" source="http://farm4.static.flickr.com/3093/2409912100_71e14ed08a.jpg" url="http://www.flickr.com/photos/the_decapitator/2409912100/sizes/m/" media="photo" />
+  	<size label="Original" width="700" height="467" source="http://farm4.static.flickr.com/3093/2409912100_3305c4a108_o.jpg" url="http://www.flickr.com/photos/the_decapitator/2409912100/sizes/o/" media="photo" />
+  </sizes>
+</rsp>

data/test/fixtures/photos.search.xml

@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<rsp stat="ok">
+<photos page="1" pages="385" perpage="100" total="38424">
+	<photo id="3076020861" owner="31987693@N05" secret="b956549c07" server="3278" farm="4" title="Mona and Lisa" ispublic="1" isfriend="0" isfamily="0" />
+	<photo id="3075386827" owner="9377349@N05" secret="4e40291b2d" server="3151" farm="4" title="IMG_0055 1.JPG" ispublic="1" isfriend="0" isfamily="0" />
+</photos>
+</rsp>

data/test/fixtures/photosets.comments.getList.xml

@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<rsp stat="ok">
+<comments photo_id="1">
+	<comment id="1" author="10490170@N04" authorname="blip" datecreate="1239217523" permalink="http://www.flickr.com/photos/frootpantz/3422268412/#comment72157616515348062">comment one</comment>
+	<comment id="2" author="10490170@N02" authorname="bleep" datecreate="1239217222" permalink="http://www.flickr.com/photos/frootpantz/3422268413/#comment72157616515348063">comment two</comment>
+</comments>
+</rsp>

data/test/fixtures/photosets.getList.xml

@@ -0,0 +1,13 @@
+<?xml version="1.0" encoding="utf-8"?>
+<rsp stat="ok">
+  <photosets>
+  	<photoset videos="0" primary="3044180117" farm="4" photos="138" id="72157609490909659" server="3012" secret="01cd1a741d">
+  		<title>Second Set</title>
+  		<description>This is the second set.</description>
+  	</photoset>
+  	<photoset videos="0" primary="2988511085" farm="4" photos="139" id="72157608538140671" server="3241" secret="a7b90926ba">
+  		<title>First Set</title>
+  		<description>This is the first set.</description>
+  	</photoset>
+  </photosets>
+</rsp>

data/test/fixtures/photosets.getPhotos.xml

@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<rsp stat="ok">
+  <photoset id="72157609490909659" primary="3044180117" owner="31066442@N69" ownername="frootpantz" page="1" per_page="500" perpage="500" pages="1" total="138">
+  	<photo id="3044163577" secret="fa27e5a824" server="3153" farm="4" title="Photo #1" isprimary="0" />
+  	<photo id="3045001128" secret="a8c0e51b39" server="3204" farm="4" title="Photo #2" isprimary="0" />
+  </photoset>
+</rsp>

data/test/fixtures/tags.getListPhoto.xml

@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<rsp stat="ok">
+<photo id="3411015045">
+	<tags>
+		<tag id="1" author="15498419@N05" authorname="stu72" raw="stu 72" machine_tag="0">stu72</tag>
+		<tag id="2" author="15498419@N05" authorname="stu72" raw="ellie" machine_tag="0">ellie</tag>
+	</tags>
+</photo>
+</rsp>

data/test/fixtures/tags.getListUser.xml

@@ -0,0 +1,10 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<rsp stat="ok">
+<who id="32719556@N00">
+	<tags>
+		<tag>08fo</tag>
+		<tag>101building</tag>
+		<tag>101cookbooks</tag>
+	</tags>
+</who>
+</rsp>

data/test/fixtures/tags.getRelated.xml

@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<rsp stat="ok">
+<tags source="family">
+	<tag>portrait</tag>
+	<tag>baby</tag>
+	<tag>child</tag>
+</tags>
+</rsp>
+

data/test/test_helper.rb

@@ -0,0 +1,141 @@
+$:.reject! { |e| e.include? 'TextMate' }
+
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+require 'matchy'
+require 'mocha'
+
+require File.dirname(__FILE__) + '/../lib/fleakr'
+
+class Test::Unit::TestCase
+
+  def self.should_autoload_when_accessing(*attributes)
+    options = attributes.extract_options!
+    attributes.each do |accessor_name|
+      should "load the additional user information when accessing the :#{accessor_name} attribute" do
+        klass = self.class.name.sub(/Test$/, '').constantize
+              
+        object = klass.new
+        object.expects(options[:with]).with()
+        object.send(accessor_name)
+      end
+    end
+  end
+
+  def self.should_have_a_value_for(attribute_test)
+    should "have a value for :#{attribute_test.keys.first}" do
+      @object.send(attribute_test.keys.first).should == attribute_test.values.first
+    end
+  end
+
+  def self.should_search_by(key)
+    should "be able to perform a scoped search by :#{key}" do
+      photos = [stub()]
+      search = stub(:results => photos)
+      
+      klass = self.class.name.sub(/Test$/, '').constantize
+      
+      instance = klass.new
+      instance.stubs(:id).with().returns('1')
+      
+      Fleakr::Objects::Search.expects(:new).with(:text => 'foo', key => '1').returns(search)
+      
+      instance.search('foo').should == photos
+    end
+  end
+
+  def self.should_have_many(*attributes)
+    class_name = self.name.demodulize.sub(/Test$/, '')
+    this_klass = "Fleakr::Objects::#{class_name}".constantize
+
+    options = attributes.extract_options!
+    finder_attribute = options[:using].nil? ? "#{class_name.downcase}_id" : options[:using]
+    
+    attributes.each do |attribute|
+      target_klass = "Fleakr::Objects::#{attribute.to_s.singularize.classify}".constantize
+      should "be able to retrieve the #{class_name.downcase}'s #{attribute}" do
+        results = [stub()]
+        object = this_klass.new
+        object.stubs(:id).with().returns('1')
+
+        target_klass.expects("find_all_by_#{finder_attribute}".to_sym).with('1').returns(results)
+        object.send(attribute).should == results
+      end
+      
+      should "memoize the results for the #{class_name.downcase}'s #{attribute}" do
+        object = this_klass.new
+        
+        target_klass.expects("find_all_by_#{finder_attribute}".to_sym).once.returns([])
+        2.times { object.send(attribute) }
+      end
+      
+    end
+  end
+
+  def self.should_find_one(thing, options)
+    class_name  = thing.to_s.singularize.camelcase
+    klass       = "Fleakr::Objects::#{class_name}".constantize
+    object_type = class_name.downcase    
+
+    condition_value = '1'
+
+    options[:with] = options[:by] if options[:with].nil?
+    params = {options[:with] => condition_value}
+
+    should "be able to find a #{thing} by #{options[:by]}" do
+      stub = stub()
+      response = mock_request_cycle :for => options[:call], :with => params
+
+      klass.expects(:new).with(response.body).returns(stub)
+      klass.send("find_by_#{options[:by]}".to_sym, condition_value).should == stub
+    end
+  end
+
+  def self.should_find_all(thing, options)
+    class_name     = thing.to_s.singularize.camelcase
+    klass          = "Fleakr::Objects::#{class_name}".constantize
+    object_type    = class_name.downcase
+    
+    should "be able to find all #{thing} by #{options[:by]}" do
+      condition_value = '1'
+      finder_options = {(options[:using] || options[:by]) => condition_value}
+    
+      response = mock_request_cycle :for => options[:call], :with => finder_options
+      
+      stubs = []
+      elements = (response.body/options[:path]).map
+      
+      
+      elements.each do |element|
+        stub = stub()
+        stubs << stub
+        
+        klass.expects(:new).with(element).returns(stub)
+      end
+      
+      klass.send("find_all_by_#{options[:by]}".to_sym, condition_value).should == stubs
+    end
+    
+  end
+  
+  def read_fixture(method_call)
+    fixture_path = File.dirname(__FILE__) + '/fixtures'
+    File.read("#{fixture_path}/#{method_call}.xml")
+  end
+  
+  def mock_request_cycle(options)
+    response = stub(:body => Hpricot.XML(read_fixture(options[:for])))
+    Fleakr::Api::MethodRequest.expects(:with_response!).with(options[:for], options[:with]).returns(response)
+    
+    response
+  end
+  
+  def create_temp_directory
+    tmp_dir = File.dirname(__FILE__) + '/tmp'
+    FileUtils.mkdir(tmp_dir)  
+    
+    tmp_dir
+  end
+  
+end

data/test/unit/fleakr/api/file_parameter_test.rb

@@ -0,0 +1,63 @@
+require File.dirname(__FILE__) + '/../../../test_helper'
+
+module Fleakr::Api
+  class FileParameterTest < Test::Unit::TestCase
+    
+    context "An instance of the FileParameter class" do
+      
+      setup do
+        @temp_dir = File.expand_path(create_temp_directory)
+        @filename = "#{@temp_dir}/image.jpg"
+      end
+      
+      teardown do
+        FileUtils.rm_rf(@temp_dir)
+      end
+      
+      should "know not to include itself in the parameter signature" do
+        parameter = FileParameter.new('photo', @filename)
+        parameter.include_in_signature?.should be(false)
+      end
+      
+      {'jpg' => 'image/jpeg', 'png' => 'image/png', 'gif' => 'image/gif'}.each do |ext, mime_type|
+        should "know the correct MIME type for an extension of #{ext}" do
+          parameter = FileParameter.new('photo', "#{@temp_dir}/image.#{ext}")
+          parameter.mime_type.should == mime_type
+        end
+      end
+      
+      should "retrieve the contents of the file when accessing the value" do
+        File.expects(:read).with(@filename).returns('bopbip')
+        
+        parameter = FileParameter.new('photo', @filename)
+        parameter.value.should == 'bopbip'
+      end
+      
+      should "cache the file contents after retrieving them" do
+        File.expects(:read).with(@filename).once.returns('bopbip')
+        
+        parameter = FileParameter.new('photo', @filename)
+        2.times { parameter.value }
+      end
+      
+      should "know how to generate a form representation of itself" do
+        filename  = 'image.jpg'
+        mime_type = 'image/jpeg'
+
+        parameter = FileParameter.new('photo', filename)
+        parameter.stubs(:mime_type).with().returns(mime_type)
+        parameter.stubs(:value).with().returns('data')
+        
+        expected = 
+          "Content-Disposition: form-data; name=\"photo\"; filename=\"#{filename}\"\r\n" +
+          "Content-Type: image/jpeg\r\n" +
+          "\r\n" +
+          "data\r\n"
+        
+        parameter.to_form.should == expected
+      end
+      
+    end
+    
+  end
+end