groupdocs 0.3.11 → 1.0.0

data/spec/groupdocs/signature/list_spec.rb

@@ -0,0 +1,92 @@
+require 'spec_helper'
+
+describe GroupDocs::Signature::List do
+
+  it_behaves_like GroupDocs::Api::Entity
+
+  describe '.get!' do
+    before(:each) do
+      mock_api_server(load_json('lists_get'))
+    end
+
+    it 'accepts access credentials hash' do
+      lambda do
+        described_class.get!(client_id: 'client_id', private_key: 'private_key')
+      end.should_not raise_error(ArgumentError)
+    end
+
+    it 'returns array of GroupDocs::Signature::List objects' do
+      lists = described_class.get!
+      lists.should be_an(Array)
+      lists.each do |list|
+        list.should be_a(GroupDocs::Signature::List)
+      end
+    end
+  end
+
+  it { should respond_to(:id)            }
+  it { should respond_to(:id=)           }
+  it { should respond_to(:name)          }
+  it { should respond_to(:name=)         }
+  it { should respond_to(:values)        }
+  it { should respond_to(:values=)       }
+  it { should respond_to(:defaultValue)  }
+  it { should respond_to(:defaultValue=) }
+
+  it { should have_alias(:default_value,  :defaultValue)  }
+  it { should have_alias(:default_value=, :defaultValue=) }
+
+  describe '#values=' do
+    it 'converts array of values to a string' do
+      subject.values = %w(Test1 Test2)
+      subject.instance_variable_get(:@values).should == 'Test1;Test2'
+    end
+
+    it 'does nothing if values is a string' do
+      subject.values = 'Test1;Test2'
+      subject.instance_variable_get(:@values).should == 'Test1;Test2'
+    end
+  end
+
+  describe '#values' do
+    it 'returns values as an array' do
+      subject.values = 'Test1;Test2'
+      subject.values.should == %w(Test1 Test2)
+    end
+  end
+
+  describe '#add!' do
+    before(:each) do
+      mock_api_server(load_json('list_add'))
+    end
+
+    it 'accepts access credentials hash' do
+      lambda do
+        subject.add!(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.add!
+    end
+
+    it 'updates identifier of list' do
+      lambda do
+        subject.add!
+      end.should change(subject, :id)
+    end
+  end
+
+  describe '#delete!' do
+    before(:each) do
+      mock_api_server('{ "status": "Ok", "result": { "list": 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/groupdocs/signature/recipient_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+
+describe GroupDocs::Signature::Recipient do
+
+  it_behaves_like GroupDocs::Api::Entity
+
+  it { should respond_to(:id)         }
+  it { should respond_to(:id=)        }
+  it { should respond_to(:email)      }
+  it { should respond_to(:email=)     }
+  it { should respond_to(:firstName)  }
+  it { should respond_to(:firstName=) }
+  it { should respond_to(:lastName)   }
+  it { should respond_to(:lastName=)  }
+  it { should respond_to(:nickname)   }
+  it { should respond_to(:nickname=)  }
+  it { should respond_to(:roleId)     }
+  it { should respond_to(:roleId=)    }
+  it { should respond_to(:order)      }
+  it { should respond_to(:order=)     }
+  it { should respond_to(:status)     }
+  it { should respond_to(:status=)    }
+
+  it { should have_alias(:first_name,  :firstName)  }
+  it { should have_alias(:first_name=, :firstName=) }
+  it { should have_alias(:last_name,   :lastName)   }
+  it { should have_alias(:last_name=,  :lastName=)  }
+  it { should have_alias(:role_id,     :roleId)     }
+  it { should have_alias(:role_id=,    :roleId=)    }
+
+  describe '#status' do
+    it 'converts status to human-readable format' do
+      subject.status = 1
+      subject.status.should == :notified
+    end
+  end
+end

data/spec/groupdocs/signature/role_spec.rb

@@ -0,0 +1,100 @@
+require 'spec_helper'
+
+describe GroupDocs::Signature::Role do
+
+  it_behaves_like GroupDocs::Api::Entity
+
+  describe '.get!' do
+    before(:each) do
+      mock_api_server(load_json('signature_roles_get'))
+    end
+
+    it 'accepts access credentials hash' do
+      lambda do
+        described_class.get!({}, client_id: 'client_id', private_key: 'private_key')
+      end.should_not raise_error(ArgumentError)
+    end
+
+    it 'allows passing options' do
+      -> { described_class.get!(id: "dsaoij3928ukr03") }.should_not raise_error(ArgumentError)
+    end
+
+    it 'returns array of GroupDocs::Signature::Role objects' do
+      roles = described_class.get!
+      roles.should be_an(Array)
+      roles.each do |role|
+        role.should be_a(GroupDocs::Signature::Role)
+      end
+    end
+  end
+
+  it { should respond_to(:id)           }
+  it { should respond_to(:id=)          }
+  it { should respond_to(:name)         }
+  it { should respond_to(:name=)        }
+  it { should respond_to(:canEdit)      }
+  it { should respond_to(:canEdit=)     }
+  it { should respond_to(:canSign)      }
+  it { should respond_to(:canSign=)     }
+  it { should respond_to(:canAnnotate)  }
+  it { should respond_to(:canAnnotate=) }
+  it { should respond_to(:canDelegate)  }
+  it { should respond_to(:canDelegate=) }
+
+  it { should have_alias(:can_edit, :canEdit)           }
+  it { should have_alias(:can_edit=, :canEdit=)         }
+  it { should have_alias(:can_sign, :canSign)           }
+  it { should have_alias(:can_sign=, :canSign=)         }
+  it { should have_alias(:can_annotate, :canAnnotate)   }
+  it { should have_alias(:can_annotate=, :canAnnotate=) }
+  it { should have_alias(:can_delegate, :canDelegate)   }
+  it { should have_alias(: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
+end

data/spec/groupdocs/signature/template_spec.rb

@@ -0,0 +1,82 @@
+require 'spec_helper'
+
+describe GroupDocs::Signature::Template do
+
+  it_behaves_like GroupDocs::Api::Entity
+  include_examples GroupDocs::Signature::DocumentMethods
+  include_examples GroupDocs::Signature::EntityFields
+  include_examples GroupDocs::Signature::EntityMethods
+  include_examples GroupDocs::Signature::FieldMethods
+  include_examples GroupDocs::Signature::RecipientMethods
+  include_examples GroupDocs::Signature::ResourceMethods
+
+  describe '.all!' do
+    before(:each) do
+      mock_api_server(load_json('templates_all'))
+    end
+
+    it 'accepts access credentials hash' do
+      lambda do
+        described_class.all!({}, client_id: 'client_id', private_key: 'private_key')
+      end.should_not raise_error(ArgumentError)
+    end
+
+    it 'allows passing options' do
+      -> { described_class.all!(page: 1, count: 3) }.should_not raise_error(ArgumentError)
+    end
+
+    it 'returns array of GroupDocs::Signature::Template objects' do
+      templates = described_class.all!
+      templates.should be_an(Array)
+      templates.each do |template|
+        template.should be_a(GroupDocs::Signature::Template)
+      end
+    end
+  end
+
+  it { should respond_to(:templateExpireTime)  }
+  it { should respond_to(:templateExpireTime=) }
+
+  it { should have_alias(:template_expire_time, :templateExpireTime)   }
+  it { should have_alias(:template_expire_time=, :templateExpireTime=) }
+
+  describe '#add_recipient!' do
+    let(:recipient) do
+      GroupDocs::Signature::Recipient.new
+    end
+
+    before(:each) do
+      mock_api_server('{ "status": "Ok", "result": {}}')
+    end
+
+    it 'accepts access credentials hash' do
+      lambda do
+        subject.add_recipient!(recipient, client_id: 'client_id', private_key: 'private_key')
+      end.should_not raise_error(ArgumentError)
+    end
+
+    it 'raises error if recipient is not GroupDocs::Signature::Recipient object' do
+      -> { subject.add_recipient!('Recipient') }.should raise_error(ArgumentError)
+    end
+  end
+
+  describe '#modify_recipient!' do
+    let(:recipient) do
+      GroupDocs::Signature::Recipient.new
+    end
+
+    before(:each) do
+      mock_api_server('{ "status": "Ok", "result": {}}')
+    end
+
+    it 'accepts access credentials hash' do
+      lambda do
+        subject.modify_recipient!(recipient, client_id: 'client_id', private_key: 'private_key')
+      end.should_not raise_error(ArgumentError)
+    end
+
+    it 'raises error if recipient is not GroupDocs::Signature::Recipient object' do
+      -> { subject.modify_recipient!('Recipient') }.should raise_error(ArgumentError)
+    end
+  end
+end

data/spec/groupdocs/signature_spec.rb

@@ -0,0 +1,117 @@
+require 'spec_helper'
+
+describe GroupDocs::Signature do
+
+  it_behaves_like GroupDocs::Api::Entity
+
+  describe '.get!' do
+    before(:each) do
+      mock_api_server(load_json('signatures_get'))
+    end
+
+    it 'accepts access credentials hash' do
+      lambda do
+        described_class.get!(client_id: 'client_id', private_key: 'private_key')
+      end.should_not raise_error(ArgumentError)
+    end
+
+    it 'returns array of GroupDocs::Signature objects' do
+      signatures = described_class.get!
+      signatures.should be_an(Array)
+      signatures.each do |signature|
+        signature.should be_a(GroupDocs::Signature)
+      end
+    end
+  end
+
+  it { should respond_to(:id)                    }
+  it { should respond_to(:id=)                   }
+  it { should respond_to(:userGuid)              }
+  it { should respond_to(:userGuid=)             }
+  it { should respond_to(:recipientId)           }
+  it { should respond_to(:recipientId=)          }
+  it { should respond_to(:name)                  }
+  it { should respond_to(:name=)                 }
+  it { should respond_to(:companyName)           }
+  it { should respond_to(:companyName=)          }
+  it { should respond_to(:position)              }
+  it { should respond_to(:position=)             }
+  it { should respond_to(:firstName)             }
+  it { should respond_to(:firstName=)            }
+  it { should respond_to(:lastName)              }
+  it { should respond_to(:lastName=)             }
+  it { should respond_to(:fullName)              }
+  it { should respond_to(:fullName=)             }
+  it { should respond_to(:textInitials)          }
+  it { should respond_to(:textInitials=)         }
+  it { should respond_to(:signatureImageFileId)  }
+  it { should respond_to(:signatureImageFileId=) }
+  it { should respond_to(:initialsImageFileId)   }
+  it { should respond_to(:initialsImageFileId=)  }
+  it { should respond_to(:signatureImageUrl)     }
+  it { should respond_to(:signatureImageUrl=)    }
+  it { should respond_to(:initialsImageUrl)      }
+  it { should respond_to(:initialsImageUrl=)     }
+  it { should respond_to(:createdTimeStamp)      }
+  it { should respond_to(:createdTimeStamp=)     }
+
+  it { should have_alias(:user_guid, :userGuid)                             }
+  it { should have_alias(:user_guid=, :userGuid=)                           }
+  it { should have_alias(:recipient_id, :recipientId)                       }
+  it { should have_alias(:recipient_id=, :recipientId=)                     }
+  it { should have_alias(:company_name, :companyName)                       }
+  it { should have_alias(:company_name=, :companyName=)                     }
+  it { should have_alias(:first_name, :firstName)                           }
+  it { should have_alias(:first_name=, :firstName=)                         }
+  it { should have_alias(:last_name, :lastName)                             }
+  it { should have_alias(:last_name=, :lastName=)                           }
+  it { should have_alias(:full_name, :fullName)                             }
+  it { should have_alias(:full_name=, :fullName=)                           }
+  it { should have_alias(:text_initials, :textInitials)                     }
+  it { should have_alias(:text_initials=, :textInitials=)                   }
+  it { should have_alias(:signature_image_file_id, :signatureImageFileId)   }
+  it { should have_alias(:signature_image_file_id=, :signatureImageFileId=) }
+  it { should have_alias(:initials_image_file_id, :initialsImageFileId)     }
+  it { should have_alias(:initials_image_file_id=, :initialsImageFileId=)   }
+  it { should have_alias(:signature_image_url, :signatureImageUrl)          }
+  it { should have_alias(:signature_image_url=, :signatureImageUrl=)        }
+  it { should have_alias(:initials_image_url, :initialsImageUrl)            }
+  it { should have_alias(:initials_image_url=, :initialsImageUrl=)          }
+  it { should have_alias(:created_time_stamp, :createdTimeStamp)            }
+  it { should have_alias(:created_time_stamp=, :createdTimeStamp=)          }
+
+  describe '#create!' do
+    before(:each) do
+      mock_api_server(load_json('signature_create'))
+    end
+
+    it 'accepts access credentials hash' do
+      lambda do
+        subject.create!('Signature', 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.create!('Signature')
+    end
+
+    it 'updates identifier of signature' do
+      lambda do
+        subject.create!('Signature')
+      end.should change(subject, :id)
+    end
+  end
+
+  describe '#delete!' do
+    before(:each) do
+      mock_api_server('{ "status": "Ok", "result": {}}')
+    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/groupdocs/storage/file_spec.rb

@@ -3,7 +3,6 @@ require 'spec_helper'
 describe GroupDocs::Storage::File do
 
   it_behaves_like GroupDocs::Api::Entity
-  include_examples GroupDocs::Extensions::Lookup
   include_examples GroupDocs::Api::Helpers::AccessMode
 
   describe '.upload!' do
@@ -13,18 +12,32 @@ describe GroupDocs::Storage::File do
 
     it 'accepts access credentials hash' do
       lambda do
-        described_class.upload!(__FILE__, '/upload_path', client_id: 'client_id', private_key: 'private_key')
+        described_class.upload!(__FILE__, {}, client_id: 'client_id', private_key: 'private_key')
       end.should_not raise_error(ArgumentError)
     end
 
-    it 'checks that upload path starts with /' do
-      GroupDocs::Api::Helpers::Path.should_receive(:verify_starts_with_root).with('/upload_path')
-      described_class.upload!(__FILE__, '/upload_path')
+    it 'accepts options hash' do
+      lambda do
+        described_class.upload!(__FILE__, path: 'folder1')
+      end.should_not raise_error(ArgumentError)
+    end
+
+    it 'uses root folder by default' do
+      opts = {}
+      described_class.upload!(__FILE__, opts)
+      opts[:path].should == ''
+    end
+
+    it 'uses file name by default' do
+      opts = {}
+      described_class.upload!(__FILE__, opts)
+      opts[:name].should == Object::File.basename(__FILE__)
     end
 
-    it 'appends filename to upload path if it is not passed' do
-      GroupDocs::Api::Helpers::Path.should_receive(:append_file_name).with('/upload_path', __FILE__)
-      described_class.upload!(__FILE__, '/upload_path')
+    it 'uses name if passed' do
+      opts = { name: 'file.pdf' }
+      described_class.upload!(__FILE__, opts)
+      opts[:name].should == opts[:name]
     end
 
     it 'returns GroupDocs::Storage::File object' do
@@ -32,6 +45,22 @@ describe GroupDocs::Storage::File do
     end
   end
 
+  describe '.upload_web!' do
+    before(:each) do
+      mock_api_server(load_json('file_upload'))
+    end
+
+    it 'accepts access credentials hash' do
+      lambda do
+        described_class.upload_web!('http://www.google.com', client_id: 'client_id', private_key: 'private_key')
+      end.should_not raise_error(ArgumentError)
+    end
+
+    it 'returns GroupDocs::Storage::File object' do
+      described_class.upload_web!('http://www.google.com').should be_a(GroupDocs::Storage::File)
+    end
+  end
+
   it { should respond_to(:id)           }
   it { should respond_to(:id=)          }
   it { should respond_to(:guid)         }
@@ -59,10 +88,7 @@ describe GroupDocs::Storage::File do
   it { should respond_to(:path)         }
   it { should respond_to(:path=)        }
 
-  it 'is compatible with response JSON' do
-    subject.should respond_to(:adj_name=)
-    subject.method(:adj_name=).should == subject.method(:name=)
-  end
+  it { should have_alias(:adj_name=, :name=) }
 
   describe '#type=' do
     it 'saves type in machine readable format if symbol is passed' do
@@ -108,31 +134,6 @@ describe GroupDocs::Storage::File do
     end
   end
 
-  describe '#upload!' do
-    before(:each) do
-      mock_api_server(load_json('file_upload'))
-    end
-
-    it 'accepts access credentials hash' do
-      lambda do
-        subject.upload!('/', client_id: 'client_id', private_key: 'private_key')
-      end.should_not raise_error(ArgumentError)
-    end
-
-    it 'calls upload! class method and pass parameters to it' do
-      subject = described_class.new(name: File.basename(__FILE__), path: File.dirname(__FILE__))
-      described_class.should_receive(:upload!).with(__FILE__, '/Folder', {})
-      subject.upload!('/Folder')
-    end
-
-    it 'returns new GroupDocs::Storage::File object' do
-      subject = described_class.new(name: File.basename(__FILE__), path: File.dirname(__FILE__))
-      new_file = subject.upload!
-      new_file.should be_a(GroupDocs::Storage::File)
-      new_file.should_not == subject
-    end
-  end
-
   describe '#download!' do
     before(:each) do
       mock_api_server(File.read('spec/support/files/resume.pdf'))
@@ -166,28 +167,31 @@ describe GroupDocs::Storage::File do
 
     it 'accepts access credentials hash' do
       lambda do
-        subject.move!('/resume.pdf', client_id: 'client_id', private_key: 'private_key')
+        subject.move!('folder1', {}, client_id: 'client_id', private_key: 'private_key')
       end.should_not raise_error(ArgumentError)
     end
 
-    it 'checks that path starts with /' do
-      GroupDocs::Api::Helpers::Path.should_receive(:verify_starts_with_root).with('/resume.pdf')
-      subject.move!('/resume.pdf')
+    it 'accepts options credentials hash' do
+      lambda do
+        subject.move!('folder1', name: 'file.pdf')
+      end.should_not raise_error(ArgumentError)
     end
 
-    it 'appends filename to move to path if it is not passed' do
-      GroupDocs::Api::Helpers::Path.should_receive(:append_file_name).with('/Folder', subject.name)
-      subject.move!('/Folder')
+    it 'uses current file name by default' do
+      subject.name = 'resume.pdf'
+      opts = {}
+      subject.move!('folder1', opts)
+      opts[:name].should == subject.name
     end
 
-    it 'sends "Groupdocs-Move" header' do
-      mock_api_server(load_json('file_move'), :'Groupdocs-Move' => '123')
-      subject.stub(id: 123)
-      subject.move!('/resume2.pdf')
+    it 'uses name if passed' do
+      opts = { name: 'file.pdf' }
+      subject.move!('folder1', opts)
+      opts[:name].should == opts[:name]
     end
 
     it 'returns moved to file' do
-      subject.move!('/resume2.pdf').should be_a(GroupDocs::Storage::File)
+      subject.move!('folder1').should be_a(GroupDocs::Storage::File)
     end
   end
 
@@ -203,7 +207,7 @@ describe GroupDocs::Storage::File do
     end
 
     it 'uses #move! to rename file' do
-      subject.should_receive(:move!).with('/resume2.pdf', {})
+      subject.should_receive(:move!).with(subject.path, { name: 'resume2.pdf' }, {})
       subject.rename!('resume2.pdf')
     end
   end
@@ -215,24 +219,27 @@ describe GroupDocs::Storage::File do
 
     it 'accepts access credentials hash' do
       lambda do
-        subject.copy!('/resume.pdf', client_id: 'client_id', private_key: 'private_key')
+        subject.copy!('resume.pdf', {}, client_id: 'client_id', private_key: 'private_key')
       end.should_not raise_error(ArgumentError)
     end
 
-    it 'checks that path starts with /' do
-      GroupDocs::Api::Helpers::Path.should_receive(:verify_starts_with_root).with('resume.pdf')
-      subject.copy!('resume.pdf')
+    it 'accepts options credentials hash' do
+      lambda do
+        subject.copy!('folder1', name: 'file.pdf')
+      end.should_not raise_error(ArgumentError)
     end
 
-    it 'appends filename to move to path if it is not passed' do
-      GroupDocs::Api::Helpers::Path.should_receive(:append_file_name).with('/Folder', subject.name)
-      subject.copy!('/Folder')
+    it 'uses current file name by default' do
+      subject.name = 'resume.pdf'
+      opts = {}
+      subject.copy!('folder1', opts)
+      opts[:name].should == subject.name
     end
 
-    it 'sends "Groupdocs-Copy" header' do
-      mock_api_server(load_json('file_copy'), :'Groupdocs-Copy' => '123')
-      subject.stub(id: 123)
-      subject.copy!('/resume2.pdf')
+    it 'uses name if passed' do
+      opts = { name: 'file.pdf' }
+      subject.copy!('folder1', opts)
+      opts[:name].should == opts[:name]
     end
 
     it 'returns copied to file' do
@@ -276,6 +283,14 @@ describe GroupDocs::Storage::File do
     end
   end
 
+  describe '#move_to_trash!' do
+    it 'accepts access credentials hash' do
+      lambda do
+        subject.move_to_trash!(client_id: 'client_id', private_key: 'private_key')
+      end.should_not raise_error(ArgumentError)
+    end
+  end
+
   describe '#to_document' do
     it 'creates new GroupDocs::Document' do
       subject.to_document.should be_a(GroupDocs::Document)