groupdocs 1.3.0 → 1.4.0

data/spec/groupdocs/signature/form_spec.rb

@@ -4,6 +4,8 @@ describe GroupDocs::Signature::Form do
 
   it_behaves_like GroupDocs::Api::Entity
   include_examples GroupDocs::Signature::EntityMethods
+  include_examples GroupDocs::Signature::DocumentMethods
+  include_examples GroupDocs::Signature::FieldMethods
   include_examples GroupDocs::Signature::ResourceMethods
 
   describe '.all!' do
@@ -42,6 +44,8 @@ describe GroupDocs::Signature::Form do
   it { should have_accessor(:fieldsInFinalFileName)      }
   it { should have_accessor(:canParticipantDownloadForm) }
   it { should have_accessor(:status)                     }
+  it { should have_accessor(:watermarkText)              }
+  it { should have_accessor(:watermarkImage)             }
 
   it { should alias_accessor(:owner_guid, :ownerGuid)                                     }
   it { should alias_accessor(:template_guid, :templateGuid)                               }
@@ -50,8 +54,9 @@ describe GroupDocs::Signature::Form do
   it { should alias_accessor(:documents_count, :documentsCount)                           }
   it { should alias_accessor(:documents_pages, :documentsPages)                           }
   it { should alias_accessor(:participants_count, :participantsCount)                     }
-  it { should alias_accessor(:fields_in_final_file_name, :fieldsInFinalFileName)          }
   it { should alias_accessor(:can_participant_download_form, :canParticipantDownloadForm) }
+  it { should alias_accessor(:watermark_text, :watermarkText)                             }
+  it { should alias_accessor(:watermark_image, :watermarkImage)                           }
 
   describe '#status' do
     it 'converts status to human-readable format' do
@@ -60,39 +65,52 @@ describe GroupDocs::Signature::Form do
     end
   end
 
-  describe '#create!' do
-    let(:template) { GroupDocs::Signature::Template.new }
+  describe '#fields_in_final_file_name=' do
+    it 'converts field names in machine-readable format if array is passed' do
+      subject.fields_in_final_file_name = %w(on off)
+      subject.instance_variable_get(:@fieldsInFinalFileName).should == 'on,off'
+    end
+
+    it 'saves field names as is if not an array is passed' do
+      subject.fields_in_final_file_name = 'on,off'
+      subject.instance_variable_get(:@fieldsInFinalFileName).should == 'on,off'
+    end
+  end
+
+  describe '#fields_in_final_file_name' do
+    it 'returns field names in human-readable format' do
+      subject.fields_in_final_file_name = %w(on off)
+      subject.fields_in_final_file_name.should == %w(on off)
+    end
+  end
 
+  describe '#create!' do
     before(:each) do
       mock_api_server(load_json('form_get'))
     end
 
     it 'accepts access credentials hash' do
       lambda do
-        subject.create!(template, {}, :client_id => 'client_id', :private_key => 'private_key')
+        subject.create!({}, :client_id => 'client_id', :private_key => 'private_key')
       end.should_not raise_error(ArgumentError)
     end
 
     it 'accepts options hash' do
       lambda do
-        subject.create!(template, :assembly_id => 'aodfh43yr9834hf943h')
+        subject.create!(:assembly_id => 'aodfh43yr9834hf943h')
       end.should_not raise_error(ArgumentError)
     end
 
     it 'uses hashed version of self as request body' do
       subject.should_receive(:to_hash)
-      subject.create!(template)
+      subject.create!
     end
 
     it 'updates identifier of entity' do
       lambda do
-        subject.create!(template)
+        subject.create!
       end.should change(subject, :id)
     end
-
-    it 'raises error if template is not GroupDocs::Signature::Template object' do
-      lambda { subject.create!('Template') }.should raise_error(ArgumentError)
-    end
   end
 
   describe '#documents!' do
@@ -150,4 +168,22 @@ describe GroupDocs::Signature::Form do
       end.should_not raise_error(ArgumentError)
     end
   end
+
+  describe '#update_from_template!' do
+    let(:template) { GroupDocs::Signature::Template.new }
+
+    before(:each) do
+      mock_api_server('{ "status": "Ok", "result": {}}')
+    end
+
+    it 'raises error if template is not GroupDocs::Signature::Template object' do
+      lambda { subject.update_from_template!('Template') }.should raise_error(ArgumentError)
+    end
+
+    it 'accepts access credentials hash' do
+      lambda do
+        subject.update_from_template!(template, :client_id => 'client_id', :private_key => 'private_key')
+      end.should_not raise_error(ArgumentError)
+    end
+  end
 end

data/spec/groupdocs/signature/role_spec.rb

@@ -40,51 +40,8 @@ describe GroupDocs::Signature::Role do
   it { should alias_accessor(:can_annotate, :canAnnotate) }
   it { should alias_accessor(:can_delegate, :canDelegate) }
 
-  describe '#can_edit?' do
-    it 'returns true if role can edit' do
-      subject.can_edit = 1
-      subject.can_edit?.should be_true
-    end
-
-    it 'returns false if role cannot edit' do
-      subject.can_edit = 0
-      subject.can_edit?.should be_false
-    end
-  end
-
-  describe '#can_sign?' do
-    it 'returns true if role can sign' do
-      subject.can_sign = 1
-      subject.can_sign?.should be_true
-    end
-
-    it 'returns false if role cannot sign' do
-      subject.can_sign = 0
-      subject.can_sign?.should be_false
-    end
-  end
-
-  describe '#can_annotate?' do
-    it 'returns true if role can annotate' do
-      subject.can_annotate = 1
-      subject.can_annotate?.should be_true
-    end
-
-    it 'returns false if role cannot annotate' do
-      subject.can_annotate = 0
-      subject.can_annotate?.should be_false
-    end
-  end
-
-  describe '#can_delegate?' do
-    it 'returns true if role can delegate' do
-      subject.can_delegate = 1
-      subject.can_delegate?.should be_true
-    end
-
-    it 'returns false if role cannot delegate' do
-      subject.can_delegate = 0
-      subject.can_delegate?.should be_false
-    end
-  end
+  it { should have_alias(:can_edit?,     :can_edit)     }
+  it { should have_alias(:can_sign?,     :can_sign)     }
+  it { should have_alias(:can_annotate?, :can_annotate) }
+  it { should have_alias(:can_delegate?, :can_delegate) }
 end

data/spec/groupdocs/signature_spec.rb

@@ -38,6 +38,8 @@ describe GroupDocs::Signature do
   it { should have_accessor(:initialsImageFileId)  }
   it { should have_accessor(:signatureImageUrl)    }
   it { should have_accessor(:initialsImageUrl)     }
+  it { should have_accessor(:signatureData)        }
+  it { should have_accessor(:initialsData)         }
   it { should have_accessor(:createdTimeStamp)     }
   it { should have_accessor(:image_path)           }
 
@@ -52,6 +54,8 @@ describe GroupDocs::Signature do
   it { should alias_accessor(:initials_image_file_id, :initialsImageFileId)   }
   it { should alias_accessor(:signature_image_url, :signatureImageUrl)        }
   it { should alias_accessor(:initials_image_url, :initialsImageUrl)          }
+  it { should alias_accessor(:signature_data, :signatureData)                 }
+  it { should alias_accessor(:initials_data, :initialsData)                   }
   it { should alias_accessor(:created_time_stamp, :createdTimeStamp)          }
 
   describe '#create!' do

data/spec/groupdocs/storage/provider_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+describe GroupDocs::Storage::Provider do
+
+  it_behaves_like GroupDocs::Api::Entity
+
+  it { should have_accessor(:id)          }
+  it { should have_accessor(:provider)    }
+  it { should have_accessor(:type)        }
+  it { should have_accessor(:token)       }
+  it { should have_accessor(:publicKey)   }
+  it { should have_accessor(:privateKey)  }
+  it { should have_accessor(:rootFolder)  }
+  it { should have_accessor(:isPrimary)   }
+  it { should have_accessor(:serviceHost) }
+  
+  it { should alias_accessor(:public_key, :publicKey)     }
+  it { should alias_accessor(:private_key, :privateKey)   }
+  it { should alias_accessor(:root_folder, :rootFolder)   }
+  it { should alias_accessor(:is_primary, :isPrimary)     }
+  it { should alias_accessor(:service_host, :serviceHost) }
+end

data/spec/groupdocs/user_spec.rb

@@ -42,6 +42,42 @@ describe GroupDocs::User do
     end
   end
 
+  describe '.embed_key!' do
+    before(:each) do
+      mock_api_server(load_json('user_embed_key'))
+    end
+
+    it 'accepts access credentials hash' do
+      lambda do
+        described_class.embed_key!('test-area', :client_id => 'client_id', :private_key => 'private_key')
+      end.should_not raise_error(ArgumentError)
+    end
+    
+    it 'returns new user embed key for defined area' do
+      result = described_class.embed_key!('test-area')
+      result.should be_a(String)
+    end
+  end
+
+  describe '.providers!' do
+    before(:each) do
+      mock_api_server(load_json('user_providers'))
+    end
+
+    it 'accepts access credentials hash' do
+      lambda do
+        described_class.providers!(:client_id => 'client_id', :private_key => 'private_key')
+      end.should_not raise_error(ArgumentError)
+    end
+
+    it 'returns array of GroupDocs::Storage::Provider' do
+      providers = described_class.providers!
+      providers.should be_an(Array)
+      providers.each do |provider|
+        provider.should be_a(GroupDocs::Storage::Provider)
+      end
+    end
+  end
   it { should have_accessor(:id)                 }
   it { should have_accessor(:guid)               }
   it { should have_accessor(:nickname)           }
@@ -130,4 +166,22 @@ describe GroupDocs::User do
       end
     end
   end
+
+  describe '#roles!' do
+    before(:each) do
+      mock_api_server(load_json('user_roles'))
+    end
+
+    it 'accepts access credentials hash' do
+      lambda do
+        subject.roles!(:client_id => 'client_id', :private_key => 'private_key')
+      end.should_not raise_error(ArgumentError)
+    end
+
+    it 'returns array' do
+      roles = subject.roles!
+      roles.should be_an(Array)
+    end
+  end
+
 end

data/spec/support/json/user_embed_key.json

@@ -0,0 +1,39 @@
+{
+  "result": {
+    "key": {
+      "user": {
+        "nickname": "test@test.com",
+        "firstname": "First",
+        "lastname": "Last",
+        "pkey": "iwhfsfy8sdufh9hfsfsd9",
+        "pswd_salt": null,
+        "claimed_id": null,
+        "token": null,
+        "storage": null,
+        "photo": null,
+        "active": false,
+        "trial": false,
+        "news_eanbled": null,
+        "alerts_eanbled": null,
+        "support_eanbled": null,
+        "support_email": null,
+        "annotation_branded": null,
+        "viewer_branded": null,
+        "signedupOn": 1335963525287,
+        "signedinOn": 1335963525287,
+        "signin_count": 0,
+        "roles": null,
+        "id": 85,
+        "guid": "8sd7tfsdf",
+        "primary_email": "test@test.com"
+      },
+      "guid": "60a06ef8f23a49cf807977f1444fbdd8",
+      "area": "test-area",
+      "active": true,
+      "hit_count": 0
+    }
+  },
+  "status": "Ok",
+  "error_message": null,
+  "composedOn": 1359383495765
+}

data/spec/support/json/user_providers.json

@@ -0,0 +1,31 @@
+{
+  "result": {
+    "providers": [
+      {
+        "id": 38,
+        "provider": "Dropbox",
+        "type": "Shared",
+        "token": "lWYWx1ZU9mc3RyaW5nc3RyaW5nPjwvQXJyYXlPZktleVZhbHVlT2Z",
+        "publicKey": "kfmwehvfusotcgk",
+        "privateKey": "swaurn5gnfrbh1s",
+        "rootFolder": null,
+        "isPrimary": false,
+        "serviceHost": null
+      },
+      {
+        "id": 54,
+        "provider": "BoxNet",
+        "type": "Shared",
+        "token": "Nnc2MDB3NzFncXBnMjk1YXVidXk2aGd1bnRnemlibWI=",
+        "publicKey": null,
+        "privateKey": "fyypebzyu9tpe4753utoe1fcru",
+        "rootFolder": null,
+        "isPrimary": false,
+        "serviceHost": null
+      }]
+  },
+  "status": "Ok",
+  "error_message": null,
+  "composedOn": 1365653541727
+}
+

data/spec/support/json/user_roles.json

@@ -0,0 +1,25 @@
+{
+  "result": {
+    "roles": [
+      {
+        "id": 1,
+        "name": "SysAdmin"
+      },
+      {
+        "id": 2,
+        "name": "Admin"
+      },
+      {
+        "id": 3,
+        "name": "User"
+      },
+      {
+        "id": 4,
+        "name": "Guest"
+      }
+    ]
+  },
+  "status": "Ok",
+  "error_message": null,
+  "composedOn": 1365660243257
+}

data/spec/support/shared_examples/signature/shared/entity_fields.rb

@@ -13,19 +13,21 @@ shared_examples_for GroupDocs::Signature::EntityFields do
   it { should have_accessor(:documentsCount)   }
   it { should have_accessor(:documentsPages)   }
   it { should have_accessor(:recipients)       }
+  it { should have_accessor(:watermarkText)    }
+  it { should have_accessor(:watermarkImage)   }
 
-  it { should alias_accessor(:owner_id, :ownerId)                }
-  it { should alias_accessor(:owner_guid, :ownerGuid)            }
-  it { should alias_accessor(:reminder_time, :reminderTime)      }
-  it { should alias_accessor(:step_expire_time, :stepExpireTime) }
-  # owner_should_sign is overwritten
-  it { should have_alias(:owner_should_sign=, :ownerShouldSign=) }
-  # ordered_signature is overwritten
-  it { should have_alias(:ordered_signature=, :orderedSignature=) }
-  it { should alias_accessor(:email_subject, :emailSubject)       }
-  it { should alias_accessor(:email_body, :emailBody)             }
-  it { should alias_accessor(:documents_count, :documentsCount)   }
-  it { should alias_accessor(:documents_pages, :documentsPages)   }
+  it { should alias_accessor(:owner_id, :ownerId)                   }
+  it { should alias_accessor(:owner_guid, :ownerGuid)               }
+  it { should alias_accessor(:reminder_time, :reminderTime)         }
+  it { should alias_accessor(:step_expire_time, :stepExpireTime)    }
+  it { should alias_accessor(:owner_should_sign, :ownerShouldSign)  }
+  it { should alias_accessor(:ordered_signature, :orderedSignature) }
+  it { should alias_accessor(:email_subject, :emailSubject)         }
+  it { should alias_accessor(:email_body, :emailBody)               }
+  it { should alias_accessor(:documents_count, :documentsCount)     }
+  it { should alias_accessor(:documents_pages, :documentsPages)     }
+  it { should alias_accessor(:watermark_text, :watermarkText)       }
+  it { should alias_accessor(:watermark_image, :watermarkImage)     }
 
   describe '#recipients=' do
     it 'converts each recipient to GroupDocs::Signature::Recipient object if hash is passed' do
@@ -51,18 +53,4 @@ shared_examples_for GroupDocs::Signature::EntityFields do
       end.should_not change(subject, :recipients)
     end
   end
-
-  describe '#owner_should_sign' do
-    it 'returns true if owner should sign' do
-      subject.owner_should_sign = 1
-      subject.owner_should_sign.should be_true
-    end
-  end
-
-  describe '#ordered_signature' do
-    it 'returns :ordered for ordered entity' do
-      subject.owner_should_sign = 1
-      subject.ordered_signature.should == :ordered
-    end
-  end
 end

data/spec/support/shared_examples/signature/shared/field_methods.rb

@@ -1,4 +1,12 @@
 shared_examples_for GroupDocs::Signature::FieldMethods do
+  let(:args) do
+    case described_class.name
+    when 'GroupDocs::Signature::Form'
+      [document]
+    when 'GroupDocs::Signature::Template', 'GroupDocs::Signature::Envelope'
+      [document, recipient]
+    end
+  end
 
   describe '#fields!' do
     let(:document)  { GroupDocs::Document.new(:file => GroupDocs::Storage::File.new) }
@@ -10,20 +18,12 @@ shared_examples_for GroupDocs::Signature::FieldMethods do
 
     it 'accepts access credentials hash' do
       lambda do
-        subject.fields!(document, recipient, :client_id => 'client_id', :private_key => 'private_key')
+        subject.fields!(*args, :client_id => 'client_id', :private_key => 'private_key')
       end.should_not raise_error(ArgumentError)
     end
 
-    it 'raises error if document is not GroupDocs::Document object' do
-      lambda { subject.fields!('Document', recipient) }.should raise_error(ArgumentError)
-    end
-
-    it 'raises error if recipient is not GroupDocs::Signature::Recipient object' do
-      lambda { subject.fields!(document, 'Recipient') }.should raise_error(ArgumentError)
-    end
-
     it 'returns array of GroupDocs::Signature::Field objects' do
-      fields = subject.fields!(document, recipient)
+      fields = subject.fields!(*args)
       fields.should be_an(Array)
       fields.each do |field|
         field.should be_a(GroupDocs::Signature::Field)
@@ -42,25 +42,17 @@ shared_examples_for GroupDocs::Signature::FieldMethods do
 
     it 'accepts access credentials hash' do
       lambda do
-        subject.add_field!(field, document, recipient, { :force_new_field => false }, :client_id => 'client_id', :private_key => 'private_key')
+        subject.add_field!(field, *args, { :force_new_field => false }, :client_id => 'client_id', :private_key => 'private_key')
       end.should_not raise_error(ArgumentError)
     end
 
     it 'raises error if field is not GroupDocs::Signature::Field object' do
-      lambda { subject.add_field!('Field', document, recipient) }.should raise_error(ArgumentError)
-    end
-
-    it 'raises error if document is not GroupDocs::Document object' do
-      lambda { subject.add_field!(field, 'Document', recipient) }.should raise_error(ArgumentError)
-    end
-
-    it 'raises error if recipient is not GroupDocs::Signature::Recipient object' do
-      lambda { subject.add_field!(field, document, 'Recipient') }.should raise_error(ArgumentError)
+      lambda { subject.add_field!('Field', *args) }.should raise_error(ArgumentError)
     end
 
     it 'raises error if field does not specify location' do
       field = GroupDocs::Signature::Field.new
-      lambda { subject.add_field!(field, document, recipient) }.should raise_error(ArgumentError)
+      lambda { subject.add_field!(field, *args) }.should raise_error(ArgumentError)
     end
 
     it 'uses field and field locationas payload' do
@@ -71,7 +63,7 @@ shared_examples_for GroupDocs::Signature::FieldMethods do
       field.location.should_receive(:to_hash).and_return(location)
       payload.should_receive(:merge!).with(location).and_return(payload)
       payload.should_receive(:merge!).with(:forceNewField => true).and_return({})
-      subject.add_field!(field, document, recipient)
+      subject.add_field!(field, *args)
     end
 
     it 'allows overriding force new field flag' do
@@ -82,7 +74,7 @@ shared_examples_for GroupDocs::Signature::FieldMethods do
       field.location.should_receive(:to_hash).and_return(location)
       payload.should_receive(:merge!).with(location).and_return(payload)
       payload.should_receive(:merge!).with(:forceNewField => false).and_return({})
-      subject.add_field!(field, document, recipient, :force_new_field => false)
+      subject.add_field!(field, *args, :force_new_field => false)
     end
   end
 
@@ -121,6 +113,46 @@ shared_examples_for GroupDocs::Signature::FieldMethods do
     end
   end
 
+  describe '#assign_field!' do
+    case described_class.name
+    when 'GroupDocs::Signature::Form'
+      it 'does not have #assign_field! method' do
+        subject.methods.should_not include(:assign_field!)
+      end
+    when 'GroupDocs::Signature::Template', 'GroupDocs::Signature::Envelope'
+      let(:field)       { GroupDocs::Signature::Field.new }
+      let(:document)    { GroupDocs::Document.new(:file => GroupDocs::Storage::File.new) }
+      let(:assign_from) { GroupDocs::Signature::Recipient.new }
+      let(:assign_to)   { GroupDocs::Signature::Recipient.new }
+
+      before(:each) do
+        mock_api_server(load_json('signature_field_add'))
+      end
+
+      it 'accepts access credentials hash' do
+        lambda do
+          subject.assign_field!(field, document, assign_from, assign_to, :client_id => 'client_id', :private_key => 'private_key')
+        end.should_not raise_error(ArgumentError)
+      end
+
+      it 'raises error if field is not GroupDocs::Signature::Field object' do
+        lambda { subject.assign_field!('Field', document, assign_from, assign_to) }.should raise_error(ArgumentError)
+      end
+
+      it 'raises error if document is not GroupDocs::Document object' do
+        lambda { subject.assign_field!(field, 'Document', assign_from, assign_to) }.should raise_error(ArgumentError)
+      end
+
+      it 'raises error if assign from is not GroupDocs::Signature::Recipient object' do
+        lambda { subject.assign_field!(field, document, 'Assign', assign_to) }.should raise_error(ArgumentError)
+      end
+
+      it 'raises error if assign to is not GroupDocs::Signature::Recipient object' do
+        lambda { subject.assign_field!(field, document, assign_from, 'Assign') }.should raise_error(ArgumentError)
+      end
+    end
+  end
+
   describe '#delete_field!' do
     let(:field) do
       GroupDocs::Signature::Field.new
@@ -152,24 +184,16 @@ shared_examples_for GroupDocs::Signature::FieldMethods do
     end
 
     it 'raises error if location is not GroupDocs::Signature::Field::Location object' do
-      lambda { subject.modify_field_location!('Location', field, document, recipient) }.should raise_error(ArgumentError)
+      lambda { subject.modify_field_location!('Location', field, *args) }.should raise_error(ArgumentError)
     end
 
     it 'raises error if field is not GroupDocs::Signature::Field object' do
-      lambda { subject.modify_field_location!(location, 'Field', document, recipient) }.should raise_error(ArgumentError)
-    end
-
-    it 'raises error if document is not GroupDocs::Document object' do
-      lambda { subject.modify_field_location!(location, field, 'Document', recipient) }.should raise_error(ArgumentError)
-    end
-
-    it 'raises error if recipient is not GroupDocs::Signature::Recipient object' do
-      lambda { subject.modify_field_location!(location, field, document, 'Recipient') }.should raise_error(ArgumentError)
+      lambda { subject.modify_field_location!(location, 'Field', *args) }.should raise_error(ArgumentError)
     end
 
     it 'accepts access credentials hash' do
       lambda do
-        subject.modify_field_location!(location, field, document, recipient, :client_id => 'client_id', :private_key => 'private_key')
+        subject.modify_field_location!(location, field, *args, :client_id => 'client_id', :private_key => 'private_key')
       end.should_not raise_error(ArgumentError)
     end
   end