fleakr 0.6.3 → 0.7.0

data/lib/fleakr/api/option.rb

@@ -6,7 +6,7 @@ module Fleakr
     # Top-level class for creating specific option instances based on type
     #
     class Option
-      
+
       MAPPING = {
         :tags        => 'TagOption',
         :viewable_by => 'ViewOption',
@@ -14,85 +14,85 @@ module Fleakr
         :type        => 'TypeOption',
         :hide?       => 'HiddenOption'
       }
-      
+
       # Initialize a new option for the specified type and value
       #
       def self.for(type, value)
         class_for(type).new(type, value)
       end
-      
+
       def self.class_for(type) # :nodoc:
         class_name = MAPPING[type] || 'SimpleOption'
-        "Fleakr::Api::#{class_name}".constantize
+        Fleakr::Api.const_get(class_name)
       end
-      
+
     end
-    
+
     # = SimpleOption
-    # 
+    #
     # Simple name / value option pair
     #
     class SimpleOption
 
       attr_reader :type, :value
-     
+
       # Create an option of the specified type and value
       #
       def initialize(type, value)
         @type  = type
         @value = value
       end
-      
+
       # Generate hash representation of this option
       #
       def to_hash
         {type => value}
       end
-      
+
     end
-    
+
     # = TagOption
     #
     # Represents values for tags
     #
     class TagOption < SimpleOption
-      
+
       # Tag with specified values.  Value passed will be converted to an array if it isn't
       # already
-      # 
+      #
       def initialize(type, value)
         super type, value
         @value = Array(self.value)
       end
-    
-      # Hash representation of tag values (separated by spaces).  Handles multi-word tags 
+
+      # Hash representation of tag values (separated by spaces).  Handles multi-word tags
       # by enclosing each tag in double quotes.
       #
       def to_hash
         tags = value.map {|tag| "\"#{tag}\"" }
         {type => tags.join(' ')}
       end
-      
+
     end
-    
+
     # = ViewOption
     #
     # Specify who is able to view the photo.
     #
     class ViewOption < SimpleOption
-      
+
       # Specify who this is viewable by (e.g. everyone / friends / family).
       #
       def initialize(type, value)
         super type, Array(value)
       end
-      
+
       # Is this publicly viewable? (i.e. :everyone)
       #
       def public?
         value == [:everyone]
       end
-      
+
       # Is this viewable by friends? (i.e. :friends)
       #
       def friends?
@@ -104,43 +104,43 @@ module Fleakr
       def family?
         value.include?(:family)
       end
-      
+
       # Hash representation of photo permissions
       #
       def to_hash
         {:is_public => public?.to_i, :is_friend => friends?.to_i, :is_family => family?.to_i}
       end
-      
+
     end
-    
+
     # = LevelOption
     #
     # Specify the "safety level" of this photo (e.g. safe / moderate / restricted)
     #
     class LevelOption < SimpleOption
-     
-      def value # :nodoc: 
+
+      def value # :nodoc:
         case @value
           when :safe        then 1
           when :moderate    then 2
           when :restricted  then 3
         end
       end
-      
+
       # Hash representation of the safety_level for this photo
       #
       def to_hash
         {:safety_level => value}
       end
-      
+
     end
-    
+
     # = TypeOption
     #
     # Specify the type of this photo (e.g. photo / screenshot / other)
     #
     class TypeOption < SimpleOption
-      
+
       def value # :nodoc:
         case @value
           when :photo       then 1
@@ -148,27 +148,27 @@ module Fleakr
           when :other       then 3
         end
       end
-      
+
       # Hash representation of this type
       #
       def to_hash
         {:content_type => value}
       end
-      
+
     end
-    
+
     # = HiddenOption
     #
     # Specify whether this photo should be hidden from search
     #
     class HiddenOption < SimpleOption
-     
+
       # Hash representation of whether to hide this photo
       #
       def to_hash
         {:hidden => (value ? 2 : 1)}
       end
-      
+
     end
 
   end

data/lib/fleakr/api/parameter_list.rb

@@ -1,6 +1,6 @@
 module Fleakr
   module Api # :nodoc:
-    
+
     # = ParameterList
     #
     # Represents a list of parameters that get passed as part of a
@@ -8,13 +8,13 @@ module Fleakr
     # into query strings (using #to_query) or form data (using #to_form)
     #
     class ParameterList
-      
+
       attr_reader :upload_options # :nodoc:
-      
+
       # Create a new parameter list with optional parameters:
       #
       #   list = Fleakr::Api::ParameterList.new(:username => 'reagent')
-      # 
+      #
       # You can also disable the sending of the authentication token using
       # the second parameter:
       #
@@ -27,35 +27,35 @@ module Fleakr
       end
 
       # Should we send an authentication token as part of this list of parameters?
-      # By default this is true if the token is available as a global value or if 
+      # By default this is true if the token is available as a global value or if
       # the :auth_token key/value is part of the initial list.  You can override this
       # in the constructor.
-      # 
+      #
       def send_authentication_token?
         @send_authentication_token && !authentication_token.nil?
       end
-      
+
       # The default options to send as part of the parameter list, defaults to
       # sending the API key
       #
       def default_options
         {:api_key => Fleakr.api_key}
       end
-      
+
       # Should this parameter list be signed? This will be true if Fleakr.shared_secret
       # is set, false if not.
       #
       def sign?
-        !Fleakr.shared_secret.blank?
+        !Fleakr::Support::Utility.blank?(Fleakr.shared_secret)
       end
-      
-      # Generate the query string representation of this parameter 
+
+      # Generate the query string representation of this parameter
       # list - e.g. <tt>foo=bar&blee=baz</tt>
       #
       def to_query
         list.map {|element| element.to_query }.join('&')
       end
-      
+
       # Generate the form representation of this parameter list including the
       # boundary
       #
@@ -65,54 +65,54 @@ module Fleakr
 
         form
       end
-      
+
       # Retrieve the authentication token from either the list of parameters
       # or the global value (e.g. Fleakr.auth_token)
       #
       def authentication_token
         Fleakr.auth_token.nil? ? @options[:auth_token] : Fleakr.auth_token
       end
-      
+
       # Add an option to the list that should be sent with a request.
       #
       def add_option(name, value)
         @options.merge!(name => value)
       end
-      
+
       # Add an option that should be sent with an upload request.
       #
       def add_upload_option(name, value)
         @upload_options.merge!(name => value)
       end
-      
+
       def options # :nodoc:
         options = default_options.merge(@options)
         options.merge!(:auth_token => authentication_token) if send_authentication_token?
-        
+
         options
       end
-      
+
       def boundary # :nodoc:
         @boundary ||= Digest::MD5.hexdigest(rand.to_s)
       end
-      
+
       def signature # :nodoc:
         sorted_options = options_without_signature.sort {|a,b| a[0].to_s <=> b[0].to_s }
         signature_text = sorted_options.map {|o| "#{o[0]}#{o[1]}" }.join
 
         Digest::MD5.hexdigest("#{Fleakr.shared_secret}#{signature_text}")
       end
-      
+
       def options_without_signature # :nodoc:
         options.reject {|k,v| k.to_s == 'api_sig'}
       end
-      
+
       def options_with_signature # :nodoc:
         options_without_signature.merge(:api_sig => signature)
       end
-      
+
       def list # :nodoc:
-        options_for_list = sign? ? options_with_signature : options_without_signature 
+        options_for_list = sign? ? options_with_signature : options_without_signature
         value_parameters = options_for_list.map {|k,v| ValueParameter.new(k, v) }
         file_parameters  = upload_options.map {|k,v| FileParameter.new(k, v) }
 

data/lib/fleakr/objects.rb

@@ -2,6 +2,8 @@ require 'fleakr/objects/authentication_token'
 require 'fleakr/objects/collection'
 require 'fleakr/objects/contact'
 require 'fleakr/objects/error'
+require 'fleakr/objects/metadata_collection'
+require 'fleakr/objects/metadata'
 require 'fleakr/objects/group'
 require 'fleakr/objects/image'
 require 'fleakr/objects/photo_context'
@@ -10,4 +12,5 @@ require 'fleakr/objects/comment'
 require 'fleakr/objects/tag'
 require 'fleakr/objects/search'
 require 'fleakr/objects/set'
-require 'fleakr/objects/user'
+require 'fleakr/objects/user'
+require 'fleakr/objects/url'

data/lib/fleakr/objects/metadata.rb

@@ -0,0 +1,35 @@
+module Fleakr
+  module Objects
+
+    # = Metadata
+    #
+    # This class wraps the functionality of EXIF data extraction. It's called
+    # by the Fleakr::Objects::Photo class to obtain EXIF values
+    #
+    # Example:
+    #
+    #  user = Fleakr.user('brownout')
+    #  user.photos.first.metadata
+    #
+    # == Attributes
+    #
+    # [raw] The raw value returned by Flickr (e.g. 1/500 for ExposureTime)
+    # [clean] The clean value returned by Flickr for the tag (e.g. 0.0.02 (1/500) for ExposureTime)
+    # [tagspace] The tag space of the EXIF data, (e.g. TIFF, ExifIFD, Composite)
+    # [tag] The label as a tag, (e.g. ExposureProgram)
+    # [label] The label for the tag, (e.g. 'Exposure Program')
+    #
+
+    class Metadata
+
+      include Fleakr::Support::Object
+
+      flickr_attribute :tagspace, :tag, :label
+      flickr_attribute :raw, :from => 'raw'
+      flickr_attribute :clean, :from => 'clean'
+
+      find_all :by_photo_id, :call => 'photos.getExif', :path => 'photo/exif'
+
+    end
+  end
+end

data/lib/fleakr/objects/metadata_collection.rb

@@ -0,0 +1,36 @@
+module Fleakr
+  module Objects
+
+    class MetadataCollection
+
+      include Enumerable
+
+      attr_reader :photo
+
+      def initialize(photo)
+        @photo = photo
+      end
+
+      def data
+        @data ||= begin
+          elements = Metadata.find_all_by_photo_id(photo.id)
+          elements.inject({}) {|c, e| c.merge(e.label => e) }
+        end
+      end
+
+      def keys
+        data.keys
+      end
+
+      def [](key)
+        data[key].raw
+      end
+
+      def each(&block)
+        data.each(&block)
+      end
+
+    end
+
+  end
+end

data/lib/fleakr/objects/photo.rb

@@ -1,11 +1,11 @@
 module Fleakr
   module Objects # :nodoc:
-    
+
     # = Photo
     #
-    # Handles both the retrieval of Photo objects from various associations (e.g. User / Set) as 
+    # Handles both the retrieval of Photo objects from various associations (e.g. User / Set) as
     # well as the ability to upload images to the Flickr site.
-    # 
+    #
     # == Attributes
     #
     # [id] The ID for this photo
@@ -22,7 +22,7 @@ module Fleakr
     # [large] The large representation of this photo
     # [original] The original photo
     # [previous] The previous photo based on the current context
-    # [next] The next photo based on the current context 
+    # [next] The next photo based on the current context
     #
     # == Associations
     #
@@ -57,13 +57,17 @@ module Fleakr
       find_all :by_set_id, :using => :photoset_id, :call => 'photosets.getPhotos', :path => 'photoset/photo'
       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'
-      
+
       lazily_load :posted, :taken, :updated, :comment_count, :url, :description, :with => :load_info
-      
+
       has_many :images, :tags, :comments
 
+      def metadata
+        @metadata ||= MetadataCollection.new(self)
+      end
+
       # Upload the photo specified by <tt>filename</tt> to the user's Flickr account. When uploading,
       # there are several options available (none are required):
       #
@@ -85,7 +89,7 @@ module Fleakr
         Photo.find_by_id(photo.id)
       end
 
-      # Replace the current photo's image with the one specified by filename.  This 
+      # Replace the current photo's image with the one specified by filename.  This
       # call requires authentication.
       #
       def replace_with(filename)
@@ -108,7 +112,7 @@ module Fleakr
       end
 
       # The user who uploaded this photo.  See Fleakr::Objects::User for additional information.
-      # 
+      #
       def owner
         @owner ||= User.find_by_id(owner_id)
       end
@@ -118,13 +122,13 @@ module Fleakr
       def posted_at
         Time.at(posted.to_i)
       end
-      
+
       # When was this photo taken?
       #
       def taken_at
         Time.parse(taken)
       end
-      
+
       # When was this photo last updated?  This includes addition of tags and other metadata.
       #
       def updated_at