smugmugapi 0.9.0

data/History.txt

@@ -0,0 +1,4 @@
+== 0.9.0 / 2007-12-03
+
+* Initial public release
+

data/Manifest.txt

@@ -0,0 +1,18 @@
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+lib/smugmugapi.rb
+lib/smugmug/core.rb
+lib/smugmug/exception.rb
+lib/smugmug/logon.rb
+lib/smugmug/proxy.rb
+lib/smugmug/upload.rb
+lib/smugmug/utility.rb
+lib/smugmug/xmlstruct.rb
+examples/upload.rb
+test/test_smugmug.rb
+test/test_smugmug.rb
+test/test_smugmug.rb
+test/test_utility.rb
+test/test_xmlstruct.rb

data/README.txt

@@ -0,0 +1,61 @@
+smugmug
+    by Patrick Hurley
+    http://rubygorge.org/projects/sumgmugapi/
+
+== DESCRIPTION:
+  
+A very light wrapper around the 1.2.0 and 1.2.1 REST API at SmugMug 
+(http://smugmug.com/). The syntax is almost identical to the one 
+described at the wiki (http://smugmug.jot.com/WikiHome/1.2.0). 
+
+== FEATURES/PROBLEMS:
+  
+I have written some simple tests of my "local" code, but have not 
+attempted to mock out SmugMug or write a bunch of fragile hard coded 
+tests.
+
+On top of that I just put the code together without tests as I was
+"testing" against the API. So there are a few more rough edges than
+I like, but it does seem to work :-)
+
+So I know there will be bugs, sorry -- please let me know when you 
+find them and I will try and fix them as quickly as possible.
+
+== SYNOPSIS:
+
+See examples sub-directory, have a question (or a good example),
+please drop me an email and I will add it to the examples directory,
+at least till we get real documentation (don't hold your breath :-)
+
+== REQUIREMENTS:
+
+Internet tubes
+
+== INSTALL:
+
+sudo gem install smugmugapi
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2007 Patrick Hurley
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,15 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+require './lib/smugmugapi.rb'
+
+Hoe.new('smugmugapi', SmugMugAPI::VERSION) do |p|
+  p.rubyforge_name = 'smugmugapi'
+  p.author = 'Patrick Hurley'
+  p.email = 'phurley@gmail.com'
+  p.summary = 'A very light wrapper around the SmugMug REST API'
+  p.description = p.paragraphs_of('README.txt', 2..5).join("\n\n")
+  p.url = p.paragraphs_of('README.txt', 0).first.split(/\n/)[1..-1]
+  p.changes = p.paragraphs_of('History.txt', 0..1).join("\n\n")
+end

data/examples/upload.rb

@@ -0,0 +1,19 @@
+require "rubygems"
+require "smugmugapi"
+
+# And you thought I would put my password here for you :-)
+smugmug.login("phurley@gmail.com", IO.read('password')) do
+  
+  category = smugmug.categories.get.find { |e| e.title.match(/family/i) }.id
+  
+  album = smugmug.albums.create(
+    :title => 'Test Album',
+    :category_id => category,
+    :description => 'Just made this album',
+    :keywords => 'blue apple foo bar'
+  )  
+  album = album.id
+   
+  puts smugmug.upload('mona_lisa.jpg', :album_id => album, :caption => "Wow it actually works")
+  
+end

data/lib/smugmug/core.rb

@@ -0,0 +1,88 @@
+require "rexml/document"
+require "uri"
+require "net/https"
+
+class SmugMugAPI
+  class << self
+    USERAGENT = "SumMug Ruby API Library"
+
+    attr_writer :api_key, :agent, :api_version, :default_params
+
+    def default_params
+      @default_params ||= { :APIKey => api_key }
+    end
+
+    def api_version
+      @api_version || '1.2.0'
+    end
+    
+    def api_key
+      @api_key || 'RXcw7ywveg9pEj1n6HBJfuDXqsFsx4jw'
+    end
+
+    def api_path
+      @url || "api.smugmug.com/hack/rest/#{api_version}/"
+    end
+
+    def agent
+      @agent || USERAGENT
+    end
+
+    def groups
+      # it would be better to have a smugmug reflection method to 
+      # get this information but this is a fairly exhaustive list 
+      # and it will be easy to add to this as well
+      %w(albums albumtemplates categories images login subcategories users 
+      
+         communities family friends orders pricing propricing sharegroups 
+         styles themes watermarks)
+    end
+    
+    def get(passed_params, headers={}, transport='http')
+      params = default_params.merge(passed_params)
+
+      url = transport + "://" + api_path + "?" +
+        params.map { |k,v| URI.encode("#{SmugMugAPI.camelize(k)}=#{v}") }.join("&")
+      uri = URI.parse(url)
+      headers['User-Agent'] = agent
+      
+      http = Net::HTTP.new(uri.host, uri.port)
+      if transport == 'https'
+        http.use_ssl     = true
+        http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      end
+
+      http.start do
+        http.get(uri.path + '?' + uri.query, headers)
+      end
+    end
+
+    def parse_response(response)
+      puts "HTTP #{response.code}: #{response.message}" if $DEBUG
+      
+      raise SmugMugAPI::Error.new("HTTP #{response.code} on #{url}") unless response.code.to_i == 200
+      
+      doc = REXML::Document.new(response.body)
+      if doc.root.attributes['stat'] != 'ok'
+        err = doc.root.elements['/rsp/err']
+        code = err.attributes['code']
+        msg = err.attributes['msg']
+        raise SmugMugAPI::Error.new("#{code}: #{msg}")
+      end
+
+      XMLStruct.new(doc)      
+    end
+    
+    def https_call(params={})
+      call(params, 'https')
+    end
+    
+    def http_call(params={})
+      call(params, 'http')
+    end
+    
+    def call(params={}, transport = "http")
+      parse_response(get(params, {}, transport))
+    end
+  end
+end

data/lib/smugmug/exception.rb

@@ -0,0 +1,4 @@
+class SmugMugAPI
+  class Error < Exception
+  end
+end

data/lib/smugmug/logon.rb

@@ -0,0 +1,49 @@
+class SmugMugAPI
+
+  def login(email, password)
+    res = SmugMugAPI.https_call(
+    :method => 'smugmug.login.withPassword',
+    :EmailAddress => email,
+    :Password => password
+    )
+
+    SmugMugAPI.default_params[:SessionID] = res.session.id
+
+    if block_given?
+      begin
+        yield res
+      ensure
+        logout
+      end
+    else
+      res
+    end
+  end
+
+  def login_with_hash(user, hash)
+    res = SmugMugAPI.https_call(
+      :method       => 'smugmug.login.withHash',
+      :UserID       => user,
+      :PasswordHash => hash
+    )
+
+    SmugMugAPI.default_params[:SessionID] = res.session.id
+
+    if block_given?
+      begin
+        yield res
+      ensure
+        logout
+      end
+    else
+      res
+    end
+  end
+
+  def logout
+    result = SmugMugAPI.call(:method => 'smugmug.logout')
+    SmugMugAPI.default_params.delete(:SessionID)
+    result
+  end
+
+end

data/lib/smugmug/proxy.rb

@@ -0,0 +1,37 @@
+require "xmlstruct"
+
+class SmugProxy
+  def initialize(base="", params = {})
+    @base = base
+    @params = params
+  end
+  
+  def method_missing(method, params={})
+    method = method.to_s.gsub(/_(.)/) { $1.upcase }
+    method = method.gsub(/URL/i, "URL").gsub(/EXIF/i, "EXIF")
+    
+    # it would be better to have a smugmug reflection method to get this information
+    # but this is a fairly exhaustive list and it will be easy to add to this as well
+    groups = %w(albums albumtemplates categories images login subcategories users 
+                communities family friends orders pricing propricing sharegroups styles themes watermarks)
+                
+    if groups.include?(method)  
+      SmugProxy.new(@base + "." + method.to_s, params)
+    else
+      puts "CALL: #{@base + "." + method}(#{params.inspect})"
+    end
+  end
+  
+  def to_s
+    @base + "(#{@params.inspect})"
+  end
+end
+
+sm = SmugProxy.new("smugmug")
+puts sm
+
+sm.users.get_tree("wow")
+sm.users.getTree("wow")
+sm.images.images.family.getURLs
+sm.images.get_urls
+

data/lib/smugmug/upload.rb

@@ -0,0 +1,29 @@
+require 'digest/md5'
+require "pp"
+
+class SmugMugAPI
+
+  def upload(fname, params={})
+    base_name = File.basename(fname)
+    uri = URI.parse("http://upload.smugmug.com/#{base_name}")
+    image = IO::read(fname)
+
+    Net::HTTP.start(uri.host, uri.port) do |http|
+      headers = {
+        'Content-Type'  => 'image/jpeg',
+        'Content-Lenth' => image.size.to_s,
+        'Content-MD5'   => Digest::MD5.hexdigest(image),
+        'X-Smug-SessionID' => SmugMugAPI.default_params[:SessionID],
+        'X-Smug-Version'   => SmugMugAPI.api_version,
+        'X-Smug-ResponseType' => 'REST',
+        'X-Smug-FileName' => base_name
+      }
+
+      adjusted_headers = Hash[*params.map { |k,v| [ "X-Smug-" + SmugMugAPI.camelize(k), v.to_s ] }.flatten ]
+      headers = headers.merge(adjusted_headers)
+
+      resp = http.send_request('PUT', uri.request_uri, image, headers)
+      SmugMugAPI.parse_response(resp)
+    end
+  end
+end

data/lib/smugmug/utility.rb

@@ -0,0 +1,15 @@
+class SmugMugAPI
+  def self.camelize(str, upcase_first_char = true)
+    if upcase_first_char
+      str = str.to_s.gsub(/(^|_)(.)/) { $2.upcase }
+    else
+      str = str.to_s.gsub(/_(.)/) { $1.upcase }
+    end
+    str = str.gsub(/URL/i, "URL").gsub(/EXIF/i, "EXIF")
+    str = str.gsub(/(?!^)ID$/i, "ID")
+    str = str.gsub(/EXIF/i, "EXIF")
+    str = str.gsub(/X(.?)Large/i) { "X#{$1}Large" }
+    str = "method" if str == "Method" #special case
+    str
+  end  
+end

data/lib/smugmug/xmlstruct.rb

@@ -0,0 +1,88 @@
+
+class SmugMugAPI
+  class XMLStruct
+    include Enumerable
+    
+    def id(*args)
+      method_missing(:id, *args)
+    end
+
+    def initialize(xml)
+      if xml.is_a?(REXML::Document)
+        @xml = xml.root.elements[2]
+      else
+        @xml = xml
+      end
+    end
+
+    def self.attrib_key(key)
+      case key
+      when "Id", "id", :id
+        "id"
+      when Fixnum
+        key
+      else
+        key = XMLStruct.camalize(key)
+        key = key.gsub(/ID$/i, "ID")
+        key = key.gsub(/EXIF/i, "EXIF")
+        key.gsub(/X(.?)Large/i) { "X#{$1}Large" }
+      end
+    end
+    
+    def [](attrib)
+      if attrib.is_a?(Fixnum)
+        # puts "Finding #{attrib} hmmm: #{@xml.elements[attrib]}"
+        result = XMLStruct.new(@xml.elements[attrib])
+        # puts "Found #{result}"
+        result
+      else
+        # key = XMLStruct.attrib_key(attrib)
+        @xml.attributes[XMLStruct.attrib_key(attrib)]
+      end
+    end
+    
+    def first
+      XMLStruct.new(@xml.elements[1])
+    end
+    
+    def size
+      @xml.elements.size
+    end
+    
+    def empty?
+      size == 0
+    end
+    
+    def last
+      XMLStruct.new(@xml.elements[@xml.elements.size])
+    end
+    
+    def []=(attrib,value)
+      @xml.attributes[XMLStruct.attrib_key(attrib)] = value
+    end
+
+    def each
+      @xml.elements.each do |xml|
+        yield XMLStruct.new(xml)
+      end
+    end
+
+    def method_missing(*args)
+      method = XMLStruct.camalize(args.shift)
+      path = "#{method}"
+      if node = @xml.elements[path]
+        XMLStruct.new(node)
+      else
+        self[method]
+      end
+    end
+
+    def self.camalize(str)
+      str.to_s.gsub(/(^|_)(.)/) { $2.upcase }
+    end
+
+    def to_s
+      @xml.to_s
+    end
+  end
+end

data/lib/smugmugapi.rb

@@ -0,0 +1,33 @@
+require File.join(File.dirname(__FILE__), "smugmug/core")
+require File.join(File.dirname(__FILE__), "smugmug/utility")
+require File.join(File.dirname(__FILE__), "smugmug/xmlstruct")
+require File.join(File.dirname(__FILE__), "smugmug/exception")
+require File.join(File.dirname(__FILE__), "smugmug/upload")
+require File.join(File.dirname(__FILE__), "smugmug/logon")
+
+class SmugMugAPI
+  VERSION = "0.9.0"
+  
+  def initialize(base="smugmug")
+    @base = base
+  end
+  
+  def method_missing(method, *params)
+    cmd = @base + "." + SmugMugAPI.camelize(method, false)
+    if SmugMugAPI.groups.include?(method.to_s)
+      SmugMugAPI.new(cmd)
+    else
+      param_hash = params.first || {}
+      SmugMugAPI.call(
+        { :method => cmd }.merge(param_hash)
+      )
+    end  
+  end
+end
+
+# added here for pretty interface
+module Kernel
+  def smugmug(*params)
+    @smugmug ||= SmugMugAPI.new
+  end
+end

data/test/test_smugmug.rb

@@ -0,0 +1,10 @@
+require "test/unit"
+
+require "smugmugapi"
+
+class TestSmugMugAPI < Test::Unit::TestCase
+  def test_case_name
+    assert(1 == 1)
+    # how to test something that is build on top of an online service...
+  end
+end

data/test/test_utility.rb

@@ -0,0 +1,22 @@
+require "test/unit"
+
+require "smugmugapi"
+
+class TestUtility < Test::Unit::TestCase
+  
+  def test_camelize_specials
+    # special cases, used to smooth out the meta madness
+    test_data = [
+      ["PhotoID",    "photo_id"],
+      ["PhotoEXIF",  "photo_exif"],
+      ["PhotoURL",   "photo_url"],
+      ["X3Large",    "x3_large"],
+      ["X3Large",    "x3large"],
+      ["method",     "method"],    
+    ]
+    
+    test_data.each do |expected, raw|
+      assert_equal(expected, SmugMugAPI.camelize(raw))
+    end
+  end
+end

data/test/test_xmlstruct.rb

@@ -0,0 +1,44 @@
+require "test/unit"
+
+require "smugmugapi"
+
+class TestXMLStruct < Test::Unit::TestCase
+  ALBUM = <<EOF
+  <?xml version='1.0' encoding='UTF-8'?>
+  <rsp stat='ok'>
+    <method>smugmug.albums.get</method>
+    <Albums>
+      <Album id='3903818' Title='Decorating for xmas 2007' Passworded='0' ImageCount='7'>
+        <Category Name='Holidays' id='31'/>
+      </Album>
+      <Album id='3903815' Title='Misc Fall 2007' Passworded='0' ImageCount='11'>
+        <Category Name='Other' id='0'/>
+      </Album>
+      <Album id='3903813' Title='Pat&apos;s 40th Birthday' Passworded='0' ImageCount='23'>
+        <Category Name='Other' id='0'/>
+      </Album>
+      <Album id='3903805' Title='Hurleyhome' Passworded='0' ImageCount='0'>
+        <Category Name='Family' id='9'/>
+      </Album>
+    </Albums>
+  </rsp>
+EOF
+
+  def test_album_queries
+    albums = SmugMugAPI::XMLStruct.new(REXML::Document.new(ALBUM))
+    
+    assert_equal(4, albums.size)
+    assert_equal(31, albums[1].category.id.to_i)
+    assert_equal('Holidays', albums[1].category.name)    
+    assert_equal('Other', albums[2].category.name)
+    assert_equal('Family', albums.last.category.name)
+    
+    assert_equal("Holidays", albums.first.category.name)
+    assert_equal("Decorating for xmas 2007", albums.first.title)
+    
+    assert_equal("Pat's 40th Birthday", albums[3].title)
+  end
+  
+  # need many more tests for my meta maddness
+  # feel free to write lots of tests :-)
+end

data.tar.gz.sig

@@ -0,0 +1,2 @@
+2�e�3�鲌Ǡ��2#�v���r���8ܖz��1����C���z��<OW�a+��@�ɥ�XH�#	b�\���|JZ�x������4��QN���u���VԸ�"��7� I&���9��ؿ�޾����J����)�G���)��ݿ
+ø�b$#ٞ�����l+�8!�U��-t:���7w��K���r���(=L�+�

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.9.4
+specification_version: 1
+name: smugmugapi
+version: !ruby/object:Gem::Version 
+  version: 0.9.0
+date: 2007-12-03 00:00:00 -05:00
+summary: A very light wrapper around the SmugMug REST API
+require_paths: 
+- lib
+email: phurley@gmail.com
+homepage: "    by Patrick Hurley"
+rubyforge_project: smugmugapi
+description: "== FEATURES/PROBLEMS:  I have written some simple tests of my \"local\" code, but have not  attempted to mock out SmugMug or write a bunch of fragile hard coded  tests.  On top of that I just put the code together without tests as I was \"testing\" against the API. So there are a few more rough edges than I like, but it does seem to work :-)  So I know there will be bugs, sorry -- please let me know when you  find them and I will try and fix them as quickly as possible.  == SYNOPSIS:"
+autorequire: 
+default_executable: 
+bindir: bin
+has_rdoc: true
+required_ruby_version: !ruby/object:Gem::Version::Requirement 
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      version: 0.0.0
+  version: 
+platform: ruby
+signing_key: 
+cert_chain: 
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIDMDCCAhigAwIBAgIBADANBgkqhkiG9w0BAQUFADA+MRAwDgYDVQQDDAdwaHVy
+  bGV5MRUwEwYKCZImiZPyLGQBGRYFZ21haWwxEzARBgoJkiaJk/IsZAEZFgNjb20w
+  HhcNMDcxMjAzMjAyNjU5WhcNMDgxMjAyMjAyNjU5WjA+MRAwDgYDVQQDDAdwaHVy
+  bGV5MRUwEwYKCZImiZPyLGQBGRYFZ21haWwxEzARBgoJkiaJk/IsZAEZFgNjb20w
+  ggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQC00L0dHlSg1NL6oIUrcRBs
+  pU9MtYdRjYTqR+tERyl5Wk8UNIFuzIQNpeMrzg2NOe4O6xxycr8wzZ4w64LYxrtd
+  uzII7tJOJd5HchVGi31EDPpc+oHSeNPkOtOjIWkpkfdHSuyqpQcyvXb6sdmF9LGU
+  vZGoPdesijBE5hzQvZ2IOeXKZh+i5I4/HoXbd7vS6h5mxTDM3LUATxt7AdHgmq7R
+  8XSib1pDniYAx5jPOc++aN3pGkCXragDa48CssEHMCgTE8hsYTOPNeN8BMCkit/r
+  py7uigHQ3ZCMc9g77WAHuJ5BR2kpZgdy/GQd9NgAGhJqr2Agd3ksGeGL2cgHDat9
+  AgMBAAGjOTA3MAkGA1UdEwQCMAAwCwYDVR0PBAQDAgSwMB0GA1UdDgQWBBSP1Olh
+  sOUBB6iyLHQFmbbUttDd9jANBgkqhkiG9w0BAQUFAAOCAQEAj6jHhZBNrhzYIUrv
+  DUUQ++8/9jCO2+NjBQC7O3Vme0bloMJtErIw4kHYICBaAbpk26Csx+0As4vquDmo
+  LJwA/nXRbJSB3rj9kAU4nWaWQhIyrm0R+Vt5WENNeo4FoBaZvkb/ghE0Ywni1aLq
+  9fvn84MwVZzQenvY1drn9jARZH+eq/NDOUloFlndccrYeBgoZJKi81xYuzwgjzU0
+  +aeEWr1e/UCRL8/zg7K6ywuEbeCTszJfK0pWSbFkMMm+ZRgvgsKx3E3C0KZUUz/1
+  alHFBzBR9j68NPrORviWlClOXtvA16AyJPfIb/tJiSN11RZC2lyVwIdK3/1L/ckA
+  9WgvxA==
+  -----END CERTIFICATE-----
+
+post_install_message: 
+authors: 
+- Patrick Hurley
+files: 
+- History.txt
+- Manifest.txt
+- README.txt
+- Rakefile
+- lib/smugmugapi.rb
+- lib/smugmug/core.rb
+- lib/smugmug/exception.rb
+- lib/smugmug/logon.rb
+- lib/smugmug/proxy.rb
+- lib/smugmug/upload.rb
+- lib/smugmug/utility.rb
+- lib/smugmug/xmlstruct.rb
+- examples/upload.rb
+- test/test_smugmug.rb
+- test/test_utility.rb
+- test/test_xmlstruct.rb
+test_files: 
+- test/test_smugmug.rb
+- test/test_utility.rb
+- test/test_xmlstruct.rb
+rdoc_options: 
+- --main
+- README.txt
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.txt
+executables: []
+
+extensions: []
+
+requirements: []
+
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Version::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.3.0
+    version: