cajun-smile 0.1.1 → 0.1.2

data/README.rdoc

@@ -1,6 +1,24 @@
 = smile
 
-Description goes here.
+Smile is a simple gem to talk to SmugMug.com.
+
+smug = Smile::Smug.new
+smug.auth_anonymously
+albums = smug.albums( :NickName => 'kleinpeter' )
+
+album = albums.first # just test the first one
+
+album.photos # and see the pretty pics
+
+ -- or --
+ 
+smug = Smile::Smug.new
+smug.auth( 'my_nick', 'my_pass' )
+albums = smug.albums # theses are mine
+
+album = albums.first # just test the first one
+
+album.photos # and see the pretty pics
 
 == Copyright
 

data/Rakefile

@@ -12,6 +12,7 @@ begin
     gem.files << "lib/**/*"
     gem.add_dependency( 'rest-client' )
     gem.add_dependency( 'activesupport' )
+    gem.rubyforge_project = 'cajun-gems'
     
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
   end
@@ -19,6 +20,34 @@ rescue LoadError
   puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
 end
 
+# These are new tasks
+# These are new tasks
+begin
+  require 'rake/contrib/sshpublisher'
+  namespace :rubyforge do
+
+    desc "Release gem and RDoc documentation to RubyForge"
+    task :release => ["rubyforge:release:gem", "rubyforge:release:docs"]
+
+    namespace :release do
+      desc "Publish RDoc to RubyForge."
+      task :docs => [:rdoc] do
+        config = YAML.load(
+            File.read(File.expand_path('~/.rubyforge/user-config.yml'))
+        )
+
+        host = "#{config['username']}@rubyforge.org"
+        remote_dir = "/var/www/gforge-projects/cajun-gems/"
+        local_dir = 'rdoc'
+
+        Rake::SshDirPublisher.new(host, remote_dir, local_dir).upload
+      end
+    end
+  end
+rescue LoadError
+  puts "Rake SshDirPublisher is unavailable or your rubyforge environment is not configured."
+end
+
 require 'rake/testtask'
 Rake::TestTask.new(:test) do |test|
   test.libs << 'lib' << 'test'

data/VERSION.yml

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

data/lib/smile/album.rb

@@ -1,3 +1,10 @@
+# 
+#  album.rb
+#  smile
+#  
+#  Created by Zac Kleinpeter on 2009-04-28.
+#  Copyright 2009 Cajun Country. All rights reserved.
+# 
 class Smile::Album < Smile::Base
 
   class << self
@@ -5,31 +12,78 @@ class Smile::Album < Smile::Base
       hash = Hash.from_xml( xml )["rsp"]
       hash["albums"]["album"].map do |album|
         album.merge!( :album_id => album["id"] )
+        
         a = Smile::Album.new( album )
         a.session_id = session_id
         a
       end
     end
-  end
-
-=begin
-  *  SessionID - string.
-  * AlbumID - integer.
-  * Heavy - boolean (optional).
-  * Password - string (optional).
-  * SitePassword - string (optional).
-  * AlbumKey - string.
-=end
-    def photos( options=nil )
+    
+    # This will pull a single album from the smugmug
+    #
+    # * SessionID - string. ( by default if logged in)
+    # * AlbumID - string.
+    # * Password - string (optional).
+    # * SitePassword - string (optional).
+    # * AlbumKey - string.
+    # 
+    def find( options={} )
       params = default_params.merge(
-          :method => 'smugmug.images.get',
-          :AlbumID => album_id,
-          :AlbumKey => key,
-          :Heavy => 1
+          :method => 'smugmug.albums.getInfo'
       )
-
+      
       params.merge!( options ) if( options )
-      xml = RestClient.post BASE, params
-      Smile::Photo.from_xml( xml, sesson_id )
+      
+      xml = RestClient.post Smile::Base::BASE, params
+      
+      album = Hash.from_xml( xml )["rsp"]["album"]
+      album.merge!( :album_id => album["id"] )
+      
+      a = Smile::Album.new( album )
+      a.session_id = session_id
+      a
     end
+  end
+
+  # This will pull all the photos for a given album
+  # * SessionID - string. ( by default if logged in)
+  # * AlbumID - integer.
+  # * Heavy - boolean (optional).
+  # * Password - string (optional).
+  # * SitePassword - string (optional).
+  # * AlbumKey - string.
+  def photos( options=nil )
+    params = default_params.merge(
+        :method => 'smugmug.images.get',
+        :AlbumID => album_id,
+        :AlbumKey => key,
+        :Heavy => 1
+    )
+
+    params.merge!( options ) if( options )
+    
+    xml = RestClient.post BASE, params
+    Smile::Photo.from_xml( xml, session_id )
+  end
+  
+  # * integer AlbumID
+  # * integer Month
+  # * integer Year
+  # * boolean Heavy (optional)
+  def stats( options =nil )
+    params = default_params.merge( 
+      :method => 'smugmug.albums.getStats',
+      :AlbumID => album_id,
+      :month => Date.today.month,
+      :year => Date.today.year
+    )
+    
+    params.merge!( options ) if( options )
+    
+    xml = RestClient.post BASE, params
+    rsp = Hash.from_xml( xml )["rsp"]
+    raise "invalid user" if rsp["stat"] == 'fail'
+    hash = Hash.from_xml( xml )["rsp"]
+    OpenStruct.new( hash )
+  end
 end

data/lib/smile/base.rb

@@ -1,16 +1,32 @@
+# 
+#  base.rb
+#  smile
+#  
+#  Created by Zac Kleinpeter on 2009-04-28.
+#  Copyright 2009 Cajun Country. All rights reserved.
+# 
 module Smile
   class Base < OpenStruct
     BASE = 'http://api.smugmug.com/hack/rest/1.2.0/'
     BASE_SECURE = 'https://api.smugmug.com/hack/rest/1.2.0/'
     API = 'HSoqGCJ8ilF42BeThMGDZqqqOgj1eXqN'
 
+    class << self
+      attr_accessor :session_id
+      # This will be included in every request once you have logged in
+      def default_params
+        base = { :APIKey => API }
+        if( session_id )
+          base.merge!( :SessionID => session_id )
+        end
+        base
+      end
+    end
+    
     attr_accessor :session_id
     def default_params
-      base = { :APIKey => API }
-      if( session_id )
-        base.merge!( :SessionID => session_id )
-      end
-      base
+      self.class.session_id = self.session_id
+      self.class.default_params
     end
   end
 end

data/lib/smile/photo.rb

@@ -1,14 +1,227 @@
+# 
+#  photo.rb
+#  smile
+#  
+#  Created by Zac Kleinpeter on 2009-04-28.
+#  Copyright 2009 Cajun Country. All rights reserved.
+# 
 class Smile::Photo < Smile::Base
   
   class << self
+    # Convert the given xml into photo objects to play with
     def from_xml( xml, session_id )
       hash = Hash.from_xml( xml )["rsp"]
+      
       hash["images"]["image"].map do |image|
         image.merge!( :image_id => image["id"] )
-        a = Smile::Photo.new( image )
-        a.session_id = session_id
-        a
+        image.merge!( :album_key => image["album"]["key"] )
+        image.merge!( :album_id => image["album"]["id"] )
+        image.delete( 'album' )
+      
+        p = Smile::Photo.new( image )
+        p.session_id = session_id
+        p
       end
     end
+    
+    # This will pull a single image from the smugmug
+    #
+    # * int ImageID
+    # * String Password optional
+    # * String SitePassword optional
+    # * String ImageKey
+    # 
+    def find( options={} )
+      params = default_params.merge(
+          :method => 'smugmug.images.getInfo'
+      )
+      
+      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"] )
+      image.delete( 'album' )
+      
+      p = Smile::Photo.new( image )
+      p.session_id = session_id
+      p
+    end
+  end
+  
+  # This method will return camera and photograph details about the image specified by ImageID.
+  # The Album must be owned by the Session holder, or else be Public (if password-protected, a
+  # Password must be provided), to return results. Otherwise, an "invalid user" faultCode will
+  # result. Additionally, the album owner must have specified that EXIF data is allowed. Note that
+  # many photos have no EXIF data, so an empty or partially returned result is very normal.# 
+  #
+  # Arguments:* 
+  # 
+  # String Password optional
+  # String SitePassword optional
+  #
+  # Result:* struct "Image" [some, none, or all may be returned]
+  # 
+  # int "id"
+  # String "DateTime"
+  # String "DateTimeOriginal"
+  # String "DateTimeDigitized"
+  # String "Make"
+  # String "Model"
+  # String "ExposureTime"
+  # String "Aperture"
+  # int "ISO"
+  # String "FocalLength"
+  # int "FocalLengthIn35mmFilm"
+  # String "CCDWidth"
+  # String "CompressedBitsPerPixel"
+  # int "Flash"
+  # int "Metering"
+  # int "ExposureProgram"
+  # String "ExposureBiasValue"
+  # int "ExposureMode"
+  # int "LightSource"
+  # int "WhiteBalance"
+  # String "DigitalZoomRatio"
+  # int "Contrast"
+  # int "Saturation"
+  # int "Sharpness"
+  # String "SubjectDistance"
+  # int "SubjectDistanceRange"
+  # int "SensingMethod"
+  # String "ColorSpace"
+  # String "Brightness"
+  def details( options =nil )
+    params = default_params.merge(
+      :method => "smugmug.images.getEXIF",
+      :ImageID => self.image_id,
+      :ImageKey => self.key
+    )
+    
+    params.merge!( options ) if( options )
+    xml = RestClient.post Smile::Base::BASE, params
+    
+    rsp = Hash.from_xml( xml )["rsp"]
+    raise rsp["message"] if rsp["stat"] == 'fail'
+      
+    image = Hash.from_xml( xml )["rsp"]["image"]
+    image.merge!( :image_id => image["id"] )
+    
+    OpenStruct.new( image )
+  end
+  
+  # This method will return details about the image specified by ImageID. The Album must be owned
+  # by the Session holder, or else be Public (if password-protected, a Password must be provided),
+  # to return results.. Otherwise, an "invalid user" faultCode will result. Additionally, some
+  # fields are only returned to the Album owner.
+  # 
+  # Arguments:
+  # 
+  # String Password optional
+  # String SitePassword optional
+  #
+  # Result:* struct "Image"
+  # 
+  # int "id"
+  # String "Caption"
+  # int "Position"
+  # int "Serial"
+  # int "Size"
+  # int "Width"
+  # int "Height"
+  # String "LastUpdated"
+  # String "FileName" owner only
+  # String "MD5Sum" owner only
+  # String "Watermark" owner only
+  # Boolean "Hidden" owner only
+  # String "Format"  owner only
+  # String "Keywords" 
+  # String "Date" owner only
+  # String "AlbumURL"
+  # String "TinyURL"
+  # String "ThumbURL"
+  # String "SmallURL"
+  # String "MediumURL"
+  # String "LargeURL" (if available)
+  # String "XLargeURL" (if available)
+  # String "X2LargeURL" (if available)
+  # String "X3LargeURL" (if available)
+  # String "OriginalURL" (if available)
+  # struct "Album"
+  # integer "id"
+  # String "Key"
+  def info( options =nil )
+    params = default_params.merge(
+      :method => "smugmug.images.getInfo",
+      :ImageID => self.image_id,
+      :ImageKey => self.key
+    )
+    
+    params.merge!( options ) if( options )
+    xml = RestClient.post Smile::Base::BASE, params
+    
+    rsp = Hash.from_xml( xml )["rsp"]
+    raise rsp["message"] if rsp["stat"] == 'fail'
+      
+    image = Hash.from_xml( xml )["rsp"]["image"]
+    image.merge!( :image_id => image["id"] )
+    
+    OpenStruct.new( image )  
+  end
+  
+  # This method will return all the URLs for the various sizes of the image specified by
+  # ImageID. The Album must be owned by the Session holder, or else be Public (if
+  # password-protected, a Password must be provided), to return results. Otherwise, an "invalid
+  # user" faultCode will result. Additionally, obvious restrictions on Originals and Larges
+  # apply if so set by the owner. They will return as empty strings for those URLs if they're
+  # unavailable.
+  # 
+  # Arguments:*
+  # 
+  # int TemplateID
+  # optional, specifies which Style to build the AlbumURL with. Default: 3
+  #   Possible values:
+  #     Elegant: 3
+  #     Traditional: 4
+  #     All Thumbs: 7
+  #     Slideshow: 8
+  #     Journal: 9
+  # String Password optional
+  # String SitePassword optional
+  #
+  # Result:* struct
+  # 
+  # String "AlbumURL"
+  # String "TinyURL"
+  # String "ThumbURL"
+  # String "SmallURL"
+  # String "MediumURL"
+  # String "LargeURL" (if available)
+  # String "XLargeURL" (if available)
+  # String "X2LargeURL" (if available)
+  # String "X3LargeURL" (if available)
+  # String "OriginalURL" (if available)
+  def urls( options =nil )
+    params = default_params.merge(
+      :method => "smugmug.images.getURLs",
+      :ImageID => self.image_id,
+      :ImageKey => self.key
+    )
+    
+    params.merge!( options ) if( options )
+    xml = RestClient.post Smile::Base::BASE, params
+    
+    rsp = Hash.from_xml( xml )["rsp"]
+    raise rsp["message"] if rsp["stat"] == 'fail'
+    
+    image = Hash.from_xml( xml )["rsp"]["image"]
+    image.merge!( :image_id => image["id"] )
+    
+    OpenStruct.new( image )  
+  end
+  
+  def album
+    Smile::Album.find( :AlbumID => album_id, :AlbumKey => album_key )
   end
 end

data/lib/smile/smug.rb

@@ -1,3 +1,10 @@
+# 
+#  smug.rb
+#  smile
+#  
+#  Created by Zac Kleinpeter on 2009-04-28.
+#  Copyright 2009 Cajun Country. All rights reserved.
+# 
 module Smile
   class Smug < Smile::Base
  
@@ -16,6 +23,7 @@ module Smile
       nil
     end
 
+    
     def auth_anonymously
       params = default_params.merge(
         :method => 'smugmug.login.anonymously'
@@ -37,21 +45,100 @@ module Smile
       RestClient.post( BASE, params )
     end
 
-=begin
-*  SessionID - string.
-* NickName - string (optional).
-* Heavy - boolean (optional).
-* SitePassword - string (optional).
 
-=end
+    # Retrieves a list of albums for a given user. If you are logged in it will return
+    # your albums.
+    # 
+    # Arguments
+    # NickName - string (optional).
+    # Heavy - boolean (optional).
+    # SitePassword - string (optional).
+    #
+    # Result
+    #     STANDARD RESPONSE
+    # 
+    # array Albums
+    # Album
+    #   integer id
+    #   string Key
+    #   string Title
+    #   struct Category
+    #   string id
+    #   string Name
+    #   struct SubCategory
+    #   string id
+    #   string Name
+    #
+    #     HEAVY RESPONSE
+    #   
+    # array Albums
+    # Album
+    #   integer id
+    #   string Key
+    #   string Title
+    #   struct Category
+    #     string id
+    #     string Name
+    #   struct SubCategory
+    #     string id
+    #     string Name
+    #   string Description
+    #   string Keywords
+    #   boolean Geography (owner)
+    #   integer Position
+    #   struct Hightlight (owner)
+    #     string id
+    #   integer ImageCount
+    #   string LastUpdated
+    #   boolean Header (owner, power & pro only)
+    #   boolean Clean (owner)
+    #   boolean EXIF (owner)
+    #   boolean Filenames (owner)
+    #   struct Template (owner)
+    #     string id
+    #   string SortMethod (owner)
+    #   boolean SortDirection (owner)
+    #   string Password (owner)
+    #   string PasswordHint (owner)
+    #   boolean Public (owner)
+    #   boolean WorldSearchable (owner)
+    #   boolean SmugSearchable (owner)
+    #   boolean External (owner)
+    #   boolean Protected (owner, power & pro only)
+    #   boolean Watermarking (owner, pro only)
+    #   struct Watermark (owner, pro only)
+    #     string id
+    #   boolean HideOwner (owner)
+    #   boolean Larges (owner, pro only)
+    #   boolean XLarges (owner, pro only)
+    #   boolean X2Larges (owner)
+    #   boolean X3Larges (owner)
+    #   boolean Originals (owner)
+    #   boolean CanRank (owner)
+    #   boolean FriendEdit (owner)
+    #   boolean FamilyEdit (owner)
+    #   boolean Comments (owner)
+    #   boolean Share (owner)
+    #   boolean Printable (owner)
+    #   int ColorCorrection (owner)
+    #   boolean DefaultColor (owner, pro only)  deprecated
+    #   integer ProofDays (owner, pro only)
+    #   string Backprinting (owner, pro only)
+    #   float UnsharpAmount (owner, power & pro only)
+    #   float UnsharpRadius (owner, power & pro only)
+    #   float UnsharpThreshold (owner, power & pro only)
+    #   float UnsharpSigma (owner, power & pro only)
+    #   struct Community (owner)
+    #     string id
     def albums( options=nil )
       params = default_params.merge( 
         :method => 'smugmug.albums.get',
         :heavy => 1
-      )
+      )      
 
       params = params.merge( options ) if( options )
       xml = RestClient.post BASE, params
+      
       Smile::Album.from_xml( xml, session_id )
     rescue
       nil

data/test/smile_test.rb

@@ -1,7 +1,63 @@
 require 'test_helper'
 
 class SmileTest < Test::Unit::TestCase
-  should "probably rename this file and start testing for real" do
-    flunk "hey buddy, you should probably rename this file and start testing for real"
+  def setup
+    @smug = Smile::Smug.new
+    @smug.auth_anonymously
+  end
+  
+  def test_auth
+    assert_not_nil( @smug.auth_anonymously )
+  end
+  
+  def test_have_albums
+    assert_nothing_raised(Exception) do
+      assert_not_nil( @smug.albums( :NickName => 'kleinpeter' ) )
+    end
+  end
+  
+  def test_have_photos
+    assert_nothing_raised(Exception) do
+      album = @smug.albums( :NickName => 'kleinpeter' ).first
+      assert_not_nil( album.photos )
+    end
+  end
+  
+  def test_photo_has_album
+    assert_nothing_raised(Exception) do
+      album = @smug.albums( :NickName => 'kleinpeter' ).first
+      photo = album.photos.first
+      assert_equal( album.album_id, photo.album.album_id )
+      assert_equal( album.key, photo.album.key )
+    end
+  end
+  
+  def test_photo_has_album_has_photo
+    assert_nothing_raised(Exception) do
+      album = @smug.albums( :NickName => 'kleinpeter' ).first
+      photo = album.photos.first
+      alt_photo = photo.album.photos.first
+      
+      assert_equal( photo.image_id, alt_photo.image_id )
+    end
+  end
+  
+  # NOTE have to be logged in to test this one
+  # def test_album_stats
+  #   assert_nothing_raised(Exception) do
+  #     album = @smug.albums( :NickName => 'kleinpeter' ).first
+  #     assert_not_nil( album.stats )
+  #   end
+  # end
+  
+  def test_photo_extras
+    assert_nothing_raised(Exception) do
+      album = @smug.albums( :NickName => 'kleinpeter' ).first
+      photo = album.photos.first
+      
+      assert_not_nil( photo.details )
+      assert_not_nil( photo.info )
+      assert_not_nil( photo.urls )
+    end
   end
 end

data/test/test_helper.rb

@@ -1,6 +1,6 @@
 require 'rubygems'
 require 'test/unit'
-require 'shoulda'
+require 'ruby-debug' 
 
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 $LOAD_PATH.unshift(File.dirname(__FILE__))

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: cajun-smile
 version: !ruby/object:Gem::Version 
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors: 
 - cajun
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-04-08 00:00:00 -07:00
+date: 2009-04-29 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -76,10 +76,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   version: 
 requirements: []
 
-rubyforge_project: 
+rubyforge_project: cajun-gems
 rubygems_version: 1.2.0
 signing_key: 
-specification_version: 2
+specification_version: 3
 summary: TODO
 test_files: 
 - test/smile_test.rb