flickrip 0.0.1 → 0.2.0

data/lib/flickrip/flickr_image.rb

@@ -0,0 +1,48 @@
+require 'nokogiri'
+require 'open-uri'
+
+#require './url_parser'
+
+module Flickrip
+  class FlickrImage
+    def initialize(url)
+      @url = url
+    end
+
+    def image_for_size(size="l",allow_redirect=false)
+      #TODO: if size is a symbol (.sym?), then convert it to the character representation
+      toks = Flickrip::UrlParser.parse @url
+      if toks.has_key?(:user) && toks.has_key?(:imageid)
+        pageurl = compute_page_url_for_user_imageid_size toks[:user], toks[:imageid], size
+        begin
+          page = Nokogiri::HTML( open( pageurl, :redirect => allow_redirect ) )
+          src = page.css("div#allsizes-photo > img").first.attributes["src"].value
+          return open( src )
+        rescue Exception => ex
+          if ex.class == OpenURI::HTTPRedirect
+            # Original image size not found
+          end
+          # TODO: Raise NonFlickrImageUrl exception
+          # TODO: if there is a 404 or 302 error, or a Flickr unauthorized request, then
+          # the file size requested does not exist. Raise InvalidFlickrImageSize exception
+        end
+      else
+        # TODO: Raise NonFlickrImageUrl exception
+      end
+
+    end
+
+    def original_image
+      image_for_size "o"
+    end
+
+    def largest_image
+      # Let flickr try to redirect us to the largest size image
+      image_for_size "o", true
+    end
+
+    def compute_page_url_for_user_imageid_size(user, imageid, size)
+      "http://www.flickr.com/photos/#{user}/#{imageid}/sizes/#{size}/"
+    end
+  end
+end

data/lib/flickrip/sizes.rb

@@ -0,0 +1,6 @@
+
+module Flickrip
+  SIZES = %w[o l z m n s t q sq]
+  SIZE_KEYS = %w[original large medium2 medium small2 small thumbnail square150 square75]
+end
+

data/lib/flickrip/url_parser.rb

@@ -0,0 +1,47 @@
+
+module Flickrip
+  class UrlParser
+    SET_REGEX = /^http.*flickr.*\/(.*)\/sets\/(\d+)/
+    IN_SET_REGEX = /^http.*flickr.*\/(.*)\/(\d+)\/in\/set-(\d+)/
+    IMAGE_REGEX = /^http.*flickr.*\/(.*)\/(\d+)/
+
+    def self.parse(url)
+      return {} if url.nil?
+      # test for "/in-set/"
+      g = url.scan IN_SET_REGEX
+      if g.count == 1
+        return Hash[ [:user,:imageid,:setid].zip g[0] ]
+      end
+
+      # test for "/sets/"
+      g = url.scan SET_REGEX
+      if g.count == 1
+        return Hash[ [:user,:setid].zip g[0] ]
+      end
+
+      # fall back to single image
+      g = url.scan IMAGE_REGEX
+      if g.count == 1
+        return Hash[ [:user,:imageid].zip g[0] ]
+      end
+
+      # if we get here, we didnt have a valid flickr url
+      {}
+    end
+
+    def self.is_set?(url)
+      h = self.parse(url)
+      h.has_key?(:user) && h.has_key?(:setid)
+    end
+
+    def self.is_in_set?(url)
+      h = self.parse(url)
+      h.has_key?(:user) && h.has_key?(:setid) && h.has_key?(:imageid)
+    end
+
+    def self.is_image?(url)
+      h = self.parse(url)
+      h.has_key?(:user) && h.has_key?(:imageid)
+    end
+  end
+end

data/lib/flickrip/version.rb

@@ -1,3 +1,3 @@
 module Flickrip
-  VERSION = '0.0.1'
+  VERSION = '0.2.0'
 end

data/lib/flickrip.rb

@@ -1,3 +1,10 @@
-module Flickrip
+require 'flickrip/version'
+require 'flickrip/sizes'
+require 'flickrip/url_parser'
+
 
+module Flickrip
+  def self.version_string
+    "Flickrip version #{Flickrip::VERSION}"
+  end
 end

data/spec/flickr_image_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+describe Flickrip::FlickrImage do
+  before :each do
+    @no_original_image = "http://www.flickr.com/photos/marshallmickelson/5092430080/sizes/l/in/set-72157630506651062/"
+    @allows_original_image = "http://www.flickr.com/photos/cdevers/5066504321/"
+  end
+
+  it 'Can download an original size image' do
+    i = Flickrip::FlickrImage.new @allows_original_image
+    file = i.original_image
+    file.class.should == Tempfile
+  end
+
+  it 'Cant download an original size image if Flickr doesnt allow it' do
+    i = Flickrip::FlickrImage.new @no_original_image
+    file = i.original_image
+    file.should be_nil
+  end
+
+  it 'Can download the largest size available' do
+    i = Flickrip::FlickrImage.new @no_original_image
+    file = i.largest_image
+    file.class.should == Tempfile
+  end
+
+end

data/spec/flickrip_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe Flickrip do
+  it 'should return correct version string' do
+    Flickrip.version_string.should == "Flickrip version #{Flickrip::VERSION}"
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+require 'rspec'
+require 'flickrip'
+require 'flickrip/url_parser'
+require 'flickrip/flickr_image'
+
+
+RSpec.configure do |config|
+  config.color_enabled = true
+  config.formatter     = 'documentation'
+end

data/spec/url_parser_spec.rb

@@ -0,0 +1,93 @@
+require 'spec_helper'
+
+describe Flickrip::UrlParser do
+  before :each do
+    @isseturl_mobile = "http://m.flickr.com/#/photos/d3sign/7441358166/in/set-72157630283819102/"
+    @setsurl_mobile  = "http://m.flickr.com/#/photos/d3sign/sets/72157630283819102/"
+    @imageurl_mobile = "http://m.flickr.com/#/photos/d3sign/7441358166/"
+    @photourl_mobile = "http://m.flickr.com/#/photos/d3sign/7441358166/sizes/l/in/photostream/"
+
+    @junkfurl_mobile = "http://m.flickr.com/#/junk/nothing/t0/s33/here/"
+
+    #non-mobile
+    @isseturl = "http://www.flickr.com/photos/d3sign/7441358166/in/set-72157630283819102/"
+    @setsurl  = "http://www.flickr.com/photos/d3sign/sets/72157630283819102/"
+    @imageurl = "http://www.flickr.com/photos/d3sign/7441358166/"
+    @photourl = "http://www.flickr.com/photos/d3sign/7441358166/sizes/l/in/photostream/"
+    @junkfurl = "http://www.flickr.com/junk/nothing/t0/s33/here/"
+
+    @junkurl         = "http://www.someothersite.com/test"
+
+    @insethash = {:user=>"d3sign",:imageid=>"7441358166",:setid=>"72157630283819102"}
+    @sethash = {:user=>"d3sign",:setid=>"72157630283819102"}
+    @imagehash = {:user=>"d3sign",:imageid=>"7441358166"}
+  end
+
+  it 'Parser cant parse a nil url' do
+    Flickrip::UrlParser.parse( nil ).should == {}
+  end
+
+  it 'Parser cant parse a malformed url' do
+    Flickrip::UrlParser.parse( "flickr/d3sign/7441358166/" ).should == {}
+  end
+
+
+  it 'Parser finds in-set Url on mobile isseturl' do
+    Flickrip::UrlParser.parse( @isseturl_mobile ).should == @insethash
+  end
+
+  it 'Parser finds sets Url on mobile setsurl' do
+    Flickrip::UrlParser.parse( @setsurl_mobile ).should == @sethash
+  end
+
+  it 'Parser finds image Url on mobile imageurl' do
+    Flickrip::UrlParser.parse( @imageurl_mobile ).should == @imagehash
+  end
+
+    it 'Parser finds image Url on photourl' do
+    Flickrip::UrlParser.parse( @photourl_mobile ).should == @imagehash
+  end
+
+
+  it 'Parser cant parse a junk mobile flickr url' do
+    Flickrip::UrlParser.parse( @junkfurl_mobile ).should == {}
+  end
+
+  it 'Parser finds in-set Url on isseturl' do
+    Flickrip::UrlParser.parse( @isseturl ).should == @insethash
+  end
+
+  it 'Parser finds sets Url on setsurl' do
+    Flickrip::UrlParser.parse( @setsurl ).should == @sethash
+  end
+
+  it 'Parser finds image Url on imageurl' do
+    Flickrip::UrlParser.parse( @imageurl ).should == @imagehash
+  end
+
+  it 'Parser finds image Url on photourl' do
+    Flickrip::UrlParser.parse( @photourl ).should == @imagehash
+  end
+
+
+  it 'Parser cant parse a junk flickr url' do
+    Flickrip::UrlParser.parse( @junkfurl ).should == {}
+  end
+
+
+  it 'Parser cant parse a junk url' do
+    Flickrip::UrlParser.parse( @junkurl ).should == {}
+  end
+
+  it 'Parser can determine setness of a url' do
+    Flickrip::UrlParser.is_set?( @setsurl ).should == true
+  end
+  
+  it 'Parser can determine insetness of a url' do
+    Flickrip::UrlParser.is_in_set?( @isseturl ).should == true
+  end
+
+  it 'Parser can determine imageness of a url' do
+    Flickrip::UrlParser.is_image?( @imageurl ).should == true
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: flickrip
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,8 +9,24 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-09 00:00:00.000000000 Z
-dependencies: []
+date: 2012-07-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.5'
 description: Inspects flickr http/dom, and allows downloading of images and full sets
 email:
 - flickrip@0x07.com
@@ -18,8 +34,15 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- lib/flickrip/flickr_image.rb
+- lib/flickrip/sizes.rb
+- lib/flickrip/url_parser.rb
 - lib/flickrip/version.rb
 - lib/flickrip.rb
+- spec/flickr_image_spec.rb
+- spec/flickrip_spec.rb
+- spec/spec_helper.rb
+- spec/url_parser_spec.rb
 homepage: http://github.com/marshallmick007/flickrip
 licenses: []
 post_install_message: 
@@ -44,4 +67,8 @@ rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Flickr HTTP parser and image extractor
-test_files: []
+test_files:
+- spec/flickr_image_spec.rb
+- spec/flickrip_spec.rb
+- spec/spec_helper.rb
+- spec/url_parser_spec.rb