groupdocs 1.1.0 → 1.2.0

data/groupdocs.gemspec

@@ -17,11 +17,12 @@ Gem::Specification.new do |s|
 
   s.add_runtime_dependency 'rest-client', '~> 1.6'
   s.add_runtime_dependency 'json'       , '~> 1.7'
+  s.add_runtime_dependency 'mime-types' , '~> 1.19'
 
-  s.add_development_dependency 'rspec'    , '~> 2.11'
+  s.add_development_dependency 'rspec'    , '~> 2.12'
   s.add_development_dependency 'fuubar'   , '~> 1.1'
-  s.add_development_dependency 'rake'     , '~> 0.9'
-  s.add_development_dependency 'simplecov', '~> 0.6'
+  s.add_development_dependency 'rake'     , '~> 10.0'
+  s.add_development_dependency 'simplecov', '~> 0.7'
   s.add_development_dependency 'yard'     , '~> 0.8'
-  s.add_development_dependency 'webmock'  , '~> 1.8'
+  s.add_development_dependency 'webmock'  , '~> 1.9'
 end

data/lib/groupdocs/api.rb

@@ -1,2 +1,3 @@
+require 'groupdocs/api/helpers'
 require 'groupdocs/api/entity'
 require 'groupdocs/api/request'

data/lib/groupdocs/api/entity.rb

@@ -2,6 +2,8 @@ module GroupDocs
   module Api
     class Entity
 
+      extend Api::Helpers::Accessor
+
       #
       # Implements flexible API object creation.
       #

data/lib/groupdocs/api/helpers.rb

@@ -1,7 +1,9 @@
 require 'groupdocs/api/helpers/byte_flag_helper'
 require 'groupdocs/api/helpers/access_mode_helper'
 require 'groupdocs/api/helpers/access_rights_helper'
+require 'groupdocs/api/helpers/accessor_helper'
 require 'groupdocs/api/helpers/credentials_helper'
+require 'groupdocs/api/helpers/mime_helper'
 require 'groupdocs/api/helpers/path_helper'
 require 'groupdocs/api/helpers/rest_helper'
 require 'groupdocs/api/helpers/status_helper'

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

@@ -0,0 +1,30 @@
+module GroupDocs
+  module Api
+    module Helpers
+      module Accessor
+
+        #
+        # Allows to easily alias accessors.
+        #
+        # @example
+        #   class File < Api::Entity
+        #     attr_accessor :fileName
+        #     alias_accessor :file_name, :fileName
+        #   end
+        #   file = File.new
+        #   file.file_name = "document"
+        #   file.file_name
+        #   #=> "document"
+        #
+        # @param [Symbol] new_name
+        # @param [Symbol] old_name
+        #
+        def alias_accessor(new_name, old_name)
+          alias_method :"#{new_name}",  :"#{old_name}"
+          alias_method :"#{new_name}=", :"#{old_name}="
+        end
+
+      end # Accessor
+    end # Helpers
+  end # Api
+end # GroupDocs

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

@@ -0,0 +1,21 @@
+require 'mime/types'
+
+module GroupDocs
+  module Api
+    module Helpers
+      module MIME
+
+        private
+
+        #
+        # Returns MIME type for file.
+        # @api private
+        #
+        def mime_type(filepath)
+          ::MIME::Types.type_for(filepath).first
+        end
+
+      end # MIME
+    end # Helpers
+  end # Api
+end # GroupDocs

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

@@ -7,8 +7,9 @@ module GroupDocs
       module REST
 
         DEFAULT_HEADERS = {
-          accept:         'application/json',
-          content_length: 0
+          accept: 'application/json',
+          content_length: 0,
+          groupdocs_referrer: "ruby/#{VERSION}"
         }
 
         private

data/lib/groupdocs/api/request.rb

@@ -1,5 +1,3 @@
-require 'groupdocs/api/helpers'
-
 module GroupDocs
   module Api
     class Request
@@ -9,7 +7,7 @@ module GroupDocs
       include Api::Helpers::REST
 
       # @attr_reader [RestClient::Resource] resource Entry point for all API requests
-      attr_reader   :resource
+      attr_reader :resource
       # @attr [String] response Response from server in JSON format
       attr_accessor :response
       # @attr [Hash] options Hash of options

data/lib/groupdocs/datasource.rb

@@ -42,8 +42,7 @@ module GroupDocs
     attr_accessor :fields
 
     # Human-readable accessors
-    alias_method :description,  :descr
-    alias_method :description=, :descr=
+    alias_accessor :description, :descr
 
     #
     # Converts timestamp which is return by API server to Time object.

data/lib/groupdocs/document.rb

@@ -18,6 +18,7 @@ module GroupDocs
     include Api::Helpers::AccessMode
     include Api::Helpers::AccessRights
     include Api::Helpers::Status
+    extend Api::Helpers::MIME
 
     #
     # Returns an array of views for all documents.
@@ -34,7 +35,7 @@ module GroupDocs
       api = Api::Request.new do |request|
         request[:access] = access
         request[:method] = :GET
-        request[:path] = "/doc/{{client_id}}/views"
+        request[:path] = '/doc/{{client_id}}/views'
       end
       api.add_params(options)
       json = api.execute!
@@ -44,6 +45,101 @@ module GroupDocs
       end
     end
 
+    #
+    # Returns an array of all templates (documents in "Templates" directory).
+    #
+    # @param [Hash] access Access credentials
+    # @option access [String] :client_id
+    # @option access [String] :private_key
+    # @return [Array<GroupDocs::Document>]
+    #
+    def self.templates!(options = {}, access = {})
+      json = Api::Request.new do |request|
+        request[:access] = access
+        request[:method] = :GET
+        request[:path] = '/merge/{{client_id}}/templates'
+      end.execute!
+
+      json[:templates].map do |template|
+        template.merge!(file: Storage::File.new(template))
+        Document.new(template)
+      end
+    end
+
+    #
+    # Signs given documents with signatures.
+    #
+    # @example
+    #   # prepare documents
+    #   file_one = GroupDocs::Storage::File.new(name: 'document_one.doc', local_path: '~/Documents/document_one.doc')
+    #   file_two = GroupDocs::Storage::File.new(name: 'document_one.pdf', local_path: '~/Documents/document_one.pdf')
+    #   document_one = file_one.to_document
+    #   document_two = file_two.to_document
+    #   # prepare signatures
+    #   signature_one = GroupDocs::Signature.new(name: 'John Smith', image_path: '~/Documents/signature_one.png')
+    #   signature_two = GroupDocs::Signature.new(name: 'Sara Smith', image_path: '~/Documents/signature_two.png')
+    #   signature_one.position = { top: 0.1, left: 0.07, width: 50, height: 50 }
+    #   signature_two.position = { top: 0.2, left: 0.2, width: 100, height: 100 }
+    #   # sign documents and download results
+    #   signed_documents = GroupDocs::Document.sign_documents!([document_one, document_two], [signature_one, signature_two])
+    #   signed_documents.each do |document|
+    #     document.file.download! '~/Documents'
+    #   end
+    #
+    # @param [Array<GroupDocs::Document>] documents Each document file should have "#name" and "#local_path"
+    # @param [Array<GroupDocs::Signature>] signatures Each signature should have "#name", "#image_path" and "#position"
+    #
+    def self.sign_documents!(documents, signatures, options = {}, access = {})
+      documents.each do |document|
+        document.is_a?(Document) or raise ArgumentError, "Each document should be GroupDocs::Document object, received: #{document.inspect}"
+        document.file.name       or raise ArgumentError, "Each document file should have name, received: #{document.file.name.inspect}"
+        document.file.local_path or raise ArgumentError, "Each document file should have local_path, received: #{document.file.local_path.inspect}"
+      end
+      signatures.each do |signature|
+        signature.is_a?(Signature) or raise ArgumentError, "Each signature should be GroupDocs::Signature object, received: #{signature.inspect}"
+        signature.name             or raise ArgumentError, "Each signature should have name, received: #{signature.name.inspect}"
+        signature.image_path       or raise ArgumentError, "Each signature should have image_path, received: #{signature.image_path.inspect}"
+        signature.position         or raise ArgumentError, "Each signature should have position, received: #{signature.position.inspect}"
+      end
+
+      documents_to_sign = []
+      documents.map(&:file).each do |file|
+        document = { name: file.name }
+        contents = File.read(file.local_path)
+        contents = Base64.strict_encode64(contents)
+        document.merge!(data: "data:#{mime_type(file.local_path)};base64,#{contents}")
+
+        documents_to_sign << document
+      end
+
+      signers = []
+      signatures.each do |signature|
+        contents = File.read(signature.image_path)
+        contents = Base64.strict_encode64(contents)
+        signer = { name: signature.name, data: "data:#{mime_type(signature.image_path)};base64,#{contents}" }
+        signer.merge!(signature.position)
+        # place signature on is not implemented yet
+        signer.merge!(placeSignatureOn: nil)
+
+        signers << signer
+      end
+
+      json = Api::Request.new do |request|
+        request[:access] = access
+        request[:method] = :POST
+        request[:path] = '/signature/{{client_id}}/sign'
+        request[:request_body] = { documents: documents_to_sign, signers: signers }
+      end.execute!
+
+      signed_documents = []
+      json[:documents].each_with_index do |document, i|
+        file = Storage::File.new(guid: document[:documentId], name: "#{documents[i].file.name}_signed.pdf")
+        signed_documents << Document.new(file: file)
+      end
+
+      signed_documents
+    end
+
     # @attr [GroupDocs::Storage::File] file
     attr_accessor :file
     # @attr [Time] process_date
@@ -54,8 +150,10 @@ module GroupDocs
     attr_accessor :output_formats
     # @attr [Symbol] status
     attr_accessor :status
-    # @attr [Integet] order
+    # @attr [Integer] order
     attr_accessor :order
+    # @attr [Integer] field_count
+    attr_accessor :field_count
 
     #
     # Coverts passed array of attributes hash to array of GroupDocs::Storage::File.
@@ -114,6 +212,39 @@ module GroupDocs
         "You have to pass GroupDocs::Storage::File object: #{file.inspect}."
     end
 
+    #
+    # Returns array of URLs to images representing document pages.
+    #
+    # @example
+    #   file = GroupDocs::Storage::Folder.list!.last
+    #   document = file.to_document
+    #   document.page_images! 1024, 768, first_page: 0, page_count: 1
+    #
+    # @param [Integer] width Image width
+    # @param [Integer] height Image height
+    # @param [Hash] options
+    # @option options [Integer] :first_page Start page to return image for (starting with 0)
+    # @option options [Integer] :page_count Number of pages to return image for
+    # @option options [Integer] :quality
+    # @option options [Boolean] :use_pdf
+    # @option options [Boolean] :token
+    # @param [Hash] access Access credentials
+    # @option access [String] :client_id
+    # @option access [String] :private_key
+    # @return [Array<String>]
+    #
+    def page_images!(width, height, options = {}, access = {})
+      api = Api::Request.new do |request|
+        request[:access] = access
+        request[:method] = :GET
+        request[:path] = "/doc/{{client_id}}/files/#{file.guid}/pages/images/#{width}x#{height}/urls"
+      end
+      api.add_params(options)
+      json = api.execute!
+
+      json[:url]
+    end
+
     #
     # Returns access mode of document.
     #
@@ -613,7 +744,6 @@ module GroupDocs
     # @param [Hash] access Access credentials
     # @option access [String] :client_id
     # @option access [String] :private_key
-    # @return [Array<Symbol>]
     #
     def set_reviewers!(reviewers, access = {})
       Api::Request.new do |request|

data/lib/groupdocs/document/annotation.rb

@@ -39,19 +39,13 @@ module GroupDocs
     alias_method :annotationGuid=, :guid=
 
     # Human-readable accessors
-    alias_method :session_guid,         :sessionGuid
-    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
-    alias_method :created_on=,          :createdOn=
-    alias_method :annotation_position,  :annotationPosition
-    alias_method :annotation_position=, :annotationPosition=
-    alias_method :position,             :annotation_position
+    alias_accessor :session_guid,        :sessionGuid
+    alias_accessor :document_guid,       :documentGuid
+    alias_accessor :creator_guid,        :creatorGuid
+    alias_accessor :reply_guid,          :replyGuid
+    alias_accessor :created_on,          :createdOn
+    alias_accessor :annotation_position, :annotationPosition
+    alias_accessor :position,            :annotationPosition
 
     #
     # Creates new GroupDocs::Document::Annotation.
@@ -249,6 +243,13 @@ module GroupDocs
         request[:path] = "/ant/{{client_id}}/annotations/#{guid}/markerPosition"
         request[:request_body] = { x: x, y: y }
       end.execute!
+
+      if box
+        box.x = x
+        box.y = y
+      else
+        self.box = { x: x, y: y }
+      end
     end
 
     #

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

@@ -55,14 +55,10 @@ module GroupDocs
     attr_accessor :repliedOn
 
     # Human-readable accessors
-    alias_method :annotation_guid,  :annotationGuid
-    alias_method :annotation_guid=, :annotationGuid=
-    alias_method :user_guid,        :userGuid
-    alias_method :user_guid=,       :userGuid=
-    alias_method :user_name,        :userName
-    alias_method :user_name=,       :userName=
-    alias_method :replied_on,       :repliedOn
-    alias_method :replied_on=,      :repliedOn=
+    alias_accessor :annotation_guid, :annotationGuid
+    alias_accessor :user_guid,       :userGuid
+    alias_accessor :user_name,       :userName
+    alias_accessor :replied_on,      :repliedOn
 
     #
     # Creates new GroupDocs::Document::Annotation.

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

@@ -51,10 +51,8 @@ module GroupDocs
     attr_accessor :FullName
 
     # Human-readable accessors
-    alias_method :email_address,         :emailAddress
-    alias_method :email_address=,        :emailAddress=
-    alias_method :full_name,             :FullName
-    alias_method :full_name=,            :FullName=
+    alias_accessor :email_address, :emailAddress
+    alias_accessor :full_name,     :FullName
 
   end # Document::Annotation::Reviewer
 end # GroupDocs

data/lib/groupdocs/document/field.rb

@@ -7,21 +7,23 @@ module GroupDocs
     attr_accessor :name
     # @attr [String] type
     attr_accessor :type
-    # @attr [GroupDocs::Document::Rectangle] rectangle
-    attr_accessor :rectangle
+    # @attr [GroupDocs::Document::Rectangle] rect
+    attr_accessor :rect
 
     #
     # Coverts passed hash to GroupDocs::Document::Rectangle object.
-    #
     # @param [Hash] options
-    # @return [GroupDocs::Document::Rectangle]
     #
-    def rectangle=(options)
-      @rectangle = GroupDocs::Document::Rectangle.new(options)
+    def rect=(rectangle)
+      if rectangle.is_a?(Hash)
+        rectangle = GroupDocs::Document::Rectangle.new(rectangle)
+      end
+
+      @rect = rectangle
     end
 
-    # Compatibility with response JSON
-    alias_method :rect=, :rectangle=
+    # Human-readable accessors
+    alias_accessor :rectangle, :rect
 
   end # Document::Field
 end # GroupDocs

data/lib/groupdocs/document/rectangle.rb

@@ -1,26 +1,18 @@
 module GroupDocs
   class Document::Rectangle < Api::Entity
 
-    # @attr [Float] X
-    attr_accessor :X
-    # @attr [Float] Y
-    attr_accessor :Y
-    # @attr [Float] Width
-    attr_accessor :Width
-    # @attr [Float] Height
-    attr_accessor :Height
+    # @attr [Float] x
+    attr_accessor :x
+    # @attr [Float] y
+    attr_accessor :y
+    # @attr [Float] width
+    attr_accessor :width
+    # @attr [Float] height
+    attr_accessor :height
 
     # Human-readable accessors
-    alias_method :x,      :X
-    alias_method :x=,     :X=
-    alias_method :y,      :Y
-    alias_method :y=,     :Y=
-    alias_method :w,      :Width
-    alias_method :w=,     :Width=
-    alias_method :width,  :w
-    alias_method :h,      :Height
-    alias_method :h=,     :Height=
-    alias_method :height, :Height
+    alias_accessor :w, :width
+    alias_accessor :h, :height
 
   end # Document::Rectangle
 end # GroupDocs