smile 0.1.3 → 0.2.0

data/README.rdoc

@@ -1,10 +1,17 @@
 = smile
 
 Smile is a simple gem to talk to SmugMug.com.
+This gem wraps the 1.2.0 interface.
 
-New auth accessors
+== New Features
+
+=== Search feeds
+  Smile.search( 'blueberries' ) => [Smile::Photo] 
+  Smile.search_rss( 'bison' ) => RSS::Parser Feed
+  Smile.search_raw( 'grand' ) => Raw response from the feed
+
+===New auth accessors
   smug = Smile.auth_anonymously
-   _and_
   smug = Smile.auth( 'nick', 'pass' )
 
 
@@ -16,8 +23,7 @@ New auth accessors
 
   album.photos # and see the pretty pics
 
-== or
- 
+==== Old auth accessors ( NOTE: These are still supported )
   smug = Smile::Smug.new
   smug.auth( 'my_nick', 'my_pass' )
   albums = smug.albums # theses are mine
@@ -29,8 +35,8 @@ New auth accessors
 
 == TODO
 * Clean up params so they are not case sensitive
-* Add in RSS/Atom feeds as search options
-* Update Documentation
+* Create better exception handlers
+* Update Documentation ( getting there.  it's being published on rdoc.info now )
 * Plugin in Cucumber
 
 

data/VERSION.yml

@@ -1,4 +1,4 @@
 --- 
-:minor: 1
-:patch: 3
 :major: 0
+:minor: 2
+:patch: 0

data/lib/smile/base.rb

@@ -16,7 +16,6 @@ module Smile
       # This will be included in every request once you have logged in
       def default_params
         base = { :APIKey => API }
-        #set_session
         if( session_id )
           base.merge!( :SessionID => session_id )
         end

data/lib/smile/param_converter.rb

@@ -0,0 +1,61 @@
+module Smile::ParamConverter
+  module_function
+  
+  def convert( param, value=nil )
+    key = nil
+    case param.to_s.downcase.to_sym
+      when :popular_category
+        key = :popularCategory
+      when :geo_all 
+        key = :geoAll
+      when :geo_keyword 
+        key = :geoKeyword
+      when :geo_search 
+        key = :geoSearch
+      when :geo_community
+        key = :geoCommunity 
+      when :open_search_keyword
+        key = :openSearchKeyword
+      when :user_keyword 
+        key = :userkeyword
+      when :nickname_recent 
+        key = :nicknameRecent
+      when :nickname_popular 
+        key = :nicknamePopular
+      when :user_comments 
+        key = :userComments
+      when :geo_user 
+        key = :geoUser
+      when :geo_album 
+        key = :geoAlbum
+      when :size
+        key = :Size
+        value = value.titlecase
+      when :image_count
+        key = :ImageCount
+      when :data
+        key = :Data
+      when :type
+        key = :Type
+      when :image_id
+        key = :ImageID
+      when :image_key
+        key = :ImageKey
+      when :image_count
+        key = :ImageCount
+      else
+        key = param
+    end
+    
+    [ key, value ]
+  end
+  
+  def clean_hash_keys( hash_to_clean )
+    cleaned_hash ={}
+    hash_to_clean.each_pair do |key,value|
+      cleaned_hash[convert( key ).first] = value
+    end
+    cleaned_hash
+  end
+  
+end

data/lib/smile/photo.rb

@@ -26,12 +26,15 @@ class Smile::Photo < Smile::Base
     
     # This will pull a single image from the smugmug
     #
-    # * int ImageID
+    # * int image_id
     # * String Password optional
     # * String SitePassword optional
     # * String ImageKey
     # 
     def find( options={} )
+      set_session if( session_id.nil? )
+      options = Smile::ParamConverter.clean_hash_keys( options )
+      
       params = default_params.merge(
           :method => 'smugmug.images.getInfo'
       )
@@ -39,6 +42,7 @@ class Smile::Photo < Smile::Base
       params.merge!( options ) if( options )
       xml = RestClient.post Smile::Base::BASE, params
       image = Hash.from_xml( xml )["rsp"]["image"]
+      
       image.merge!( :image_id => image["id"] )
       image.merge!( :album_key => image["album"]["key"] )
       image.merge!( :album_id => image["album"]["id"] )

data/lib/smile.rb

@@ -5,105 +5,126 @@ require 'lib/smile/base'
 require 'lib/smile/smug'
 require 'lib/smile/album'
 require 'lib/smile/photo'
+require 'lib/smile/param_converter'
 require 'cgi'
 require 'rss'
 
 module Smile
+  module_function
+  
   def auth_anonymously
     smug = Smile::Smug.new
     smug.auth_anonymously
     smug
   end
-  module_function( :auth_anonymously )
   
-  def auth( user, pass )
+  # Login to SmugMug using a specific user account.
+  #
+  # @param [String] username The username ( Nickname ) for the SmugMug account
+  # @param [String] password The password for the SmugMug account
+  #
+  # @return [Smile::SmugMug.new] An Smug object that has been authenticated
+  def auth( username, password )
     smug = Smile::Smug.new
-    smug.auth( user, pass )
+    smug.auth( username, password )
     smug
   end
-  module_function( :auth )
   
   def base_feed( options={} )
     options.merge!( :format => 'rss' )
     url = "http://api.smugmug.com/hack/feed.mg?"
     url_params =[]
     options.each_pair do |k,value|
-      case k.to_s.downcase.to_sym
-        when :popular_category
-          key = :popularCategory
-        when :geo_all 
-          key = :geoAll
-        when :geo_keyword 
-          key = :geoKeyword
-        when :geo_search 
-          key = :geoSearch
-        when :geo_community
-          key = :geoCommunity 
-        when :open_search_keyword
-          key = :openSearchKeyword
-        when :user_keyword 
-          key = :userkeyword
-        when :nickname_recent 
-          key = :nicknameRecent
-        when :nickname_popular 
-          key = :nicknamePopular
-        when :user_comments 
-          key = :userComments
-        when :geo_user 
-          key = :geoUser
-        when :geo_album 
-          key = :geoAlbum
-        when :size
-          key = :Size
-          value = value.titlecase
-        when :image_count
-          key = :ImageCount
-        else
-          key = k
-      end
+      key, value = Smile::ParamConverter.convert( k, value )
       
       url_params << "#{key.to_s}=#{ CGI.escape( value ) }"
     end
     
-    content = RestClient.get( url + url_params.join( "&" ) )
-    RSS::Parser.parse( content, false )
+    RestClient.get( url + url_params.join( "&" ) )
   end
-  module_function( :base_feed )
+  private( :base_feed )
   
-  # Search SmugMug for pics.
-  # By Default it will use the keyword search.
+  # Search SmugMug for pics.  This search is slower than the others, but returns Smile::Photo objects
+  # 
+  # @param [String] data This is the search term that you want to use
+  # @param [optional, Hash] options Hash of options for the search method
+  # @option options [optional, String] :keyword override the keyword search
+  # @option options [optional, String] :popular Use term all or today
+  # @option options [optional, String] :popular_category Use term category ( e.g. cars )
+  # @option options [optional, String] :geo_all Geo Stuff
+  # @option options [optional, String] :geo_community More Geo Stuff
+  # @option options [optional, String] :geo_search Geo Search
+  # @option options [optional, String] :open_search_keyword Key word
+  # @option options [optional, String] :user_keyword Use term nickname
+  # @option options [optional, String] :gallery Use term albumID_albumKey
+  # @option options [optional, String] :nickname Use term nickname
+  # @option options [optional, String] :nickname_recent Use term nickname
+  # @option options [optional, String] :nickname_popular Use term nickname
+  # @option options [optional, String] :user_comments Use term nickname
+  # @option options [optional, String] :geo_user Use term nickname
+  # @option options [optional, String] :geo_album Use term nickname
   # 
-  # options
-  #   type => [ 
-  #     keyword 
-  #     popular # Use term all or today
-  #     popularCategory # Use term category ( e.g. cars )
-  #     geoAll 
-  #     geoKeyword 
-  #     geoSearch 
-  #     geoCommunity 
-  #     openSearchKeyword
-  #     userkeyword # Use term nickname
-  #     gallery # Use term albumID_albumKey
-  #     nickname # Use term nickname
-  #     nicknameRecent # Use term nickname
-  #     nicknamePopular # Use term nickname
-  #     usercomments # Use term nickname
-  #     geoUser # Use term nickname
-  #     geoAlbum # Use term albumID_albumKey
-  #   ]
+  # @return [Array<Smile::Photo>] Smile::Photo objects will be returned.  This take longer due to
+  # pulling more details from every photo.
   def search( data, options={} )
-    rss = search_raw( data, options )
-    rss.items.map{ |item| item.guid.content }
+    rss = search_rss( data, options )
     
+    rss.items.map do |item| 
+      image_id, image_key = item.link.split('/').last.split('#').last.split('_')
+      Smile::Photo.find( :image_id => image_id, :image_key => image_key )
+    end
   end
-  module_function( :search )
   
-  # Get the RAW feed
+  # Search SmugMug for pics.  This search is slower than the others, but returns Smile::Photo objects
+  # 
+  # @param [String] data This is the search term that you want to use
+  # @param [optional, Hash] options Hash of options for the search method
+  # @option options [optional, String] :keyword override the keyword search
+  # @option options [optional, String] :popular Use term all or today
+  # @option options [optional, String] :popular_category Use term category ( e.g. cars )
+  # @option options [optional, String] :geo_all Geo Stuff
+  # @option options [optional, String] :geo_community More Geo Stuff
+  # @option options [optional, String] :geo_search Geo Search
+  # @option options [optional, String] :open_search_keyword Key word
+  # @option options [optional, String] :user_keyword Use term nickname
+  # @option options [optional, String] :gallery Use term albumID_albumKey
+  # @option options [optional, String] :nickname Use term nickname
+  # @option options [optional, String] :nickname_recent Use term nickname
+  # @option options [optional, String] :nickname_popular Use term nickname
+  # @option options [optional, String] :user_comments Use term nickname
+  # @option options [optional, String] :geo_user Use term nickname
+  # @option options [optional, String] :geo_album Use term nickname
+  # 
+  # @return [Array<Smile::Photo>] RSS feed from the RSS::Parser.parse method
+  def search_rss( data, options={} )
+    raw = search_raw( data, options )
+    RSS::Parser.parse( raw, false )
+  end
+  
+  # Raw feed from the SmugMug data feeds
+  # 
+  # @param [String] data This is the search term that you want to use
+  # @param [optional, Hash] options Hash of options for the search method
+  # @option options [optional, String] :keyword override the keyword search
+  # @option options [optional, String] :popular Use term all or today
+  # @option options [optional, String] :popular_category Use term category ( e.g. cars )
+  # @option options [optional, String] :geo_all Geo Stuff
+  # @option options [optional, String] :geo_community More Geo Stuff
+  # @option options [optional, String] :geo_search Geo Search
+  # @option options [optional, String] :open_search_keyword Key word
+  # @option options [optional, String] :user_keyword Use term nickname
+  # @option options [optional, String] :gallery Use term albumID_albumKey
+  # @option options [optional, String] :nickname Use term nickname
+  # @option options [optional, String] :nickname_recent Use term nickname
+  # @option options [optional, String] :nickname_popular Use term nickname
+  # @option options [optional, String] :user_comments Use term nickname
+  # @option options [optional, String] :geo_user Use term nickname
+  # @option options [optional, String] :geo_album Use term nickname
+  # 
+  # @return [RestClientResponse] The response from a RestClient.get request
   def search_raw( data, options={} )
     options.merge!( :type => 'keyword', :data => data )
     base_feed( options )
   end
-  module_function( :search_raw )
 end
 

data/smile.gemspec

@@ -2,24 +2,26 @@
 
 Gem::Specification.new do |s|
   s.name = %q{smile}
-  s.version = "0.1.3"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["cajun"]
-  s.date = %q{2009-06-16}
+  s.date = %q{2009-07-11}
   s.email = %q{zac@kleinpeter.org}
   s.extra_rdoc_files = [
     "LICENSE",
      "README.rdoc"
   ]
   s.files = [
-    "LICENSE",
+    ".yardoc",
+     "LICENSE",
      "README.rdoc",
      "Rakefile",
      "VERSION.yml",
      "lib/smile.rb",
      "lib/smile/album.rb",
      "lib/smile/base.rb",
+     "lib/smile/param_converter.rb",
      "lib/smile/photo.rb",
      "lib/smile/smug.rb",
      "smile.gemspec",

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: smile
 version: !ruby/object:Gem::Version 
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors: 
 - cajun
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-06-16 00:00:00 -05:00
+date: 2009-07-11 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -42,6 +42,7 @@ extra_rdoc_files:
 - LICENSE
 - README.rdoc
 files: 
+- .yardoc
 - LICENSE
 - README.rdoc
 - Rakefile
@@ -49,6 +50,7 @@ files:
 - lib/smile.rb
 - lib/smile/album.rb
 - lib/smile/base.rb
+- lib/smile/param_converter.rb
 - lib/smile/photo.rb
 - lib/smile/smug.rb
 - smile.gemspec