flickraw 0.3.2 → 0.4

data/examples/flickr_KDE.rb

@@ -8,8 +8,8 @@ require 'open-uri'
 DESKTOP=1
 
 list = flickr.interestingness.getList
-photo = list[rand( 100)]
-sizes = flickr.photos.getSizes( :photo_id => photo.id)
+photo = list[rand(100)]
+sizes = flickr.photos.getSizes(:photo_id => photo.id)
 original = sizes.find {|s| s.label == 'Original' }
 
 url = original.source

data/flickraw_rdoc.rb

@@ -1,6 +1,5 @@
 require "rdoc/parsers/parserfactory"
 require "rdoc/parsers/parse_rb"
-require "cgi"
 
 FLICKR_API_URL='http://www.flickr.com/services/api'
 
@@ -56,14 +55,12 @@ module RDoc
         m.singleton = false
 
         m.start_collecting_tokens
-        m.add_token FakedToken.new( <<END
-# Generated automatically from the flickr api
+        m.add_token FakedToken.new( %{
+# Generated automatically from flickr api
   def #{name}(*args)
-    Request.call '#{flickr_method}', *args
+    @flickr.call '#{flickr_method}', *args
   end
-END
-)
-
+} )
         doc.add_method m
         progress(".")
         @stats.num_methods += 1
@@ -86,7 +83,7 @@ END
             arguments << "[#{arg.name} "
             arguments << "<em>(required)</em> " if arg.optional == '0'
             arguments << "] "
-            arguments << "#{CGI.unescapeHTML(arg.to_s)}\n"
+            arguments << "#{unescapeHTML(arg.to_s)}\n"
           }
         end
       end
@@ -95,13 +92,13 @@ END
         errors = "<b>Error codes</b>\n"
         info.errors.each {|e|
           errors << "* #{e.code}: <em>#{e.message}</em>\n\n"
-          errors << "  #{e.to_s}\n"
+          errors << "  #{unescapeHTML e.to_s}\n"
         }
       end
 
       if info.method.respond_to? :response
         response = "<b>Returns</b>\n"
-        raw = CGI.unescapeHTML(info.method.response.to_s)
+        raw = unescapeHTML(info.method.response.to_s)
         response << raw.collect { |line| line.insert(0, ' ') }.join
       else
         response = ''
@@ -133,14 +130,16 @@ END
     end
 
     def unescapeHTML(string)
+      string.gsub!('\/', '/')
       string.gsub(/&(.*?);/n) do
         match = $1.dup
         case match
-        when /\Aamp\z/ni           then '&'
-        when /\Aquot\z/ni          then '"'
-        when /\Agt\z/ni            then '>'
-        when /\Alt\z/ni            then '<'
-        else                            "&#{match};"
+        when /\Aamp\z/ni   then '&'
+        when /\Aquot\z/ni  then '"'
+        when /\Agt\z/ni    then '>'
+        when /\Alt\z/ni    then '<'
+        when /\Anbsp\z/ni  then ' '
+        else                    "&#{match};"
         end
       end
     end

data/lib/flickraw.rb

@@ -20,12 +20,12 @@
 # SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
 
-require 'rexml/document'
 require 'net/http'
 require 'md5'
+require 'yaml'
 
 module FlickRaw
-  VERSION='0.3.2'
+  VERSION='0.4'
 
   FLICKR_HOST='api.flickr.com'.freeze
 
@@ -40,67 +40,45 @@ module FlickRaw
 
   @api_key = '7b124df89b638e545e3165293883ef62'
 
-  # This is a wrapper around the xml response which provides an easy interface.
-  class Xml
-    include Enumerable
-    # Returns the text content of the response
-    attr_reader :to_s
-
-    # Returns the raw xml of the response
-    attr_reader :to_xml
-
-    def initialize(xml) # :nodoc:
-      @to_s   = xml.texts.join(' ')
-      @to_xml = xml.to_s
-
-      xml.attributes.each {|a, v| attribute a, v }
-
-      if xml.name =~ /s\z/
-        elements = REXML::XPath.match( xml, xml.name.sub(/s\z/, ''))
-        @list = elements.collect { |e| Xml.new e }
-      else
-        @list = [self]
-        xml.elements.each {|e|
-          if instance_variable_get "@#{e.name}"
-            send(e.name) << Xml.new(e)
-          else
-            attribute e.name, Xml.new(e)
-          end
-        }
-      end
-    end
-
-    def [](index); @list[index]; end
-    def each; @list.each { |el| yield el }; end
-    def length; @list.length; end
-
-    protected
-    def << el; @list << el; end
-
-    private
-    def attribute(sym, value)
-      instance_variable_set "@#{sym}", value
+  module SimpleOStruct # :nodoc:
+    def __attr_define(k,v)
+      instance_variable_set "@#{k}", v
       meta = class << self; self; end
-      meta.class_eval { attr_reader sym.to_s }
+      meta.class_eval { attr_reader k.to_s }
     end
   end
 
-  # This is what you get in response to an API call.
-  class Response < Xml
-    # This is called internally. It builds the response object according to xml response from the server.
-    def initialize(raw_xml)
-      doc = REXML::Document.new raw_xml
-      super doc.root
-      super doc.root.elements[1] if doc.root.elements.size == 1
+  class Response # :nodoc:
+    include SimpleOStruct
+    def initialize(h); h.each {|k, v| __attr_define k, Response.structify(v, k) } end
+    def self.structify(obj, name = '')
+      if obj.is_a? Hash
+        if name =~ /s$/ and obj[$`].is_a? Array
+          list = structify obj[$`]
+          list.extend SimpleOStruct
+          list.instance_eval { obj.each {|kv, vv| __attr_define kv, vv } }
+          list
+        elsif content = obj['_content']
+          content.extend SimpleOStruct
+          content.instance_eval { obj.each {|kv, vv| __attr_define kv, vv } }
+          content
+        else
+          blank = Response.new(obj)
+        end
+      elsif obj.is_a? Array
+        obj.collect {|e| structify e}
+      else
+        obj
+      end
     end
   end
 
   class FailedResponse < StandardError
     attr_reader :code
     alias :msg :message
-    def initialize(msg, code)
+    def initialize(msg, code, req)
       @code = code
-      super( msg)
+      super("'#{req}' - #{msg}")
     end
   end
 
@@ -142,20 +120,13 @@ module FlickRaw
     end
 
     # List of the flickr subobjects of this object
-    def self.flickr_objects
-      @flickr_objects ||= []
-    end
+    def self.flickr_objects; @flickr_objects ||= [] end
 
     # List of the flickr methods of this object
-    def self.flickr_methods
-      @flickr_methods ||= []
-    end
+    def self.flickr_methods; @flickr_methods ||= [] end
 
     # Returns the prefix of the request corresponding to this class.
-    def self.request_name
-      class_req = name.downcase.gsub( /::/, '.')
-      class_req.sub( /[^\.]+\./, '')              # Removes RawFlickr at the beginning
-    end
+    def self.request_name; name.downcase.gsub(/::/, '.').sub(/[^\.]+\./, '') end
   end
 
   # Root class of the flickr api hierarchy.
@@ -170,14 +141,8 @@ module FlickRaw
     # Raises FailedResponse if the response status is _failed_.
     def call(req, args={})
       path = REST_PATH + build_args(args, req).collect { |a, v| "#{a}=#{v}" }.join('&')
-
-      http_response = Net::HTTP.start(FLICKR_HOST) { |http|
-        http.get(path, 'User-Agent' => "Flickraw/#{VERSION}")
-      }
-      res = Response.new http_response.body
-      raise FailedResponse.new(res.msg, res.code) if res.stat == 'fail'
-      lookup_token(req, res)
-      res
+      http_response = Net::HTTP.start(FLICKR_HOST) { |http| http.get(path, 'User-Agent' => "Flickraw/#{VERSION}") }
+      parse_response(http_response, req)
     end
 
     # Use this to upload the photo in _file_.
@@ -190,30 +155,45 @@ module FlickRaw
       boundary = MD5.md5(photo).to_s
 
       header = {'Content-type' => "multipart/form-data, boundary=#{boundary} ", 'User-Agent' => "Flickraw/#{VERSION}"}
-      query = build_args(args).collect { |a, v|
-        "--#{boundary}\r\n" <<
-        "Content-Disposition: form-data; name=\"#{a}\"\r\n\r\n" <<
-        "#{v}\r\n"
-      }.join('')
-      query << "--#{boundary}\r\n" <<
-               "Content-Disposition: form-data; name=\"photo\"; filename=\"#{file}\"\r\n" <<
-               "Content-Transfer-Encoding: binary\r\n" <<
-               "Content-Type: image/jpeg\r\n\r\n" <<
-               photo <<
-               "\r\n" <<
-               "--#{boundary}--"
-
-      http_response = Net::HTTP.start(FLICKR_HOST) { |http|
-        http.post(UPLOAD_PATH, query, header)
+      query = ''
+      build_args(args).each { |a, v|
+        query <<
+          "--#{boundary}\r\n" <<
+          "Content-Disposition: form-data; name=\"#{a}\"\r\n\r\n" <<
+          "#{v}\r\n"
       }
-      res = Response.new http_response.body
-      raise FailedResponse.new(res.msg, res.code) if res.stat == 'fail'
-      res
+      query <<
+        "--#{boundary}\r\n" <<
+        "Content-Disposition: form-data; name=\"photo\"; filename=\"#{file}\"\r\n" <<
+        "Content-Transfer-Encoding: binary\r\n" <<
+        "Content-Type: image/jpeg\r\n\r\n" <<
+        photo <<
+        "\r\n" <<
+        "--#{boundary}--"
+
+      http_response = Net::HTTP.start(FLICKR_HOST) { |http| http.post(UPLOAD_PATH, query, header) }
+      xml = http_response.body
+      if xml[/stat="(\w+)"/, 1] == 'fail'
+        msg = xml[/msg="([^"]+)"/, 1]
+        code = xml[/code="([^"]+)"/, 1]
+        raise FailedResponse.new(msg, code, 'flickr.upload')
+      end
+      Response.structify( {:stat => 'ok', :photoid => xml[/<photoid>(\w+)<\/photoid>/, 1], :ticketid => xml[/<ticketid>(\w+)<\/ticketid>/, 1]})
     end
 
     private
+    def parse_response(response, req = nil)
+      yaml = YAML.load(response.body.gsub(/:([^\s])/, ': \1'))
+      raise FailedResponse.new(yaml['message'], yaml['code'], req) if yaml.delete('stat') == 'fail'
+      name, yaml = yaml.to_a.first if yaml.size == 1
+
+      res = Response.structify yaml, name
+      lookup_token(req, res)
+      res
+    end
+
     def build_args(args={}, req = nil)
-      full_args = {:api_key => FlickRaw.api_key}
+      full_args = {:api_key => FlickRaw.api_key, :format => 'json', :nojsoncallback => 1}
       full_args[:method] = req if req
       full_args[:auth_token] = @token if @token
       args.each {|k, v| full_args[k.to_sym] = v }
@@ -223,7 +203,7 @@ module FlickRaw
 
     def lookup_token(req, res)
       token_reqs = ['flickr.auth.getToken', 'flickr.auth.getFullToken', 'flickr.auth.checkToken']
-      @token = res.token if token_reqs.include?(req) and res.respond_to?( :token)
+      @token = res.token if token_reqs.include?(req) and res.respond_to?(:token)
     end
   end
 
@@ -238,7 +218,6 @@ module FlickRaw
     def auth_url(args={})
       full_args = {:api_key => FlickRaw.api_key, :perms => 'read'}
       args.each {|k, v| full_args[k.to_sym] = v }
-
       full_args[:api_sig] = api_sig(full_args) if FlickRaw.shared_secret
 
       'http://' + FLICKR_HOST + AUTH_PATH + full_args.collect { |a, v| "#{a}=#{v}" }.join('&')
@@ -251,7 +230,7 @@ module FlickRaw
   end
 
   methods = Flickr.new.call 'flickr.reflection.getMethods'
-  methods.each { |method| Flickr.build_request method.to_s }
+  methods.each { |method| Flickr.build_request method }
 end
 
 class Object
@@ -260,7 +239,5 @@ class Object
   #
   #  recent_photos = flickr.photos.getRecent
   #  puts recent_photos[0].title
-  def flickr
-    @flickr ||= FlickRaw::Flickr.new
-  end
+  def flickr; @flickr ||= FlickRaw::Flickr.new end
 end

data/rakefile

@@ -1,11 +1,12 @@
 require 'rake/rdoctask'
 require 'rake/packagetask'
 require 'rake/gempackagetask'
+require 'rake/testtask'
 
 require 'lib/flickraw'
 require 'flickraw_rdoc'
 
-PKG_FILES = FileList["lib/flickraw.rb", "flickraw_rdoc.rb", "copying.txt", "README", "TODO", "rakefile", "examples/*.rb"].to_a
+PKG_FILES = FileList["lib/flickraw.rb", "flickraw_rdoc.rb", "copying.txt", "README", "TODO", "rakefile", "examples/*.rb", "test/*.rb"].to_a
 
 spec = Gem::Specification.new do |s|
   s.summary = "Flickr library with a syntax close to the syntax described on http://www.flickr.com/services/api"
@@ -29,3 +30,4 @@ Rake::GemPackageTask.new spec do |p|
   p.need_tar_gz = true
 end
 
+Rake::TestTask.new

data/test/test.rb

@@ -0,0 +1,46 @@
+require 'test/unit'
+require 'lib/flickraw'
+
+class Basic < Test::Unit::TestCase
+  def test_known
+    known_methods = ["flickr.activity.userComments", "flickr.activity.userPhotos", "flickr.auth.checkToken", "flickr.auth.getFrob", "flickr.auth.getFullToken", "flickr.auth.getToken", "flickr.blogs.getList", "flickr.blogs.postPhoto", "flickr.contacts.getList", "flickr.contacts.getPublicList", "flickr.favorites.add", "flickr.favorites.getList", "flickr.favorites.getPublicList", "flickr.favorites.remove", "flickr.groups.browse", "flickr.groups.getInfo", "flickr.groups.pools.add", "flickr.groups.pools.getContext", "flickr.groups.pools.getGroups", "flickr.groups.pools.getPhotos", "flickr.groups.pools.remove", "flickr.groups.search", "flickr.interestingness.getList", "flickr.people.findByEmail", "flickr.people.findByUsername", "flickr.people.getInfo", "flickr.people.getPublicGroups", "flickr.people.getPublicPhotos", "flickr.people.getUploadStatus", "flickr.photos.addTags", "flickr.photos.comments.addComment", "flickr.photos.comments.deleteComment", "flickr.photos.comments.editComment", "flickr.photos.comments.getList", "flickr.photos.delete", "flickr.photos.geo.getLocation", "flickr.photos.geo.getPerms", "flickr.photos.geo.removeLocation", "flickr.photos.geo.setLocation", "flickr.photos.geo.setPerms", "flickr.photos.getAllContexts", "flickr.photos.getContactsPhotos", "flickr.photos.getContactsPublicPhotos", "flickr.photos.getContext", "flickr.photos.getCounts", "flickr.photos.getExif", "flickr.photos.getFavorites", "flickr.photos.getInfo", "flickr.photos.getNotInSet", "flickr.photos.getPerms", "flickr.photos.getRecent", "flickr.photos.getSizes", "flickr.photos.getUntagged", "flickr.photos.getWithGeoData", "flickr.photos.getWithoutGeoData", "flickr.photos.licenses.getInfo", "flickr.photos.licenses.setLicense", "flickr.photos.notes.add", "flickr.photos.notes.delete", "flickr.photos.notes.edit", "flickr.photos.recentlyUpdated", "flickr.photos.removeTag", "flickr.photos.search", "flickr.photos.setDates", "flickr.photos.setMeta", "flickr.photos.setPerms", "flickr.photos.setTags", "flickr.photos.transform.rotate", "flickr.photos.upload.checkTickets", "flickr.photosets.addPhoto", "flickr.photosets.comments.addComment", "flickr.photosets.comments.deleteComment", "flickr.photosets.comments.editComment", "flickr.photosets.comments.getList", "flickr.photosets.create", "flickr.photosets.delete", "flickr.photosets.editMeta", "flickr.photosets.editPhotos", "flickr.photosets.getContext", "flickr.photosets.getInfo", "flickr.photosets.getList", "flickr.photosets.getPhotos", "flickr.photosets.orderSets", "flickr.photosets.removePhoto", "flickr.reflection.getMethodInfo", "flickr.reflection.getMethods", "flickr.tags.getHotList", "flickr.tags.getListPhoto", "flickr.tags.getListUser", "flickr.tags.getListUserPopular", "flickr.tags.getListUserRaw", "flickr.tags.getRelated", "flickr.test.echo", "flickr.test.login", "flickr.test.null", "flickr.urls.getGroup", "flickr.urls.getUserPhotos", "flickr.urls.getUserProfile", "flickr.urls.lookupGroup", "flickr.urls.lookupUser"]
+    found_methods = flickr.reflection.getMethods
+    assert_instance_of Array, found_methods
+    known_methods.each { |m| assert found_methods.include?(m), m}
+  end
+
+  def test_found
+    found_methods = flickr.reflection.getMethods
+    found_methods.each { |m|
+      assert_nothing_raised {
+        begin
+          eval m
+        rescue FlickRaw::FailedResponse
+        end
+      }
+    }
+  end
+
+  def test_photos
+    list = flickr.photos.getRecent :per_page => '10'
+    assert_instance_of Array, list
+    assert_equal(list.size, 10)
+
+    id = secret = info = nil
+    assert_nothing_raised(NoMethodError) {
+      id = list[0].id
+      secret = list[0].secret
+    }
+    assert_nothing_raised(FlickRaw::FailedResponse) {
+      info = flickr.photos.getInfo :photo_id => id, :secret => secret
+    }
+    assert_respond_to info, :id
+    assert_respond_to info, :secret
+    assert_respond_to info, :title
+    assert_respond_to info, :description
+    assert_respond_to info, :owner
+    assert_respond_to info, :dates
+    assert_respond_to info, :comments
+    assert_respond_to info, :tags
+  end
+end

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.0
 specification_version: 1
 name: flickraw
 version: !ruby/object:Gem::Version 
-  version: 0.3.2
-date: 2006-10-24 00:00:00 +02:00
+  version: "0.4"
+date: 2007-01-09 00:00:00 +01:00
 summary: Flickr library with a syntax close to the syntax described on http://www.flickr.com/services/api
 require_paths: 
 - lib
@@ -35,10 +35,11 @@ files:
 - README
 - TODO
 - rakefile
+- examples/flickr_KDE.rb
 - examples/auth.rb
 - examples/interestingness.rb
-- examples/flickr_KDE.rb
 - examples/upload.rb
+- test/test.rb
 test_files: []
 
 rdoc_options: []