fleakr 0.4.0 → 0.4.1

data/README.rdoc

@@ -186,19 +186,39 @@ Once this is set, you'll see your Authentication URL on the key details page (it
 something like http://www.flickr.com/auth-534525246245).  Paste this URL into your browser and 
 confirm access to get your mini-token. Now you're ready to make authenticated requests:
 
-  require 'rubygems'
-  require 'fleakr'
+    require 'rubygems'
+    require 'fleakr'
 
-  Fleakr.api_key       = 'ABC123'
-  Fleakr.shared_secret = 'sekrit' # Available with your key details on the Flickr site
-  Fleakr.mini_token    = '362-133-214'
+    Fleakr.api_key       = 'ABC123'
+    Fleakr.shared_secret = 'sekrit' # Available with your key details on the Flickr site
+    Fleakr.mini_token    = '362-133-214'
 
-  Fleakr.upload('/path/to/my/photo.jpg')
-  Fleakr.token.value # => "34132412341235-12341234ef34"
+    Fleakr.upload('/path/to/my/photo.jpg')
+    Fleakr.token.value # => "34132412341235-12341234ef34"
 
 Once you use the mini-token once, it is no longer available.  To use the generated auth_token
 for future requests, just set Fleakr.auth_token to the generated value.
 
+=== What Went Wrong?
+
+Because so much of the underlying API is hidden under the covers, it's often tough to know
+what's really going on when you run into unexpected behavior.  To make things easier, you can
+have Fleakr log all of the API traffic.  Here's how:
+
+    Fleakr.logger = Logger.new('/tmp/fleakr.log')
+    
+Now any calls to the API will log both their request and response data to that file.  But be 
+warned, this can be pretty verbose by default (especially if you're doing file uploads).  To see
+just the requests you need to tune the log level:
+
+    logger = Logger.new('/tmp/fleakr.log')
+    logger.level = Logger::INFO
+    
+    Fleakr.logger = logger
+    
+Even if something doesn't go wrong, this is a good way to get a sense for when you're making
+API requests.
+
 == Roadmap / TODO
 
 === 0.4.x

data/Rakefile

@@ -20,6 +20,7 @@ spec = Gem::Specification.new do |s|
   
   s.add_dependency('hpricot', '~> 0.6.0')
   s.add_dependency('activesupport', '~> 2.2.0')
+  s.add_dependency('loggable', '~> 0.2.0')
 end
 
 Rake::GemPackageTask.new(spec) do |pkg|

data/lib/fleakr.rb

@@ -1,12 +1,13 @@
 $:.unshift(File.dirname(__FILE__))
+require 'rubygems'
 
 require 'uri'
 require 'cgi'
 require 'net/http'
-require 'rubygems'
 require 'hpricot'
 require 'activesupport'
 require 'md5'
+require 'loggable'
 
 require 'fleakr/api'
 require 'fleakr/core_ext'

data/lib/fleakr/api/method_request.rb

@@ -41,7 +41,11 @@ module Fleakr
       end
 
       def send # :nodoc:
-        Response.new(Net::HTTP.get(endpoint_uri))
+        logger.info("Sending request to: #{endpoint_uri}")
+        response_xml = Net::HTTP.get(endpoint_uri)
+        logger.debug("Response data:\n#{response_xml}")
+        
+        Response.new(response_xml)
       end
       
       private

data/lib/fleakr/api/upload_request.rb

@@ -49,8 +49,13 @@ module Fleakr
 
       def send # :nodoc:
         response = Net::HTTP.start(endpoint_uri.host, endpoint_uri.port) do |http| 
+          logger.info("Sending upload request to: #{endpoint_uri}")
+          logger.debug("Request data:\n#{self.parameters.to_form}")
+          logger.debug("Request headers:\n#{self.headers.inspect}")
+          
           http.post(endpoint_uri.path, self.parameters.to_form, self.headers)
         end
+        logger.debug("Response data:\n#{response.body}")
         Response.new(response.body)
       end
       

data/lib/fleakr/objects/photo.rb

@@ -53,7 +53,7 @@ module Fleakr
       find_all :by_user_id, :call => 'people.getPublicPhotos', :path => 'photos/photo'
       find_all :by_group_id, :call => 'groups.pools.getPhotos', :path => 'photos/photo'
       
-      find_one :by_id, :using => :photo_id, :call => 'photos.getInfo', :authenticate? => true
+      find_one :by_id, :using => :photo_id, :call => 'photos.getInfo'
       
       lazily_load :posted, :taken, :updated, :comment_count, :url, :description, :with => :load_info
       

data/lib/fleakr/version.rb

@@ -3,7 +3,7 @@ module Fleakr
     
     MAJOR = 0
     MINOR = 4
-    TINY  = 0
+    TINY  = 1
     
     def self.to_s
       [MAJOR, MINOR, TINY].join('.')

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: fleakr
 version: !ruby/object:Gem::Version 
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors: 
 - Patrick Reagan
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-01-02 00:00:00 -05:00
+date: 2009-01-21 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -32,6 +32,16 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: 2.2.0
     version: 
+- !ruby/object:Gem::Dependency 
+  name: loggable
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 0.2.0
+    version: 
 description: 
 email: reaganpr@gmail.com
 executables: []