snip-snap 0.1.0 → 0.1.1

data/README.rdoc

@@ -5,18 +5,18 @@
 SnipSnap is a Ruby library that will allow you to extract the URL of an image from
 one of many popular image sharing services.  Just give it the shortened URL and it can
 give you the full URL to the embedded image.  This library currently supports Img.ly,
-Skitch, Twitpic, and Yfrog - others are coming.
+Skitch, Twitpic, Flickr, and Yfrog - others are coming.
 
 == Installation
 
-    sudo gem install snip-snap
+    sudo gem install snip-snap --source=http://gemcutter.org
 
 == Usage
 
     require 'rubygems
     require 'snip_snap'
     
-    client = SnipSnap.factory('http://yfrog.com/7hb9lj')
+    client = SnipSnap.from_url('http://yfrog.com/7hb9lj')
     puts client.image_url
 
 == License

data/Rakefile

@@ -18,6 +18,7 @@ spec = Gem::Specification.new do |s|
   # s.executables    = ['snip-snap']
   
   s.add_dependency('curb', '>= 0.5.1.0')
+  s.add_dependency('fleakr', '>= 0.5.1')
 end
 
 Rake::GemPackageTask.new(spec) do |pkg|

data/lib/snip_snap.rb

@@ -1,6 +1,7 @@
 $:.unshift File.dirname(__FILE__)
 
 require 'curb'
+require 'fleakr'
 require 'uri'
 
 require 'snip_snap/client'
@@ -9,6 +10,7 @@ require 'snip_snap/skitch'
 require 'snip_snap/imgly'
 require 'snip_snap/yfrog'
 require 'snip_snap/twitpic'
+require 'snip_snap/flickr'
 
 # = SnipSnap
 #
@@ -19,13 +21,14 @@ require 'snip_snap/twitpic'
 # * Skitch
 # * Twitpic
 # * Yfrog
+# * Flickr
 #
 # To use, just point it at a URL:
 # 
 #  require 'rubygems'
 #  require 'snip_snap'
 #
-#  client = SnipSnap.factory('http://yfrog.com/7hb9lj')
+#  client = SnipSnap.from_url('http://yfrog.com/7hb9lj')
 #  puts client.image_url
 #
 # That's it.
@@ -37,12 +40,13 @@ module SnipSnap
       'skitch.com'  => 'Skitch',
       'img.ly'      => 'Imgly',
       'twitpic.com' => 'Twitpic',
-      'yfrog.com'   => 'Yfrog'
+      'yfrog.com'   => 'Yfrog',
+      'flic.kr'     => 'Flickr'
     }
   end
 
   # Use the correct class to handle image extraction for a given URL
-  def self.factory(url)
+  def self.from_url(url)
     const_get(class_name_for(url)).new(url)
   end
   
@@ -51,4 +55,9 @@ module SnipSnap
     host_map[uri.host]
   end
   
+  # Set the Flickr API key for use by the underlying Flickr API library
+  def self.flickr_api_key=(key)
+    Fleakr.api_key = key
+  end
+  
 end

data/lib/snip_snap/client.rb

@@ -9,35 +9,32 @@ module SnipSnap
         @url = url
       end
       
-      def get
-        get_response {|c| c.http_get }
-      end
-
-      def head
-        get_response {|c| c.http_head }
-      end
-
-      def get_response(&block)
+      def fetch
         client = Curl::Easy.new(url) do |config|
           config.follow_location = true
-          config.max_redirects = 5
+          config.max_redirects   = 5
+          config.head            = self.class.head?
         end
 
-        block.call(client)
+        client.perform
 
         client
       end
+      
+      def response
+        @response ||= fetch
+      end
 
     end
     
     module ClassMethods
       
       def request_method(method_name)
-        class_eval <<-CODE
-          def response
-            @response ||= #{method_name}
-          end
-        CODE
+        @request_method = method_name
+      end
+      
+      def head?
+        @request_method == :head
       end
       
     end

data/lib/snip_snap/flickr.rb

@@ -0,0 +1,22 @@
+module SnipSnap
+  class Flickr
+
+    include Client
+
+    request_method :head
+    
+    def identifier
+      url = response.last_effective_url
+      url.match(/([^\/]+)\/$/)[1]
+    end
+    
+    def photo
+      Fleakr::Objects::Photo.find_by_id(identifier)
+    end
+    
+    def image_url
+      photo.medium.url
+    end
+    
+  end
+end

data/lib/snip_snap/version.rb

@@ -3,7 +3,7 @@ module SnipSnap
     
     MAJOR = 0
     MINOR = 1
-    TINY  = 0
+    TINY  = 1
     
     def self.to_s # :nodoc:
       [MAJOR, MINOR, TINY].join('.')

data/test/unit/snip_snap/client_test.rb

@@ -19,84 +19,85 @@ module SnipSnap
     
     context "An instance of the ClientImplementation class" do
       
-      should "be able to make a get request" do
-        url = 'http://example.com'
+      should "be able to fetch a response" do
+        response = stub()
         
-        client = mock() do |c|
-          c.expects(:http_get).with()
-        end
+        c = ClientImplementation.new('http://example.com')
+        c.expects(:fetch).once.with().returns(response)
         
-        config = mock() do |c|
-          c.expects(:follow_location=).with(true)
-          c.expects(:max_redirects=).with(5)
-        end
+        c.response.should == response
+      end
+      
+      should "cache the response object" do
+        response = stub()
         
-        Curl::Easy.expects(:new).with(url).yields(config).returns(client)
+        c = ClientImplementation.new('http://example.com')
+        c.expects(:fetch).once.with().returns(response)
         
-        c = ClientImplementation.new(url)
-        c.get.should == client
+        2.times { c.response }
       end
       
-      should "be able to make a head request" do
+    end
+    
+    context "The ClientGetImplementation class" do
+      
+      should "know that it doesn't make a head request" do
+        ClientGetImplementation.head?.should be(false)
+      end
+      
+    end
+    
+    context "An instance of the ClientGetImplementation class" do
+      
+      should "fetch a response using a GET request" do
         url = 'http://example.com'
         
         client = mock() do |c|
-          c.expects(:http_head).with()
+          c.expects(:perform).with()
         end
         
         config = mock() do |c|
           c.expects(:follow_location=).with(true)
           c.expects(:max_redirects=).with(5)
+          c.expects(:head=).with(false)
         end
         
         Curl::Easy.expects(:new).with(url).yields(config).returns(client)
         
-        c = ClientImplementation.new(url)
-        c.head.should == client
+        c = ClientGetImplementation.new(url)
+        c.fetch.should == client
       end
       
     end
     
-    context "An instance of the ClientGetImplementation class" do
-      
-      should "fetch a response using a GET request when calling response" do
-        response = stub()
-        
-        c = ClientGetImplementation.new('http://example.com')
-        c.expects(:get).with().returns(response)
-        
-        c.response.should == response
-      end
-      
-      should "cache the response object" do
-        response = stub()
-        
-        c = ClientGetImplementation.new('http://example.com')
-        c.expects(:get).once.with().returns(response)
-        
-        2.times { c.response.should }
+    
+    context "The ClientHeadImplementation class" do
+
+      should "know that it doesn't makes a head request" do
+        ClientHeadImplementation.head?.should be(true)
       end
       
     end
     
     context "An instance of the ClientHeadImplementation class" do
       
-      should "fetch a response using a GET request when calling response" do
-        response = stub()
+      should "fetch a response using a HEAD request" do
+        url = 'http://example.com'
         
-        c = ClientHeadImplementation.new('http://example.com')
-        c.expects(:head).with().returns(response)
+        client = mock() do |c|
+          c.expects(:perform).with()
+        end
         
-        c.response.should == response
-      end
-      
-      should "cache the response object" do
-        response = stub()
+        config = mock() do |c|
+          c.expects(:follow_location=).with(true)
+          c.expects(:max_redirects=).with(5)
+          c.expects(:head=).with(true)
+        end
         
-        c = ClientHeadImplementation.new('http://example.com')
-        c.expects(:head).once.with().returns(response)
+        Curl::Easy.expects(:new).with(url).yields(config).returns(client)
         
-        2.times { c.response.should }
+        c = ClientHeadImplementation.new(url)
+        c.fetch.should == client
       end
       
     end

data/test/unit/snip_snap/flickr_test.rb

@@ -0,0 +1,49 @@
+require File.dirname(__FILE__) + '/../../test_helper'
+
+module SnipSnap
+  class FlickrTest < Test::Unit::TestCase
+    
+    context "An instance of the Flickr class" do
+      setup do
+        @url          = 'http://flic.kr/p/64cBqN'
+        @expanded_url = 'http://www.flickr.com/photos/northernraven/3317998738/'
+      end
+      
+      should "know the identifier for the photo" do
+        response = stub()
+        response.stubs(:last_effective_url).with().returns(@expanded_url)
+        
+        f = SnipSnap::Flickr.new(@url)
+        f.stubs(:response).with().returns(response)
+        
+        f.identifier.should == '3317998738'
+      end
+      
+      should "be able to find the photo for the identifier" do
+        identifier = '3317998738'
+        photo      = stub()
+        
+        Fleakr::Objects::Photo.expects(:find_by_id).with(identifier).returns(photo)
+        
+        f = SnipSnap::Flickr.new(@url)
+        f.stubs(:identifier).with().returns(identifier)
+        
+        f.photo.should == photo
+      end
+      
+      should "know the image url" do
+        url = 'http://farm.flickr.com/photo.jpg'
+        
+        photo = stub()
+        photo.stubs(:medium).with().returns(stub(:url => url))
+        
+        f = SnipSnap::Flickr.new(@url)
+        f.stubs(:photo).with().returns(photo)
+        
+        f.image_url.should == url
+      end
+      
+    end
+    
+  end
+end

data/test/unit/snip_snap/imgly_test.rb

@@ -14,15 +14,6 @@ module SnipSnap
         i.url.should == @expanded_url
       end
       
-      should "use a HEAD request when retrieving the response" do
-        response = stub()
-        
-        i = SnipSnap::Imgly.new(@url)
-        i.expects(:head).with().returns(response)
-        
-        i.response.should == response
-      end
-      
       should "be able to return an image url for a given url" do
         response = stub()
         response.stubs(:last_effective_url).with().returns(@expanded_url)

data/test/unit/snip_snap/skitch_test.rb

@@ -11,15 +11,6 @@ module SnipSnap
         s.url.should == @url
       end
       
-      should "use a GET request when retrieving the response" do
-        response = stub()
-        
-        s = SnipSnap::Skitch.new(@url)
-        s.expects(:get).with().returns(response)
-        
-        s.response.should == response
-      end
-            
       should "be able to return an image url for a given url" do
         s = SnipSnap::Skitch.new(@url)
         

data/test/unit/snip_snap/twitpic_test.rb

@@ -14,15 +14,6 @@ module SnipSnap
         t.url.should == @expanded_url
       end
       
-      should "use a HEAD request when retrieving the response" do
-        response = stub()
-        
-        t = SnipSnap::Twitpic.new(@url)
-        t.expects(:head).with().returns(response)
-        
-        t.response.should == response
-      end
-      
       should "be able to return an image url for a given url" do
         response = stub()
         response.stubs(:last_effective_url).with().returns(@expanded_url)

data/test/unit/snip_snap/yfrog_test.rb

@@ -14,15 +14,6 @@ module SnipSnap
         y.url.should == @expanded_url
       end
       
-      should "use a GET request when retrieving the response" do
-        response = stub()
-        
-        y = SnipSnap::Yfrog.new(@url)
-        y.expects(:get).with().returns(response)
-        
-        y.response.should == response
-      end
-      
       should "be able to return an image url for a given url" do
         y = SnipSnap::Yfrog.new(@url)
         

data/test/unit/snip_snap_test.rb

@@ -2,7 +2,7 @@ require File.dirname(__FILE__) + '/../test_helper'
 
 class SnipSnapTest < Test::Unit::TestCase
 
-  describe "The SnipSnap module" do
+  context "The SnipSnap module" do
 
     should "know the correct class name for a Skitch URL" do
       url = 'http://skitch.com/reagent/bh4ei/bleeergh'
@@ -24,32 +24,52 @@ class SnipSnapTest < Test::Unit::TestCase
       SnipSnap.class_name_for(url).should == 'Yfrog'
     end
     
+    should "know the correct class name for a Flickr URL" do
+      url = 'http://flic.kr/p/64cBqN'
+      SnipSnap.class_name_for(url).should == 'Flickr'
+    end
+    
     should "be able to create an instance of the Skitch class with the supplied URL" do
       url = 'http://skitch.com/reagent/bh4ei/bleeergh'
       SnipSnap::Skitch.expects(:new).with(url).returns('skitch')
       
-      SnipSnap.factory(url).should == 'skitch'
+      SnipSnap.from_url(url).should == 'skitch'
     end
     
     should "be able to create an instance of the Imgly class with the supplied URL" do
       url = 'http://img.ly/3ey'
       SnipSnap::Imgly.expects(:new).with(url).returns('imgly')
       
-      SnipSnap.factory(url).should == 'imgly'
+      SnipSnap.from_url(url).should == 'imgly'
     end
     
     should "be able to create an instance of the Twitpic class with the supplied URL" do
       url = 'http://twitpic.com/203o0'
       SnipSnap::Twitpic.expects(:new).with(url).returns('twitpic')
 
-      SnipSnap.factory(url).should == 'twitpic'
+      SnipSnap.from_url(url).should == 'twitpic'
     end
 
     should "be able to create an instance of the Yfrog class with the supplied URL" do
       url = 'http://yfrog.com/ahb97j'
       SnipSnap::Yfrog.expects(:new).with(url).returns('yfrog')
 
-      SnipSnap.factory(url).should == 'yfrog'
+      SnipSnap.from_url(url).should == 'yfrog'
+    end
+    
+    should "be able to create an instance of the Flickr class with the supplied URL" do
+      url = 'http://flic.kr/p/64cBqN'
+      SnipSnap::Flickr.expects(:new).with(url).returns('flickr')
+
+      SnipSnap.from_url(url).should == 'flickr'
+    end
+    
+    should "be able to set the Flickr API key" do
+      key = 'abc123'
+      
+      Fleakr.expects(:api_key=).with(key)
+      
+      SnipSnap.flickr_api_key = key
     end
     
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: snip-snap
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors: 
 - Patrick Reagan
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-09-02 00:00:00 -04:00
+date: 2009-09-06 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -22,6 +22,16 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: 0.5.1.0
     version: 
+- !ruby/object:Gem::Dependency 
+  name: fleakr
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.5.1
+    version: 
 description: 
 email: reaganpr@gmail.com
 executables: []
@@ -34,6 +44,7 @@ files:
 - README.rdoc
 - Rakefile
 - lib/snip_snap/client.rb
+- lib/snip_snap/flickr.rb
 - lib/snip_snap/imgly.rb
 - lib/snip_snap/skitch.rb
 - lib/snip_snap/twitpic.rb
@@ -44,6 +55,7 @@ files:
 - test/fixtures/yfrog.xml
 - test/test_helper.rb
 - test/unit/snip_snap/client_test.rb
+- test/unit/snip_snap/flickr_test.rb
 - test/unit/snip_snap/imgly_test.rb
 - test/unit/snip_snap/skitch_test.rb
 - test/unit/snip_snap/twitpic_test.rb