groupdocs 0.3.11 → 1.0.0

data/spec/groupdocs/document/rectangle_spec.rb

@@ -13,26 +13,14 @@ describe GroupDocs::Document::Rectangle do
   it { should respond_to(:Height)  }
   it { should respond_to(:Height=) }
 
-  it 'has human-readable accessors' do
-    subject.should respond_to(:x)
-    subject.should respond_to(:x=)
-    subject.should respond_to(:y)
-    subject.should respond_to(:y=)
-    subject.should respond_to(:w)
-    subject.should respond_to(:w=)
-    subject.should respond_to(:width)
-    subject.should respond_to(:h)
-    subject.should respond_to(:h=)
-    subject.should respond_to(:height)
-    subject.method(:x).should      == subject.method(:X)
-    subject.method(:x=).should     == subject.method(:X=)
-    subject.method(:y).should      == subject.method(:Y)
-    subject.method(:y=).should     == subject.method(:Y=)
-    subject.method(:w).should      == subject.method(:Width)
-    subject.method(:w=).should     == subject.method(:Width=)
-    subject.method(:width).should  == subject.method(:w)
-    subject.method(:h).should      == subject.method(:Height)
-    subject.method(:h=).should     == subject.method(:Height=)
-    subject.method(:height).should == subject.method(:h)
-  end
+  it { should have_alias(:x, :X)        }
+  it { should have_alias(:x=, :X=)      }
+  it { should have_alias(:y, :Y)        }
+  it { should have_alias(:y=, :Y=)      }
+  it { should have_alias(:w, :Width)    }
+  it { should have_alias(:w=, :Width=)  }
+  it { should have_alias(:width, :w)    }
+  it { should have_alias(:h, :Height)   }
+  it { should have_alias(:h=, :Height=) }
+  it { should have_alias(:height, :h)   }
 end

data/spec/groupdocs/document_spec.rb

@@ -3,7 +3,6 @@ require 'spec_helper'
 describe GroupDocs::Document do
 
   it_behaves_like GroupDocs::Api::Entity
-  include_examples GroupDocs::Extensions::Lookup
   include_examples GroupDocs::Api::Helpers::Status
 
   subject do
@@ -31,23 +30,6 @@ describe GroupDocs::Document do
     end
   end
 
-  describe '.all!' do
-    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 'calls GroupDocs::Storage::File.all! and converts each file to document' do
-      file1 = GroupDocs::Storage::File.new
-      file2 = GroupDocs::Storage::File.new
-      GroupDocs::Storage::File.should_receive(:all!).with('/', {}).and_return([file1, file2])
-      file1.should_receive(:to_document).and_return(described_class.new(file: file1))
-      file2.should_receive(:to_document).and_return(described_class.new(file: file2))
-      described_class.all!
-    end
-  end
-
   it { should respond_to(:file)            }
   it { should respond_to(:file=)           }
   it { should respond_to(:process_date)    }
@@ -56,11 +38,10 @@ describe GroupDocs::Document do
   it { should respond_to(:outputs=)        }
   it { should respond_to(:output_formats)  }
   it { should respond_to(:output_formats=) }
+  it { should respond_to(:order)           }
+  it { should respond_to(:order=)          }
 
-  it 'is compatible with response JSON' do
-    subject.should respond_to(:proc_date=)
-    subject.method(:proc_date=).should == subject.method(:process_date=)
-  end
+  it { should have_alias(:access_mode=, :access_mode_set!) }
 
   describe '#outputs=' do
     let(:response) do
@@ -149,8 +130,7 @@ describe GroupDocs::Document do
     end
 
     it 'is aliased to #access_mode=' do
-      subject.should respond_to(:access_mode=)
-      subject.method(:access_mode=).should == subject.method(:access_mode_set!)
+      subject.should have_alias(:access_mode=, :access_mode_set!)
     end
   end
 
@@ -198,7 +178,7 @@ describe GroupDocs::Document do
     end
 
     it 'does not set last view if document has never been viewed' do
-      mock_api_server('{"status": "Ok", "result": {"last_view": null }}')
+      mock_api_server('{ "status": "Ok", "result": { "last_view": null }}')
       subject.metadata!.last_view.should be_nil
     end
   end
@@ -375,7 +355,7 @@ describe GroupDocs::Document do
       subject.create_questionnaire!(questionnaire)
     end
 
-    it 'adds ID from response to questionnaire' do
+    it 'updates ID from response to questionnaire' do
       lambda do
         subject.create_questionnaire!(questionnaire)
       end.should change(questionnaire, :id)
@@ -449,7 +429,7 @@ describe GroupDocs::Document do
     end
 
     it 'returns empty array if annotations are null in response' do
-      mock_api_server('{"status": "Ok", "result": {"annotations": null }}')
+      mock_api_server('{ "status": "Ok", "result": { "annotations": null }}')
       subject.annotations!.should be_empty
     end
   end

data/spec/groupdocs/job_spec.rb

@@ -31,6 +31,22 @@ describe GroupDocs::Job do
     end
   end
 
+  describe '.get!' do
+    before(:each) do
+      mock_api_server(load_json('job_get'))
+    end
+
+    it 'accepts access credentials hash' do
+      lambda do
+        described_class.get!(1, client_id: 'client_id', private_key: 'private_key')
+      end.should_not raise_error(ArgumentError)
+    end
+
+    it 'returns GroupDocs::Job object' do
+      described_class.get!(1).should be_a(GroupDocs::Job)
+    end
+  end
+
   describe '.create!' do
     before(:each) do
       mock_api_server(load_json('job_create'))
@@ -66,6 +82,12 @@ describe GroupDocs::Job do
 
   it { should respond_to(:id)              }
   it { should respond_to(:id=)             }
+  it { should respond_to(:guid)            }
+  it { should respond_to(:guid=)           }
+  it { should respond_to(:name)            }
+  it { should respond_to(:name=)           }
+  it { should respond_to(:priority)        }
+  it { should respond_to(:priority=)       }
   it { should respond_to(:actions)         }
   it { should respond_to(:actions=)        }
   it { should respond_to(:email_results)   }
@@ -140,6 +162,11 @@ describe GroupDocs::Job do
         document.should be_a(GroupDocs::Document)
       end
     end
+
+    it 'returns empty array if null is returned instead of inputs array' do
+      mock_api_server('{ "status": "Ok", "result": {}}')
+      subject.documents!.should be_empty
+    end
   end
 
   describe '#add_document!' do
@@ -172,6 +199,22 @@ describe GroupDocs::Job do
     end
   end
 
+  describe '#delete_document!' do
+    before(:each) do
+      mock_api_server('{ "result": {}, "status": "Ok" }')
+    end
+
+    it 'accepts access credentials hash' do
+      lambda do
+        subject.delete_document!('a9ufg8s7dfgsdf', client_id: 'client_id', private_key: 'private_key')
+      end.should_not raise_error(ArgumentError)
+    end
+
+    it 'returns empty hash' do
+      subject.delete_document!('a9ufg8s7dfgsdf').should be_empty
+    end
+  end
+
   describe '#add_datasource!' do
     let(:document) do
       GroupDocs::Document.new(file: GroupDocs::Storage::File.new)

data/spec/groupdocs/questionnaire/question_spec.rb

@@ -17,12 +17,8 @@ describe GroupDocs::Questionnaire::Question do
   it { should respond_to(:answers)     }
   it { should respond_to(:answers=)    }
 
-  it 'has human-readable accessors' do
-    subject.should respond_to(:default_answer)
-    subject.should respond_to(:default_answer=)
-    subject.method(:default_answer).should  == subject.method(:def_answer)
-    subject.method(:default_answer=).should == subject.method(:def_answer=)
-  end
+  it { should have_alias(:default_answer, :def_answer)   }
+  it { should have_alias(:default_answer=, :def_answer=) }
 
   describe '#answers=' do
     it 'converts each answer to GroupDocs::Questionnaire::Question::Answer object' do

data/spec/groupdocs/questionnaire_spec.rb

@@ -68,12 +68,8 @@ describe GroupDocs::Questionnaire do
   it { should respond_to(:pages)  }
   it { should respond_to(:pages=) }
 
-  it 'has human-readable accessors' do
-    subject.should respond_to(:description)
-    subject.should respond_to(:description=)
-    subject.method(:description).should  == subject.method(:descr)
-    subject.method(:description=).should == subject.method(:descr=)
-  end
+  it { should have_alias(:description, :descr)   }
+  it { should have_alias(:description=, :descr=) }
 
   describe '#pages=' do
     it 'converts each page to GroupDocs::Questionnaire::Page object if hash is passed' do
@@ -129,7 +125,7 @@ describe GroupDocs::Questionnaire do
       subject.create!
     end
 
-    it 'adds ID of questionnaire from response to self' do
+    it 'updates identifier of questionnaire' do
       lambda do
         subject.create!
       end.should change(subject, :id)

data/spec/groupdocs/signature/contact_spec.rb

@@ -0,0 +1,129 @@
+require 'spec_helper'
+
+describe GroupDocs::Signature::Contact do
+
+  it_behaves_like GroupDocs::Api::Entity
+
+  describe '.get!' do
+    before(:each) do
+      mock_api_server(load_json('contacts_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!(page: 1, email: 'com') }.should_not raise_error(ArgumentError)
+    end
+
+    it 'returns array of GroupDocs::Signature::Contact objects' do
+      contacts = described_class.get!
+      contacts.should be_an(Array)
+      contacts.each do |contact|
+        contact.should be_a(GroupDocs::Signature::Contact)
+      end
+    end
+  end
+
+  describe '.import!' do
+    let(:contact) do
+      described_class.new(first_name: 'John', last_name: 'Smith', email: 'john@smith.com')
+    end
+
+    before(:each) do
+      mock_api_server(load_json('contacts_import'))
+    end
+
+    it 'accepts access credentials hash' do
+      lambda do
+        described_class.import!([contact], client_id: 'client_id', private_key: 'private_key')
+      end.should_not raise_error(ArgumentError)
+    end
+
+    it 'raises error if contacts is not array' do
+      -> { described_class.import!(contact) }.should raise_error(ArgumentError)
+    end
+
+    it 'raises error if array element is not GroupDocs::Signature::Contact' do
+      -> { described_class.import!(%w(test)) }.should raise_error(ArgumentError)
+    end
+
+    it 'uses hashed version of array elements as request body' do
+      contact.should_receive(:to_hash)
+      described_class.import!([contact])
+    end
+  end
+
+  it { should respond_to(:id)         }
+  it { should respond_to(:id=)        }
+  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(:email)      }
+  it { should respond_to(:email=)     }
+  it { should respond_to(:provider)   }
+  it { should respond_to(:provider=)  }
+
+  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=)   }
+
+  describe '#add!' do
+    before(:each) do
+      mock_api_server(load_json('contact_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 contact' do
+      lambda do
+        subject.add!
+      end.should change(subject, :id)
+    end
+  end
+
+  describe '#update!' do
+    before(:each) do
+      mock_api_server(load_json('contact_add'))
+    end
+
+    it 'accepts access credentials hash' do
+      lambda do
+        subject.update!(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
+  end
+
+  describe '#delete!' do
+    before(:each) do
+      mock_api_server('{ "status": "Ok", "result": { "contact": 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/envelope/log_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+describe GroupDocs::Signature::Envelope::Log do
+
+  it_behaves_like GroupDocs::Api::Entity
+
+  it { should respond_to(:id)             }
+  it { should respond_to(:id=)            }
+  it { should respond_to(:date)           }
+  it { should respond_to(:date=)          }
+  it { should respond_to(:userName)       }
+  it { should respond_to(:userName=)      }
+  it { should respond_to(:action)         }
+  it { should respond_to(:action=)        }
+  it { should respond_to(:remoteAddress)  }
+  it { should respond_to(:remoteAddress=) }
+
+  it { should have_alias(:user_name,       :userName)       }
+  it { should have_alias(:user_name=,      :userName=)      }
+  it { should have_alias(:remote_address,  :remoteAddress)  }
+  it { should have_alias(:remote_address=, :remoteAddress=) }
+
+end

data/spec/groupdocs/signature/envelope_spec.rb

@@ -0,0 +1,296 @@
+require 'spec_helper'
+
+describe GroupDocs::Signature::Envelope 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('envelopes_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::Envelope objects' do
+      envelopes = described_class.all!
+      envelopes.should be_an(Array)
+      envelopes.each do |envelope|
+        envelope.should be_a(GroupDocs::Signature::Envelope)
+      end
+    end
+  end
+
+  describe '.for_me!' do
+    before(:each) do
+      mock_api_server(load_json('envelopes_all'))
+    end
+
+    it 'accepts access credentials hash' do
+      lambda do
+        described_class.for_me!({}, client_id: 'client_id', private_key: 'private_key')
+      end.should_not raise_error(ArgumentError)
+    end
+
+    it 'allows passing options' do
+      -> { described_class.for_me!(page: 1, count: 3) }.should_not raise_error(ArgumentError)
+    end
+
+    it 'returns array of GroupDocs::Signature::Envelope objects' do
+      envelopes = described_class.for_me!
+      envelopes.should be_an(Array)
+      envelopes.each do |envelope|
+        envelope.should be_a(GroupDocs::Signature::Envelope)
+      end
+    end
+  end
+
+  it { should respond_to(:creationDateTime)    }
+  it { should respond_to(:creationDateTime=)   }
+  it { should respond_to(:status)              }
+  it { should respond_to(:status=)             }
+  it { should respond_to(:statusDateTime)      }
+  it { should respond_to(:statusDateTime=)     }
+  it { should respond_to(:envelopeExpireTime)  }
+  it { should respond_to(:envelopeExpireTime=) }
+  it { should respond_to(:status)              }
+  it { should respond_to(:status=)             }
+
+  it { should have_alias(:creation_date_time, :creationDateTime)       }
+  it { should have_alias(:creation_date_time=, :creationDateTime=)     }
+  it { should have_alias(:status_date_time, :statusDateTime)           }
+  it { should have_alias(:status_date_time=, :statusDateTime=)         }
+  it { should have_alias(:envelope_expire_time, :envelopeExpireTime)   }
+  it { should have_alias(:envelope_expire_time=, :envelopeExpireTime=) }
+
+  describe '#status' do
+    it 'converts status to human-readable format' do
+      subject.status = 1
+      subject.status.should == :in_progress
+    end
+  end
+
+  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
+
+  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) }
+    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.fill_field!('test', 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.fill_field!('test', 'Field', document, recipient) }.should raise_error(ArgumentError)
+    end
+
+    it 'raises error if document is not GroupDocs::Document object' do
+      -> { subject.fill_field!('test', field, 'Document', recipient) }.should raise_error(ArgumentError)
+    end
+
+    it 'raises error if recipient is not GroupDocs::Signature::Recipient object' do
+      -> { subject.fill_field!('test', field, document, 'Recipient') }.should raise_error(ArgumentError)
+    end
+
+    it 'returns filled field' do
+      subject.fill_field!('test', field, document, recipient).should be_a(GroupDocs::Signature::Field)
+    end
+
+    it 'uses signature identifier if field is :signature and GroupDocs::Signature is passed' do
+      api = stub(GroupDocs::Api::Request)
+      api.stub!(execute!: { field: {} })
+      GroupDocs::Api::Request.stub(new: api)
+      signature = GroupDocs::Signature.new(id: '123')
+      api.should_receive(:add_params).with(signatureId: '123')
+      field.field_type = :signature
+      subject.fill_field!(signature, field, document, recipient)
+    end
+
+    it 'converts boolean value to required string if field is :checkbox' do
+      api = stub(GroupDocs::Api::Request)
+      options = {}
+      api.stub!(execute!: { field: {} })
+      api.stub!(options: { request_body: nil })
+      GroupDocs::Api::Request.stub(new: api)
+      field.field_type = :checkbox
+      subject.fill_field!(true, field, document, recipient)
+      api.options[:request_body].should == 'on'
+    end
+  end
+
+  describe '#sign!' do
+    let(:recipient) { GroupDocs::Signature::Recipient.new }
+
+    before(:each) do
+      mock_api_server('{ "status": "Ok", "result": {}}')
+    end
+
+    it 'accepts access credentials hash' do
+      lambda do
+        subject.sign!(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.sign!('Recipient') }.should raise_error(ArgumentError)
+    end
+  end
+
+  describe '#decline!' do
+    let(:recipient) { GroupDocs::Signature::Recipient.new }
+
+    before(:each) do
+      mock_api_server('{ "status": "Ok", "result": {}}')
+    end
+
+    it 'accepts access credentials hash' do
+      lambda do
+        subject.decline!(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.decline!('Recipient') }.should raise_error(ArgumentError)
+    end
+  end
+
+  describe '#signed_documents!' do
+    before(:each) do
+      mock_api_server(File.read('spec/support/files/envelope.zip'))
+      subject.stub(name: 'envelope')
+    end
+
+    let(:path) { Dir.tmpdir }
+
+    it 'accepts access credentials hash' do
+      lambda do
+        subject.signed_documents!(path, client_id: 'client_id', private_key: 'private_key')
+      end.should_not raise_error(ArgumentError)
+    end
+
+    it 'downloads file to given path' do
+      file = stub('file')
+      Object::File.should_receive(:open).with("#{path}/#{subject.name}.zip", 'w').and_yield(file)
+      file.should_receive(:write).with(File.read('spec/support/files/envelope.zip'))
+      subject.signed_documents!(path)
+    end
+
+    it 'returns saved file path' do
+      subject.signed_documents!(path).should == "#{path}/#{subject.name}.zip"
+    end
+  end
+
+  describe '#logs!' do
+    before(:each) do
+      mock_api_server(load_json('envelope_logs'))
+    end
+
+    it 'accepts access credentials hash' do
+      lambda do
+        subject.logs!(client_id: 'client_id', private_key: 'private_key')
+      end.should_not raise_error(ArgumentError)
+    end
+
+    it 'returns array of GroupDocs::Signature::Envelope::Log objects' do
+      logs = subject.logs!
+      logs.should be_an(Array)
+      logs.each do |log|
+        log.should be_a(GroupDocs::Signature::Envelope::Log)
+      end
+    end
+  end
+
+  describe '#send!' do
+    before(:each) do
+      mock_api_server('{ "status": "Ok", "result": {}}')
+    end
+
+    it 'accepts access credentials hash' do
+      lambda do
+        subject.send!(client_id: 'client_id', private_key: 'private_key')
+      end.should_not raise_error(ArgumentError)
+    end
+  end
+
+  describe '#archive!' do
+    before(:each) do
+      mock_api_server('{ "status": "Ok", "result": {}}')
+    end
+
+    it 'accepts access credentials hash' do
+      lambda do
+        subject.archive!(client_id: 'client_id', private_key: 'private_key')
+      end.should_not raise_error(ArgumentError)
+    end
+  end
+
+  describe '#restart!' do
+    before(:each) do
+      mock_api_server('{ "status": "Ok", "result": {}}')
+    end
+
+    it 'accepts access credentials hash' do
+      lambda do
+        subject.restart!(client_id: 'client_id', private_key: 'private_key')
+      end.should_not raise_error(ArgumentError)
+    end
+  end
+end