groupdocs 0.2 → 0.2.1

data/lib/groupdocs/document/annotation.rb

@@ -111,7 +111,7 @@ module GroupDocs
             reply
           else
             reply.merge!(annotation: self)
-            GroupDocs::Document::Annotation::Reply.new(reply)
+            Document::Annotation::Reply.new(reply)
           end
         end
       end
@@ -144,7 +144,7 @@ module GroupDocs
     # @option access [String] :private_key
     #
     def create!(access = {})
-      json = GroupDocs::Api::Request.new do |request|
+      json = Api::Request.new do |request|
         request[:access] = access
         request[:method] = :POST
         request[:path] = "/ant/{{client_id}}/files/#{document.file.guid}/annotations"
@@ -166,7 +166,7 @@ module GroupDocs
     # @return [Array<GroupDocs::User>]
     #
     def collaborators_set!(emails, access = {})
-      json = GroupDocs::Api::Request.new do |request|
+      json = Api::Request.new do |request|
         request[:access] = access
         request[:method] = :PUT
         request[:path] = "/ant/{{client_id}}/files/#{document.file.guid}/collaborators"
@@ -174,7 +174,7 @@ module GroupDocs
       end.execute!
 
       json[:collaborators].map do |collaborator|
-        GroupDocs::User.new(collaborator)
+        User.new(collaborator)
       end
     end
     # note that aliased version cannot accept access credentials hash
@@ -188,7 +188,7 @@ module GroupDocs
     # @option access [String] :private_key
     #
     def remove!(access = {})
-      GroupDocs::Api::Request.new do |request|
+      Api::Request.new do |request|
         request[:access] = access
         request[:method] = :DELETE
         request[:path] = "/ant/{{client_id}}/annotations/#{guid}"
@@ -208,7 +208,7 @@ module GroupDocs
     # @raise [ArgumentError] If :after option is passed but it's not an instance of Time
     #
     def replies!(options = {}, access = {})
-      GroupDocs::Document::Annotation::Reply.get!(self, options, access)
+      Document::Annotation::Reply.get!(self, options, access)
     end
 
   end # Document::Annotation

data/lib/groupdocs/document/annotation/reply.rb

@@ -23,7 +23,7 @@ module GroupDocs
 
       options[:after] = (options[:after].to_i * 1000) if options[:after]
 
-      api = GroupDocs::Api::Request.new do |request|
+      api = Api::Request.new do |request|
         request[:access] = access
         request[:method] = :GET
         request[:path] = "/ant/{{client_id}}/annotations/#{annotation.guid}/replies"
@@ -33,7 +33,7 @@ module GroupDocs
 
       json[:replies].map do |reply|
         reply.merge!(annotation: annotation)
-        GroupDocs::Document::Annotation::Reply.new(reply)
+        Document::Annotation::Reply.new(reply)
       end
     end
 
@@ -101,7 +101,7 @@ module GroupDocs
     # @raise [NameError] if annotation or annotation_guid are not set
     #
     def create!(access = {})
-      json = GroupDocs::Api::Request.new do |request|
+      json = Api::Request.new do |request|
         request[:access] = access
         request[:method] = :POST
         request[:path] = "/ant/{{client_id}}/annotations/#{get_annotation_guid}/replies"
@@ -127,7 +127,7 @@ module GroupDocs
     # @option access [String] :private_key
     #
     def edit!(access = {})
-      GroupDocs::Api::Request.new do |request|
+      Api::Request.new do |request|
         request[:access] = access
         request[:method] = :PUT
         request[:path] = "/ant/{{client_id}}/replies/#{guid}"
@@ -145,7 +145,7 @@ module GroupDocs
     # @todo currently not implemented in API
     #
     def remove!(access = {})
-      GroupDocs::Api::Request.new do |request|
+      Api::Request.new do |request|
         request[:access] = access
         request[:method] = :DELETE
         request[:path] = "/ant/{{client_id}}/replies/#{guid}"

data/lib/groupdocs/extensions.rb

@@ -0,0 +1 @@
+require 'groupdocs/extensions/lookup'

data/lib/groupdocs/extensions/lookup.rb

@@ -0,0 +1,52 @@
+module GroupDocs
+  module Extensions
+    #
+    # Extends classes providing them with .find! and .find_all! class methods
+    # which is a bit of sugar for working with files, folder and documents,
+    #
+    # It's not that flexible because requires extending class to implement
+    # .all! class method.
+    #
+    # This module is a subject to modifications.
+    #
+    module Lookup
+
+      #
+      # Returns first object matching given options.
+      #
+      # @param [Symbol] attribute
+      # @param [Integer, String, Regexp] value
+      # @param [Hash] access Access credentials
+      # @option access [String] :client_id
+      # @option access [String] :private_key
+      # @return [GroupDocs::Api::Entity] Matching entity
+      #
+      def find!(attribute, value, access = {})
+        find_all!(attribute, value, access).first
+      end
+
+      #
+      # Returns all objects matching given options.
+      #
+      # Each entity has to implement #all! method for this to work.
+      #
+      # @param [Symbol] attribute
+      # @param [Integer, String, Regexp] value
+      # @param [Hash] access Access credentials
+      # @option access [String] :client_id
+      # @option access [String] :private_key
+      # @return [Array] Array of matching entities
+      #
+      # @raise [NoMethodError] if extending class does not implement .all! class method.
+      #
+      def find_all!(attribute, value, access = {})
+        respond_to?(:all!) or raise NoMethodError, "#{self}.all! is not implemented - aborting."
+
+        all!('/', access).select do |object|
+          value === object.send(attribute)
+        end
+      end
+
+    end # Lookup
+  end # Extensions
+end # GroupDocs

data/lib/groupdocs/job.rb

@@ -1,8 +1,8 @@
 module GroupDocs
   class Job < GroupDocs::Api::Entity
 
-    extend GroupDocs::Api::Helpers::Actions
-    include GroupDocs::Api::Helpers::Status
+    extend Api::Helpers::Actions
+    include Api::Helpers::Status
 
     #
     # Returns array of recent jobs.
@@ -16,7 +16,7 @@ module GroupDocs
     # @return [Array<GroupDocs::Job>]
     #
     def self.all!(options = {}, access = {})
-      api = GroupDocs::Api::Request.new do |request|
+      api = Api::Request.new do |request|
         request[:access] = access
         request[:method] = :GET
         request[:path] = '/async/{{client_id}}/jobs'
@@ -25,7 +25,7 @@ module GroupDocs
       json = api.execute!
 
       json[:jobs].map do |job|
-        GroupDocs::Job.new(job)
+        Job.new(job)
       end
     end
 
@@ -47,7 +47,7 @@ module GroupDocs
       options[:actions] = convert_actions(options[:actions])
       options[:out_formats] = options[:out_formats].join(?;) if options[:out_formats]
 
-      api = GroupDocs::Api::Request.new do |request|
+      api = Api::Request.new do |request|
         request[:access] = access
         request[:method] = :POST
         request[:path] = '/async/{{client_id}}/jobs'
@@ -55,7 +55,7 @@ module GroupDocs
       end
       json = api.execute!
 
-      GroupDocs::Job.new(id: json[:job_id])
+      Job.new(id: json[:job_id])
     end
 
     # @attr [Integer] id
@@ -71,7 +71,7 @@ module GroupDocs
     def documents=(documents)
       @documents = documents.map do |document|
         document.merge!(file: GroupDocs::Storage::File.new(document))
-        GroupDocs::Document.new(document)
+        Document.new(document)
       end
     end
 
@@ -84,7 +84,7 @@ module GroupDocs
     # @return [Array<GroupDocs::Document>]
     #
     def documents!(access = {})
-      json = GroupDocs::Api::Request.new do |request|
+      json = Api::Request.new do |request|
         request[:access] = access
         request[:method] = :GET
         request[:path] = "/async/{{client_id}}/jobs/#{id}/documents"
@@ -92,7 +92,7 @@ module GroupDocs
 
       json[:documents].map do |document|
         document.merge!(file: GroupDocs::Storage::File.new(document))
-        GroupDocs::Document.new(document)
+        Document.new(document)
       end
     end
 
@@ -113,7 +113,7 @@ module GroupDocs
       document.is_a?(GroupDocs::Document) or raise ArgumentError,
         "Document should be GroupDocs::Document object. Received: #{document.inspect}"
 
-      api = GroupDocs::Api::Request.new do |request|
+      api = Api::Request.new do |request|
         request[:access] = access
         request[:method] = :PUT
         request[:path] = "/async/{{client_id}}/jobs/#{id}/files/#{document.file.guid}"
@@ -144,7 +144,7 @@ module GroupDocs
       datasource.is_a?(GroupDocs::DataSource) or raise ArgumentError,
         "Datasource should be GroupDocs::DataSource object. Received: #{datasource.inspect}"
 
-      GroupDocs::Api::Request.new do |request|
+      Api::Request.new do |request|
         request[:access] = access
         request[:method] = :PUT
         request[:path] = "/async/{{client_id}}/jobs/#{id}/files/#{document.file.guid}/datasources/#{datasource.id}"
@@ -165,7 +165,7 @@ module GroupDocs
     def add_url!(url, options = {}, access = {})
       options.merge!(absolute_url: url)
 
-      api = GroupDocs::Api::Request.new do |request|
+      api = Api::Request.new do |request|
         request[:access] = access
         request[:method] = :PUT
         request[:path] = "/async/{{client_id}}/jobs/#{id}/urls"
@@ -189,7 +189,7 @@ module GroupDocs
     def update!(options, access = {})
       options[:status] = parse_status(options[:status]) if options[:status]
 
-      GroupDocs::Api::Request.new do |request|
+      Api::Request.new do |request|
         request[:access] = access
         request[:method] = :PUT
         request[:path] = "/async/{{client_id}}/jobs/#{id}"

data/lib/groupdocs/questionnaire.rb

@@ -5,7 +5,7 @@ module GroupDocs
     require 'groupdocs/questionnaire/page'
     require 'groupdocs/questionnaire/question'
 
-    include GroupDocs::Api::Helpers::Access
+    include Api::Helpers::AccessMode
 
     #
     # Returns an array of all questionnaires.
@@ -16,14 +16,14 @@ module GroupDocs
     # @return [Array<GroupDocs::Questionnaire>]
     #
     def self.all!(access = {})
-      json = GroupDocs::Api::Request.new do |request|
+      json = Api::Request.new do |request|
         request[:access] = access
         request[:method] = :GET
         request[:path] = '/merge/{{client_id}}/questionnaires'
       end.execute!
 
       json[:questionnaires].map do |questionnaire|
-        GroupDocs::Questionnaire.new(questionnaire)
+        Questionnaire.new(questionnaire)
       end
     end
 
@@ -37,13 +37,13 @@ module GroupDocs
     # @return [GroupDocs::Questionnaire, nil]
     #
     def self.get!(id, access = {})
-      json = GroupDocs::Api::Request.new do |request|
+      json = Api::Request.new do |request|
         request[:access] = access
         request[:method] = :GET
         request[:path] = "/merge/{{client_id}}/questionnaires/#{id}"
       end.execute!
 
-      GroupDocs::Questionnaire.new(json[:questionnaire])
+      Questionnaire.new(json[:questionnaire])
     rescue RestClient::BadRequest
       nil
     end
@@ -57,14 +57,14 @@ module GroupDocs
     # @return [Array<GroupDocs::Questionnaire::Execution>]
     #
     def self.executions!(access = {})
-      json = GroupDocs::Api::Request.new do |request|
+      json = Api::Request.new do |request|
         request[:access] = access
         request[:method] = :GET
         request[:path] = '/merge/{{client_id}}/questionnaires/executions'
       end.execute!
 
       json[:executions].map do |execution|
-        GroupDocs::Questionnaire::Execution.new(execution)
+        Questionnaire::Execution.new(execution)
       end
     end
 
@@ -92,7 +92,7 @@ module GroupDocs
           if page.is_a?(GroupDocs::Questionnaire::Page)
             page
           else
-            GroupDocs::Questionnaire::Page.new(page)
+            Questionnaire::Page.new(page)
           end
         end
       end
@@ -120,7 +120,7 @@ module GroupDocs
     # @option access [String] :private_key
     #
     def create!(access = {})
-      json = GroupDocs::Api::Request.new do |request|
+      json = Api::Request.new do |request|
         request[:access] = access
         request[:method] = :POST
         request[:path] = '/merge/{{client_id}}/questionnaires'
@@ -138,7 +138,7 @@ module GroupDocs
     # @option access [String] :private_key
     #
     def update!(access = {})
-      GroupDocs::Api::Request.new do |request|
+      Api::Request.new do |request|
         request[:access] = access
         request[:method] = :PUT
         request[:path] = "/merge/{{client_id}}/questionnaires/#{id}"
@@ -154,7 +154,7 @@ module GroupDocs
     # @option access [String] :private_key
     #
     def remove!(access = {})
-      GroupDocs::Api::Request.new do |request|
+      Api::Request.new do |request|
         request[:access] = access
         request[:method] = :DELETE
         request[:path] = "/merge/{{client_id}}/questionnaires/#{id}"
@@ -173,14 +173,14 @@ module GroupDocs
     # @return [Array<GroupDocs::DataSource>]
     #
     def datasources!(access = {})
-      json = GroupDocs::Api::Request.new do |request|
+      json = Api::Request.new do |request|
         request[:access] = access
         request[:method] = :GET
         request[:path] = "/merge/{{client_id}}/questionnaires/#{id}/datasources"
       end.execute!
 
       json[:datasources].map do |datasource|
-        GroupDocs::DataSource.new(datasource)
+        DataSource.new(datasource)
       end
     end
 
@@ -204,7 +204,7 @@ module GroupDocs
       execution.is_a?(GroupDocs::Questionnaire::Execution) or raise ArgumentError,
         "Execution should be GroupDocs::Questionnaire::Execution object, received: #{execution.inspect}"
 
-      json = GroupDocs::Api::Request.new do |request|
+      json = Api::Request.new do |request|
         request[:access] = access
         request[:method] = :POST
         request[:path] = "/merge/{{client_id}}/questionnaires/#{id}/executions"

data/lib/groupdocs/questionnaire/execution.rb

@@ -19,7 +19,7 @@ module GroupDocs
     # @return [Array<GroupDocs::Questionnaire::Execution>]
     #
     def self.all!(access = {})
-      GroupDocs::Questionnaire.executions!(access)
+      Questionnaire.executions!(access)
     end
 
     # @attr [Integer] id
@@ -90,7 +90,7 @@ module GroupDocs
     # @option access [String] :private_key
     #
     def set_status!(status, access = {})
-      GroupDocs::Api::Request.new do |request|
+      Api::Request.new do |request|
         request[:access] = access
         request[:method] = :PUT
         request[:path] = "/merge/{{client_id}}/questionnaires/executions/#{id}/status"
@@ -108,7 +108,7 @@ module GroupDocs
     # @option access [String] :private_key
     #
     def update!(access = {})
-      GroupDocs::Api::Request.new do |request|
+      Api::Request.new do |request|
         request[:access] = access
         request[:method] = :PUT
         request[:path] = "/merge/{{client_id}}/questionnaires/executions/#{id}"

data/lib/groupdocs/questionnaire/page.rb

@@ -19,7 +19,7 @@ module GroupDocs
           if question.is_a?(GroupDocs::Questionnaire::Question)
             question
           else
-            GroupDocs::Questionnaire::Question.new(question)
+            Questionnaire::Question.new(question)
           end
         end
       end

data/lib/groupdocs/questionnaire/question.rb

@@ -32,7 +32,7 @@ module GroupDocs
           if answer.is_a?(GroupDocs::Questionnaire::Question::Answer)
             answer
           else
-            GroupDocs::Questionnaire::Question::Answer.new(answer)
+            Questionnaire::Question::Answer.new(answer)
           end
         end
       end

data/lib/groupdocs/storage.rb

@@ -19,7 +19,7 @@ module GroupDocs
     # @return [Hash]
     #
     def self.info!(access = {})
-      json = GroupDocs::Api::Request.new do |request|
+      json = Api::Request.new do |request|
         request[:access] = access
         request[:method] = :GET
         request[:path] = '/storage/{{client_id}}'

data/lib/groupdocs/storage/file.rb

@@ -2,7 +2,8 @@ module GroupDocs
   module Storage
     class File < GroupDocs::Api::Entity
 
-      extend GroupDocs::Api::Sugar::Lookup
+      extend Extensions::Lookup
+      include Api::Helpers::AccessMode
 
       DOCUMENT_TYPES = {
         undefined: -1,
@@ -31,17 +32,17 @@ module GroupDocs
       # @raise [ArgumentError] If path does not start with /
       #
       def self.upload!(filepath, upload_path = '/', access = {})
-        upload_path.chars.first == '/' or raise ArgumentError, "Path should start with /: #{upload_path.inspect}"
-        upload_path << "/#{Object::File.basename(filepath)}" unless upload_path =~ /\.(\w){3,4}$/
+        Api::Helpers::Path.verify_starts_with_root(upload_path)
+        Api::Helpers::Path.append_file_name(upload_path, filepath)
 
-        json = GroupDocs::Api::Request.new do |request|
+        json = Api::Request.new do |request|
           request[:access] = access
           request[:method] = :POST
           request[:path] = "/storage/{{client_id}}/folders#{upload_path}"
           request[:request_body] = Object::File.new(filepath, 'rb')
         end.execute!
 
-        GroupDocs::Storage::File.new(json)
+        Storage::File.new(json)
       end
 
       #
@@ -132,6 +133,15 @@ module GroupDocs
         Time.at(@created_on)
       end
 
+      #
+      # Converts access mode to human-readable format.
+      #
+      # @return [Symbol]
+      #
+      def access
+        parse_access_mode(@access)
+      end
+
       #
       # Converts timestamp which is return by API server to Time object.
       #
@@ -151,7 +161,7 @@ module GroupDocs
       # @return [String] Path to downloaded file
       #
       def download!(path, access = {})
-        response = GroupDocs::Api::Request.new do |request|
+        response = Api::Request.new do |request|
           request[:access] = access
           request[:method] = :DOWNLOAD
           request[:path] = "/storage/{{client_id}}/files/#{id}"
@@ -175,20 +185,18 @@ module GroupDocs
       # @option access [String] :private_key
       # @return [GroupDocs::Storage::File] Moved to file
       #
-      # @raise [ArgumentError] If path does not start with /
-      #
       def move!(path, access = {})
-        path.chars.first == '/' or raise ArgumentError, "Path should start with /: #{path.inspect}"
-        path << "/#{Object::File.basename(name)}" unless path =~ /\.(\w){3,4}$/
+        Api::Helpers::Path.verify_starts_with_root(path)
+        Api::Helpers::Path.append_file_name(path, name)
 
-        json = GroupDocs::Api::Request.new do |request|
+        json = Api::Request.new do |request|
           request[:access] = access
           request[:method] = :PUT
           request[:headers] = { :'Groupdocs-Move' => id }
           request[:path] = "/storage/{{client_id}}/files#{path}"
         end.execute!
 
-        GroupDocs::Storage::File.new(json[:dst_file])
+        Storage::File.new(json[:dst_file])
       end
 
       #
@@ -214,20 +222,18 @@ module GroupDocs
       # @option access [String] :private_key
       # @return [GroupDocs::Storage::File] Copied to file
       #
-      # @raise [ArgumentError] If path does not start with /
-      #
       def copy!(path, access = {})
-        path.chars.first == '/' or raise ArgumentError, "Path should start with /: #{path.inspect}"
-        path << "/#{Object::File.basename(name)}" unless path =~ /\.(\w){3,4}$/
+        Api::Helpers::Path.verify_starts_with_root(path)
+        Api::Helpers::Path.append_file_name(path, name)
 
-        json = GroupDocs::Api::Request.new do |request|
+        json = Api::Request.new do |request|
           request[:access] = access
           request[:method] = :PUT
           request[:headers] = { :'Groupdocs-Copy' => id }
           request[:path] = "/storage/{{client_id}}/files#{path}"
         end.execute!
 
-        GroupDocs::Storage::File.new(json[:dst_file])
+        Storage::File.new(json[:dst_file])
       end
 
       #
@@ -239,7 +245,7 @@ module GroupDocs
       # @return [GroupDocs::Storage::File] Archive file
       #
       def compress!(access = {})
-        json = GroupDocs::Api::Request.new do |request|
+        json = Api::Request.new do |request|
           request[:access] = access
           request[:method] = :POST
           request[:path] = "/storage/{{client_id}}/files/#{id}/archive/zip"
@@ -247,7 +253,7 @@ module GroupDocs
 
         # HACK add filename for further file operations
         json[:name] = "#{name}.zip"
-        GroupDocs::Storage::File.new(json)
+        Storage::File.new(json)
       end
 
       #
@@ -258,14 +264,11 @@ module GroupDocs
       # @option access [String] :private_key
       #
       def delete!(access = {})
-        GroupDocs::Api::Request.new do |request|
+        Api::Request.new do |request|
           request[:access] = access
           request[:method] = :DELETE
           request[:path] = "/storage/{{client_id}}/files/#{guid}"
         end.execute!
-      # TODO: workaround for http://scotland.groupdocs.com/jira/browse/CORE-423
-      rescue RestClient::BadRequest
-        nil
       end
 
       #
@@ -274,7 +277,7 @@ module GroupDocs
       # @return [GroupDocs::Document]
       #
       def to_document
-        GroupDocs::Document.new(file: self)
+        Document.new(file: self)
       end
 
     end # File