groupdocs 1.3.0 → 1.4.0

data/lib/groupdocs/signature/role.rb

@@ -44,37 +44,11 @@ module GroupDocs
     alias_accessor :can_annotate, :canAnnotate
     alias_accessor :can_delegate, :canDelegate
 
-    #
-    # Returns true if role can edit.
-    # @return [Boolean]
-    #
-    def can_edit?
-      can_edit == 1
-    end
-
-    #
-    # Returns true if role can sign.
-    # @return [Boolean]
-    #
-    def can_sign?
-      can_sign == 1
-    end
-
-    #
-    # Returns true if role can annotate.
-    # @return [Boolean]
-    #
-    def can_annotate?
-      can_annotate == 1
-    end
-
-    #
-    # Returns true if role can delegate.
-    # @return [Boolean]
-    #
-    def can_delegate?
-      can_delegate == 1
-    end
+    # Boolean methods for Ruby DSL
+    alias_method :can_edit?,     :can_edit
+    alias_method :can_sign?,     :can_sign
+    alias_method :can_annotate?, :can_annotate
+    alias_method :can_delegate?, :can_delegate
 
   end # Signature::Role
 end # GroupDocs

data/lib/groupdocs/signature/shared/document_methods.rb

@@ -24,7 +24,8 @@ module GroupDocs
         end.execute!
 
         json[:documents].map do |document|
-          file = Storage::File.new(:guid => document[:documentId], :name => document[:name])
+          id = document[:documentId] || document[:id]
+          file = Storage::File.new(:guid => id, :name => document[:name])
           Document.new(document.merge(:file => file))
         end
       end

data/lib/groupdocs/signature/shared/entity_fields.rb

@@ -36,6 +36,10 @@ module GroupDocs
       attr_accessor :documentsPages
       # @attr [Array<GroupDocs::Signature::Contact>] recipients
       attr_accessor :recipients
+      # @attr [String] watermarkText
+      attr_accessor :watermarkText
+      # @attr [String] watermarkImage
+      attr_accessor :watermarkImage
 
       # Human-readable accessors
       alias_accessor :owner_id,          :ownerId
@@ -48,6 +52,8 @@ module GroupDocs
       alias_accessor :email_body,        :emailBody
       alias_accessor :documents_count,   :documentsCount
       alias_accessor :documents_pages,   :documentsPages
+      alias_accessor :watermark_text,    :watermarkText
+      alias_accessor :watermark_image,   :watermarkImage
 
       #
       # Converts each recipient to GroupDocs::Signature::Recipient object.
@@ -65,22 +71,6 @@ module GroupDocs
         end
       end
 
-      #
-      # Returns true if owner should sign.
-      # @return [Boolean]
-      #
-      def owner_should_sign
-        @ownerShouldSign == 1 ? true : false
-      end
-
-      #
-      # Returns ordered signature type.
-      # @return [Symbol]
-      #
-      def ordered_signature
-        @orderedSignature == 1 ? :parallel : :ordered
-      end
-
     end # EntityFields
   end # Signature
 end # GroupDocs

data/lib/groupdocs/signature/shared/entity_methods.rb

@@ -52,8 +52,8 @@ module GroupDocs
       #   envelope.create!
       #
       # @param [Hash] options Hash of options
-      # @option options [Integer] :template_id Template GUID to use
-      # @option options [Integer] :envelope_id Envelope GUID to use
+      # @option options [String] :template_id Template GUID to use
+      # @option options [String] :envelope_id Envelope GUID to use
       # @param [Hash] access Access credentials
       # @option access [String] :client_id
       # @option access [String] :private_key

data/lib/groupdocs/signature/shared/field_methods.rb

@@ -55,7 +55,7 @@ module GroupDocs
       #
       # @example Add field to template
       #   template = GroupDocs::Signature::Template.get!("g94h5g84hj9g4gf23i40j")
-      #   field = GroupDocs::Signature::Field.get!.detect { |f| f.name == "Signature" }
+      #   field = GroupDocs::Signature::Field.get!.detect { |f| f.type == :signature }
       #   field.location = { location_x: 0.1, location_y: 0.1, page: 1 }
       #   document = template.documents!.first
       #   recipient = template.recipients!.first
@@ -63,7 +63,7 @@ module GroupDocs
       #
       # @example Add field to envelope
       #   envelope = GroupDocs::Signature::Envelope.get!("g94h5g84hj9g4gf23i40j")
-      #   field = GroupDocs::Signature::Field.get!.detect { |f| f.name == "Signature" }
+      #   field = GroupDocs::Signature::Field.get!.detect { |f| f.type == :signature }
       #   field.location = { location_x: 0.1, location_y: 0.1, page: 1 }
       #   document = envelope.documents!.first
       #   recipient = envelope.recipients!.first
@@ -151,6 +151,53 @@ module GroupDocs
         end.execute!
       end
 
+      #
+      # Assigns document field to new recipient.
+      #
+      # @example Assign template field
+      #   template = GroupDocs::Signature::Template.get!("g94h5g84hj9g4gf23i40j")
+      #   document = template.documents!.first
+      #   recipient_one = template.recipients![0]
+      #   recipient_two = template.recipients![1]
+      #   field = template.fields!(document, recipient).first
+      #   template.assign_field! field, document, recipient_one, recipient_two
+      #
+      # @example Assign envelope field
+      #   envelope = GroupDocs::Signature::Envelope.get!("g94h5g84hj9g4gf23i40j")
+      #   document = envelope.documents!.first
+      #   recipient_one = envelope.recipients![0]
+      #   recipient_two = envelope.recipients![1]
+      #   field = envelope.fields!(document, recipient).first
+      #   envelope.assign_field! field, document, recipient_one, recipient_two
+      #
+      # @param [GroupDocs::Signature::Field] field
+      # @param [GroupDocs::Document] document
+      # @param [GroupDocs::Signature::Recipient] assign_from
+      # @param [GroupDocs::Signature::Recipient] assign_to
+      # @param [Hash] access Access credentials
+      # @option access [String] :client_id
+      # @option access [String] :private_key
+      # @raise [ArgumentError] if field is not GroupDocs::Signature::Field
+      # @raise [ArgumentError] if document is not GroupDocs::Document
+      #
+      def assign_field!(field, document, assign_from, assign_to, access = {})
+        field.is_a?(GroupDocs::Signature::Field) or raise ArgumentError,
+          "Field should be GroupDocs::Signature::Field object, received: #{field.inspect}"
+        document.is_a?(GroupDocs::Document) or raise ArgumentError,
+          "Document should be GroupDocs::Document object, received: #{document.inspect}"
+        assign_from.is_a?(GroupDocs::Signature::Recipient) or raise ArgumentError,
+          "Assign from should be GroupDocs::Signature::Recipient object, received: #{assign_from.inspect}"
+        assign_to.is_a?(GroupDocs::Signature::Recipient) or raise ArgumentError,
+          "Assign to should be GroupDocs::Signature::Recipient object, received: #{assign_to.inspect}"
+
+        Api::Request.new do |request|
+          request[:access] = access
+          request[:method] = :POST
+          request[:path] = "/signature/{{client_id}}/#{class_name.pluralize}/#{id}/documents/#{document.file.guid}/field/#{field.id}",
+          request[:request_body] = { :currentRecipientId => assign_from.id, :newRecipientId => assign_to.id }
+        end.execute!
+      end
+
       #
       # Deletes field.
       #
@@ -259,6 +306,13 @@ module GroupDocs
       #   location = field.locations.first
       #   envelope.delete_field_location! location, field
       #
+      # @example Delete field location in form
+      #   form = GroupDocs::Signature::Form.get!("g94h5g84hj9g4gf23i40j")
+      #   document = form.documents!.first
+      #   field = form.fields!(document).first
+      #   location = field.locations.first
+      #   form.delete_field_location! location, field
+      #
       # @param [GroupDocs::Signature::Field::Location] location
       # @param [GroupDocs::Signature::Field] field
       # @param [Hash] access Access credentials

data/lib/groupdocs/storage.rb

@@ -1,6 +1,7 @@
 require 'groupdocs/storage/folder'
 require 'groupdocs/storage/file'
 require 'groupdocs/storage/package'
+require 'groupdocs/storage/provider'
 
 
 module GroupDocs

data/lib/groupdocs/storage/provider.rb

@@ -0,0 +1,32 @@
+module GroupDocs
+  module Storage
+    class Provider < Api::Entity
+
+      # @attr [Integer] id
+      attr_accessor :id
+      # @attr [String] provider
+      attr_accessor :provider
+      # @attr [String] type
+      attr_accessor :type
+      # @attr [String] token
+      attr_accessor :token
+      # @attr [String] publicKey
+      attr_accessor :publicKey
+      # @attr [String] privateKey
+      attr_accessor :privateKey
+      # @attr [String] rootFolder
+      attr_accessor :rootFolder
+      # @attr [Boolean] isPrimary
+      attr_accessor :isPrimary
+      # @attr [String] serviceHost
+      attr_accessor :serviceHost
+
+      alias_accessor :public_key,   :publicKey
+      alias_accessor :private_key,  :privateKey
+      alias_accessor :root_folder,  :rootFolder
+      alias_accessor :is_primary,   :isPrimary
+      alias_accessor :service_host, :serviceHost
+
+    end # Provider
+  end # Storage
+end # GroupDocs

data/lib/groupdocs/user.rb

@@ -59,6 +59,54 @@ module GroupDocs
       GroupDocs::User.new data.merge(json)
     end
 
+    #
+    # Generates new active user embed key.
+    #
+    # @example
+    #   GroupDocs::User.embed_key!('test-area')
+    #   #=> "60a06ef8f23a49cf807977f1444fbdd8"
+    #
+    # @param [String] area
+    # @param [Hash] access Access credentials
+    # @option access [String] :client_id
+    # @option access [String] :private_key
+    # @return [String]
+    #
+    def self.embed_key!(area, access = {})
+      json = Api::Request.new do |request|
+        request[:access] = access
+        request[:method] = :GET
+        request[:path] = "/mgmt/{{client_id}}/embedkey/new/#{area}"
+      end.execute!
+
+      json[:key][:guid]
+    end
+
+    #
+    # Returns an array of storage providers.
+    #
+    # @example
+    #   providers = GroupDocs::User.providers!
+    #   providers.first.provider
+    #   #=> "Dropbox"
+    #
+    # @param [Hash] access Access credentials
+    # @option access [String] :client_id
+    # @option access [String] :private_key
+    # @return [Array<GroupDocs::Storage::Provider>]
+    #
+    def self.providers!(access = {})
+      json = Api::Request.new do |request|
+        request[:access] = access
+        request[:method] = :GET
+        request[:path] = '/mgmt/{{client_id}}/storages'
+      end.execute!
+
+      json[:providers].map do |provider|
+        Storage::Provider.new(provider)
+      end
+    end
+
     # @attr [Integer] id
     attr_accessor :id
     # @attr [String] guid
@@ -174,5 +222,23 @@ module GroupDocs
       end
     end
 
+    #
+    # Returns an array of roles.
+    #
+    # @param [Hash] access Access credentials
+    # @option access [String] :client_id
+    # @option access [String] :private_key
+    # @return [Array]
+    #
+    def roles!(access = {})
+      json = Api::Request.new do |request|
+        request[:access] = access
+        request[:method] = :GET
+        request[:path] = '/mgmt/{{client_id}}/roles'
+      end.execute!
+
+      json[:roles]
+    end
+
   end # User
 end # GroupDocs

data/lib/groupdocs/version.rb

@@ -1,3 +1,3 @@
 module GroupDocs
-  VERSION = '1.3.0'
+  VERSION = '1.4.0'
 end # GroupDocs

data/spec/groupdocs/signature/contact_spec.rb

@@ -57,6 +57,27 @@ describe GroupDocs::Signature::Contact do
     end
   end
 
+  describe '.add_integration!' do
+    before(:each) do
+      mock_api_server('{ "status": "Ok", "result": { "contact": null }}')
+    end
+
+    let(:integration) do
+      {
+        :provider                => :google,
+        :refresh_token           => 'token',
+        :access_token            => 'token',
+        :access_token_expiration => '2014-12-12'
+      }
+    end
+
+    it 'accepts access credentials hash' do
+      lambda do
+        described_class.add_integration!(integration, :client_id => 'client_id', :private_key => 'private_key')
+      end.should_not raise_error(ArgumentError)
+    end
+  end
+
   it { should have_accessor(:id)        }
   it { should have_accessor(:firstName) }
   it { should have_accessor(:lastName)  }

data/spec/groupdocs/signature/envelope_spec.rb

@@ -62,11 +62,13 @@ describe GroupDocs::Signature::Envelope do
   it { should have_accessor(:status)             }
   it { should have_accessor(:statusDateTime)     }
   it { should have_accessor(:envelopeExpireTime) }
+  it { should have_accessor(:isDemo)             }
   it { should have_accessor(:status)             }
 
   it { should alias_accessor(:creation_date_time, :creationDateTime)     }
   it { should alias_accessor(:status_date_time, :statusDateTime)         }
   it { should alias_accessor(:envelope_expire_time, :envelopeExpireTime) }
+  it { should alias_accessor(:is_demo, :isDemo)                          }
 
   describe '#status' do
     it 'converts status to human-readable format' do
@@ -115,6 +117,29 @@ describe GroupDocs::Signature::Envelope do
     end
   end
 
+  describe '#delegate_recipient!' do
+    let(:old) { GroupDocs::Signature::Recipient.new }
+    let(:new) { GroupDocs::Signature::Recipient.new }
+
+    before(:each) do
+      mock_api_server('{ "status": "Ok", "result": {}}')
+    end
+
+    it 'accepts access credentials hash' do
+      lambda do
+        subject.delegate_recipient!(old, new, :client_id => 'client_id', :private_key => 'private_key')
+      end.should_not raise_error(ArgumentError)
+    end
+
+    it 'raises error if old recipient is not GroupDocs::Signature::Recipient object' do
+      lambda { subject.delegate_recipient!('Recipient', new) }.should raise_error(ArgumentError)
+    end
+
+    it 'raises error if new recipient is not GroupDocs::Signature::Recipient object' do
+      lambda { subject.delegate_recipient!(old, 'Recipient') }.should raise_error(ArgumentError)
+    end
+  end
+
   describe '#fill_field!' do
     let(:field)     { GroupDocs::Signature::Field.new(:location => { :location_x => 0.1, :page => 1 }) }
     let(:document)  { GroupDocs::Document.new(:file => GroupDocs::Storage::File.new) }
@@ -242,7 +267,7 @@ describe GroupDocs::Signature::Envelope do
         mock_api_server(File.read('spec/support/files/resume.pdf'))
       end
 
-      it 'downloads ZIP file' do
+      it 'downloads PDF file' do
         file = stub('file')
         subject.stub(:documents! => [1])
         Object::File.should_receive(:open).with("#{path}/#{subject.name}.pdf", 'wb').and_yield(file)
@@ -266,6 +291,33 @@ describe GroupDocs::Signature::Envelope do
     end
   end
 
+  describe '#signed_document!' do
+    before(:each) do
+      mock_api_server(File.read('spec/support/files/resume.pdf'))
+      subject.name = 'envelope'
+    end
+
+    let(:path)     { Dir.tmpdir }
+    let(:document) { GroupDocs::Document.new(:file => GroupDocs::Storage::File.new) }
+
+    it 'accepts access credentials hash' do
+      lambda do
+        subject.signed_document!(document, path, :client_id => 'client_id', :private_key => 'private_key')
+      end.should_not raise_error(ArgumentError)
+    end
+
+    it 'returns saved file path' do
+      subject.signed_document!(document, path).should == "#{path}/#{subject.name}.pdf"
+    end
+
+    it 'downloads PDF file' do
+      file = stub('file')
+      Object::File.should_receive(:open).with("#{path}/#{subject.name}.pdf", 'wb').and_yield(file)
+      file.should_receive(:write).with(File.read('spec/support/files/resume.pdf'))
+      subject.signed_document!(document, path)
+    end
+  end
+
   describe '#logs!' do
     before(:each) do
       mock_api_server(load_json('envelope_logs'))

data/spec/groupdocs/signature/field_spec.rb

@@ -72,7 +72,6 @@ describe GroupDocs::Signature::Field do
   it { should alias_accessor(:font_italic,        :fontItalic)        }
   it { should alias_accessor(:font_underline,     :fontUnderline)     }
   it { should alias_accessor(:is_system,          :isSystem)          }
-  it { should alias_accessor(:acceptable_values,  :acceptableValues)  }
   it { should alias_accessor(:default_value,      :defaultValue)      }
   it { should alias_accessor(:text_rows,          :textRows)          }
   it { should alias_accessor(:text_columns,       :textColumns)       }
@@ -163,6 +162,25 @@ describe GroupDocs::Signature::Field do
     end
   end
 
+  describe '#acceptable_values=' do
+    it 'converts values in machine-readable format if array is passed' do
+      subject.acceptable_values = %w(on off)
+      subject.instance_variable_get(:@acceptableValues).should == 'on;off'
+    end
+
+    it 'saves values as is if not an array is passed' do
+      subject.acceptable_values = 'on;off'
+      subject.instance_variable_get(:@acceptableValues).should == 'on;off'
+    end
+  end
+
+  describe '#acceptable_values' do
+    it 'returns values in human-readable format' do
+      subject.acceptable_values = %w(on off)
+      subject.acceptable_values.should == %w(on off)
+    end
+  end
+
   describe '#create!' do
     before(:each) do
       mock_api_server(load_json('signature_field_add'))