flickraw 0.3.1 → 0.3.2

data/README

@@ -0,0 +1,43 @@
+= Flickraw
+
+Flickraw is a library to access flickr[http://flickr.com] api in a simple way.
+It maps exactly the methods described in {the official api documentation}[http://www.flickr.com/services/api].
+It also try to present the data returned in a simple and intuitive way.
+
+You can read the class documentation here : FlickRaw.
+
+The rubyforge project : http://rubyforge.org/projects/flickraw
+
+= Installation
+Type this in a console (you might need to be superuser)
+ gem install flickraw
+
+You can recreate this documentation by typing this in the source directory:
+ rake rdoc
+
+= Usage
+
+ require 'flickraw'
+
+ list   = flickr.photos.getRecent
+
+ id     = list[0].id
+ secret = list[0].secret
+ info = flickr.photos.getInfo :photo_id => id, :secret => secret
+
+ info.title           # => "PICT986"
+ info.dates.taken     # => "2006-07-06 15:16:18"
+
+
+ sizes = flickr.photos.getSizes :photo_id => id
+
+ original = sizes.find {|s| s.label == 'Original' }
+ original.width       # => "800"
+
+See the _examples_ directory to find more examples.
+
+= Notes
+If you want to use the api authenticated with several user at the same time, you must pass the authentication token explicitely each time.
+This is because it is keeping the authentication token internally.
+As an alternative, you can create new Flickr objects besides Object.flickr which is created for you. Use Flickr.new to this effect.
+

data/TODO

@@ -0,0 +1,6 @@
+== General
+* Add helper classes for URL support
+
+== Documentation
+* Document the object returned by the flickr method calls ( FlickRaw::Xml )
+* Add more examples.

data/copying.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2006 Hank Lords <hanklords@gmail.com>
+
+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/flickraw_rdoc.rb

@@ -1,5 +1,6 @@
 require "rdoc/parsers/parserfactory"
 require "rdoc/parsers/parse_rb"
+require "cgi"
 
 FLICKR_API_URL='http://www.flickr.com/services/api'
 

data/lib/flickraw.rb

@@ -21,11 +21,11 @@
 
 
 require 'rexml/document'
-require 'open-uri'
+require 'net/http'
 require 'md5'
 
 module FlickRaw
-  VERSION='0.3.1'
+  VERSION='0.3.2'
 
   FLICKR_HOST='api.flickr.com'.freeze
 
@@ -42,6 +42,7 @@ module FlickRaw
 
   # 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
 
@@ -51,36 +52,36 @@ module FlickRaw
     def initialize(xml) # :nodoc:
       @to_s   = xml.texts.join(' ')
       @to_xml = xml.to_s
-      @list = nil
 
       xml.attributes.each {|a, v| attribute a, v }
 
       if xml.name =~ /s\z/
         elements = REXML::XPath.match( xml, xml.name.sub(/s\z/, ''))
-        unless elements.empty?
-          @list = elements.collect { |e| Xml.new e }
-        end
+        @list = elements.collect { |e| Xml.new e }
       else
-        xml.elements.each {|e| attribute e.name, Xml.new(e) }
+        @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 respond_to?(m) # :nodoc:
-      super || @list.respond_to?(m)
-    end
+    def [](index); @list[index]; end
+    def each; @list.each { |el| yield el }; end
+    def length; @list.length; end
 
-    private
-    def method_missing(sym, *args, &block)
-      if @list.respond_to?( sym)
-        @list.send sym, *args, &block
-      else
-        super
-      end
-    end
+    protected
+    def << el; @list << el; end
 
+    private
     def attribute(sym, value)
+      instance_variable_set "@#{sym}", value
       meta = class << self; self; end
-      meta.class_eval { define_method(sym) { value } }
+      meta.class_eval { attr_reader sym.to_s }
     end
   end
 
@@ -126,7 +127,7 @@ module FlickRaw
           klass = Class.new Request
           const_set(class_name, klass)
           attr_reader name
-	  flickr_objects << name
+          flickr_objects << name
         end
 
         klass.build_request method_nesting.join('.')
@@ -168,10 +169,13 @@ module FlickRaw
     #
     # Raises FailedResponse if the response status is _failed_.
     def call(req, args={})
-      url = 'http://' + FLICKR_HOST + REST_PATH + build_args(args, req).collect { |a, v| "#{a}=#{v}" }.join('&')
+      path = REST_PATH + build_args(args, req).collect { |a, v| "#{a}=#{v}" }.join('&')
 
-      res = Response.new open(url, 'User-Agent' => "Flickraw/#{VERSION}")
-      raise FailedResponse.new( res.msg, res.code) if res.stat == 'fail'
+      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
     end

data/rakefile

@@ -5,7 +5,7 @@ require 'rake/gempackagetask'
 require 'lib/flickraw'
 require 'flickraw_rdoc'
 
-PKG_FILES = FileList["lib/flickraw.rb", "flickraw_rdoc.rb", "rakefile", "examples/*.rb"].to_a
+PKG_FILES = FileList["lib/flickraw.rb", "flickraw_rdoc.rb", "copying.txt", "README", "TODO", "rakefile", "examples/*.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"
@@ -27,4 +27,5 @@ end
 
 Rake::GemPackageTask.new spec do |p|
   p.need_tar_gz = true
-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.1
-date: 2006-09-02 00:00:00 +02:00
+  version: 0.3.2
+date: 2006-10-24 00:00:00 +02:00
 summary: Flickr library with a syntax close to the syntax described on http://www.flickr.com/services/api
 require_paths: 
 - lib
@@ -31,6 +31,9 @@ authors:
 files: 
 - lib/flickraw.rb
 - flickraw_rdoc.rb
+- copying.txt
+- README
+- TODO
 - rakefile
 - examples/auth.rb
 - examples/interestingness.rb