groupdocs 0.3.11 → 1.0.0

data/lib/groupdocs/storage/file.rb

@@ -1,63 +1,73 @@
 module GroupDocs
   module Storage
-    class File < GroupDocs::Api::Entity
+    class File < Api::Entity
 
-      extend Extensions::Lookup
       include Api::Helpers::AccessMode
+      include Api::Helpers::Path
 
       DOCUMENT_TYPES = %w(Undefined Cells Words Slides Pdf Html Image)
 
       #
       # Uploads file to API server.
       #
-      # @example
-      #   GroupDocs::Storage::File.upload!('resume.pdf', '/folder/cv.pdf', description: 'My resume')
+      # @example Upload file to root directory
+      #   GroupDocs::Storage::File.upload!('resume.pdf')
+      #
+      # @example Upload file to specific directory
+      #   GroupDocs::Storage::File.upload!('resume.pdf', path: 'folder1')
+      #
+      # @example Upload and rename file
+      #   GroupDocs::Storage::File.upload!('resume.pdf', name: 'cv.pdf')
+      #
+      # @example Upload file with description
+      #   GroupDocs::Storage::File.upload!('resume.pdf', description: 'Resume')
       #
       # @param [String] filepath Path to file to be uploaded
-      # @param [String] upload_path Full path to directory to upload file to starting with "/".
-      #                             You can also add filename and then uploaded file will use it.
+      # @param [Hash] options
+      # @option options [String] path Folder path to upload to
+      # @option options [String] name Name of file to be renamed
+      # @option options [String] description File description
       # @param [Hash] access Access credentials
       # @option access [String] :client_id
       # @option access [String] :private_key
       # @return [GroupDocs::Storage::File]
       #
-      # @raise [ArgumentError] If path does not start with /
-      #
-      def self.upload!(filepath, upload_path = '/', access = {})
-        Api::Helpers::Path.verify_starts_with_root(upload_path)
-        Api::Helpers::Path.append_file_name(upload_path, filepath)
+      def self.upload!(filepath, options = {}, access = {})
+        options[:path] ||= ''
+        options[:name] ||= Object::File.basename(filepath)
+        path = prepare_path("#{options[:path]}/#{options[:name]}")
 
-        json = Api::Request.new do |request|
+        api = Api::Request.new do |request|
           request[:access] = access
           request[:method] = :POST
-          request[:path] = "/storage/{{client_id}}/folders#{upload_path}"
+          request[:path] = "/storage/{{client_id}}/folders/#{path}"
           request[:request_body] = Object::File.new(filepath, 'rb')
-        end.execute!
+        end
+        api.add_params(description: options[:description]) if options[:description]
+        json = api.execute!
 
         Storage::File.new(json)
       end
 
       #
-      # Returns an array of all files on server starting with given path.
+      # Uploads web page as file.
       #
-      # @param [String] path Starting path to look for files
+      # @param [String] url
       # @param [Hash] access Access credentials
       # @option access [String] :client_id
       # @option access [String] :private_key
-      # @return [Array<GroupDocs::Storage::File>]
-      #
-      def self.all!(path = '/', access = {})
-        files = Array.new
-        folder = GroupDocs::Storage::Folder.new(path: path)
-        folder.list!({}, access).each do |entity|
-          if entity.is_a?(GroupDocs::Storage::Folder)
-            files += all!("#{path}/#{entity.name}", access)
-          else
-            files << entity
-          end
+      # @return [GroupDocs::Storage::File]
+      #
+      def self.upload_web!(url, access = {})
+        api = Api::Request.new do |request|
+          request[:access] = access
+          request[:method] = :POST
+          request[:path] = '/storage/{{client_id}}/urls'
         end
+        api.add_params(url: url)
+        json = api.execute!
 
-        files
+        Storage::File.new(json)
       end
 
       # @attr [Integer] id
@@ -152,26 +162,6 @@ module GroupDocs
         Time.at(@modified_on / 1000)
       end
 
-      #
-      # Uploads file to server.
-      #
-      # Note that it doesn't update self and instead returns new instance.
-      #
-      # @example
-      #   file = GroupDocs::Storage::File.new(name: 'document_one.doc', path: File.dirname(__FILE__))
-      #   file = file.upload!
-      #
-      # @param [String] upload_path Full path to directory to upload file to starting with "/".
-      #                             You can also add filename and then uploaded file will use it.
-      # @param [Hash] access Access credentials
-      # @option access [String] :client_id
-      # @option access [String] :private_key
-      # @return [GroupDocs::Storage::File]
-      #
-      def upload!(upload_path = '/', access = {})
-        self.class.upload!("#{path}/#{name}", upload_path, access)
-      end
-
       #
       # Downloads file to given path.
       #
@@ -199,22 +189,23 @@ module GroupDocs
       #
       # Moves file to given path.
       #
-      # @param [String] path Full path to directory to move file to starting with "/".
-      #                      You can also add filename and then moved file will use it.
+      # @param [String] path
+      # @param [Hash] options
+      # @option options [String] name
       # @param [Hash] access Access credentials
       # @option access [String] :client_id
       # @option access [String] :private_key
       # @return [GroupDocs::Storage::File] Moved to file
       #
-      def move!(path, access = {})
-        Api::Helpers::Path.verify_starts_with_root(path)
-        Api::Helpers::Path.append_file_name(path, name)
+      def move!(path, options = {}, access = {})
+        options[:name] ||= name
+        path = prepare_path("#{path}/#{options[:name]}")
 
         json = Api::Request.new do |request|
           request[:access] = access
           request[:method] = :PUT
           request[:headers] = { :'Groupdocs-Move' => id }
-          request[:path] = "/storage/{{client_id}}/files#{path}"
+          request[:path] = "/storage/{{client_id}}/files/#{path}"
         end.execute!
 
         Storage::File.new(json[:dst_file])
@@ -230,28 +221,29 @@ module GroupDocs
       # @return [GroupDocs::Storage::File] Renamed file
       #
       def rename!(name, access = {})
-        move!("#{path}#{name}", access)
+        move!(path, { name: name }, access)
       end
 
       #
       # Moves file to given path.
       #
-      # @param [String] path Full path to directory to copy file to starting with "/".
-      #                      You can also add filename and then copied file will use it.
+      # @param [String] path
+      # @param [Hash] options
+      # @option options [String] name
       # @param [Hash] access Access credentials
       # @option access [String] :client_id
       # @option access [String] :private_key
       # @return [GroupDocs::Storage::File] Copied to file
       #
-      def copy!(path, access = {})
-        Api::Helpers::Path.verify_starts_with_root(path)
-        Api::Helpers::Path.append_file_name(path, name)
+      def copy!(path, options = {}, access = {})
+        options[:name] ||= name
+        path = prepare_path("#{path}/#{options[:name]}")
 
         json = Api::Request.new do |request|
           request[:access] = access
           request[:method] = :PUT
           request[:headers] = { :'Groupdocs-Copy' => id }
-          request[:path] = "/storage/{{client_id}}/files#{path}"
+          request[:path] = "/storage/{{client_id}}/files/#{path}"
         end.execute!
 
         Storage::File.new(json[:dst_file])
@@ -272,7 +264,7 @@ module GroupDocs
           request[:path] = "/storage/{{client_id}}/files/#{id}/archive/zip"
         end.execute!
 
-        # HACK add filename for further file operations
+        # add filename for further file operations
         json[:name] = "#{name}.zip"
         Storage::File.new(json)
       end
@@ -292,6 +284,21 @@ module GroupDocs
         end.execute!
       end
 
+      #
+      # Moves file to trash on server.
+      #
+      # @param [Hash] access Access credentials
+      # @option access [String] :client_id
+      # @option access [String] :private_key
+      #
+      def move_to_trash!(access = {})
+        Api::Request.new do |request|
+          request[:access] = access
+          request[:method] = :PUT
+          request[:path] = "/storage/{{client_id}}/trash/#{path}/#{name}"
+        end.execute!
+      end
+
       #
       # Converts file to GroupDocs::Document.
       #

data/lib/groupdocs/storage/folder.rb

@@ -1,9 +1,9 @@
 module GroupDocs
   module Storage
-    class Folder < GroupDocs::Api::Entity
+    class Folder < Api::Entity
 
-      extend Extensions::Lookup
       include Api::Helpers::AccessMode
+      include Api::Helpers::Path
 
       #
       # Creates folder on server.
@@ -15,39 +15,17 @@ module GroupDocs
       # @return [GroupDocs::Storage::Folder] Created folder
       #
       def self.create!(path, access = {})
-        Api::Helpers::Path.verify_starts_with_root(path)
+        path = prepare_path(path)
 
         json = Api::Request.new do |request|
           request[:access] = access
           request[:method] = :POST
-          request[:path] = "/storage/{{client_id}}/paths#{path}"
+          request[:path] = "/storage/{{client_id}}/paths/#{path}"
         end.execute!
 
         Storage::Folder.new(json)
       end
 
-      #
-      # Returns an array of all folders on server starting with given path.
-      #
-      # @param [String] path Starting path to look for folders
-      # @param [Hash] access Access credentials
-      # @option access [String] :client_id
-      # @option access [String] :private_key
-      # @return [Array<GroupDocs::Storage::Folder>]
-      #
-      def self.all!(path = '/', access = {})
-        folders = Array.new
-        folder = GroupDocs::Storage::Folder.new(path: path)
-        folder.list!({}, access).each do |entity|
-          if entity.is_a?(GroupDocs::Storage::Folder)
-            folders << entity
-            folders += all!("#{path}/#{entity.name}", access)
-          end
-        end
-
-        folders
-      end
-
       #
       # Returns a list of all directories and files in the path.
       #
@@ -62,8 +40,8 @@ module GroupDocs
       # @option access [String] :private_key
       # @return [Array<GroupDocs::Storage::Folder, GroupDocs::Storage::File>]
       #
-      def self.list!(path = '/', options = {}, access = {})
-        Api::Helpers::Path.verify_starts_with_root(path)
+      def self.list!(path = '', options = {}, access = {})
+        path = prepare_path(path)
         new(path: path).list!(options, access)
       end
 
@@ -120,98 +98,86 @@ module GroupDocs
       end
 
       #
-      # Moves folder contents to given path.
+      # Returns an array of files and folders.
       #
-      # @param [String] destination_path Destination to move contents to
+      # @param [Hash] options Hash of options
+      # @option options [Integer] :page Page to start with
+      # @option options [Integer] :count How many items to list
+      # @option options [String] :order_by Field name to sort by
+      # @option options [Boolean] :order_asc Set to true to return in ascending order
       # @param [Hash] access Access credentials
       # @option access [String] :client_id
       # @option access [String] :private_key
-      # @return [String] Moved to folder path
+      # @return [Array<GroupDocs::Storage::Folder, GroupDocs::Storage::File>]
       #
-      def move!(destination_path, access = {})
-        Api::Helpers::Path.verify_starts_with_root(destination_path)
-        destination_path = "#{destination_path}/#{name}"
+      def list!(options = {}, access = {})
+        options[:order_by].capitalize! if options[:order_by]
+        full_path = prepare_path("#{path}/#{name}")
 
-        Api::Request.new do |request|
+        api = Api::Request.new do |request|
           request[:access] = access
-          request[:method] = :PUT
-          request[:headers] = { :'Groupdocs-Move' => path }
-          request[:path] = "/storage/{{client_id}}/folders#{destination_path}"
-        end.execute!
+          request[:method] = :GET
+          request[:path] = "/storage/{{client_id}}/folders/#{full_path}"
+        end
+        api.add_params(options)
+        json = api.execute!
 
-        destination_path
-      end
+        folders = json[:folders].map do |folder|
+          folder.merge!(path: full_path)
+          Storage::Folder.new(folder)
+        end
+        files = json[:files].map do |file|
+          file.merge!(path: full_path)
+          Storage::File.new(file)
+        end
 
-      #
-      # Renames folder to new one.
-      #
-      # @param [String] name New name
-      # @param [Hash] access Access credentials
-      # @option access [String] :client_id
-      # @option access [String] :private_key
-      # @return [String] New name
-      #
-      def rename!(name, access = {})
-        move!("/#{name}", access).sub(/^\//, '')
+        folders + files
       end
 
       #
-      # Copies folder contents to given path.
+      # Moves folder contents to given path.
       #
-      # @param [String] destination_path Destination to copy contents to
+      # @param [String] destination Destination to move contents to
       # @param [Hash] access Access credentials
       # @option access [String] :client_id
       # @option access [String] :private_key
-      # @return [String] Copied to folder path
+      # @return [String] Moved to folder path
       #
-      def copy!(destination_path, access = {})
-        Api::Helpers::Path.verify_starts_with_root(destination_path)
-        destination_path = "#{destination_path}/#{name}"
+      def move!(destination, access = {})
+        src_path = prepare_path(path)
+        dst_path = prepare_path("#{destination}/#{name}")
 
         Api::Request.new do |request|
           request[:access] = access
           request[:method] = :PUT
-          request[:headers] = { :'Groupdocs-Copy' => path }
-          request[:path] = "/storage/{{client_id}}/folders#{destination_path}"
+          request[:headers] = { :'Groupdocs-Move' => src_path }
+          request[:path] = "/storage/{{client_id}}/folders/#{dst_path}"
         end.execute!
 
-        destination_path
+        dst_path
       end
 
       #
-      # Returns an array of files and folders.
+      # Copies folder contents to given path.
       #
-      # @param [Hash] options Hash of options
-      # @option options [Integer] :page Page to start with
-      # @option options [Integer] :count How many items to list
-      # @option options [String] :order_by Field name to sort by
-      # @option options [Boolean] :order_asc Set to true to return in ascending order
+      # @param [String] destination_path Destination to copy contents to
       # @param [Hash] access Access credentials
       # @option access [String] :client_id
       # @option access [String] :private_key
-      # @return [Array<GroupDocs::Storage::Folder, GroupDocs::Storage::File>]
+      # @return [String] Copied to folder path
       #
-      def list!(options = {}, access = {})
-        options[:order_by].capitalize! if options[:order_by]
+      def copy!(destination, access = {})
+        src_path = prepare_path(path)
+        dst_path = prepare_path("#{destination}/#{name}")
 
-        api = Api::Request.new do |request|
+        Api::Request.new do |request|
           request[:access] = access
-          request[:method] = :GET
-          request[:path] = "/storage/{{client_id}}/folders#{path}/#{name}"
-        end
-        api.add_params(options)
-        json = api.execute!
-
-        folders = json[:folders].map do |folder|
-          folder.merge!(path: path)
-          Storage::Folder.new(folder)
-        end
-        files = json[:files].map do |file|
-          file.merge!(path: path)
-          Storage::File.new(file)
-        end
+          request[:method] = :PUT
+          request[:headers] = { :'Groupdocs-Copy' => src_path }
+          request[:path] = "/storage/{{client_id}}/folders/#{dst_path}"
+        end.execute!
 
-        folders + files
+        dst_path
       end
 
       #
@@ -229,7 +195,7 @@ module GroupDocs
       # @return [GroupDocs::Storage::Folder] Created folder
       #
       def create!(access = {})
-        self.class.create!("/#{name}", access)
+        self.class.create! prepare_path("#{path}/#{name}"), access
       end
 
       #
@@ -243,7 +209,7 @@ module GroupDocs
         Api::Request.new do |request|
           request[:access] = access
           request[:method] = :DELETE
-          request[:path] = "/storage/{{client_id}}/folders/#{path}/#{name}"
+          request[:path] = "/storage/{{client_id}}/folders/#{prepare_path("#{path}/#{name}")}"
         end.execute!
       end
 

data/lib/groupdocs/storage/package.rb

@@ -1,6 +1,6 @@
 module GroupDocs
   module Storage
-    class Package < GroupDocs::Api::Entity
+    class Package < Api::Entity
 
       # @attr [String] name Package name
       attr_accessor :name