divshare 0.3.0 → 0.3.1

data/README

@@ -1,14 +1,26 @@
-== Description
+divshare
+========
 
-The divshare gem makes it easier to use the divshare API. To use it, you need
+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
+Usage
+-----
 
-Here's a brief script that illustrates the basic operations:
+Here's a brief walkthrough of the basic operations (see `examples/` for more information):
 
-    require 'rubygems'
     require 'divshare'
+
+    # Set these for your divshare account
+    api_key    = 'your api key'
+    api_secret = 'your api secret'
+    email      = 'your login email address'
+    password   = 'your password'
+    filename   = 'a file you want to upload'
+
     client = Divshare::Client.new(api_key, api_secret)
     client.login(email, password)
     all_my_files = client.get_user_files
@@ -16,6 +28,9 @@ Here's a brief script that illustrates the basic operations:
       print "#{f.file_name} (#{f.file_size}) "
       puts "was last downloaded #{Time.at(f.last_downloaded_at.to_i)}"
     end
+    ticket = client.get_upload_ticket
+    uploaded_id = client.upload(ticket, filename)
+    puts "#{filename} uploaded with new id: #{uploaded_id}"
     client.logout
 
 Now, going through the same script step-by-step. Use your Divshare API
@@ -38,13 +53,22 @@ Do something with the files:
       puts "was last downloaded #{Time.at(f.last_downloaded_at.to_i)}"
     end
 
+Upload a file, and capture its id:
+
+    ticket = client.get_upload_ticket
+    uploaded_id = client.upload(ticket, filename)
+
 Logout
 
     client.logout
 
-== Installation
+Installation
+------------
 
 Install using rubygems:
 
     sudo gem install divshare 
 
+Or clone from github
+    
+    git clone git://github.com/wasnotrice/divshare.git

data/Rakefile

@@ -5,19 +5,17 @@ begin
     t.spec_files = FileList['spec/**/*_spec.rb']
     t.libs = ['spec', 'lib']
     t.spec_opts = ["-c", "-f s"]
-    t.ruby_opts = ["-r rubygems"] # If you want to use rubygems for requires
+    t.ruby_opts = ["-r rubygems"] # Remove to require dependencies another way
   end
 rescue LoadError
   puts "RSpec not available. Can't run specs without it. Install with: sudo gem install rspec"
 end
 
-task :default => :spec
-
 begin
   require "jeweler"
   Jeweler::Tasks.new do |gemspec|
     gemspec.name            = "divshare"
-    gemspec.description     = "A Ruby interface to the DivShare file hosting service"
+    gemspec.description     = File.read('README')
     gemspec.summary         = "A Ruby interface to the DivShare file hosting service"
     gemspec.date            = Time.now.strftime("%Y-%m-%d")
     gemspec.files           = ["README", "LICENSE", "VERSION", "Rakefile", Dir::glob("lib/**/**")].flatten
@@ -27,8 +25,11 @@ begin
     gemspec.rubyforge_project = "divshare"
 
     gemspec.add_dependency "hpricot"
-    gemspec.add_dependency "mime-types"
+    gemspec.add_dependency "mime-types", ">= 1.16"
   end
 rescue LoadError
   puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
 end
+
+task :default => :spec
+task :build => :spec

data/VERSION

@@ -1 +1 @@
-0.3.0
+0.3.1

data/examples/example.rb

@@ -0,0 +1,22 @@
+#/usr/bin/env ruby
+require 'rubygems'
+require 'divshare'
+
+# Set these as needed
+api_key    = 'your api key'
+api_secret = 'your api secret'
+email      = 'your login email address'
+password   = 'your password'
+filename   = 'a file you want to upload'
+
+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
+ticket = client.get_upload_ticket
+uploaded_id = client.upload(ticket, filename)
+puts "#{filename} uploaded with new id: #{uploaded_id}"
+client.logout

data/lib/divshare/multipart.rb

@@ -1,37 +1,37 @@
-# This is based on this article from Pivot Labs:
-# http://pivots.pivotallabs.com/users/damon/blog/articles/227-standup-04-27-07-testing-file-uploads
-
-require 'net/https'
-require "mime/types" # Requires gem install mime-types
-
-module Net #:nodoc:all
-  class HTTP::Post
-    def multipart_params=(param_hash={})
-      boundary_token = [Array.new(8) {rand(256)}].join
-      self.content_type = "multipart/form-data; boundary=#{boundary_token}"
-      boundary_marker = "--#{boundary_token}\r\n"
-      self.body = param_hash.map { |param_name, param_value|
-        boundary_marker + case param_value
-        when File
-          file_to_multipart(param_name, param_value)
-        else
-          text_to_multipart(param_name, param_value.to_s)
-        end
-      }.join('') + "--#{boundary_token}--\r\n"
-    end
-
-    protected
-    def file_to_multipart(key,file)
-      filename = File.basename(file.path)
-      mime_types = MIME::Types.of(filename)
-      mime_type = mime_types.empty? ? "application/octet-stream" : mime_types.first.content_type
-      part = %Q|Content-Disposition: form-data; name="#{key}"; filename="#{filename}"\r\n|
-      part += "Content-Transfer-Encoding: binary\r\n"
-      part += "Content-Type: #{mime_type}\r\n\r\n#{file.read}\r\n"
-    end
-
-    def text_to_multipart(key,value)
-      "Content-Disposition: form-data; name=\"#{key}\"\r\n\r\n#{value}\r\n"
-    end
-  end
-end
+# This is based on this article from Pivot Labs:
+# http://pivots.pivotallabs.com/users/damon/blog/articles/227-standup-04-27-07-testing-file-uploads
+
+require 'net/https'
+require "mime/types" # To use this library as a gem: gem install mime-types
+
+module Net #:nodoc:all
+  class HTTP::Post
+    def multipart_params=(param_hash={})
+      boundary_token = [Array.new(8) {rand(256)}].join
+      self.content_type = "multipart/form-data; boundary=#{boundary_token}"
+      boundary_marker = "--#{boundary_token}\r\n"
+      self.body = param_hash.map { |param_name, param_value|
+        boundary_marker + case param_value
+        when File
+          file_to_multipart(param_name, param_value)
+        else
+          text_to_multipart(param_name, param_value.to_s)
+        end
+      }.join('') + "--#{boundary_token}--\r\n"
+    end
+
+    protected
+    def file_to_multipart(key,file)
+      filename = File.basename(file.path)
+      mime_types = MIME::Types.of(filename)
+      mime_type = mime_types.empty? ? "application/octet-stream" : mime_types.first.content_type
+      part = %Q|Content-Disposition: form-data; name="#{key}"; filename="#{filename}"\r\n|
+      part += "Content-Transfer-Encoding: binary\r\n"
+      part += "Content-Type: #{mime_type}\r\n\r\n#{file.read}\r\n"
+    end
+
+    def text_to_multipart(key,value)
+      "Content-Disposition: form-data; name=\"#{key}\"\r\n\r\n#{value}\r\n"
+    end
+  end
+end

data/spec/client_spec.rb

@@ -22,14 +22,23 @@ module ClientSpecHelper
     @client = Client.new(@api_key, @api_secret)
   end
   
-  def login_setup
+  def login_setup(opts={})
     @mock_response = mock('response')
     @mock_login_response = mock('login_response')
-    Net::HTTP.should_receive(:post_form).twice.and_return(@mock_login_response, @mock_response)   
+    Net::HTTP.should_receive(:post_form).twice.and_return(@mock_login_response, @mock_response)
     @mock_login_response.should_receive(:body).and_return(successful_login_xml)
+    _extra_upload_setup if opts[:request_type] == :upload
     @client = Client.new(@api_key, @api_secret)
     @client.login(@user_email, @password)
   end
+
+  private
+  def _extra_upload_setup
+    @mock_http = mock('http')
+    Net::HTTP.should_receive(:new).and_return(@mock_http)
+    @mock_http.should_receive(:read_timeout=)
+    @mock_http.should_receive(:request).and_return({'location' => "http://any.old.url/?file1=123-abcdefghijkl"})
+  end
 end
 
 describe "A new Divshare Client" do
@@ -208,4 +217,25 @@ describe "A Divshare Client, unsuccessfully logging out" do
     @mock_response.should_receive(:body).and_return(unsuccessful_logout_xml)
     lambda {@client.logout}.should raise_error(Divshare::APIError)
   end
-end
+end
+
+describe "A Divshare Client, uploading a file" do
+  include ClientSpecHelper
+  
+  before :all do
+    common_setup
+  end
+  
+  before :each do 
+    login_setup(:request_type => :upload)
+    @mock_response.should_receive(:body).and_return(get_upload_ticket_xml)
+  end
+  
+  it "should upload an image file" do
+    ticket = @client.get_upload_ticket
+    filepath = File.expand_path(File.join(File.dirname(__FILE__), 'fixtures/divshare_logo.png'))
+    @client.upload(ticket, filepath).should == '123-abcdefghijkl'
+  end
+end
+  
+  

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: divshare
 version: !ruby/object:Gem::Version 
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors: 
 - Eric Watson
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-11-10 00:00:00 -06:00
+date: 2009-11-19 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -30,9 +30,83 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: "0"
+        version: "1.16"
     version: 
-description: A Ruby interface to the DivShare file hosting service
+description: |-
+  divshare
+  ========
+  
+  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 walkthrough of the basic operations (see `examples/` for more information):
+  
+      require 'divshare'
+  
+      # Set these for your divshare account
+      api_key    = 'your api key'
+      api_secret = 'your api secret'
+      email      = 'your login email address'
+      password   = 'your password'
+      filename   = 'a file you want to upload'
+  
+      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
+      ticket = client.get_upload_ticket
+      uploaded_id = client.upload(ticket, filename)
+      puts "#{filename} uploaded with new id: #{uploaded_id}"
+      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
+  
+  Upload a file, and capture its id:
+  
+      ticket = client.get_upload_ticket
+      uploaded_id = client.upload(ticket, filename)
+  
+  Logout
+  
+      client.logout
+  
+  Installation
+  ------------
+  
+  Install using rubygems:
+  
+      sudo gem install divshare 
+  
+  Or clone from github
+      
+      git clone git://github.com/wasnotrice/divshare.git
 email: wasnotrice@gmail.com
 executables: []
 
@@ -87,3 +161,4 @@ test_files:
 - spec/encoder_spec.rb
 - spec/spec_helper.rb
 - spec/user_spec.rb
+- examples/example.rb