sme_storage 0.0.1

data/LICENSE

@@ -0,0 +1,9 @@
+Copyright (c) 2010, Vehera LTD
All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+  *	Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+  * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+  * Neither the name of Vehera nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README

@@ -0,0 +1,12 @@
+A small ruby library for uploading files to SMEStorage (http://www.smestorage.com/). It does not implement all of SMEStorage's API, just the file upload part.
+
+Basic usage:
+
+  require "rubygems"
+  require "sme_storage"
+
+  storage = SmeStorage.new("user", "password")
+  storage.authenticate
+  storage.upload("/Users/augustl/Desktop/testfile.txt")
+
+Author: August Lilleaas, august.lilleaas@gmail.com

data/Rakefile

@@ -0,0 +1,13 @@
+require 'rake'
+require 'rake/testtask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test it!'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/*_test.rb'
+  t.verbose = true
+end

data/lib/sme_storage/api.rb

@@ -0,0 +1,67 @@
+require "net/http"
+require "uri"
+require "base64"
+require "rexml/document"
+
+class SmeStorage
+  # The interface to the REST api. You need a token to interact with it.
+  #
+  #   @token = SmeStorage::Api.get_token(username, password)
+  #
+  # When you have the token, you can call any action you want in the API.
+  #
+  #   SmeStorage::Api.get(@token, "doInitUpload", "arbitary", "parameters", "here")
+  class Api
+    HTTP = Net::HTTP.new("www.smestorage.com", 80)
+    API_URI = "/api"
+    USER_AGENT = "SMEStorage Automator Upload Workflow"
+    
+    attr_reader :root
+    
+    # Similar to +new+, but also fetches and parses XML in one pass.
+    def self.get(*args)
+      instance = new(*args)
+      instance.fetch
+      instance.parse
+      return instance
+    end
+    
+    # Returns the token if successful, false if not.
+    def self.get_token(username, password)
+      response = get(nil, "gettoken", username, password)
+      response.ok? && response.root.elements["token"].text
+    end
+    
+    # The token can be nil, for authentication operations. The action matches
+    # the action names in the SMEStorage API. The arguments are the base64
+    # encoded comma separated arguments, also matching the SMEStorage API.
+    def initialize(token, action, *arguments)
+      @token = token || "*"
+      @action = action
+      @arguments = encode_arguments(arguments)
+      @uri = [API_URI, @token, @action, @arguments].join("/")
+    end
+    
+    def fetch
+      request = Net::HTTP::Get.new(@uri)
+      request["User-Agent"] = USER_AGENT
+      @xml = HTTP.request(request).body
+    end
+    
+    def parse
+      @doc = REXML::Document.new(@xml)
+      @root = @doc.root
+      @status = @root.elements["status"].text
+    end
+    
+    def ok?
+      @status == "ok"
+    end
+    
+    private
+    
+    def encode_arguments(arguments)
+      arguments.map {|arg| Base64.encode64(arg).chomp }.join(",")
+    end
+  end
+end

data/lib/sme_storage/mime_boundary.rb

@@ -0,0 +1,15 @@
+class SmeStorage
+  # Inspired by TMail.new_boundary. Generates a unique boundary for the
+  # multipart file uploads in +Uploader+.
+  class MimeBoundary
+    def initialize
+      t = Time.now
+      random_tag = sprintf("%x%x_%x%x", t.to_i, t.tv_usec, Thread.current.object_id, rand(255))
+      @boundary = "mimepart_" + random_tag
+    end
+    
+    def to_s
+      @boundary
+    end
+  end
+end

data/lib/sme_storage/uploader.rb

@@ -0,0 +1,38 @@
+require "net/http"
+require "uri"
+
+class SmeStorage
+  # The actual uploading of a file is not done with the regular API. It
+  # emulates a HTML form type multipart upload.
+  class Uploader
+    UPLOADER_SCRIPT = "http://www.smetube.com/cgi-bin/uploader/uploader1.cgi"
+    
+    def initialize(upload_code, path_to_file)
+      @upload_code = upload_code
+      @path_to_file = path_to_file
+      @boundary = MimeBoundary.new.to_s
+      @uri = URI.parse("#{UPLOADER_SCRIPT}?#{@upload_code}")
+    end
+    
+    # Mimics a HTML form type multipart upload.
+    def upload
+      http = Net::HTTP.new(@uri.host, @uri.port)
+      request = Net::HTTP::Post.new(@uri.request_uri)
+      request.body = request_body(File.basename(@path_to_file), File.read(@path_to_file))
+      request["Content-Type"] = "multipart/form-data, boundary=#{@boundary}"
+      http.request(request)
+    end
+    
+    def request_body(filename, file)
+      post_body = []
+      post_body << "--#{@boundary}\r\n"
+      post_body << "Content-Disposition: form-data; name=\"datafile\"; filename=\"#{filename}\"\r\n"
+      post_body << "Content-Type: text/plain\r\n"
+      post_body << "\r\n"
+      post_body << file
+      post_body << "\r\n--#{@boundary}--\r\n"
+      
+      post_body.join
+    end
+  end
+end

data/lib/sme_storage.rb

@@ -0,0 +1,79 @@
+require "sme_storage/api"
+require "sme_storage/mime_boundary"
+require "sme_storage/uploader"
+
+# The wrapper class for the uploading operation.
+#
+#   storage = SmeStorage.new("username", "password")
+#   storage.authenticate
+#   storage.upload("/path/to/file")
+class SmeStorage
+  class NotAuthenticated < RuntimeError; end
+  def initialize(username, password)
+    @username, @password = username, password
+  end
+  
+  # Performs the authentication. Has to be called before upload.
+  def authenticate
+    @token = Api.get_token(@username, @password)
+    @authenticated = (@token != nil)
+  end
+  
+  # The actual upload. Takes a File instance, or a Pathname, or a
+  # String (path to the file, not file contents).
+  def upload(file_thing)
+    raise NotAuthenticated unless authenticated?
+
+    case file_thing.class.name.to_sym # so that we don't have to require pathname
+    when :File
+      perform_upload(file_thing.path)
+    when :Pathname
+      perform_upload(file_thing.to_s)
+    when :String
+      perform_upload(file_thing)
+    else
+      raise ArgumentError, "Needs a File, String or Pathname"
+    end
+  end
+  
+  def authenticated?
+    @authenticated == true
+  end
+  
+  private
+  
+  def perform_upload(path)
+    if !File.file?(path)
+      raise ArgumentError, "The file `#{path}' does not exist."
+    end
+    
+    # Tell the API we're going to upload
+    init_call = Api.get(@token, "doInitUpload",
+      File.basename(path), # File label
+      "", # Description
+      "", # Tags
+      "", # ID of parent folder
+      File.basename(path), # Filename
+      "xml", # Response type
+      "", # Response data, when response type is javascript
+      "", # Encryption phrase. Blank means unencrypted
+      "", # File ID, for overwrites
+      "n" # Chuck the file (y or n)
+    )
+    
+    # Perform the upload
+    upload_code = init_call.root.elements["uploadcode"].text
+    Uploader.new(upload_code, path).upload
+    
+    # Tell the API that we have uploaded
+    response = Api.get(@token, "doCompleteUpload", upload_code)
+    
+    if response.ok?
+      file_id = response.root.elements["file"].elements["fi_id"].text
+      tiny_url = Api.get(@token, "getFileTinyURL", file_id)
+      tiny_url.root.elements["tinyurl"].text
+    else
+      false
+    end
+  end
+end

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification 
+name: sme_storage
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- August Lilleaas
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-01-29 00:00:00 +01:00
+default_executable: 
+dependencies: []
+
+description: "    Uploads files to SMEStorage with theri API.\n"
+email: august.lilleaas@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README
+- LICENSE
+- Rakefile
+- lib/sme_storage/api.rb
+- lib/sme_storage/mime_boundary.rb
+- lib/sme_storage/uploader.rb
+- lib/sme_storage.rb
+has_rdoc: true
+homepage: http://gitorious.org/smestorage
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: SMEStorage file upload library.
+test_files: []
+