flickrrb 1.0

data/README.rdoc

@@ -0,0 +1,29 @@
+= Flickrrb
+
+Flickrrb is a library to access flickr[http://flickr.com] api in a simple way.
+It tries to map the methods described in {the official api documentation}[http://www.flickr.com/services/api].
+
+
+= Installation
+ gem install flickrrb
+
+= Usage
+
+  input = IO::popen('pbpaste').read
+
+  # matches the photo id eg 3249240923
+  # or the url eg http://www.flickr.com/photos/jump_leads/3249240923/
+  photo_id = input.match('/?(\d+)/?$')[1]
+
+  flickr = Flickr.new :api_key => "9d96d3ae6145f12660896ae23b33f949"#, :debug => true
+  sizes = flickr.photos.getSizes(:photo_id => photo_id)
+
+  sizes.each do |s|
+    p "#{s.label} - #{s.source}"
+  end
+
+== Todo
+*  Access sizes nicely.
+*  Maybe use JSON instead of xml responses.
+*  Auth.
+*  Handle ids nicer.

data/Rakefile

@@ -0,0 +1,32 @@
+require 'rake/testtask'
+require 'rake/rdoctask'
+#require 'rake/packagetask'
+require 'rake/gempackagetask'
+
+
+Rake::TestTask.new 'test' do |t|
+    t.pattern = 'test/*.rb'
+end
+
+spec = Gem::Specification.new do |s|
+  s.summary = "Another Flickr Interface."
+  s.description = "A simple interface to the Flickr public API."
+  s.name = "flickrrb"
+  s.author = "Henry Maddocks"
+  s.email =  "henry.maddocks@gmail.com"
+  s.homepage = ""
+  s.version = "1.0"
+  s.files = FileList["lib/flickrrb.rb", "copying.txt", "README.rdoc", "Rakefile", "test/*.rb"].to_a
+  s.test_files = FileList["test/*.rb"].to_a
+end
+
+Rake::RDocTask.new do |rd|
+  rd.rdoc_files.include "README.rdoc", "lib/flickrrb.rb"
+  rd.options << "--inline-source"
+end
+
+Rake::GemPackageTask.new spec do |p|
+  p.need_tar_gz = true
+end
+
+task 'default' => ['test']

data/copying.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2009 Henry Maddocks
+
+Permission is hereby granted, free of charge, to any person
+obtaining a copy of this software and associated documentation
+files (the "Software"), to deal in the Software without
+restriction, including without limitation the rights to use,
+copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.

data/lib/flickrrb.rb

@@ -0,0 +1,248 @@
+require 'net/http'
+require 'cgi'
+require 'rexml/document'
+
+class APIException < StandardError; end
+
+class Flickr
+  FlickrMethod = Struct.new(:name, :args)
+  
+  def initialize option = {} #api_key, debug = false
+    @debug = option[:debug].nil? ? false : option[:debug]
+
+    @flickr_client = FlickrClient.new option[:http], @debug
+    @api_key = option[:api_key]
+    @method = []
+  end
+
+  def method_missing name, *args
+#   raise APIException, "Args must be a hash" unless args.first.kind_of?(Hash)
+    m = FlickrMethod.new(name, args.first)
+    @method << m
+    unless args.empty?
+      p @method if @debug == true
+      begin
+        command = build_command
+        @method = []
+        @flickr_client.send(command)
+      rescue
+        @method = []
+        raise
+      end
+    else
+      self
+    end
+  end
+  
+#  private
+  
+  def build_command
+    method = "flickr"
+    args = {}
+    
+    @method.each do |m|
+      method << ".#{m.name.to_s}"
+      args.merge!(m.args) unless m.args.nil?
+    end
+
+    a = args.keys.collect do |k|
+      "#{k.to_s}=#{CGI.escape(args[k])}"
+    end.join('&')
+    
+    "?method=#{method}&api_key=#{@api_key}&#{a}"
+  end
+  
+  def send command
+    @flickr_client.send command
+  end
+  
+  class Group
+    attr :id
+    attr :name
+    attr :description
+    attr :members
+    
+    def initialize xml
+      if xml.elements['name'].nil?
+        init_from_attributes xml
+      else
+        init_from_elements xml
+      end
+    end
+    
+    def init_from_attributes xml
+      @id = xml.attributes['nsid']
+      @name = xml.attributes['name']
+    end
+    
+    def init_from_elements xml
+      @id = xml.attributes['id']
+      @name = xml.elements['name'].text
+      @description = xml.elements['description'].text
+      @members = xml.elements['members'].text
+    end
+  end
+
+  class Photo
+    attr :id
+    attr :owner_real_name
+    attr :owner_user_name
+    attr :owner
+    attr :title
+    attr :candownload
+    attr :description
+    attr :tags
+    attr :date
+    
+    def initialize xml
+      @id = xml.attributes['id']
+      @owner_user_name = xml.attributes['ownername']
+      @owner = xml.attributes['owner']
+      @title = xml.attributes['title']
+       
+       if @title.nil?
+         @owner_real_name = xml.elements['owner'].attributes['realname']
+         @owner_user_name = xml.elements['owner'].attributes['username']
+         @owner = xml.elements['owner'].attributes['nsid']
+         @title = xml.elements['title'].text
+         @description = xml.elements['description'].text
+         @date = xml.elements['dates'].attributes['taken']
+
+         @tags = []
+         xml.elements.each('tags/tag') do |t|
+           @tags << t.text
+         end
+       end
+
+      # <usage candownload='1' canblog='0' canprint='0'/>
+    end
+    
+    def inspect
+      "id; #{@id}\n \
+      title; #{@title}\n \
+      description; #{@description}\n \
+      user name; #{@owner_user_name}\n \
+      real name; #{@owner_real_name}\n \
+      date; #{@date}\n \
+      tags; #{@tags.inspect}"
+    end
+  end
+  
+  class Size
+    attr :label
+    attr :width
+    attr :height
+    attr :source
+    attr :url
+    
+    def initialize xml
+      @label  = xml.attributes['label']
+      @width  = xml.attributes['width']
+      @height = xml.attributes['height']
+      @source = xml.attributes['source']
+      @url    = xml.attributes['url']
+    end
+  end
+  
+  class Person
+    attr :id
+    attr :username
+    attr :realname
+    attr :ispro
+    attr :location
+    attr :photosurl
+    attr :profileurl
+    attr :photos_count
+        
+    def initialize xml
+      @id = xml.attributes['id']
+      @ispro = xml.attributes['ispro']
+      @username = xml.elements['username'].text
+      unless xml.elements['realname'].nil?
+        @realname = xml.elements['realname'].text
+        @location = xml.elements['location'].text
+        @photosurl = xml.elements['photosurl'].text
+        @profileurl = xml.elements['profileurl'].text
+        @photos_count = xml.elements['photos'].elements['count'].text
+      end
+    end
+  end
+  
+  class FlickrClient
+    def initialize http = nil, debug = false
+      flickr_url = URI.parse "http://api.flickr.com/"
+      
+      if http.nil?
+        @flickr_client = Net::HTTP.new flickr_url.host, flickr_url.port
+      else
+        @flickr_client = http
+      end
+      @debug = debug
+    end
+    
+    def send command
+      p "/services/rest/#{command}" if @debug
+      build_response(@flickr_client.get("/services/rest/#{command}").body)
+    end
+    
+    def build_response xml
+      p xml if @debug
+      doc = REXML::Document.new(xml, { 'ForceArray' => false })
+      raise APIException, "Invalid response from Flickr" if doc.root.nil?
+      resp = []
+      if doc.root.attributes["stat"] == "ok"
+        doc.root.elements.each {|e| resp << self.__send__(e.name.to_sym, e)}
+      else
+        handle_error doc
+      end
+
+      resp.first
+    end
+    
+    def handle_error xml
+      # This is a bit ugly!
+      message = xml.elements['rsp'].elements['err'].attributes['msg']
+      raise APIException, message
+    end
+    
+    def groups xml
+      xml.elements.collect do |g|
+        group g
+      end
+    end
+
+    def group xml
+      Group.new xml
+    end
+    
+    def photos xml
+      pages = xml.attributes['pages']
+      total = xml.attributes['total']
+      photos = xml.elements.collect do |p|
+        Photo.new p
+      end
+      
+      return photos, pages.to_i, total.to_i
+    end
+
+    def photo xml
+      Photo.new xml
+    end
+    
+    def sizes xml
+      xml.elements.collect do |p|
+        Size.new p
+      end
+    end
+
+    def user xml
+      Person.new xml
+    end
+    
+    def person xml
+      Person.new xml
+    end
+  end
+  
+end
+

data/test/flickrrb_test.rb

@@ -0,0 +1,225 @@
+require 'test/unit'
+require 'flickrrb'
+
+class Test_Flickr < Test::Unit::TestCase
+  def setup
+    api_key = "ef7e560f32e57e0f5328db98a93b5ac9"
+    @flickr = Flickr.new :api_key => api_key
+  end
+  
+  def test_api_key_exception
+    flickr = Flickr.new :api_key => "bad_key"
+    assert_raise APIException do
+        flickr.photos.getInfo(:photo_id => '1848466274')
+    end
+  end
+
+  def test_groups_pools_getPhotos
+    groups_photos, pages, total = @flickr.groups.pools.getPhotos :user_id => "12656878@N06", :group_id => "99404851@N00"
+
+    assert_equal 12, groups_photos.length
+    assert_equal 1, pages
+    assert_equal 12, total
+
+    
+    groups_photos.each do |photo|
+      assert_equal 'Henry Maddocks', photo.owner_user_name
+    end
+  end
+  
+  def test_create_objects
+    xml = <<EOS
+    <?xml version="1.0" encoding="utf-8" ?> \
+            <rsp stat="ok"> \
+              <photos page="1" pages="1" perpage="100" total="4"> \
+                <photo id="1848466274" owner="12656878@N06" secret="cec90f64ba" server="2402" farm="3" title="IMG_5631_2_3" ispublic="1" isfriend="0" isfamily="0" ownername="henry.maddocks" dateadded="1194217745" /> \
+                <photo id="1847626991" owner="12656878@N06" secret="a4d0774b17" server="2022" farm="3" title="IMG_5574_5_6" ispublic="1" isfriend="0" isfamily="0" ownername="henry.maddocks" dateadded="1194128771" /> \
+                <photo id="1847633163" owner="12656878@N06" secret="5089075c7a" server="2008" farm="3" title="IMG_5598_599_600" ispublic="1" isfriend="0" isfamily="0" ownername="henry.maddocks" dateadded="1194128720" /> \
+                <photo id="1848469604" owner="12656878@N06" secret="e0f8cfeab2" server="2140" farm="3" title="IMG_5646_7_8" ispublic="1" isfriend="0" isfamily="0" ownername="henry.maddocks" dateadded="1194128674" /> \
+              </photos> \
+            </rsp>
+EOS
+    
+    flickr = Flickr::FlickrClient.new
+    
+    photos, pages, total = flickr.build_response xml
+
+    assert_equal 4, photos.length
+    assert_equal 1, pages
+    assert_equal 4, total
+    assert_equal "IMG_5598_599_600", photos[2].title
+  end
+  
+  def test_photos_getInfo
+    photo = @flickr.photos.getInfo(:photo_id => '1848466274')
+    
+    assert_equal "1848466274", photo.id
+    assert_equal "IMG_5631_2_3", photo.title
+    
+  end
+      
+  def test_get_sizes
+    sizes = @flickr.photos.getSizes(:photo_id => '1848466274')
+
+    assert_equal 5, sizes.length
+    assert_equal 1280, sizes[4].width.to_i
+    assert_equal 'Original', sizes[4].label    
+  end
+  
+  def test_get_people_by_user_name
+    me = @flickr.people.findByUsername(:username => 'Henry Maddocks')
+    assert_equal '12656878@N06', me.id
+    
+    b = @flickr.people.findByUsername(:username => 'Brenda Anderson')
+    assert_equal '69005233@N00', b.id
+  end
+  
+  def test_all_together
+    groups_photos, pages, total = @flickr.groups.pools.getPhotos :user_id => "12656878@N06", :group_id => "99404851@N00"
+    
+    groups_photos.each do |photo|
+      @flickr.photos.getSizes(:photo_id => photo.id)
+    end
+    
+    assert true
+  end
+  
+  def test_photo_xml
+    data = <<EOS
+    <photo id="2733" secret="123456" server="12" isfavorite="0" license="3" rotation="90" originalsecret="1bc09ce34a" originalformat="png">
+    	<owner nsid="12037949754@N01" username="Bees" realname="Cal Henderson" location="Bedford, UK" />
+    	<title>orford_castle_taster</title>
+    	<description>hello!</description>
+    	<visibility ispublic="1" isfriend="0" isfamily="0" />
+    	<dates posted="1100897479" taken="2004-11-19 12:51:19" takengranularity="0" lastupdate="1093022469" />
+    	<permissions permcomment="3" permaddmeta="2" />
+    	<editability cancomment="1" canaddmeta="1" />
+    	<comments>1</comments>
+    	<notes>
+    		<note id="313" author="12037949754@N01" authorname="Bees" x="10" y="10" w="50" h="50">foo</note>
+    	</notes>
+    	<tags>
+    		<tag id="1234" author="12037949754@N01" raw="woo yay">wooyay</tag>
+    		<tag id="1235" author="12037949754@N01" raw="hoopla">hoopla</tag>
+    	</tags>
+    	<urls>
+    		<url type="photopage">http://www.flickr.com/photos/bees/2733/</url> 
+    	</urls>
+    </photo>
+EOS
+    
+    xml = REXML::Document.new data
+    photo = Flickr::Photo.new xml.root
+    
+    assert_equal 'orford_castle_taster', photo.title
+    assert_equal 'hello!', photo.description
+    assert_equal ['wooyay', 'hoopla'], photo.tags
+    assert_equal 'Cal Henderson', photo.owner_real_name
+    assert_equal 'Bees', photo.owner_user_name
+    assert_equal '12037949754@N01', photo.owner
+    assert_equal '2733', photo.id
+        
+  end
+  
+  def test_people_getInfo
+    data = <<EOS
+     <person nsid='12656878@N06' iconfarm='2' id='12656878@N06' ispro='0' isadmin='0' iconserver='1011'>
+        <username>henry.maddocks</username>
+        <realname>Henry Maddocks</realname>
+        <mbox_sha1sum>4e20b6c8b0fade15dcb37181c65de45b6205cecc</mbox_sha1sum>
+        <location>Wellington, New Zealand</location>
+        <photosurl>http://www.flickr.com/photos/12656878@N06/</photosurl>
+        <profileurl>http://www.flickr.com/people/12656878@N06/</profileurl>
+        <mobileurl>http://m.flickr.com/photostream.gne?id=12611556</mobileurl>
+        <photos>
+            <firstdatetaken>2005-09-24 16:20:11</firstdatetaken>
+            <firstdate>1188878270</firstdate>
+            <count>57</count>
+        </photos>
+    </person>    
+EOS
+    
+    xml = REXML::Document.new data
+    me = Flickr::Person.new xml.root
+    
+    assert_equal '12656878@N06', me.id
+    assert_equal 'henry.maddocks', me.username
+    assert_equal 'Henry Maddocks', me.realname
+    assert_equal 'Wellington, New Zealand', me.location
+    
+  end
+  
+  # def test_simple_search
+  #     assert_nothing_raised {@digitalNZ.search "Karori photograph"}
+  # end
+  # 
+  
+  
+  def test_exception
+    assert_raise APIException do
+      me = @flickr.people.getInfo(:xxxx => '12656878@N06')
+    end
+    
+    assert_raise APIException do
+      me = @flickr.people.getInfo('12656878@N06')
+    end
+    
+    assert_nothing_raised {@flickr.people.getInfo :user_id => '12656878@N06'}
+  end
+
+  def test_group_getInfo
+    data = <<EOS    
+    <group id="34427465497@N01" iconserver="1" lang="en-us" ispoolmoderated="0">
+    	<name>GNEverybody</name>
+    	<description>The group for GNE players</description>
+    	<members>69</members>
+    	<privacy>3</privacy>
+    	<throttle count="10" mode="month" remaining="3"/>
+    </group>
+EOS
+    
+    xml = REXML::Document.new data
+    group = Flickr::Group.new xml.root
+
+    assert_equal "34427465497@N01", group.id
+    assert_equal "GNEverybody", group.name
+    assert_equal "The group for GNE players", group.description
+    assert_equal "69", group.members
+
+  end
+  
+  def test_invalid_response
+    xml =""
+    flickr = Flickr::FlickrClient.new
+    
+    assert_raise APIException do
+      flickr.build_response xml
+    end
+  end
+  
+  def test_groups
+    xml = <<EOS
+    <?xml version="1.0" encoding="utf-8" ?>
+    <rsp stat="ok">
+      <groups>
+        <group nsid="34427469792@N01" name="FlickrCentral" admin="0" eighteenplus="0" />
+        <group nsid="37996584485@N01" name="Motorcycles" admin="0" eighteenplus="0" />
+        <group nsid="41894169203@N01" name="Wellington, New Zealand" admin="0" eighteenplus="0" />
+        <group nsid="51035612836@N01" name="Flickr API" admin="0" eighteenplus="0" />
+        <group nsid="52240148330@N01" name="BEER" admin="0" eighteenplus="0" />
+        <group nsid="52241691728@N01" name="Glitch Art" admin="0" eighteenplus="0" />
+        <group nsid="55475894@N00" name="* Vanishing Points *" admin="0" eighteenplus="0" />
+      </groups>
+    </rsp>
+EOS
+
+    flickr = Flickr::FlickrClient.new
+
+    groups = flickr.build_response xml
+    assert_equal 7, groups.length
+    assert_equal 'Wellington, New Zealand', groups[2].name
+    assert_equal '41894169203@N01', groups[2].id
+
+  end
+  
+end

data/test/photo_gne_test.rb

@@ -0,0 +1,25 @@
+# photo_gne_test.rb
+
+$:.push("/Users/henry/bin")
+
+require 'test/unit'
+require 'photo_gne.rb'
+
+class Test_Flickr < Test::Unit::TestCase
+  def test_url
+    assert_equal 4254104021, parse_id("http://farm5.static.flickr.com/4024/4254104021_4a69ed0cc0_b.jpg")
+    assert_equal 4254104021, parse_id("http://farm5.static.flickr.com/4024/4254104021_4a69ed0cc0.jpg")
+  end
+  
+  def test_integer
+    assert_equal 4254104021, parse_id("4254104021")
+  end
+  
+  def test_partial
+    assert_equal 4254104021, parse_id("4254104021_4a69ed0cc0.jpg")
+    assert_equal 4254104021, parse_id("4254104021_4a69ed0cc0_b.jpg")
+    assert_equal 4254104021, parse_id("4254104021_4a69ed0cc0_b")
+    assert_equal 4254104021, parse_id("4254104021_4a69ed0cc0")
+  end
+  
+end

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification 
+name: flickrrb
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  version: "1.0"
+platform: ruby
+authors: 
+- Henry Maddocks
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-04-26 00:00:00 +12:00
+default_executable: 
+dependencies: []
+
+description: A simple interface to the Flickr public API.
+email: henry.maddocks@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/flickrrb.rb
+- copying.txt
+- README.rdoc
+- Rakefile
+- test/flickrrb_test.rb
+- test/photo_gne_test.rb
+has_rdoc: true
+homepage: ""
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Another Flickr Interface.
+test_files: 
+- test/flickrrb_test.rb
+- test/photo_gne_test.rb