rapidshare-ext 0.0.5 → 0.0.6

data/History.md

@@ -1,3 +1,7 @@
+## ver. 0.0.6 2012-11-25
+
+* [changed] upload(): :overwrite parameter added
+
 ## ver. 0.0.5 2012-11-21
 
 * [fixed] remove_orphans!()

data/README.md

@@ -28,7 +28,7 @@ api = Rapidshare::API.new(:cookie => 'cookie_here') # More preferable way
 
 ### Files
 
-Now you can perform file download in two ways: by the HTTP url or by the absolute path.
+Now you can perform file downloading in two ways: by HTTP url or by absolute path.
 
 First, by the HTTP url, as it has worked before:
 ```ruby
@@ -41,7 +41,7 @@ First, by the HTTP url, as it has worked before:
     :downloads_dir => "/tmp"
 ```
 
-Download by absolute path:
+Download by absolute path from account you owned:
 ```ruby
 @rs.download "/foo/bar/baz/upload_file_1.txt",
   :downloads_dir => "/tmp"
@@ -49,7 +49,7 @@ Download by absolute path:
 
 In both the first and second samples the result will be the same.
 
-File uploading became very simple now:
+File uploading is also became very simple:
 ```ruby
 api.upload("/home/odiszapc/my_damn_cat.mov", :to => "/gallery/video", :as => "cat1.mov")
 # => {
@@ -68,11 +68,33 @@ result = api.upload("/home/odiszapc/my_damn_cat.mov", :to => "/gallery/video", :
 result[:url]
 ```
 
-By default, file is uploaded to the root folder:
+By default, file is uploaded into the root folder:
 ```ruby
 api.upload("/home/odiszapc/my_damn_humster.mov")
 ```
 
+Rapidshare allows to store multiple files having equal names under the same folder. I believe this behaviour is absolutely wrong.
+Therefore, each time upload performed it checks if the file with the given name already exists in a folder.
+If it's true, the upload() just returns info about the existing file with the :already_exists? flag is set to true without any real upload being performed.
+To force file being overwritten set the :overwrite parameter to true:
+
+```ruby
+api.upload "/home/odiszapc/my_damn_cat.mov",
+    :to => "/gallery/video",
+    :as => "cat1.mov"
+
+# No upload will be performed
+api.upload "/home/odiszapc/my_damn_cat.mov",
+    :to => "/gallery/video",
+    :as => "cat1.mov"
+
+# With the following notation file will be uploaded with overwriting the existing one
+api.upload "/home/odiszapc/my_damn_cat.mov",
+    :to => "/gallery/video",
+    :as => "cat1.mov",
+    :overwrite => true
+```
+
 Deleting files:
 ```ruby
 api.remove_file("/putin/is/a/good/reason/to/live/abroad/ticket_to_Nicaragua.jpg")
@@ -95,9 +117,9 @@ api.file_id("/foo/bar/baz.rar") # => <ID>
 ```
 
 ### Folders
-As you note you can have a hierarchy of folders in your account.
+As you note it's possible having a hierarchy of folders in your account.
 
-Creating folders:
+Creating folder hierarchy:
 ```ruby
 folder_id = api.add_folder "a/b/c" # => <FOLDER ID>
 ```
@@ -111,9 +133,9 @@ Moving folders:
 ```ruby
 api.move_folder("/a/b/c", :to => "/a")
 ```
-This moves folder "c" from directory "/a/b/" and places it under the directory "/a"
+This moves the folder "c" from the directory "/a/b/" and places it under the directory "/a"
 
-Get the hierarchy of all folders in account:
+You can get hierarchy of all the folders in account:
 ```ruby
 api.folders_hierarchy
 # => {
@@ -159,20 +181,20 @@ What does it mean? When you delete parent folder by its ID the folder will be de
 For example, let we have the basic directory tree:
 ```
 ROOT
-`-a  <- RS API allows us to delete JUST THIS folder, so hierarchy relation between folders will be lost and the folders "c" and "b" will become orphans
+`-a  <- Raw Rapidshare API allows you to delete JUST THIS folder, so hierarchy relation between folders will be lost and the folders "c" and "b" will became orphans
   `-b
     `-c
 ```
 
-My know-how: orphan folders become invisible in your File Manager on the Rapidshare web site, so you may want to hide all the data in this way (stupid idea)
+**Know-how:** orphan folders become invisible in your File Manager on the Rapidshare web site, so you may want to hide all the data in this way (stupid idea)
 
-So, the best way to delete some directory tree without washing away its consistency is the following:
+So, the best way to delete a directory tree without washing away consistency of account folder hierarchy is the following:
 ```ruby
-api.remove_folder "/a" # This will correctly delete all child directories
+api.remove_folder "/a" # This will delete all the child directories correctly
 ```
 
-But if you already have orphans in your account there is possible to fix them.
-The next method detects all orphan folders in your account and moves them into a specific folder:
+However, if you already have orphans in your account there is possible to fix them.
+So ,the next method detects all orphan folders in your account and moves them into a specific folder:
 ```ruby
 api.move_orphans :to => "/"
 ```
@@ -188,7 +210,7 @@ You can null your account by deleting all the data stored inside:
 api.erase_all_data!
 ```
 
-**Be careful with it, because all you lose all your data**
+**Be careful with it, because you stake losing all your data**
 
 ## Contributing
 

data/lib/rapidshare-ext/api.rb

@@ -113,6 +113,8 @@ module Rapidshare
       #   Folder to place uploaded file to,  default: "/"
       # <tt>:as</tt>::
       #   The name file will have in storage after it has been uploaded
+      # <tt>:overwrite</tt>::
+      #   Overwrite file if it already exists in the given folder
       #
       #    api.upload("/home/odiszapc/my_damn_cat.mov", :to => "/gallery/video", :as => "cat1.mov")
       def upload(file_path, params = {})
@@ -120,6 +122,7 @@ module Rapidshare
         dest_path = path_trim(params.delete(:to) || '/')
         folder_id = self.add_folder dest_path
         file_name = params.delete(:as) || File.basename(file_path)
+        overwrite = params.delete :overwrite
 
         # Check file already exists within a folder
         listfiles_params = {
@@ -130,11 +133,14 @@ module Rapidshare
         }
         listfiles_response = self.listfiles listfiles_params
 
-        # In case of file is not existing upload it
-        if "NONE" == listfiles_response[0][0]
+        file_already_exists = ("NONE" != listfiles_response[0][0])
+        remove_file "#{dest_path}/#{file_name}" if file_already_exists && overwrite
+
+        # In case of file is not existing then upload it
+        if !file_already_exists || overwrite
           upload_server = "rs#{self.nextuploadserver}.rapidshare.com"
 
-         upload_params = {
+          upload_params = {
             :server => upload_server,
             :folder => folder_id,
             :filename => file_name,

data/lib/rapidshare-ext/version.rb

@@ -1,5 +1,5 @@
 module Rapidshare
   module Ext
-    VERSION = "0.0.5"
+    VERSION = "0.0.6"
   end
 end

data/test/fixtures/files/upload2.txt

@@ -0,0 +1 @@
+Another file to test upload

data/test/integration/rapidshare-ext_test.rb

@@ -17,6 +17,10 @@ class RapidshareExtTest < Test::Unit::TestCase
     @upload_file_1 = File.expand_path(File.dirname(__FILE__) + "/../fixtures/files/upload1.txt")
     @upload_file_1_md5 = Digest::MD5.hexdigest(File.read(@upload_file_1))
     @upload_file_1_size = File.size @upload_file_1
+
+    @upload_file_2 = File.expand_path(File.dirname(__FILE__) + "/../fixtures/files/upload2.txt")
+    @upload_file_2_md5 = Digest::MD5.hexdigest(File.read(@upload_file_2))
+    @upload_file_2_size = File.size @upload_file_2
   end
 
   context "Api" do
@@ -58,8 +62,17 @@ class RapidshareExtTest < Test::Unit::TestCase
 
       # Upload the same file again
       response = @rs.upload @upload_file_1, :to => remote_dir, :as => remote_filename
-      upload_assertion.call response, @upload_file_1_size, @upload_file_1_md5, remote_filename
       assert_true response[:already_exists?]
+      upload_assertion.call response, @upload_file_1_size, @upload_file_1_md5, remote_filename
+
+      # Upload another file under the same path but with overwriting the existing one
+      response = @rs.upload @upload_file_2,
+                            :to => remote_dir,
+                            :as => remote_filename,
+                            :overwrite => true
+
+      assert_false response[:already_exists?]
+      upload_assertion.call response, @upload_file_2_size, @upload_file_2_md5, remote_filename
     end
 
     should "download file" do
@@ -354,6 +367,9 @@ class RapidshareExtTest < Test::Unit::TestCase
       assert_raise_message(msg) do
         @rs.reload! :validate => true
       end
+
+      # Remedy
+      @rs.erase_all_data!
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rapidshare-ext
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-21 00:00:00.000000000 Z
+date: 2012-11-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rapidshare
@@ -128,6 +128,7 @@ files:
 - lib/rapidshare-ext/version.rb
 - rapidshare-ext.gemspec
 - test/fixtures/files/upload1.txt
+- test/fixtures/files/upload2.txt
 - test/fixtures/getaccountdetails_valid.txt
 - test/integration/rapidshare-ext_test.rb
 - test/test_helper.rb
@@ -160,6 +161,7 @@ summary: ! 'Makes your interactions with Rapidshare API more pleasant by providi
   upload files, etc'
 test_files:
 - test/fixtures/files/upload1.txt
+- test/fixtures/files/upload2.txt
 - test/fixtures/getaccountdetails_valid.txt
 - test/integration/rapidshare-ext_test.rb
 - test/test_helper.rb