smirk 0.0.4 → 0.0.5

data/README.rdoc

@@ -1,7 +1,35 @@
 = smirk
 
-Description goes here.
+Smirk is a Ruby wrapper around the SmugMug 1.2.2 API.  You can access the albums, images, and categories behind
+an authenticated account.
 
+== Usage
+
+First, you need to start a session with your SmugMug username and password.
+
+  smug = Smirk::Client.new("you@example.com", "mypassword")
+  
+You can call albums, categories, find_image, and find_album methods on a Client object.
+
+  smug.albums.map(&:title).join(", ")
+  => "Trees, Flowers, Birds"
+  
+  smug.categories.map(&:nicename).join(", ")
+  => "Airplanes, Animals, Aquariums, Architecture, Art"
+
+You can gather all the images within albums.  
+  
+  smug.albums.each do |a|
+    a.images.map(&:filename).join(", ")
+  end
+  => "IMG_513.jpg, IMG_514.jpg, IMG_515.jpg"
+
+When you're done, you should logout to terminate the session:
+
+  smug.logout
+  
+More documentation to come.
+  
 == Note on Patches/Pull Requests
  
 * Fork the project.

data/VERSION

@@ -1 +1 @@
-0.0.4
+0.0.5

data/lib/smirk/album.rb

@@ -1,8 +1,6 @@
 module Smirk
   class Album < Client
     
-    attr_reader :session_id
-    
     def initialize(session_id, info)
       info.each do |key, value|
         instance_variable_set("@#{key.downcase}", value)
@@ -13,11 +11,11 @@ module Smirk
       @session_id = session_id
     end
     
-    def images
-      params = default_params.merge!({:method => "smugmug.images.get", :AlbumID => id, :AlbumKey => key})
-      json = get(HOST, params)["Album"]["Images"]
+    def images(heavy = false)
+      params = default_params.merge!({:method => "smugmug.images.get", :AlbumID => id, :AlbumKey => key, :Heavy => heavy})
+      json = get(params)["Album"]["Images"]
       json.inject([]) do |images, i|
-        images << Smirk::Image.new(session_id, i)
+        images << Smirk::Image.new(@session_id, i)
       end
     end
     

data/lib/smirk/category.rb

@@ -1,8 +1,6 @@
 module Smirk
   class Category < Client
     
-    attr_reader :session_id
-    
     def initialize(session_id, info)
       info.each do |key, value|
         instance_variable_set("@#{key.downcase}", value)

data/lib/smirk/client.rb

@@ -5,23 +5,23 @@ module Smirk
     API_KEY = "26Kw6kit9TBk2yFcYEwv2wWajATGYs1F"
     HOST = "api.smugmug.com/services/api/json/1.2.2/"
   
-    attr_reader :user, :password, :session_id
+    attr_reader :session_id
  
     def initialize(user, password)
       @user = user
       @password = password
       params = { :method => "smugmug.login.withPassword", :APIKey => API_KEY, :EmailAddress => user, :Password => password }
-      @session_id = get(HOST, params, true)['Login']['Session']['id']
+      @session_id = get(params, true)['Login']['Session']['id']
     end
     
     def logout
       params = default_params.merge!(:method => "smugmug.logout")
-      get(HOST, params)
+      get(params)
     end
     
-    def albums
-      params = default_params.merge!(:method => "smugmug.albums.get")
-      json = get(HOST, params)["Albums"]
+    def albums(heavy => false)
+      params = default_params.merge!({:method => "smugmug.albums.get", :Heavy => heavy})
+      json = get(params)["Albums"]
       json.inject([]) do |albums, a|
         albums << Smirk::Album.new(session_id, a)
       end
@@ -29,7 +29,7 @@ module Smirk
     
     def categories
       params = default_params.merge!(:method => "smugmug.categories.get")
-      json = get(HOST, params)["Categories"]
+      json = get(params)["Categories"]
       json.inject([]) do |categories, c|
         categories << Smirk::Category.new(session_id, c)
       end
@@ -37,21 +37,21 @@ module Smirk
     
     def find_album(id, key)
       params = default_params.merge!({:method => "smugmug.albums.getInfo", :AlbumID => id, :AlbumKey => key})
-      a = get(HOST, params)["Album"]
+      a = get(params)["Album"]
       Smirk::Album.new(session_id, a)
     end
     
     def find_image(id, key)
       params = default_params.merge!({:method => "smugmug.images.getInfo", :ImageID => id, :ImageKey => key})
-      i = get(HOST, params)["Image"]
+      i = get(params)["Image"]
       Smirk::Image.new(session_id, i)
     end
     
     private
   
-    def get(uri, params = {}, ssl = false)
+    def get(params = {}, ssl = false)
       proto = ssl ? "https://" : "http://"
-      JSON.parse(RestClient.post proto+uri, params)
+      JSON.parse(RestClient.post proto+HOST, params)
     end
     
     def default_params

data/lib/smirk/image.rb

@@ -1,8 +1,6 @@
 module Smirk
   class Image < Client
     
-    attr_reader :session_id
-    
     def initialize(session_id, info)
       info.each do |key, value|
         instance_variable_set("@#{key.downcase}", value)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: smirk
 version: !ruby/object:Gem::Version 
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors: 
 - James Miller
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-02-10 00:00:00 -08:00
+date: 2010-02-12 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency