smile 0.2.0 → 0.2.1

data/VERSION.yml

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

data/lib/smile/album.rb

@@ -1,6 +1,79 @@
-# 
-#  album.rb
-#  smile
+ # 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
 #  
 #  Created by Zac Kleinpeter on 2009-04-28.
 #  Copyright 2009 Cajun Country. All rights reserved.
@@ -8,9 +81,11 @@
 class Smile::Album < Smile::Base
 
   class << self
-    def from_xml( xml, session_id )
-      hash = Hash.from_xml( xml )["rsp"]
-      hash["albums"]["album"].map do |album|
+    def from_json( json, session_id )
+      result = JSON.parse( json )
+      result["Albums"].map do |album_upcase|
+        album = upper_hash_to_lower_hash( album_upcase )
+        
         album.merge!( :album_id => album["id"] )
         
         a = Smile::Album.new( album )
@@ -34,9 +109,10 @@ class Smile::Album < Smile::Base
       
       params.merge!( options ) if( options )
       
-      xml = RestClient.post Smile::Base::BASE, params
+      json = RestClient.post Smile::Base::BASE, params
       
-      album = Hash.from_xml( xml )["rsp"]["album"]
+      album_upper = JSON.parse(json)
+      album = upper_hash_to_lower_hash( album_upper['Album'] )
       album.merge!( :album_id => album["id"] )
       
       a = Smile::Album.new( album )
@@ -62,8 +138,8 @@ class Smile::Album < Smile::Base
 
     params.merge!( options ) if( options )
     
-    xml = RestClient.post BASE, params
-    Smile::Photo.from_xml( xml, session_id )
+    json = RestClient.post BASE, params
+    Smile::Photo.from_json( json, session_id )
   end
   
   # * integer AlbumID
@@ -80,10 +156,35 @@ class Smile::Album < Smile::Base
     
     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"]
+    json = RestClient.post Smile::Base::BASE, params
+    
+    json = JSON.parse( json )
+    raise json["message"] if json["stat"] == 'fail'
+      
+    image = upper_hash_to_lower_hash( json['Album'] )
     OpenStruct.new( hash )
   end
+  
+  def add( payload, options={} )
+    if( File.exists?( payload ) )
+    RestClient.put BASE, payload,
+      :content_length => File.size( payload ),
+      :content_md5 => '?',
+      :x_smug_sessionid => session_id,
+      :x_smug_version => VERSION,
+      :x_smug_albumid => album_id,
+      :x_smug_filename => File.basename( payload ),
+      :x_smug_caption => options[:caption],
+      :x_smug_keywords => options[:keywords],
+      :x_smug_latitude => options[:latitude],
+      :x_smug_longitude => options[:longitude],
+      :x_smug_altitude => options[:altitude]
+    else
+      Exception.new( "Cannot find file #{payload}." )
+    end
+  end
+  
+  def category
+    ['category']
+  end
 end

data/lib/smile/base.rb

@@ -7,10 +7,12 @@
 # 
 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/'
+    BASE = 'http://api.smugmug.com/hack/json/1.2.0/'
+    BASE_SECURE = 'https://api.smugmug.com/hack/json/1.2.0/'
     API = 'HSoqGCJ8ilF42BeThMGDZqqqOgj1eXqN'
 
+    VERSION = '1.2.0'
+    
     class << self
       attr_accessor :session_id
       # This will be included in every request once you have logged in
@@ -29,6 +31,19 @@ module Smile
           self.session_id = smug.session_id
         end
       end
+      
+      def upper_hash_to_lower_hash( upper )
+        if( Hash === upper )
+          lower ={}
+          upper.each_pair do |key, value|
+            lower[key.downcase] = upper_hash_to_lower_hash( value )
+          end
+          lower
+        else
+          upper
+        end
+      end
+      
     end
     
     attr_accessor :session_id
@@ -36,5 +51,9 @@ module Smile
       self.class.session_id = self.session_id
       self.class.default_params
     end
+
+    def upper_hash_to_lower_hash( hash )
+      self.class.upper_hash_to_lower_hash( hash )
+    end
   end
 end

data/lib/smile/param_converter.rb

@@ -43,6 +43,8 @@ module Smile::ParamConverter
         key = :ImageKey
       when :image_count
         key = :ImageCount
+      when :nickname, :nick_name
+        key = :NickName
       else
         key = param
     end

data/lib/smile/photo.rb

@@ -9,10 +9,11 @@ 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"]
+    def from_json( json, session_id )
+      result = JSON.parse( json )
       
-      hash["images"]["image"].map do |image|
+      result["Images"].map do |image_upper|
+        image = upper_hash_to_lower_hash( image_upper )
         image.merge!( :image_id => image["id"] )
         image.merge!( :album_key => image["album"]["key"] )
         image.merge!( :album_id => image["album"]["id"] )
@@ -40,8 +41,9 @@ class Smile::Photo < Smile::Base
       )
       
       params.merge!( options ) if( options )
-      xml = RestClient.post Smile::Base::BASE, params
-      image = Hash.from_xml( xml )["rsp"]["image"]
+      json = RestClient.post Smile::Base::BASE, params
+      image_upper = JSON.parse( json )
+      image = upper_hash_to_lower_hash( image_upper['Image'] )
       
       image.merge!( :image_id => image["id"] )
       image.merge!( :album_key => image["album"]["key"] )
@@ -104,12 +106,12 @@ class Smile::Photo < Smile::Base
     )
     
     params.merge!( options ) if( options )
-    xml = RestClient.post Smile::Base::BASE, params
+    json = RestClient.post Smile::Base::BASE, params
     
-    rsp = Hash.from_xml( xml )["rsp"]
-    raise rsp["message"] if rsp["stat"] == 'fail'
+    json = JSON.parse( json )
+    raise json["message"] if json["stat"] == 'fail'
       
-    image = Hash.from_xml( xml )["rsp"]["image"]
+    image = upper_hash_to_lower_hash( json['Image'] )
     image.merge!( :image_id => image["id"] )
     
     OpenStruct.new( image )
@@ -163,12 +165,12 @@ class Smile::Photo < Smile::Base
     )
     
     params.merge!( options ) if( options )
-    xml = RestClient.post Smile::Base::BASE, params
+    json = RestClient.post Smile::Base::BASE, params
     
-    rsp = Hash.from_xml( xml )["rsp"]
-    raise rsp["message"] if rsp["stat"] == 'fail'
+    json = JSON.parse( json )
+    raise json["message"] if json["stat"] == 'fail'
       
-    image = Hash.from_xml( xml )["rsp"]["image"]
+    image = upper_hash_to_lower_hash( json['Image'] )
     image.merge!( :image_id => image["id"] )
     
     OpenStruct.new( image )  
@@ -214,12 +216,12 @@ class Smile::Photo < Smile::Base
     )
     
     params.merge!( options ) if( options )
-    xml = RestClient.post Smile::Base::BASE, params
+    json = 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"]
+    json = JSON.parse( json )
+    raise json["message"] if json["stat"] == 'fail'
+      
+    image = upper_hash_to_lower_hash( json['Image'] )
     image.merge!( :image_id => image["id"] )
     
     OpenStruct.new( image )  

data/lib/smile/smug.rb

@@ -8,6 +8,12 @@
 module Smile
   class Smug < Smile::Base
  
+    # Login to SmugMug using a specific user account.
+    #
+    # @param [String] email 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( email, pass )
      params = default_params.merge(
         :method => 'smugmug.login.withPassword',
@@ -15,28 +21,33 @@ module Smile
         :Password => pass
       )
 
-      xml = RestClient.post( BASE, params )
-      result = Hash.from_xml( xml )["rsp"]["login"]
-      self.session_id = result["session"]["id"]
+      json = RestClient.post( BASE, params )
+      result = JSON.parse( json )
+      
+      self.session_id = result["Login"]["Session"]["id"]
       result
     rescue NoMethodError => e
       nil
     end
 
-    
+    # Login to SmugMug using an anonymously account
+    # This will allow you to execute many functions, but no user specific functions
+    #
+    # @return [Smile::SmugMug.new] An Smug object that has been authenticated
     def auth_anonymously
       params = default_params.merge(
         :method => 'smugmug.login.anonymously'
       )
 
-      xml = RestClient.post( BASE, params )
-      result = Hash.from_xml( xml )["rsp"]["login"]
-      self.session_id = result["session"]["id"]
+      json = RestClient.post( BASE, params )
+      result = JSON.parse( json )
+      self.session_id = result["Login"]["Session"]["id"]
       result
     rescue NoMethodError => e
       nil
     end
 
+    # Close the session
     def logout
       params = default_params.merge(
         :method => 'smugmug.logout'
@@ -50,87 +61,16 @@ module Smile
     # 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).
+    # @param [optional,Hash] options The magic options hash all ruby devs love
+    # @option options [optional, String] :nick_name If no nick name is supplied then...
+    # @option options [optional, true or false ] :heavy ('true') This will control how much 
+    # information is returned about the album
+    # @option options [optional, String] :site_password If you have not logged in then you can provide the 
+    # password here to access private information.
     #
-    # Result
-    #     STANDARD RESPONSE
+    # @return [Array<Smile::Album>]
     # 
-    # 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
+    # @see Smug::Album#new For more information about heavy ( true and false ) responces
     def albums( options=nil )
       params = default_params.merge( 
         :method => 'smugmug.albums.get',
@@ -138,9 +78,9 @@ module Smile
       )      
 
       params = params.merge( options ) if( options )
-      xml = RestClient.post BASE, params
+      json = RestClient.post BASE, params
       
-      Smile::Album.from_xml( xml, session_id )
+      Smile::Album.from_json( json, session_id )
     rescue
       nil
     end

data/lib/smile.rb

@@ -8,10 +8,15 @@ require 'lib/smile/photo'
 require 'lib/smile/param_converter'
 require 'cgi'
 require 'rss'
+require 'json'
 
 module Smile
   module_function
   
+  # Login to SmugMug using an anonymously account
+  # This will allow you to execute many functions, but no user specific functions
+  #
+  # @return [Smile::SmugMug.new] An Smug object that has been authenticated
   def auth_anonymously
     smug = Smile::Smug.new
     smug.auth_anonymously
@@ -20,16 +25,17 @@ module Smile
   
   # Login to SmugMug using a specific user account.
   #
-  # @param [String] username The username ( Nickname ) for the SmugMug account
+  # @param [String] email The username ( e-mail address ) 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 )
+  def auth( email, password )
     smug = Smile::Smug.new
-    smug.auth( username, password )
+    smug.auth( email, password )
     smug
   end
   
+  
   def base_feed( options={} )
     options.merge!( :format => 'rss' )
     url = "http://api.smugmug.com/hack/feed.mg?"

data/smile.gemspec

@@ -2,11 +2,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{smile}
-  s.version = "0.2.0"
+  s.version = "0.2.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["cajun"]
-  s.date = %q{2009-07-11}
+  s.date = %q{2009-08-21}
   s.email = %q{zac@kleinpeter.org}
   s.extra_rdoc_files = [
     "LICENSE",
@@ -32,7 +32,7 @@ Gem::Specification.new do |s|
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
   s.rubyforge_project = %q{cajun-gems}
-  s.rubygems_version = %q{1.3.4}
+  s.rubygems_version = %q{1.3.5}
   s.summary = %q{Simple API for talking to SmugMug}
   s.test_files = [
     "test/smile_test.rb",

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: smile
 version: !ruby/object:Gem::Version 
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors: 
 - cajun
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-07-11 00:00:00 -05:00
+date: 2009-08-21 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -80,7 +80,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: cajun-gems
-rubygems_version: 1.3.4
+rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3
 summary: Simple API for talking to SmugMug