adobeshare 0.0.2

data/History.txt

@@ -0,0 +1,4 @@
+== 0.0.1 2007-10-08
+
+* 1 major enhancement:
+  * Initial release

data/License.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2007 KATO Hideyuki
+
+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/Manifest.txt

@@ -0,0 +1,12 @@
+History.txt
+License.txt
+Manifest.txt
+README.txt
+Rakefile
+lib/adobeshare.rb
+lib/adobeshare/version.rb
+lib/adobeshare/client.rb
+lib/adobeshare/node.rb
+examples/sample.rb
+examples/config.yaml.sample
+setup.rb

data/README.txt

@@ -0,0 +1,70 @@
+= AdobeShare::Client -- Adobe Share API for Ruby
+
+AdobeShare::Client is a library for upload and download documents using REST APIs for Adobe Share.
+
+* http://labs.adobe.com/technologies/share/ 
+* http://labs.adobe.com/wiki/index.php/Share:API
+
+== Example
+
+=== Create client class
+
+  client = AdobeShare::Client.new
+    if you want to access via proxy,
+    add proxy param Adobe::Client.new "http://your.proxy.server:8080/"
+  
+=== Set credentials
+
+  client.apikey = Your API Key
+  client.secret = Your Shared Secret
+  client.username = Your Adobe ID
+  client.password = Your Adobe ID passowrd
+  
+=== Login
+
+  client.login
+  
+=== Access your Adobe Share Documents
+
+==== Upload
+
+  client.add_file `binary obj`, "test.pdf", "This is Test File"
+
+==== Download
+
+  client.get_source `nodeid`
+
+==== Delete
+
+  client.delete_node `nodeid`
+
+    
+  # `nodeid` is the same as `docid` in the Flash web interface.
+  # `nodeid` indicates both the documents and the folders. Maybe. 
+    
+=== Logout
+  client.logout
+
+For details, please see examples/sample.rb
+  
+== TODO
+
+* Test::Unit !!!
+
+and, these APIs are not implemented.
+* Moving or renaming a file or folder
+* Sharing a file
+* Adding or removing recipients from a share
+
+== Requirements
+
+* httpclient
+* rubygems
+
+== Installation
+
+* gem install adobeshare
+
+== Author
+
+* KATO Hideyuki <hideyuki at kato dot jp>

data/Rakefile

@@ -0,0 +1,4 @@
+require 'config/requirements'
+require 'config/hoe' # setup Hoe + all gem configuration
+
+Dir['tasks/**/*.rake'].each { |rake| load rake }

data/examples/config.yaml.sample

@@ -0,0 +1,5 @@
+--- 
+apikey: Your API Key
+secret: Your Shared Secret
+username: Your Adobe ID
+password: Your Adobe ID passowrd

data/examples/sample.rb

@@ -0,0 +1,114 @@
+#!/usr/bin/env ruby
+require 'rubygems'
+require 'adobeshare'
+require 'yaml'
+require 'pp'
+
+class SampleClient
+  def initialize
+    config = YAML.load_file("config.yaml")
+    @client = AdobeShare::Client.new
+    @client.apikey = config["apikey"]
+    @client.secret = config["secret"]
+    @client.username = config["username"]
+    @client.password = config["password"]
+  end
+  
+  def login
+    puts "=== Login ==="
+    @client.login
+    puts "sessionid : #{@client.sessionid}"
+    #puts "secret :    #{@client.secret}"
+    puts "name :      #{@client.name}"
+  end
+  
+  def logout    
+    puts "=== Logout ==="
+    @client.logout
+  end
+  
+  def list nodeid=nil
+    puts "=== Contents List ==="
+    node = @client.get_node
+    children = node[:children]
+    children.each{|e|
+      puts "#{e[:nodeid]} : #{e[:name]}" if e[:hascontent]
+    }
+    puts "" 
+    puts children.size.to_s + " documents(or folders)"
+    puts "  in this folder (nodeid=#{node[:nodeid]})"
+  end
+  
+  def info nodeid
+    puts "=== Content Info ==="
+    node = @client.get_node nodeid
+    pp node    
+  end
+  
+  def upload filename
+    list
+    puts "=== Upload ==="
+    return unless filename
+    node = @client.get_node
+    data = nil
+    File.open(filename, "rb"){|f|
+      data = f.read
+    }
+    puts "Uploading file `#{filename}` ..."
+    @client.add_file data, File.basename(filename), "Test File", node[:nodeid]
+    list
+  end
+  
+  def download nodeid
+    puts "=== File Download ==="
+    node = @client.get_node nodeid
+    pp node
+    
+    if node[:hascontent]
+      filename = node[:name]
+      puts "Downloading file `#{filename}` ..."
+      data = @client.get_source node[:nodeid]
+      File.open(filename, "wb"){|f|
+        f.write(data)
+      }
+      if node[:thumbnailstate] == "1"
+        thumbnail = node[:name] + ".thumb.jpg"
+        puts "Downloading file `#{thumbnail}` ..."
+        data = @client.get_thumbnail node[:nodeid]
+        File.open(thumbnail, "wb"){|f|
+          f.write(data)
+        }
+      end
+    end
+  end
+  
+  def delete nodeid
+    node = info nodeid
+    puts "=== File Delete ==="
+    puts ""
+    print "Are you OK? [yN]"
+    ans = STDIN.getc.chr.downcase
+    return if ans != 'y'
+    @client.delete_node nodeid
+    list
+  end
+end
+
+if __FILE__ == $0
+  sample = SampleClient.new
+  if ARGV[0]
+    command = ARGV[0]
+    param = ARGV[1]
+    sample.login
+    sample.send(command, param)
+    sample.logout
+  else
+    puts "Usage: #{$0} command param"
+    puts "commands:"
+    puts "  list"
+    puts "  info `nodeid`"
+    puts "  upload `filename`"
+    puts "  download `nodeid`"
+    puts "  delete `nodeid`"
+  end
+end

data/lib/adobeshare.rb

@@ -0,0 +1,9 @@
+$:.unshift File.dirname(__FILE__)
+
+require 'adobeshare/version'
+require 'adobeshare/client'
+require 'adobeshare/node'
+
+module AdobeShare
+
+end

data/lib/adobeshare/client.rb

@@ -0,0 +1,303 @@
+#
+# Adobe Share API for Ruby
+#
+# Copyright (c) KATO Hideyuki, 2007. All rights reserved.
+#
+require 'http-access2'
+require 'rexml/document'
+
+include REXML
+
+module AdobeShare
+  DEFAULT_ENDPOINT = "https://api.share.adobe.com/webservices/api/v1/"  # :nodoc:
+  ENDPOINT_AUTH = DEFAULT_ENDPOINT + "auth/"          # :nodoc:
+  ENDPOINT_SESSIONS = DEFAULT_ENDPOINT + "sessions/"  # :nodoc:
+  ENDPOINT_DC = DEFAULT_ENDPOINT + "dc/"              # :nodoc:
+  
+  #
+  # Client Access Class
+  #
+  class Client
+    # User-Agent
+    UA = "AdobeShare::Client-#{VERSION::STRING}"  # :nodoc:
+  
+    # User's API Key:
+    attr_accessor :apikey
+    # User's session shared secret
+    attr_accessor :secret
+    # User's Adobe ID
+    attr_accessor :username
+    # User's password
+    attr_accessor :password
+    # User's name
+    attr_reader :name
+    # User's session ID
+    attr_reader :sessionid
+    
+    #
+    def initialize proxy=nil
+      @client = HTTPAccess2::Client.new(proxy)
+    end
+    
+    # Login to use Adobe Share service
+    def login
+      authtoken = get_authtoken
+      start_sessions authtoken
+    end
+    
+    # Logout from the servce
+    def logout
+      end_sessions
+    end
+    
+    # Get a list of nodes (files and folders) in a user's account
+    def get_node(nodeid=nil)
+      if nodeid
+        uri = ENDPOINT_DC + nodeid + "/"
+      else
+        uri = ENDPOINT_DC
+      end
+      res = http_client_request("GET", uri)
+      node = Node.new res
+      node.to_hash
+    end      
+    
+    # Get the source of a document
+    def get_source nodeid
+      get_node_content nodeid, RENDITION_SOURCE
+    end
+    
+    # Get the thumbnail of a document
+    def get_thumbnail nodeid
+      get_node_content nodeid, RENDITION_THUMBNAIL
+    end
+    
+    # Get the specified rendition of a document
+    def get_node_content nodeid, rendition
+      uri = ENDPOINT_DC + nodeid + "/" + rendition + "/"
+      res = http_client_request("GET", uri)
+    end
+    
+    # Delete a node
+    def delete_node nodeid
+      uri = ENDPOINT_DC + nodeid + "/"
+      res = http_client_request("DELETE", uri)
+    end
+    
+    # Upload and add file
+    def add_file(data, filename, description, nodeid="", renditions=true)
+      uri = ENDPOINT_DC + nodeid + "/"
+      
+      # request xml
+      req_xml = Element.new "request"
+      file = req_xml.add_element "file"
+      file.add_element "name"
+      file.add_element "description"
+      file.add_element "renditions"
+      file.elements["name"].text = filename
+      file.elements["description"].text = description
+      file.elements["renditions"].text = renditions
+      # FIXME
+      # XXX  Is there any good library or something ???
+      #        to make multipart/form-data ...
+      boundary = "mime-part-separator" + Time.new.to_i.to_s
+      req = "--#{boundary}\r\n"
+      req << "Content-Disposition: form-data; name=\"request\"\r\n"
+      req << "\r\n"
+      req << req_xml.to_s
+      req << "\r\n"
+      req << "--#{boundary}\r\n"
+      req << "Content-Disposition: form-data; name=\"file\"; filename=\"#{URI.encode(filename)}\"\r\n"
+      req << "Content-Type: application/octet-stream\r\n"
+      req << "Content-Transfer-Encoding: binary\r\n"
+      req << "\r\n"
+      req << data
+      req << "\r\n"
+      req << "--#{boundary}--\r\n"
+      
+      headers = Hash.new
+      headers["Content-Type"] = "multipart/form-data; boundary=#{boundary}"
+      res = http_client_request("POST", uri, req, headers)
+    end
+    
+    private
+    
+    # TODO this method is not tested
+    # Rename a node
+    def rename_node(nodeid, newname)
+      uri = ENDPOINT_DC + nodeid + "/?newname=" + newname
+      res = http_client_request("MOVE", uri)
+    end
+    
+    # TODO this method is not tested
+    # Move a node
+    def move_node(nodeid, destnodeid, newname)
+      uri = ENDPOINT_DC + nodeid + "/?destnodeid=" + destnodeid + "&newname=" + URI.encode(newname)
+      res = http_client_request("MOVE", uri)
+    end
+    
+    # TODO this method is not tested
+    # Replace file in an already existing node
+    def replace_file(file_name, description, nodeid, renditions=true)
+      add_file(file_name, description, nodeid, renditions)
+    end
+    
+    # TODO this method is not tested
+    # Add new folder
+    def add_folder(name, description, nodeid)
+      if nodeid
+        uri = ENDPOINT_DC + nodeid + "/"
+      else
+        uri = ENDPOINT_DC
+      end
+      req = Element.new "request"
+      folder = req.add_element "folder"
+      folder.add_element "name"
+      folder.add_element "description"
+      folder.elements["name"].text = name
+      folder.elements["description"].text = description
+      res = http_client_request("POST", uri, req)
+      doc = Document.new res
+    end
+    
+    # TODO this method is not tested
+    # Share a file
+    def share_file(nodeid, users, message, level)
+      uri = ENDPOINT_DC + nodeid + "/share/"
+      req = Element.new "request"
+      share = req.add_element "share"
+      users.each{|e|
+        user = Element.new "user"
+        user.text = e
+        share.add_element user
+      }
+      req.add_element "message"
+      req.add_element "level"
+      req.elements["message"].text = message
+      req.elements["level"].text = level
+      res = http_client_request("POST", uri, req)
+      doc = Document.new res
+    end
+    
+    # TODO this method is not tested
+    # Unshare a file
+    def unshare_file(nodeid)
+      share_file(nodeid, nil, nil, 0)
+    end
+    
+    # TODO this method is not tested
+    # Update a share file
+    def update_share(nodeid, users_to_add, users_to_remove, message)
+      uri = ENDPOINT_DC + nodeid + "/share/"
+      req = Element.new "request"
+      share = req.add_element "share"
+      users_to_add.each{|e|
+        user = Element.new "user"
+        user.text = e
+        share.add_element user
+      }
+      unshare = req.add_element "unshare"
+      users_to_remove.each{|e|
+        user = Element.new "user"
+        user.text = e
+        unshare.add_element user
+      }
+      req.add_element "message"
+      req.add_element "level"
+      req.elements["message"].text = message
+      res = http_client_request("POST", uri, req)
+      doc = Document.new res
+    end
+    
+    private
+    
+    # Requesting an authorization token
+    def get_authtoken
+      raise ParameterError unless @username && @password
+      uri = ENDPOINT_AUTH
+      req = Element.new "request"
+      req.add_element "username"
+      req.add_element "password"
+      req.elements["username"].text = username
+      req.elements["password"].text = password
+      res = http_client_request("POST", uri, req)
+      doc = Document.new res
+      authtoken = doc.elements['/response/authtoken/'].text
+      authtoken
+    end
+    
+    # Starting a new session
+    def start_sessions authtoken
+      uri = ENDPOINT_SESSIONS
+      req = Element.new "request"
+      req.add_element "authtoken"
+      req.elements["authtoken"].text = authtoken
+      res = http_client_request("POST", uri, req)
+      doc = Document.new res
+      @sessionid = doc.elements['/response/sessionid/'].text
+      @secret = doc.elements['/response/secret'].text
+      @name = doc.elements['/response/name'].text
+    end
+    
+    # Ending a session
+    def end_sessions
+      uri = ENDPOINT_SESSIONS + @sessionid +'/'
+      res = http_client_request("DELETE", uri)
+      @sessionid = nil
+      @secret = nil
+    end
+    
+    # Make HTTP Headers (Authorization)
+    def make_headers(method, uri)
+      raise ParameterError unless @apikey && @secret
+      time = Time.new
+      calltime =  time.to_i.to_s + sprintf("%06d", time.tv_usec)
+      data = "#{method} #{uri} #{calltime}"
+      sig = Digest::MD5.hexdigest(data + @secret)
+      headers = Hash.new
+      auth_string = "AdobeAuth "
+      auth_string << "sessionid=\"#{@sessionid}\"," if @sessionid
+      auth_string << "apikey=\"#{@apikey}\",data=\"#{data}\",sig=\"#{sig}\""
+      headers["Authorization"] = auth_string
+      headers["User-Agent"] = UA
+      headers
+    end
+    
+    # Performs a generic HTTP request.
+    def http_client_request(method, uri_s, request=nil, header_add={})
+      uri_s << "?method=MOVE" if method == "MOVE"
+      uri = URI.parse uri_s
+      headers = make_headers method, uri
+      headers = headers.merge header_add
+      case method
+      when "GET"
+        res = @client.get(uri, nil, headers)
+      when "POST"
+        res = @client.post(uri, request, headers)
+      when "PUT"
+        res = @client.put(uri, request, headers)
+      when "DELETE"
+        res = @client.delete(uri, headers)
+      when "MOVE"
+        res = @client.post(uri, request, headers)
+      end
+      body = res.body.content
+      status_code = res.header.response_status_code
+      reason_phrase = res.header.reason_phrase
+      if status_code >= 500
+        raise ServerError, "#{status_code} #{reason_phrase}"
+      elsif status_code >= 400
+        body = res.body.content
+        raise RequestError, "#{status_code} #{reason_phrase} (#{body})"
+      end
+      body
+    end
+  end
+  
+  class ServerError < RuntimeError
+  end
+  class RequestError < RuntimeError
+  end
+  class ParameterError < RuntimeError
+  end
+end