divshare 0.1.0

data/History.txt

@@ -0,0 +1,4 @@
+== 0.1.0 2008-03-19
+
+* 1 major enhancement:
+  * Initial release

data/License.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2007 Eric Watson
+
+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,35 @@
+History.txt
+License.txt
+Manifest.txt
+README.txt
+Rakefile
+config/hoe.rb
+config/requirements.rb
+lib/divshare.rb
+lib/divshare/client.rb
+lib/divshare/divshare_file.rb
+lib/divshare/errors.rb
+lib/divshare/post_args.rb
+lib/divshare/user.rb
+lib/divshare/version.rb
+log/debug.log
+script/destroy
+script/generate
+script/test_run_client
+script/txt2html
+setup.rb
+spec/client_spec.rb
+spec/divshare_file_spec.rb
+spec/fixtures/divshare_mock_valid_audio.html
+spec/fixtures/divshare_mock_valid_video.html
+spec/post_args_spec.rb
+spec/spec_helper.rb
+spec/user_spec.rb
+tasks/deployment.rake
+tasks/environment.rake
+tasks/website.rake
+website/index.html
+website/index.txt
+website/javascripts/rounded_corners_lite.inc.js
+website/stylesheets/screen.css
+website/template.rhtml

data/README.txt

@@ -0,0 +1,50 @@
+== Description
+
+The divshare gem makes it easier to use the divshare API. To use it, you need
+to create a Divshare account and sign up for an API key.
+
+== Usage
+
+Here's a brief script that illustrates the basic operations:
+
+    require 'rubygems'
+    require 'divshare'
+    client = Divshare::Client.new(api_key, api_secret)
+    client.login(email, password)
+    all_my_files = client.get_user_files
+    all_my_files.each do |f| 
+      print "#{f.file_name} (#{f.file_size}) "
+      puts "was last downloaded #{Time.at(f.last_downloaded_at.to_i)}"
+    end
+    client.logout
+
+Now, going through the same script step-by-step. Use your Divshare API
+key and secret (comes with key) to create a client:
+
+    client = Divshare::Client.new(api_key, api_secret)
+    
+Login using the credentials for your Divshare account:
+
+    client.login(email, password)
+
+Get an array of all of your files:
+
+    all_my_files = client.get_user_files
+    
+Do something with the files:
+
+    all_my_files.each do |f| 
+      print "#{f.file_name} (#{f.file_size}) "
+      puts "was last downloaded #{Time.at(f.last_downloaded_at.to_i)}"
+    end
+
+Logout
+
+    client.logout
+
+== Installation
+
+Install using rubygems:
+
+    sudo gem install divshare 
+

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/config/hoe.rb

@@ -0,0 +1,72 @@
+require 'divshare/version'
+
+AUTHOR = 'Eric Watson'  # can also be an array of Authors
+EMAIL = "wasnotrice@gmail.com"
+DESCRIPTION = "A Ruby interface to the DivShare file hosting service"
+GEM_NAME = 'divshare' # what ppl will type to install your gem
+RUBYFORGE_PROJECT = 'divshare' # The unix name for your project
+HOMEPATH = "http://#{RUBYFORGE_PROJECT}.rubyforge.org"
+DOWNLOAD_PATH = "http://rubyforge.org/projects/#{RUBYFORGE_PROJECT}"
+
+@config_file = "~/.rubyforge/user-config.yml"
+@config = nil
+RUBYFORGE_USERNAME = "unknown"
+def rubyforge_username
+  unless @config
+    begin
+      @config = YAML.load(File.read(File.expand_path(@config_file)))
+    rescue
+      puts <<-EOS
+ERROR: No rubyforge config file found: #{@config_file}
+Run 'rubyforge setup' to prepare your env for access to Rubyforge
+ - See http://newgem.rubyforge.org/rubyforge.html for more details
+      EOS
+      exit
+    end
+  end
+  RUBYFORGE_USERNAME.replace @config["username"]
+end
+
+
+REV = nil 
+# UNCOMMENT IF REQUIRED: 
+# REV = `svn info`.each {|line| if line =~ /^Revision:/ then k,v = line.split(': '); break v.chomp; else next; end} rescue nil
+VERS = Divshare::VERSION::STRING + (REV ? ".#{REV}" : "")
+RDOC_OPTS = ['--quiet', '--title', 'divshare documentation',
+    "--opname", "index.html",
+    "--line-numbers", 
+    "--main", "README",
+    "--inline-source"]
+
+class Hoe
+  def extra_deps 
+    @extra_deps.reject! { |x| Array(x).first == 'hoe' } 
+    @extra_deps
+  end 
+end
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+hoe = Hoe.new(GEM_NAME, VERS) do |p|
+  p.author = AUTHOR 
+  p.description = DESCRIPTION
+  p.email = EMAIL
+  p.summary = DESCRIPTION
+  p.url = HOMEPATH
+  p.rubyforge_name = RUBYFORGE_PROJECT if RUBYFORGE_PROJECT
+  p.test_globs = ["test/**/test_*.rb"]
+  p.clean_globs |= ['**/.*.sw?', '*.gem', '.config', '**/.DS_Store']  #An array of file patterns to delete on clean.
+  p.remote_rdoc_dir = '' # Release to root
+  
+  # == Optional
+  p.changes = p.paragraphs_of("History.txt", 0..1).join("\\n\\n")
+  #p.extra_deps = []     # An array of rubygem dependencies [name, version], e.g. [ ['active_support', '>= 1.3.1'] ]
+  
+  #p.spec_extras = {}    # A hash of extra values to set in the gemspec.
+  
+end
+
+CHANGES = hoe.paragraphs_of('History.txt', 0..1).join("\\n\\n")
+PATH    = (RUBYFORGE_PROJECT == GEM_NAME) ? RUBYFORGE_PROJECT : "#{RUBYFORGE_PROJECT}/#{GEM_NAME}"
+hoe.remote_rdoc_dir = File.join(PATH.gsub(/^#{RUBYFORGE_PROJECT}\/?/,''), 'rdoc')
+hoe.rsync_args = '-av --delete --ignore-errors'

data/config/requirements.rb

@@ -0,0 +1,17 @@
+require 'fileutils'
+include FileUtils
+
+require 'rubygems'
+%w[rake hoe newgem rubigen].each do |req_gem|
+  begin
+    require req_gem
+  rescue LoadError
+    puts "This Rakefile requires the '#{req_gem}' RubyGem."
+    puts "Installation: gem install #{req_gem} -y"
+    exit
+  end
+end
+
+$:.unshift(File.join(File.dirname(__FILE__), %w[.. lib]))
+
+require 'divshare'

data/lib/divshare.rb

@@ -0,0 +1,4 @@
+require 'divshare/client'
+require 'divshare/divshare_file'
+require 'divshare/post_args'
+require 'divshare/errors'

data/lib/divshare/client.rb

@@ -0,0 +1,192 @@
+require 'rubygems'
+require 'cgi'
+require 'net/http'
+require 'hpricot'
+require 'digest/md5'
+require 'divshare/errors'
+require 'divshare/divshare_file'
+require 'divshare/post_args'
+require 'divshare/user'
+
+module Divshare
+  # This is the main class for interacting with the Divshare API. Use it like this:
+  #
+  #   client = Divshare::Client.new(api_key, api_secret)
+  #   client.login(email, password)
+  #   files = client.get_files ['abcdefg-123', 'abcdefg-456']
+  #   upload_ticket = client.get_upload_ticket
+  #   client.logout
+  #
+  class Client
+    SUCCESS = '1'
+    FAILURE = '0'
+  
+    attr_reader :api_key, :api_secret, :post_url, :api_session_key, :email, :password
+    
+    # Creates a Divshare::Client. The <tt>api_key</tt> and <tt>api_secret</tt>
+    # are required, but <tt>email</tt> and <tt>password</tt> are optional. If
+    # you omit <tt>email</tt> and <tt>password</tt> here, you must send them
+    # with link:login when you call it.
+    def initialize(api_key, api_secret, email=nil, password=nil)
+      @api_key, @api_secret, @email, @password = api_key, api_secret, email, password
+      @api_session_key = nil
+      @post_url = "http://www.divshare.com/api/"
+    end
+
+    # file_ids should be an array of file ids
+    # def get_files(file_ids)
+    #   file_ids = [file_ids] unless file_ids.respond_to?(:join)
+    #   response = send_method(:get_files, 'files' => file_ids.join(','))
+    #   files_from response
+    # end
+
+    # This method replaces the real get_files until the API is cleared up and
+    # working properly. Limitation: it can only retrieve files owned by the
+    # logged-in user.
+    def get_files(file_ids)
+      file_ids = [file_ids] unless file_ids.is_a? Array
+      files = get_user_files
+      puts file_ids.class
+      files.delete_if {|f| file_ids.include?(f.file_id) == false}
+    end
+    
+    # A convenience method for finding only one file. Returns a single
+    # DivshareFile instead of an array.
+    def get_file(file_id)
+      raise ArgumentError, "Only one file id allowed for this method" if file_id.is_a?(Array)
+      get_files(file_id).first
+    end
+
+    # Returns an array of Divshare::DivshareFile objects belonging to the logged-in user. Use <tt>limit</tt> and
+    # <tt>offset</tt> to narrow things down.
+    def get_user_files(limit=nil, offset=nil)
+      args = {}
+      args['limit'] = limit unless limit.nil?
+      args['offset'] = offset unless offset.nil?
+      response = send_method(:get_user_files, args)
+      files_from response
+    end
+    
+    # Returns an array of Divshare::DivshareFile objects in the specified folder. Use <tt>limit</tt> and
+    # <tt>offset</tt> to narrow things down. 
+    def get_folder_files(folder_id, limit=nil, offset=nil)
+      args = {}
+      args['limit'] = limit unless limit.nil?
+      args['offset'] = offset unless offset.nil?
+      args['folder_id'] = folder_id
+      response = send_method(:get_folder_files, args)
+      files_from response
+    end
+
+    # Returns information about the logged-in user
+    def get_user_info
+      response = send_method :get_user_info
+      user_from response
+    end
+    
+    # Returns an upload ticket string for use in uploading files. See
+    # http://www.divshare.com/integrate/api#uploading for more information on
+    # how to use the upload ticket once you've got it.
+    def get_upload_ticket
+      response = send_method :get_upload_ticket
+      upload_ticket_from response
+    end
+
+    # Login to the Divshare service. Raises Divshare::APIError if login is
+    # unsuccessful.
+    def login(email=nil, password=nil)
+      logout if @api_session_key
+      email ||= @email
+      password ||= @password
+      response = send_method(:login, {'user_email' => email, 'user_password' => password})
+      if response.at(:api_session_key)
+        @api_session_key = response.at(:api_session_key).inner_html
+      else
+        raise Divshare::APIError, "Couldn't log in. Received: \n" + response.to_s
+      end
+    end
+
+    # Returns true if logout is successful. Raises Divshare::APIError if logout is
+    # unsuccessful.
+    def logout
+      response = send_method(:logout)
+      if response.at(:logged_out) && (%w(true 1).include? response.at(:logged_out).inner_html)
+        @api_session_key = nil
+      else
+        raise Divshare::APIError, "Couldn't log out. Received: \n" + response.to_s
+      end
+      true
+    end
+
+    # Generates the required MD5 signature as described in
+    # http://www.divshare.com/integrate/api#sig
+    def sign(method, args)
+      Digest::MD5.hexdigest(string_to_sign(args))
+    end
+
+    private
+    def files_from(xml)
+      xml = xml/:file
+      xml = [xml] unless xml.respond_to?(:each)    
+      files = xml.collect { |f| DivshareFile.new f }
+    end
+    
+    def user_from(xml)
+      xml = xml.at(:user_info)
+      Divshare::User.new(xml)
+    end
+    
+    def upload_ticket_from(xml)
+      xml = xml.at(:upload_ticket).inner_html
+    end
+    
+    # Since login and logout aren't easily re-nameable to use method missing
+    def send_method(method_id, *params)
+      response = http_post(method_id, *params)
+      xml = Hpricot(response).at(:response)
+      if xml[:status] == FAILURE
+        errors = (xml/:error).collect {|e| e.inner_html}
+        raise Divshare::APIError, errors.join("\n")
+      end
+      xml
+    end      
+    
+    def post_args(method, args)
+      PostArgs.new(self, method, args)
+    end
+    
+    def http_post(method, args={})
+      url = URI.parse(@post_url)
+      tries = 3
+      response = ""
+      begin
+        response = Net::HTTP.post_form(url, post_args(method, args)).body
+      rescue
+        tries -= 1
+          puts "Tries == '#{tries}'"
+        if tries > 0
+          retry
+        else
+          raise Divshare::ConnectionError, "Couldn't connect for '#{method}' using #{post_args(method, args)}"
+        end
+      end
+      response
+    end
+    
+    # From http://www.divshare.com/integrate/api
+    #
+    # * Your secret key is 123-secret. 
+    # * Your session key is 456-session. 
+    # * You are using the get_user_files method, and you're sending the
+    #   parameters limit=5 and offset=10.
+    #
+    # The string used to create your signature will be:
+    # 123-secret456-sessionlimit5offset10. Note that the parameters must be in
+    # alphabetical order, so limit always comes before offset. Each parameter
+    # should be paired with its value as shown.
+    def string_to_sign(args)
+      args_for_string = args.dup.delete_if {|k,v| %w(api_key method api_sig api_session_key).include?(k) }
+      "#{@api_secret}#{@api_session_key}#{args_for_string.to_a.sort.flatten.join}"
+    end
+  end
+end

data/lib/divshare/divshare_file.rb

@@ -0,0 +1,112 @@
+require 'rubygems'
+require 'hpricot'
+
+module Divshare
+  # This class represents a file stored at Divshare. Queries from a 
+  # Divshare::Client to the API return arrays of DivshareFile objects. You 
+  # can gather any information provided by the API from this object, as well 
+  # as generate a tag for embedding the file in HTML.
+  #
+  # The proper embed tag depends on the file type. The Divshare API doesn't
+  # distinguish these different filetypes, however, so this library tries to 
+  # figure out the filetype from the file's extension. 
+  class DivshareFile
+    ATTRIBUTES = %w(file_id file_name file_description file_size downloads last_downloaded_at uploaded_at folder_title folder_id)
+    AUDIO = /^\.(mp3)$/i
+    VIDEO = /^\.(avi|wmv|mov|mpg|asf)$/i
+    DOCUMENT = /^\.(doc|pdf|ppt)$/i
+    IMAGE = /^\.(jpg|gif|png)$/i
+    
+    attr_reader *ATTRIBUTES
+    attr_reader :medium
+    
+    def initialize(xml=Hpricot(""))
+      ATTRIBUTES.each do |attr|
+        if xml.at(attr)
+          value = xml.at(attr).inner_html
+          instance_variable_set("@#{attr}", value)
+        end
+      end
+      @medium = find_medium
+    end
+    
+    def audio?
+      @medium == "audio"
+    end
+    
+    def document?
+      @medium == "document"
+    end
+    
+    def video?
+      @medium == "video"
+    end
+    
+    def image?
+      @medium == "image"
+    end
+    
+    # Image options
+    #
+    # :size => :fullsize | :midsize | :thumb
+    def embed_tag(opts={})
+      return nil if @medium.nil?
+      self.send("#{@medium}_embed_tag_template", opts).gsub('[FILE ID]', @file_id)
+    end
+    
+    def to_s
+      s = "#{file_name} <Divshare::DivshareFile>\n"
+      ATTRIBUTES.each { |a| s << sprintf(" %s: %s\n", a, self.send(a)) }
+      s
+    end
+    
+    private
+    def find_medium
+      ext = @file_name ? File.extname(@file_name) : nil
+      medium = case
+        when AUDIO.match(ext): "audio"
+        when VIDEO.match(ext): "video"
+        when DOCUMENT.match(ext): "document"
+        when IMAGE.match(ext): "image"
+        else nil
+      end
+    end
+    
+    def audio_embed_tag_template(opts={})
+      tag = <<-END_OF_TAG
+<object classid="clsid:d27cdb6e-ae6d-11cf-96b8-444553540000" codebase="http://fpdownload.macromedia.com/pub/shockwave/cabs/flash/swflash.cab#version=8,0,0,0" width="335" height="47" id="divaudio2">
+    <param name="movie" value="http://www.divshare.com/flash/audio?myId=[FILE ID]" />
+    <embed src="http://www.divshare.com/flash/audio?myId=[FILE ID]" width="335" height="47" name="divaudio2" type="application/x-shockwave-flash" pluginspage="http://www.macromedia.com/go/getflashplayer"></embed>
+</object>
+      END_OF_TAG
+    end
+    
+    def video_embed_tag_template(opts={})
+      tag = <<-END_OF_TAG
+<object classid="clsid:d27cdb6e-ae6d-11cf-96b8-444553540000" codebase="http://fpdownload.macromedia.com/pub/shockwave/cabs/flash/swflash.cab#version=9,0,18,0" width="425" height="374" id="divflv">
+    <param name="movie" value="http://www.divshare.com/flash/video?myId=[FILE ID]" />
+    <param name="allowFullScreen" value="true" />
+    <embed src="http://www.divshare.com/flash/video?myId=[FILE ID]" width="425" height="374" name="divflv" allowfullscreen="true" type="application/x-shockwave-flash" pluginspage="http://www.macromedia.com/go/getflashplayer"></embed>
+</object>
+      END_OF_TAG
+    end
+    
+    def document_embed_tag_template(opts={})
+      tag = <<-END_OF_TAG
+<object classid="clsid:d27cdb6e-ae6d-11cf-96b8-444553540000" codebase="http://fpdownload.macromedia.com/pub/shockwave/cabs/flash/swflash.cab#version=8,0,0,0" width="560" height="500" id="divdoc">
+    <param name="movie" value="http://www.divshare.com/flash/document/[FILE ID]" />
+    <embed src="http://www.divshare.com/flash/document/[FILE ID]" width="560" height="500" name="divdoc" type="application/x-shockwave-flash" pluginspage="http://www.macromedia.com/go/getflashplayer"></embed>
+</object>  
+      END_OF_TAG
+    end
+    
+    def image_embed_tag_template(opts={:size=>:midsize})
+      size = case opts[:size]
+        when :midsize, :mid:     "midsize/"
+        when :thumb, :thumbnail: "thumb/"
+        else ""
+      end
+      tag = "http://www.divshare.com/img/#{size}[FILE ID]"
+    end
+  end
+end