groupdocs 0.3.11 → 1.0.0

data/lib/groupdocs/api/helpers/rest_helper.rb

@@ -1,3 +1,6 @@
+require 'json'
+require 'rest-client'
+
 module GroupDocs
   module Api
     module Helpers
@@ -25,8 +28,10 @@ module GroupDocs
           options[:method] = options[:method].downcase.to_sym
 
           if options[:request_body] && !options[:request_body].is_a?(Object::File)
-            options[:request_body] = options[:request_body].to_json
-            options[:headers][:content_type]= 'application/json'
+            unless options[:plain]
+              options[:request_body] = options[:request_body].to_json
+              options[:headers][:content_type]= 'application/json'
+            end
             options[:headers][:content_length] = options[:request_body].length
           end
         end

data/lib/groupdocs/api/helpers/url_helper.rb

@@ -1,5 +1,4 @@
 require 'base64'
-require 'hmac-sha1'
 require 'uri'
 require 'cgi'
 
@@ -56,9 +55,8 @@ module GroupDocs
         #
         def sign_url
           # calculate a hash of the path with private key
-          hash = HMAC::SHA1.new(private_key)
-          hash << options[:path]
-          hash = hash.digest
+          hash = OpenSSL::Digest::Digest.new('sha1')
+          hash = OpenSSL::HMAC.digest(hash, private_key, options[:path])
           # convert hash to base64
           hash = Base64.strict_encode64(hash)
           # remove trailing '='

data/lib/groupdocs/api/request.rb

@@ -1,4 +1,3 @@
-require 'json'
 require 'groupdocs/api/helpers'
 
 module GroupDocs
@@ -32,7 +31,8 @@ module GroupDocs
       # @option options [String] :path Path to send request to
       # @option options [Hash] :headers Additional HTTP headers
       # @option options [Hash] :access Access credentials hash
-      # @option options [Hash, File] :request_body Payload. If hash, will be converted to JSON, if File, will be send as is.
+      # @option options [Hash, String, Array, File] :request_body payload
+      # @option options [Boolean] :plain Send payload as plain text (i.e. do not convert to JSON)
       #
       # @yieldparam [Hash] options
       #
@@ -47,7 +47,6 @@ module GroupDocs
       # Executes API request to server.
       #
       # It performs the following actions step by step:
-      #   * Normalizes path (i.e. replace // with /)
       #   * Parses path (i.e. replaces client ID)
       #   * Prepends path with version if it's set
       #   * URL encodes path
@@ -59,7 +58,6 @@ module GroupDocs
       # @return [Hash, String] Parsed response
       #
       def execute!
-        normalize_path
         parse_path
         prepend_version
         url_encode_path

data/lib/groupdocs/datasource.rb

@@ -1,5 +1,5 @@
 module GroupDocs
-  class DataSource < GroupDocs::Api::Entity
+  class DataSource < Api::Entity
 
     require 'groupdocs/datasource/field'
 
@@ -153,7 +153,7 @@ module GroupDocs
         request[:method] = :DELETE
         request[:path] = "/merge/{{client_id}}/datasources/#{id}"
       end.execute!
-    # TODO: fix this in API
+    # TODO: fix this in API - http://scotland.groupdocs.com/jira/browse/CORE-387
     rescue RestClient::BadRequest
       nil
     end

data/lib/groupdocs/datasource/field.rb

@@ -1,5 +1,5 @@
 module GroupDocs
-  class DataSource::Field < GroupDocs::Api::Entity
+  class DataSource::Field < Api::Entity
 
     # @attr [String] name
     attr_accessor :name

data/lib/groupdocs/document.rb

@@ -1,5 +1,5 @@
 module GroupDocs
-  class Document < GroupDocs::Api::Entity
+  class Document < Api::Entity
 
     require 'groupdocs/document/annotation'
     require 'groupdocs/document/change'
@@ -15,23 +15,9 @@ module GroupDocs
       public:     3,
     }
 
-    extend Extensions::Lookup
     include Api::Helpers::AccessMode
     include Api::Helpers::Status
 
-    #
-    # Returns an array of all documents on server.
-    #
-    # @param [String] path Starting path to look for documents
-    # @param [Hash] access Access credentials
-    # @option access [String] :client_id
-    # @option access [String] :private_key
-    # @return [Array<GroupDocs::Storage::Document>]
-    #
-    def self.all!(path = '/', access = {})
-      Storage::File.all!(path, access).map(&:to_document)
-    end
-
     #
     # Returns an array of views for all documents.
     #
@@ -67,6 +53,8 @@ module GroupDocs
     attr_accessor :output_formats
     # @attr [Symbol] status
     attr_accessor :status
+    # @attr [Integet] order
+    attr_accessor :order
 
     #
     # Coverts passed array of attributes hash to array of GroupDocs::Storage::File.
@@ -303,7 +291,7 @@ module GroupDocs
     # Converts document to given format.
     #
     # @example
-    #   document = GroupDocs::Document.find!(:name, 'CV.doc')
+    #   document = GroupDocs::Storage::Folder.list!.first.to_document
     #   job = document.convert!(:docx)
     #   sleep(5) # wait for server to finish converting
     #   original_document = job.documents!.first
@@ -522,8 +510,8 @@ module GroupDocs
     # Returns an array of changes in document.
     #
     # @example
-    #   document_one = GroupDocs::Document.find!(:name, 'CV.doc')
-    #   document_two = GroupDocs::Document.find!(:name, 'Resume.doc')
+    #   document_one = GroupDocs::Storage::Folder.list![0].to_document
+    #   document_two = GroupDocs::Storage::Folder.list![1].to_document
     #   job = document_one.compare!(document_two)
     #   sleep(5) # wait for server to finish comparing
     #   result = job.documents!.first

data/lib/groupdocs/document/annotation.rb

@@ -1,5 +1,5 @@
 module GroupDocs
-  class Document::Annotation < GroupDocs::Api::Entity
+  class Document::Annotation < Api::Entity
 
     require 'groupdocs/document/annotation/reply'
 
@@ -17,6 +17,8 @@ module GroupDocs
     attr_accessor :sessionGuid
     # @attr [String] documentGuid
     attr_accessor :documentGuid
+    # @attr [String] creatorGuid
+    attr_accessor :creatorGuid
     # @attr [String] replyGuid
     attr_accessor :replyGuid
     # @attr [Time] createdOn
@@ -40,6 +42,8 @@ module GroupDocs
     alias_method :session_guid=,        :sessionGuid=
     alias_method :document_guid,        :documentGuid
     alias_method :document_guid=,       :documentGuid=
+    alias_method :creator_guid,         :creatorGuid
+    alias_method :creator_guid=,        :creatorGuid=
     alias_method :reply_guid,           :replyGuid
     alias_method :reply_guid=,          :replyGuid=
     alias_method :created_on,           :createdOn
@@ -156,7 +160,7 @@ module GroupDocs
     # Creates new annotation.
     #
     # @example
-    #   document = GroupDocs::Document.find!(:name, 'CV.doc')
+    #   document = GroupDocs::Storage::Folder.list!.first.to_document
     #   annotation = GroupDocs::Document::Annotation.new(document: document)
     #   annotation.create!
     #
@@ -272,5 +276,24 @@ module GroupDocs
       self.annotation_position = { x: x, y: y }
     end
 
+    #
+    # Sets access mode.
+    #
+    # @param [Symbol] mode
+    # @param [Hash] access Access credentials
+    # @option access [String] :client_id
+    # @option access [String] :private_key
+    #
+    def set_access!(mode, access = {})
+      Api::Request.new do |request|
+        request[:access] = access
+        request[:method] = :PUT
+        request[:path] = "/ant/{{client_id}}/annotations/#{guid}/annotationAccess"
+        request[:request_body] = %w(public private).index(mode.to_s)
+      end.execute!
+
+      self.access = mode
+    end
+
   end # Document::Annotation
 end # GroupDocs

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

@@ -1,5 +1,5 @@
 module GroupDocs
-  class Document::Annotation::Reply < GroupDocs::Api::Entity
+  class Document::Annotation::Reply < Api::Entity
 
     #
     # Return an array of replies for given annotation.
@@ -88,8 +88,8 @@ module GroupDocs
     # Creates reply.
     #
     # @example
-    #   document = GroupDocs::Document.find!(:name, 'CV.doc')
-    #   annotation = GroupDocs::Document::Annotation.new(document: document)
+    #   document = GroupDocs::Storage::Folder.list!.first.to_document
+    #   annotation = document.annotations!.first
     #   reply = GroupDocs::Document::Annotation::Reply.new(annotation: annotation)
     #   reply.text = "Reply text"
     #   reply.create!
@@ -98,14 +98,12 @@ module GroupDocs
     # @option access [String] :client_id
     # @option access [String] :private_key
     #
-    # @raise [NameError] if annotation or annotation_guid are not set
-    #
     def create!(access = {})
       json = Api::Request.new do |request|
         request[:access] = access
         request[:method] = :POST
         request[:path] = "/ant/{{client_id}}/annotations/#{get_annotation_guid}/replies"
-        request[:request_body] = text
+        request[:request_body] = { text: text }
       end.execute!
 
       self.guid            = json[:replyGuid]
@@ -116,7 +114,7 @@ module GroupDocs
     # Edits reply.
     #
     # @example
-    #   document = GroupDocs::Document.find!(:name, 'CV.doc')
+    #   document = GroupDocs::Storage::Folder.list!.first.to_document
     #   annotation = document.annotations!.first
     #   reply = annotation.replies!.first
     #   reply.text = "New reply text"
@@ -142,8 +140,6 @@ module GroupDocs
     # @option access [String] :client_id
     # @option access [String] :private_key
     #
-    # @todo currently not implemented in API
-    #
     def remove!(access = {})
       Api::Request.new do |request|
         request[:access] = access
@@ -157,7 +153,7 @@ module GroupDocs
     #
     # Returns annotation guid.
     #
-    # @returns [String]
+    # @return [String]
     #
     def get_annotation_guid
       annotation_guid || annotation.guid

data/lib/groupdocs/document/change.rb

@@ -1,5 +1,5 @@
 module GroupDocs
-  class Document::Change < GroupDocs::Api::Entity
+  class Document::Change < Api::Entity
 
     # @attr [Integer] id
     attr_accessor :id

data/lib/groupdocs/document/field.rb

@@ -1,5 +1,5 @@
 module GroupDocs
-  class Document::Field < GroupDocs::Api::Entity
+  class Document::Field < Api::Entity
 
     # @attr [Integer] page
     attr_accessor :page

data/lib/groupdocs/document/metadata.rb

@@ -1,5 +1,5 @@
 module GroupDocs
-  class Document::MetaData < GroupDocs::Api::Entity
+  class Document::MetaData < Api::Entity
 
     # @attr [Integer] id
     attr_accessor :id

data/lib/groupdocs/document/rectangle.rb

@@ -1,5 +1,5 @@
 module GroupDocs
-  class Document::Rectangle < GroupDocs::Api::Entity
+  class Document::Rectangle < Api::Entity
 
     # @attr [Float] X
     attr_accessor :X

data/lib/groupdocs/document/view.rb

@@ -1,5 +1,5 @@
 module GroupDocs
-  class Document::View < GroupDocs::Api::Entity
+  class Document::View < Api::Entity
 
     # @attr [GroupDocs::Document] document
     attr_accessor :document

data/lib/groupdocs/job.rb

@@ -1,11 +1,11 @@
 module GroupDocs
-  class Job < GroupDocs::Api::Entity
+  class Job < Api::Entity
 
     extend Api::Helpers::Actions
     include Api::Helpers::Status
 
     #
-    # Returns array of recent jobs.
+    # Returns array of jobs.
     #
     # @param [Hash] options Hash of options
     # @option options [Integer] :page Page to start with
@@ -29,6 +29,25 @@ module GroupDocs
       end
     end
 
+    #
+    # Returns job by its identifier.
+    #
+    # @param [Integer] id
+    # @param [Hash] access Access credentials
+    # @option access [String] :client_id
+    # @option access [String] :private_key
+    # @return [GroupDocs::Job]
+    #
+    def self.get!(id, access = {})
+      json = Api::Request.new do |request|
+        request[:access] = access
+        request[:method] = :GET
+        request[:path] = "/async/{{client_id}}/jobs/#{id}"
+      end.execute!
+
+      Job.new(json)
+    end
+
     #
     # Creates new draft job.
     #
@@ -55,11 +74,17 @@ module GroupDocs
       end
       json = api.execute!
 
-      Job.new(id: json[:job_id])
+      Job.new(id: json[:job_id], guid: json[:job_guid])
     end
 
     # @attr [Integer] id
     attr_accessor :id
+    # @attr [String] guid
+    attr_accessor :guid
+    # @attr [String] name
+    attr_accessor :name
+    # @attr [Integer] priority
+    attr_accessor :priority
     # @attr [Array<Symbol>] actions
     attr_accessor :actions
     # @attr [Boolean] email_results
@@ -130,9 +155,13 @@ module GroupDocs
       end.execute!
 
       self.status = json[:job_status]
-      json[:inputs].map do |document|
-        document.merge!(file: GroupDocs::Storage::File.new(document))
-        Document.new(document)
+      if json[:inputs]
+        json[:inputs].map do |document|
+          document.merge!(file: GroupDocs::Storage::File.new(document))
+          Document.new(document)
+        end
+      else
+        []
       end
     end
 
@@ -164,6 +193,22 @@ module GroupDocs
       json[:document_id]
     end
 
+    #
+    # Deletes document with guid from job.
+    #
+    # @param [String] guid
+    # @param [Hash] access Access credentials
+    # @option access [String] :client_id
+    # @option access [String] :private_key
+    #
+    def delete_document!(guid, access = {})
+      Api::Request.new do |request|
+        request[:access] = access
+        request[:method] = :DELETE
+        request[:path] = "/async/{{client_id}}/jobs/#{id}/documents/#{guid}"
+      end.execute!
+    end
+
     #
     # Adds datasource to job document.
     #
@@ -176,8 +221,6 @@ module GroupDocs
     # @raise [ArgumentError] If document is not a GroupDocs::Document object
     # @raise [ArgumentError] If datasource is not a GroupDocs::DataSource object
     #
-    # @todo returns 404 (http://scotland.groupdocs.com/jira/browse/CORE-384)
-    #
     def add_datasource!(document, datasource, access = {})
       document.is_a?(GroupDocs::Document) or raise ArgumentError,
         "Document should be GroupDocs::Document object. Received: #{document.inspect}"

data/lib/groupdocs/questionnaire.rb

@@ -1,5 +1,5 @@
 module GroupDocs
-  class Questionnaire < GroupDocs::Api::Entity
+  class Questionnaire < Api::Entity
 
     require 'groupdocs/questionnaire/execution'
     require 'groupdocs/questionnaire/page'
@@ -157,7 +157,7 @@ module GroupDocs
         request[:method] = :DELETE
         request[:path] = "/merge/{{client_id}}/questionnaires/#{id}"
       end.execute!
-    # TODO: fix this in API
+    # TODO: fix this in API - http://scotland.groupdocs.com/jira/browse/CORE-391
     rescue RestClient::BadRequest
       nil
     end

data/lib/groupdocs/questionnaire/execution.rb

@@ -1,5 +1,5 @@
 module GroupDocs
-  class Questionnaire::Execution < GroupDocs::Api::Entity
+  class Questionnaire::Execution < Api::Entity
 
     include Api::Helpers::Status
 

data/lib/groupdocs/questionnaire/page.rb

@@ -1,5 +1,5 @@
 module GroupDocs
-  class Questionnaire::Page < GroupDocs::Api::Entity
+  class Questionnaire::Page < Api::Entity
 
     # @attr [Integer] number
     attr_accessor :number