groupdocs 0.3.11 → 1.0.0

data/spec/support/json/template_get.json

@@ -0,0 +1,35 @@
+{
+  "status": "Ok",
+  "result":
+    {
+      "template":
+        {
+          "id": "f0dc546a8f3705e3e8d861dee5efa363",
+          "name": "New template",
+          "ownerId": 115,
+          "ownerGuid": "67e9cf57a2b9da4d",
+          "reminderTime": 1,
+          "stepExpireTime": 3,
+          "templateExpireTime": 6,
+          "ownerShouldSign": true,
+          "orderedSignature": false,
+          "emailSubject": "",
+          "emailBody": "",
+          "documentsCount": 0,
+          "documentsPages": 0,
+          "recipients":
+            [
+              {
+                "id": "1252fbc7c4704d6ff8535a9daeaaff0e",
+                "firstName": "John",
+                "lastName": "Smith",
+                "email": "test@test.com",
+                "userId": 115,
+                "userGuid": "67e9cf57a2b9da4d",
+                "order": 32767,
+                "roleId": 2
+              }
+            ]
+          }
+    }
+}

data/spec/support/json/template_get_documents.json

@@ -0,0 +1,15 @@
+{
+  "status": "Ok",
+  "result":
+    {
+      "templateId": "f0dc546a8f3705e3e8d861dee5efa363",
+      "documents":
+        [
+          {
+            "documentId": "1252fbc7c4704d6ff8535a9daeaaff0e",
+            "templateId": "f0dc546a8f3705e3e8d861dee5efa363",
+            "order": 1
+          }
+        ]
+    }
+}

data/spec/support/json/template_get_recipients.json

@@ -0,0 +1,20 @@
+{
+  "status": "Ok",
+  "result":
+    {
+      "templateId": "f0dc546a8f3705e3e8d861dee5efa363",
+      "recipients":
+        [
+          {
+            "id": "1252fbc7c4704d6ff8535a9daeaaff0e",
+            "firstName": "John",
+            "lastName": "Smith",
+            "email": "test@test.com",
+            "userId": 115,
+            "userGuid": "67e9cf57a2b9da4d",
+            "order": 32767,
+            "roleId": 2
+          }
+        ]
+    }
+}

data/spec/support/json/templates_all.json

@@ -0,0 +1,37 @@
+{
+  "status": "Ok",
+  "result":
+    {
+      "templates":
+        [
+          {
+            "id": "f0dc546a8f3705e3e8d861dee5efa363",
+            "name": "New template",
+            "ownerId": 115,
+            "ownerGuid": "67e9cf57a2b9da4d",
+            "reminderTime": 1,
+            "stepExpireTime": 3,
+            "templateExpireTime": 6,
+            "ownerShouldSign": true,
+            "orderedSignature": false,
+            "emailSubject": "",
+            "emailBody": "",
+            "documentsCount": 0,
+            "documentsPages": 0,
+            "recipients":
+              [
+                {
+                  "id": "1252fbc7c4704d6ff8535a9daeaaff0e",
+                  "firstName": "John",
+                  "lastName": "Smith",
+                  "email": "test@test.com",
+                  "userId": 115,
+                  "userGuid": "67e9cf57a2b9da4d",
+                  "order": 32767,
+                  "roleId": 2
+                }
+              ]
+            }
+        ]
+    }
+}

data/spec/support/json/user_users_get.json

@@ -0,0 +1,27 @@
+{
+  "result": {
+    "users":
+      [
+        {
+          "nickname": "test@test.com",
+          "firstname": "First",
+          "lastname": "Last",
+          "pkey": "iwhfsfy8sdufh9hfsfsd9",
+          "pswd_salt": null,
+          "claimed_id": null,
+          "token": null,
+          "storage": null,
+          "photo": null,
+          "active": false,
+          "news_eanbled": false,
+          "signedupOn": 1335963525287,
+          "roles": null,
+          "id": 85,
+          "guid": "8sd7tfsdf",
+          "primary_email": "test@test.com"
+        }
+      ]
+  },
+  "status": "Ok",
+  "error_message": null
+}

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

@@ -0,0 +1,68 @@
+shared_examples_for GroupDocs::Signature::DocumentMethods do
+
+  describe '#documents!' do
+    before(:each) do
+      mock_api_server(load_json('template_get_documents'))
+    end
+
+    it 'accepts access credentials hash' do
+      lambda do
+        subject.documents!(client_id: 'client_id', private_key: 'private_key')
+      end.should_not raise_error(ArgumentError)
+    end
+
+    it 'returns array of GroupDocs::Document objects' do
+      documents = subject.documents!
+      documents.should be_an(Array)
+      documents.each do |document|
+        document.should be_a(GroupDocs::Document)
+      end
+    end
+  end
+
+  describe '#add_document!' do
+    let(:document) do
+      GroupDocs::Document.new(file: GroupDocs::Storage::File.new)
+    end
+
+    before(:each) do
+      mock_api_server('{ "status": "Ok", "result": {}}')
+    end
+
+    it 'accepts access credentials hash' do
+      lambda do
+        subject.add_document!(document, {}, client_id: 'client_id', private_key: 'private_key')
+      end.should_not raise_error(ArgumentError)
+    end
+
+    it 'accepts options hash' do
+      lambda do
+        subject.add_document!(document, order: 1)
+      end.should_not raise_error(ArgumentError)
+    end
+
+    it 'raises error if document is not GroupDocs::Document object' do
+      -> { subject.add_document!('Document') }.should raise_error(ArgumentError)
+    end
+  end
+
+  describe '#remove_document!' do
+    let(:document) do
+      GroupDocs::Document.new(file: GroupDocs::Storage::File.new)
+    end
+
+    before(:each) do
+      mock_api_server('{ "status": "Ok", "result": {}}')
+    end
+
+    it 'accepts access credentials hash' do
+      lambda do
+        subject.remove_document!(document, 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
+      -> { subject.remove_document!('Document') }.should raise_error(ArgumentError)
+    end
+  end
+end

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

@@ -0,0 +1,89 @@
+shared_examples_for GroupDocs::Signature::EntityFields do
+
+  it { should respond_to(:id)                }
+  it { should respond_to(:id=)               }
+  it { should respond_to(:name)              }
+  it { should respond_to(:name=)             }
+  it { should respond_to(:ownerId)           }
+  it { should respond_to(:ownerId=)          }
+  it { should respond_to(:ownerGuid)         }
+  it { should respond_to(:ownerGuid=)        }
+  it { should respond_to(:reminderTime)      }
+  it { should respond_to(:reminderTime=)     }
+  it { should respond_to(:stepExpireTime)    }
+  it { should respond_to(:stepExpireTime=)   }
+  it { should respond_to(:ownerShouldSign)   }
+  it { should respond_to(:ownerShouldSign=)  }
+  it { should respond_to(:orderedSignature)  }
+  it { should respond_to(:orderedSignature=) }
+  it { should respond_to(:emailSubject)      }
+  it { should respond_to(:emailSubject=)     }
+  it { should respond_to(:emailBody)         }
+  it { should respond_to(:emailBody=)        }
+  it { should respond_to(:documentsCount)    }
+  it { should respond_to(:documentsCount=)   }
+  it { should respond_to(:documentsPages)    }
+  it { should respond_to(:documentsPages=)   }
+  it { should respond_to(:recipients)        }
+  it { should respond_to(:recipients=)       }
+
+  it { should have_alias(:owner_id, :ownerId)                     }
+  it { should have_alias(:owner_id=, :ownerId=)                   }
+  it { should have_alias(:owner_guid, :ownerGuid)                 }
+  it { should have_alias(:owner_guid=, :ownerGuid=)               }
+  it { should have_alias(:reminder_time, :reminderTime)           }
+  it { should have_alias(:reminder_time=, :reminderTime=)         }
+  it { should have_alias(:step_expire_time, :stepExpireTime)      }
+  it { should have_alias(: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 have_alias(:email_subject, :emailSubject)           }
+  it { should have_alias(:email_subject=, :emailSubject=)         }
+  it { should have_alias(:email_body, :emailBody)                 }
+  it { should have_alias(:email_body=, :emailBody=)               }
+  it { should have_alias(:documents_count, :documentsCount)       }
+  it { should have_alias(:documents_count=, :documentsCount=)     }
+  it { should have_alias(:documents_pages, :documentsPages)       }
+  it { should have_alias(:documents_pages=, :documentsPages=)     }
+
+  describe '#recipients=' do
+    it 'converts each recipient to GroupDocs::Signature::Recipient object if hash is passed' do
+      subject.recipients = [{ nickname: 'John' }]
+      recipients = subject.recipients
+      recipients.should be_an(Array)
+      recipients.each do |recipient|
+        recipient.should be_a(GroupDocs::Signature::Recipient)
+      end
+    end
+
+    it 'saves each recipient if it is GroupDocs::Signature::Recipient object' do
+      recipient1 = GroupDocs::Signature::Recipient.new(nickname: 'recipient1')
+      recipient2 = GroupDocs::Signature::Recipient.new(nickname: 'recipient2')
+      subject.recipients = [recipient1, recipient2]
+      subject.recipients.should include(recipient1)
+      subject.recipients.should include(recipient2)
+    end
+
+    it 'does nothing if nil is passed' do
+      lambda do
+        subject.recipients = nil
+      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/entity_methods.rb

@@ -0,0 +1,116 @@
+shared_examples_for GroupDocs::Signature::EntityMethods do
+
+  describe '.get!' do
+    before(:each) do
+      mock_api_server(load_json("#{subject.send(:class_name)}_get"))
+    end
+
+    it 'accepts access credentials hash' do
+      lambda do
+        described_class.get!("j5498fre9fje9f", client_id: 'client_id', private_key: 'private_key')
+      end.should_not raise_error(ArgumentError)
+    end
+
+    it "returns #{described_class} objects" do
+      described_class.get!("j5498fre9fje9f").should be_a(described_class)
+    end
+  end
+
+  # GroupDocs::Signature::Form overwrites #create! so we should not run default specs for it
+  unless described_class == GroupDocs::Signature::Form
+    describe '#create!' do
+      before(:each) do
+        mock_api_server(load_json("#{subject.send(:class_name)}_get"))
+      end
+
+      it 'accepts access credentials hash' do
+        lambda do
+          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_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!
+      end
+
+      it 'updates identifier of entity' do
+        lambda do
+          subject.create!
+        end.should change(subject, :id)
+      end
+    end
+  end
+
+  describe '#modify!' do
+    before(:each) do
+      mock_api_server(load_json("#{subject.send(:class_name)}_get"))
+    end
+
+    it 'accepts access credentials hash' do
+      lambda do
+        subject.modify!(client_id: 'client_id', private_key: 'private_key')
+      end.should_not raise_error(ArgumentError)
+    end
+
+    it 'uses hashed version of self as request body' do
+      subject.should_receive(:to_hash)
+      subject.modify!
+    end
+  end
+
+  describe '#rename!' do
+    before(:each) do
+      mock_api_server(%({ "status": "Ok", "result": { "#{subject.send(:class_name)}": null }}))
+    end
+
+    it 'accepts access credentials hash' do
+      lambda do
+        subject.rename!('Name', client_id: 'client_id', private_key: 'private_key')
+      end.should_not raise_error(ArgumentError)
+    end
+
+    # alter params for form
+    if described_class == GroupDocs::Signature::Form
+      it 'uses new_name as parameter' do
+        api = stub(GroupDocs::Api::Request)
+        api.stub!(execute!: {})
+        GroupDocs::Api::Request.stub(new: api)
+        api.should_receive(:add_params).with(new_name: 'Name')
+        subject.rename!('Name')
+      end
+    else
+      it 'uses name as parameter' do
+        api = stub(GroupDocs::Api::Request)
+        api.stub!(execute!: {})
+        GroupDocs::Api::Request.stub(new: api)
+        api.should_receive(:add_params).with(name: 'Name')
+        subject.rename!('Name')
+      end
+    end
+
+    it 'updates name of template' do
+      lambda do
+        subject.rename!('Name')
+      end.should change(subject, :name)
+    end
+  end
+
+  describe '#delete!' do
+    before(:each) do
+      mock_api_server(%({ "status": "Ok", "result": { "#{subject.send(:class_name)}": null }}))
+    end
+
+    it 'accepts access credentials hash' do
+      lambda do
+        subject.delete!(client_id: 'client_id', private_key: 'private_key')
+      end.should_not raise_error(ArgumentError)
+    end
+  end
+end

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

@@ -0,0 +1,188 @@
+shared_examples_for GroupDocs::Signature::FieldMethods do
+
+  describe '#fields!' do
+    let(:document)  { GroupDocs::Document.new(file: GroupDocs::Storage::File.new) }
+    let(:recipient) { GroupDocs::Signature::Recipient.new }
+
+    before(:each) do
+      mock_api_server(load_json('signature_fields_get'))
+    end
+
+    it 'accepts access credentials hash' do
+      lambda do
+        subject.fields!(document, recipient, 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
+      -> { subject.fields!('Document', recipient) }.should raise_error(ArgumentError)
+    end
+
+    it 'raises error if recipient is not GroupDocs::Signature::Recipient object' do
+      -> { subject.fields!(document, 'Recipient') }.should raise_error(ArgumentError)
+    end
+
+    it 'returns array of GroupDocs::Signature::Field objects' do
+      fields = subject.fields!(document, recipient)
+      fields.should be_an(Array)
+      fields.each do |field|
+        field.should be_a(GroupDocs::Signature::Field)
+      end
+    end
+  end
+
+  describe '#add_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) }
+    let(:recipient) { 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.add_field!(field, document, recipient, 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
+      -> { subject.add_field!('Field', document, recipient) }.should raise_error(ArgumentError)
+    end
+
+    it 'raises error if document is not GroupDocs::Document object' do
+      -> { subject.add_field!(field, 'Document', recipient) }.should raise_error(ArgumentError)
+    end
+
+    it 'raises error if recipient is not GroupDocs::Signature::Recipient object' do
+      -> { subject.add_field!(field, document, 'Recipient') }.should raise_error(ArgumentError)
+    end
+
+    it 'raises error if field does not specify location' do
+      field = GroupDocs::Signature::Field.new
+      -> { subject.add_field!(field, document, recipient) }.should raise_error(ArgumentError)
+    end
+
+    it 'uses field, field location and forcedNewField flag as payload' do
+      hash_one = {}
+      payload = {}
+      location = {}
+      field.should_receive(:to_hash).and_return(payload)
+      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)
+    end
+  end
+
+  describe '#modify_field!' do
+    let(:field)    { GroupDocs::Signature::Field.new }
+    let(:document) { GroupDocs::Document.new(file: GroupDocs::Storage::File.new) }
+
+    before(:each) do
+      mock_api_server(load_json('signature_field_add'))
+    end
+
+    it 'accepts access credentials hash' do
+      lambda do
+        subject.modify_field!(field, document, 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
+      -> { subject.modify_field!('Field', document) }.should raise_error(ArgumentError)
+    end
+
+    it 'raises error if document is not GroupDocs::Document object' do
+      -> { subject.modify_field!(field, 'Document') }.should raise_error(ArgumentError)
+    end
+
+    it 'uses field and first field location as payload' do
+      payload   = {}
+      location  = {}
+      locations = [location]
+      field.should_receive(:to_hash).and_return(payload)
+      payload.should_receive(:delete).with(:locations).and_return(payload)
+      field.should_receive(:locations).and_return(locations)
+      locations.should_receive(:first).and_return(location)
+      payload.should_receive(:merge!).with(location).and_return(payload)
+      subject.modify_field!(field, document)
+    end
+  end
+
+  describe '#delete_field!' do
+    let(:field) do
+      GroupDocs::Signature::Field.new
+    end
+
+    before(:each) do
+      mock_api_server('{ "status": "Ok", "result": {}}')
+    end
+
+    it 'raises error if field is not GroupDocs::Signature::Field object' do
+      -> { subject.delete_field!('Field') }.should raise_error(ArgumentError)
+    end
+
+    it 'accepts access credentials hash' do
+      lambda do
+        subject.delete_field!(field, client_id: 'client_id', private_key: 'private_key')
+      end.should_not raise_error(ArgumentError)
+    end
+  end
+
+  describe '#modify_field_location!' do
+    let(:field)     { GroupDocs::Signature::Field.new }
+    let(:document)  { GroupDocs::Document.new(file: GroupDocs::Storage::File.new) }
+    let(:recipient) { GroupDocs::Signature::Recipient.new }
+    let(:location)  { GroupDocs::Signature::Field::Location.new }
+
+    before(:each) do
+      mock_api_server(load_json('signature_field_add'))
+    end
+
+    it 'raises error if location is not GroupDocs::Signature::Field::Location object' do
+      -> { subject.modify_field_location!('Location', field, document, recipient) }.should raise_error(ArgumentError)
+    end
+
+    it 'raises error if field is not GroupDocs::Signature::Field object' do
+      -> { subject.modify_field_location!(location, 'Field', document, recipient) }.should raise_error(ArgumentError)
+    end
+
+    it 'raises error if document is not GroupDocs::Document object' do
+      -> { 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
+      -> { subject.modify_field_location!(location, field, document, 'Recipient') }.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')
+      end.should_not raise_error(ArgumentError)
+    end
+  end
+
+  describe '#delete_field_location!' do
+    let(:field)    { GroupDocs::Signature::Field.new }
+    let(:location) { GroupDocs::Signature::Field::Location.new }
+
+    before(:each) do
+      mock_api_server('{ "status": "Ok", "result": {}}')
+    end
+
+    it 'raises error if location is not GroupDocs::Signature::Field::Location object' do
+      -> { subject.delete_field_location!('Location', field) }.should raise_error(ArgumentError)
+    end
+
+    it 'raises error if field is not GroupDocs::Signature::Field object' do
+      -> { subject.delete_field_location!(location, 'Field') }.should raise_error(ArgumentError)
+    end
+
+    it 'accepts access credentials hash' do
+      lambda do
+        subject.delete_field_location!(location, field, client_id: 'client_id', private_key: 'private_key')
+      end.should_not raise_error(ArgumentError)
+    end
+  end
+end