twitphoto 0.1.1 → 0.9.0

data/Gemfile

@@ -6,6 +6,8 @@ source "http://rubygems.org"
 # Add dependencies to develop your gem here.
 # Include everything needed to run rake, tests, features, etc.
 group :development do
+  gem "yajl-ruby"
+  gem "twitter"
   gem "shoulda", ">= 0"
   gem "bundler", "~> 1.0.0"
   gem "jeweler", "~> 1.6.2"

data/Gemfile.lock

@@ -1,14 +1,35 @@
 GEM
   remote: http://rubygems.org/
   specs:
+    addressable (2.2.4)
+    faraday (0.5.7)
+      addressable (~> 2.2.4)
+      multipart-post (~> 1.1.0)
+      rack (< 2, >= 1.1.0)
+    faraday_middleware (0.3.2)
+      faraday (~> 0.5.4)
     git (1.2.5)
+    hashie (1.0.0)
     jeweler (1.6.2)
       bundler (~> 1.0)
       git (>= 1.2.5)
       rake
+    multi_json (0.0.5)
+    multi_xml (0.2.1)
+    multipart-post (1.1.0)
+    rack (1.3.0)
     rake (0.9.2)
     rcov (0.9.9)
     shoulda (2.11.3)
+    simple_oauth (0.1.4)
+    twitter (1.1.2)
+      faraday (~> 0.5.4)
+      faraday_middleware (~> 0.3.1)
+      hashie (~> 1.0.0)
+      multi_json (~> 0.0.5)
+      multi_xml (~> 0.2.0)
+      simple_oauth (~> 0.1.3)
+    yajl-ruby (0.8.2)
 
 PLATFORMS
   ruby
@@ -18,3 +39,5 @@ DEPENDENCIES
   jeweler (~> 1.6.2)
   rcov
   shoulda
+  twitter
+  yajl-ruby

data/Rakefile

@@ -16,8 +16,8 @@ Jeweler::Tasks.new do |gem|
   gem.name = "twitphoto"
   gem.homepage = "http://github.com/scosman/twitphoto"
   gem.license = "MIT"
-  gem.summary = "a gem to generate an image URL from shortened URLs from common photo sharing tools. Supports twitpic, yfrog, instagram, flickr and plixi/lockerz"
-  gem.description = "a gem to generate an image URL from shortened URLs from common photo sharing tools. Supports twitpic, yfrog, instagram, flickr and plixi/lockerz"
+  gem.summary = "a gem to generate an image URL from shortened URLs from common photo sharing tools. Supports twitter/photobucket, twitpic, yfrog, instagram and twitphoto/plixi/lockerz"
+  gem.description = "a gem to generate an image URL from shortened URLs from common photo sharing tools. Supports twitter/photobucket, twitpic, yfrog, instagram and tweetphoto/plixi/lockerz. It also includes support for the twitter gem, which helps with expanding t.co and bit.ly shortened URLs. Flickr is not supported as it would require a service call."
   gem.email = "delrox@live.com"
   gem.authors = ["Steve Cosman"]
   # dependencies defined in Gemfile

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.9.0

data/lib/adaptors.rb

@@ -1,5 +1,6 @@
 require 'uri'
 
+module TwitPhoto
 class Adaptors
   class InstagramAdaptor
     def self.getImageUrl url
@@ -56,3 +57,4 @@ class Adaptors
   end
 
 end
+end

data/lib/twitphoto.rb

@@ -1,8 +1,23 @@
 require 'adaptors'
 
+module TwitPhoto
 class TwitPhoto
 
   public
+
+  # gets all of the photo URLs from a blog of text
+  #
+  # == Parameters:
+  # text::
+  #   the text you want to extract media from
+  #
+  # == Returns:
+  # return::
+  #   an array of URLs as strings (not URI objects)
+  #
+  # == Example:
+  # Get photo URLs from a block of text
+  #   TwitPhoto::TwitPhoto.getPhotoUrlsFromText "Hello http://yfrog.com/kfx6gdj http://yfrog.com/klmjxyej"
   def self.getPhotoUrlsFromText(text)
     urlStrings = URI.extract text
     results = []
@@ -17,6 +32,18 @@ class TwitPhoto
     return results
   end
 
+  # extracts the media url from a shortened url (if possible)
+  #
+  # == Parameters:
+  # url::
+  #   The URL as a string (not URI)
+  #
+  # == Returns:
+  # return::
+  #   A media URL as a string, or nil
+  # 
+  # == Example:
+  #    TwitPhoto::TwitPhoto.getPhotoUrlFromUrl "http://yfrog.com/kfx6gdj"
   def self.getPhotoUrlFromUrl url
     adaptors = [Adaptors::YFrogAdaptor, Adaptors::TwitPicAdaptor, Adaptors::LockerzAdaptor, Adaptors::InstagramAdaptor]
 
@@ -30,4 +57,59 @@ class TwitPhoto
     return nil
   end
 
+  # returns all of the photo URLs from a tweet object from the "twitter" gem (http://twitter.rubyforge.org/)
+  #
+  # IMPORTANT: this expects detailed entities from the twitter API, so request with :include_entities => 't'
+  # 
+  # IMPORTANT: this will yield better results than the other methods, since Twitter now has native media support
+  #
+  # == Paramaters
+  # tweet::
+  #   the tweet object from the twitter gem
+  #
+  # == Returns:
+  # returns::
+  #   the array of media URLs in this tweet
+  def self.getPhotoUrlsFromTweet tweet
+    results = []
+
+    if !tweet.retweeted_status.nil?
+      tweet = tweet.retweeted_status
+    end
+
+    # ensure the user included entites
+    if !defined? tweet.entites || tweet.entities.nil? 
+      raise ArgumentError, 'not a valid tweet object, make sure you :include_entities => \'t\' in the request'
+    end
+
+    # process URLs from third party photos
+    urls = tweet.entities.urls || []
+    urls.each do |url|
+      # sometimes its in expanded, sometimes URL
+      actualUrl = url.expanded_url
+      if actualUrl.nil?
+        actualUrl = url.url
+      end
+      if !actualUrl.nil?
+        photoUrl = TwitPhoto.getPhotoUrlFromUrl actualUrl
+        if !photoUrl.nil?
+          results << photoUrl
+        end
+      end
+    end
+
+    # find any media from twitter itself (photobucket)
+    medias = tweet.entities.media || []
+    medias.each do |media|
+      #only photos
+      if 'photo'.eql? media[:type]
+        results << media.media_url
+      end
+    end
+
+    return results
+  end
+
+
+end
 end

data/test/test_twitphoto.rb

@@ -2,51 +2,78 @@ require 'helper'
 require 'test/unit'
 require 'twitphoto'
 require 'adaptors'
+require 'twitter'
 
 class TestTwitphoto < Test::Unit::TestCase
 
+  should "test usage with Twitter gem" do
+
+    tweetWithTwitterMedia = Twitter.status(82472660038197249, :include_entities => 't')
+    results = TwitPhoto::TwitPhoto.getPhotoUrlsFromTweet(tweetWithTwitterMedia)
+    assert_equal 1, results.length
+    assert_equal "http://p.twimg.com/ASUAcoWCIAIsmIA.png", results[0]
+
+    RTtweetWithTwitterMedia = Twitter.status(82486891202621440, :include_entities => 't')
+    results = TwitPhoto::TwitPhoto.getPhotoUrlsFromTweet(RTtweetWithTwitterMedia)
+    assert_equal 1, results.length
+    assert_equal "http://p.twimg.com/ASUAcoWCIAIsmIA.png", results[0]
+
+    tweetWithThirdPartyMedia = Twitter.status(82480106379026433, :include_entities => 't')
+    results = TwitPhoto::TwitPhoto.getPhotoUrlsFromTweet tweetWithThirdPartyMedia
+    assert_equal 1, results.length
+    assert_equal "http://yfrog.com/kea33tj:medium", results[0]
+
+    tweetWithThirdPartyMediaMulti = Twitter.status(82513016645623808, :include_entities => 't')
+    results = TwitPhoto::TwitPhoto.getPhotoUrlsFromTweet tweetWithThirdPartyMediaMulti
+    assert_equal 3, results.length
+
+    tweetWithNoMedia = Twitter.status(82153561638699008, :include_entities => 't')
+    results = TwitPhoto::TwitPhoto.getPhotoUrlsFromTweet tweetWithNoMedia
+    assert_equal 0, results.length
+  end
+
   should "test getPhotoFromUrl" do
-    assert_equal TwitPhoto.getPhotoUrlFromUrl("http://tweetphoto.com/28103398"), "http://api.plixi.com/api/tpapi.svc/imagefromurl?size=medium&url=http://tweetphoto.com/28103398"
-    assert_equal TwitPhoto.getPhotoUrlFromUrl("http://lockerz.com/s/110826629"), "http://api.plixi.com/api/tpapi.svc/imagefromurl?size=medium&url=http://lockerz.com/s/110826629"
-    assert_equal TwitPhoto.getPhotoUrlFromUrl("http://plixi.com/p/89511189"), "http://api.plixi.com/api/tpapi.svc/imagefromurl?size=medium&url=http://plixi.com/p/89511189"
-    assert_equal TwitPhoto.getPhotoUrlFromUrl("http://yfrog.com/gzozrllj"), "http://yfrog.com/gzozrllj:medium"
-    assert_equal TwitPhoto.getPhotoUrlFromUrl("http://instagr.am/p/Fv3t0"), "http://instagr.am/p/Fv3t0/media/?size=m"
-    assert_equal TwitPhoto.getPhotoUrlFromUrl("http://twitpic.com/5bpgp0"), "http://twitpic.com/show/thumb/5bpgp0"
-    assert TwitPhoto.getPhotoUrlFromUrl("http://google.ca").nil?
+    assert_equal TwitPhoto::TwitPhoto.getPhotoUrlFromUrl("http://tweetphoto.com/28103398"), "http://api.plixi.com/api/tpapi.svc/imagefromurl?size=medium&url=http://tweetphoto.com/28103398"
+    assert_equal TwitPhoto::TwitPhoto.getPhotoUrlFromUrl("http://lockerz.com/s/110826629"), "http://api.plixi.com/api/tpapi.svc/imagefromurl?size=medium&url=http://lockerz.com/s/110826629"
+    assert_equal TwitPhoto::TwitPhoto.getPhotoUrlFromUrl("http://plixi.com/p/89511189"), "http://api.plixi.com/api/tpapi.svc/imagefromurl?size=medium&url=http://plixi.com/p/89511189"
+    assert_equal TwitPhoto::TwitPhoto.getPhotoUrlFromUrl("http://yfrog.com/gzozrllj"), "http://yfrog.com/gzozrllj:medium"
+    assert_equal TwitPhoto::TwitPhoto.getPhotoUrlFromUrl("http://instagr.am/p/Fv3t0"), "http://instagr.am/p/Fv3t0/media/?size=m"
+    assert_equal TwitPhoto::TwitPhoto.getPhotoUrlFromUrl("http://twitpic.com/5bpgp0"), "http://twitpic.com/show/thumb/5bpgp0"
+    assert TwitPhoto::TwitPhoto.getPhotoUrlFromUrl("http://google.ca").nil?
   end
 
   should "test getPhotoUrlsFromText" do
-    assert_equal TwitPhoto.getPhotoUrlsFromText("http:www.google.com").length, 0
-    assert_equal TwitPhoto.getPhotoUrlsFromText("http:www.google.com http://tweetphoto.com/28103398").length, 1
-    assert_equal TwitPhoto.getPhotoUrlsFromText("http:www.google.com http://tweetphoto.com/28103398 http://instagr.am/p/Fv3t0").length, 2
-    assert_equal TwitPhoto.getPhotoUrlsFromText("http://lockerz.com/s/110826629").length, 1
-    assert_equal TwitPhoto.getPhotoUrlsFromText("Content http://twitpic.com/5bpgp0 content").length, 1
-    assert_equal TwitPhoto.getPhotoUrlsFromText("Content http://yfrog.com/gzozrllj http://plixi.com/p/89511189 content").length, 2
+    assert_equal TwitPhoto::TwitPhoto.getPhotoUrlsFromText("http:www.google.com").length, 0
+    assert_equal TwitPhoto::TwitPhoto.getPhotoUrlsFromText("http:www.google.com http://tweetphoto.com/28103398").length, 1
+    assert_equal TwitPhoto::TwitPhoto.getPhotoUrlsFromText("http:www.google.com http://tweetphoto.com/28103398 http://instagr.am/p/Fv3t0").length, 2
+    assert_equal TwitPhoto::TwitPhoto.getPhotoUrlsFromText("http://lockerz.com/s/110826629").length, 1
+    assert_equal TwitPhoto::TwitPhoto.getPhotoUrlsFromText("Content http://twitpic.com/5bpgp0 content").length, 1
+    assert_equal TwitPhoto::TwitPhoto.getPhotoUrlsFromText("Content http://yfrog.com/gzozrllj http://plixi.com/p/89511189 content").length, 2
   end
 
   should "test TweetPhot/Lockerz/Plixi" do
-    assert_equal Adaptors::LockerzAdaptor.getImageUrl("http://tweetphoto.com/28103398"), "http://api.plixi.com/api/tpapi.svc/imagefromurl?size=medium&url=http://tweetphoto.com/28103398"
-    assert_equal Adaptors::LockerzAdaptor.getImageUrl("http://lockerz.com/s/110826629"), "http://api.plixi.com/api/tpapi.svc/imagefromurl?size=medium&url=http://lockerz.com/s/110826629"
-    assert_equal Adaptors::LockerzAdaptor.getImageUrl("http://plixi.com/p/89511189"), "http://api.plixi.com/api/tpapi.svc/imagefromurl?size=medium&url=http://plixi.com/p/89511189" 
-    assert Adaptors::YFrogAdaptor.getImageUrl("http://notyfrog.com/gzozrllj").nil?
+    assert_equal TwitPhoto::Adaptors::LockerzAdaptor.getImageUrl("http://tweetphoto.com/28103398"), "http://api.plixi.com/api/tpapi.svc/imagefromurl?size=medium&url=http://tweetphoto.com/28103398"
+    assert_equal TwitPhoto::Adaptors::LockerzAdaptor.getImageUrl("http://lockerz.com/s/110826629"), "http://api.plixi.com/api/tpapi.svc/imagefromurl?size=medium&url=http://lockerz.com/s/110826629"
+    assert_equal TwitPhoto::Adaptors::LockerzAdaptor.getImageUrl("http://plixi.com/p/89511189"), "http://api.plixi.com/api/tpapi.svc/imagefromurl?size=medium&url=http://plixi.com/p/89511189" 
+    assert TwitPhoto::Adaptors::YFrogAdaptor.getImageUrl("http://notyfrog.com/gzozrllj").nil?
   end
   
   should "test Yfrog" do
-    assert_equal Adaptors::YFrogAdaptor.getImageUrl("http://yfrog.com/gzozrllj"), "http://yfrog.com/gzozrllj:medium" 
-    assert Adaptors::YFrogAdaptor.getImageUrl("http://notyfrog.com/gzozrllj").nil?
-    assert_equal Adaptors::YFrogAdaptor.getImageUrl("http://yfrog.com/gz23uqdj"), "http://yfrog.com/gz23uqdj:medium"
+    assert_equal TwitPhoto::Adaptors::YFrogAdaptor.getImageUrl("http://yfrog.com/gzozrllj"), "http://yfrog.com/gzozrllj:medium" 
+    assert TwitPhoto::Adaptors::YFrogAdaptor.getImageUrl("http://notyfrog.com/gzozrllj").nil?
+    assert_equal TwitPhoto::Adaptors::YFrogAdaptor.getImageUrl("http://yfrog.com/gz23uqdj"), "http://yfrog.com/gz23uqdj:medium"
   end
 
   should "test Instagram" do
-    assert_equal Adaptors::InstagramAdaptor.getImageUrl("http://instagr.am/p/Fv3t0"), "http://instagr.am/p/Fv3t0/media/?size=m"
-    assert Adaptors::InstagramAdaptor.getImageUrl("http://instagr.aam/p/Fv3t0").nil?
-    assert_equal Adaptors::InstagramAdaptor.getImageUrl("http://instagr.am/p/Fv3t0/"), "http://instagr.am/p/Fv3t0/media/?size=m"
+    assert_equal TwitPhoto::Adaptors::InstagramAdaptor.getImageUrl("http://instagr.am/p/Fv3t0"), "http://instagr.am/p/Fv3t0/media/?size=m"
+    assert TwitPhoto::Adaptors::InstagramAdaptor.getImageUrl("http://instagr.aam/p/Fv3t0").nil?
+    assert_equal TwitPhoto::Adaptors::InstagramAdaptor.getImageUrl("http://instagr.am/p/Fv3t0/"), "http://instagr.am/p/Fv3t0/media/?size=m"
   end
 
   should "test TwitPic" do
-    assert_equal Adaptors::TwitPicAdaptor.getImageUrl("http://twitpic.com/5bpgp0"), "http://twitpic.com/show/thumb/5bpgp0"
-    assert Adaptors::TwitPicAdaptor.getImageUrl("http://nottwitpic.com/5bpgp0").nil?
-    assert_equal Adaptors::TwitPicAdaptor.getImageUrl("http://twitpic.com/5b3rhe"), "http://twitpic.com/show/thumb/5b3rhe"
+    assert_equal TwitPhoto::Adaptors::TwitPicAdaptor.getImageUrl("http://twitpic.com/5bpgp0"), "http://twitpic.com/show/thumb/5bpgp0"
+    assert TwitPhoto::Adaptors::TwitPicAdaptor.getImageUrl("http://nottwitpic.com/5bpgp0").nil?
+    assert_equal TwitPhoto::Adaptors::TwitPicAdaptor.getImageUrl("http://twitpic.com/5b3rhe"), "http://twitpic.com/show/thumb/5b3rhe"
   end
 
 end

data/twitphoto.gemspec

@@ -5,12 +5,12 @@
 
 Gem::Specification.new do |s|
   s.name = %q{twitphoto}
-  s.version = "0.1.1"
+  s.version = "0.9.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = [%q{Steve Cosman}]
-  s.date = %q{2011-06-17}
-  s.description = %q{a gem to generate an image URL from shortened URLs from common photo sharing tools. Supports twitpic, yfrog, instagram, flickr and plixi/lockerz}
+  s.date = %q{2011-06-19}
+  s.description = %q{a gem to generate an image URL from shortened URLs from common photo sharing tools. Supports twitter/photobucket, twitpic, yfrog, instagram and tweetphoto/plixi/lockerz. It also includes support for the twitter gem, which helps with expanding t.co and bit.ly shortened URLs. Flickr is not supported as it would require a service call.}
   s.email = %q{delrox@live.com}
   s.extra_rdoc_files = [
     "LICENSE.txt",
@@ -34,23 +34,29 @@ Gem::Specification.new do |s|
   s.licenses = [%q{MIT}]
   s.require_paths = [%q{lib}]
   s.rubygems_version = %q{1.8.2}
-  s.summary = %q{a gem to generate an image URL from shortened URLs from common photo sharing tools. Supports twitpic, yfrog, instagram, flickr and plixi/lockerz}
+  s.summary = %q{a gem to generate an image URL from shortened URLs from common photo sharing tools. Supports twitter/photobucket, twitpic, yfrog, instagram and twitphoto/plixi/lockerz}
 
   if s.respond_to? :specification_version then
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<yajl-ruby>, [">= 0"])
+      s.add_development_dependency(%q<twitter>, [">= 0"])
       s.add_development_dependency(%q<shoulda>, [">= 0"])
       s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
       s.add_development_dependency(%q<jeweler>, ["~> 1.6.2"])
       s.add_development_dependency(%q<rcov>, [">= 0"])
     else
+      s.add_dependency(%q<yajl-ruby>, [">= 0"])
+      s.add_dependency(%q<twitter>, [">= 0"])
       s.add_dependency(%q<shoulda>, [">= 0"])
       s.add_dependency(%q<bundler>, ["~> 1.0.0"])
       s.add_dependency(%q<jeweler>, ["~> 1.6.2"])
       s.add_dependency(%q<rcov>, [">= 0"])
     end
   else
+    s.add_dependency(%q<yajl-ruby>, [">= 0"])
+    s.add_dependency(%q<twitter>, [">= 0"])
     s.add_dependency(%q<shoulda>, [">= 0"])
     s.add_dependency(%q<bundler>, ["~> 1.0.0"])
     s.add_dependency(%q<jeweler>, ["~> 1.6.2"])

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: twitphoto
 version: !ruby/object:Gem::Version 
-  hash: 25
+  hash: 59
   prerelease: 
   segments: 
   - 0
-  - 1
-  - 1
-  version: 0.1.1
+  - 9
+  - 0
+  version: 0.9.0
 platform: ruby
 authors: 
 - Steve Cosman
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-06-17 00:00:00 Z
+date: 2011-06-19 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   version_requirements: &id001 !ruby/object:Gem::Requirement 
@@ -30,9 +30,37 @@ dependencies:
   type: :development
   requirement: *id001
   prerelease: false
-  name: shoulda
+  name: yajl-ruby
 - !ruby/object:Gem::Dependency 
   version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  requirement: *id002
+  prerelease: false
+  name: twitter
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  requirement: *id003
+  prerelease: false
+  name: shoulda
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -44,11 +72,11 @@ dependencies:
         - 0
         version: 1.0.0
   type: :development
-  requirement: *id002
+  requirement: *id004
   prerelease: false
   name: bundler
 - !ruby/object:Gem::Dependency 
-  version_requirements: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -60,11 +88,11 @@ dependencies:
         - 2
         version: 1.6.2
   type: :development
-  requirement: *id003
+  requirement: *id005
   prerelease: false
   name: jeweler
 - !ruby/object:Gem::Dependency 
-  version_requirements: &id004 !ruby/object:Gem::Requirement 
+  version_requirements: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -74,10 +102,10 @@ dependencies:
         - 0
         version: "0"
   type: :development
-  requirement: *id004
+  requirement: *id006
   prerelease: false
   name: rcov
-description: a gem to generate an image URL from shortened URLs from common photo sharing tools. Supports twitpic, yfrog, instagram, flickr and plixi/lockerz
+description: a gem to generate an image URL from shortened URLs from common photo sharing tools. Supports twitter/photobucket, twitpic, yfrog, instagram and tweetphoto/plixi/lockerz. It also includes support for the twitter gem, which helps with expanding t.co and bit.ly shortened URLs. Flickr is not supported as it would require a service call.
 email: delrox@live.com
 executables: []
 
@@ -131,6 +159,6 @@ rubyforge_project:
 rubygems_version: 1.8.2
 signing_key: 
 specification_version: 3
-summary: a gem to generate an image URL from shortened URLs from common photo sharing tools. Supports twitpic, yfrog, instagram, flickr and plixi/lockerz
+summary: a gem to generate an image URL from shortened URLs from common photo sharing tools. Supports twitter/photobucket, twitpic, yfrog, instagram and twitphoto/plixi/lockerz
 test_files: []