groupdocs 0.3.11 → 1.0.0

data/spec/groupdocs/signature/field/location_spec.rb

@@ -0,0 +1,73 @@
+require 'spec_helper'
+
+describe GroupDocs::Signature::Field::Location do
+
+  it_behaves_like GroupDocs::Api::Entity
+
+  it { should respond_to(:id)              }
+  it { should respond_to(:id=)             }
+  it { should respond_to(:documentId)      }
+  it { should respond_to(:documentId=)     }
+  it { should respond_to(:fieldId)         }
+  it { should respond_to(:fieldId=)        }
+  it { should respond_to(:page)            }
+  it { should respond_to(:page=)           }
+  it { should respond_to(:locationX)       }
+  it { should respond_to(:locationX=)      }
+  it { should respond_to(:locationY)       }
+  it { should respond_to(:locationY=)      }
+  it { should respond_to(:locationWidth)   }
+  it { should respond_to(:locationWidth=)  }
+  it { should respond_to(:locationHeight)  }
+  it { should respond_to(:locationHeight=) }
+  it { should respond_to(:fontName)        }
+  it { should respond_to(:fontName=)       }
+  it { should respond_to(:fontColor)       }
+  it { should respond_to(:fontColor=)      }
+  it { should respond_to(:fontSize)        }
+  it { should respond_to(:fontSize=)       }
+  it { should respond_to(:fontBold)        }
+  it { should respond_to(:fontBold=)       }
+  it { should respond_to(:fontItalic)      }
+  it { should respond_to(:fontItalic=)     }
+  it { should respond_to(:fontUnderline)   }
+  it { should respond_to(:fontUnderline=)  }
+
+  it { should have_alias(:document_id,      :documentId)      }
+  it { should have_alias(:document_id=,     :documentId=)     }
+  it { should have_alias(:field_id,         :fieldId)         }
+  it { should have_alias(:field_id=,        :fieldId=)        }
+  it { should have_alias(:location_x,       :locationX)       }
+  it { should have_alias(:location_x=,      :locationX=)      }
+  it { should have_alias(:x,                :locationX)       }
+  it { should have_alias(:x=,               :locationX=)      }
+  it { should have_alias(:location_y,       :locationY)       }
+  it { should have_alias(:location_y=,      :locationY=)      }
+  it { should have_alias(:y,                :locationY)       }
+  it { should have_alias(:y=,               :locationY=)      }
+  it { should have_alias(:location_w,       :locationWidth)   }
+  it { should have_alias(:location_w=,      :locationWidth=)  }
+  it { should have_alias(:location_width,   :locationWidth)   }
+  it { should have_alias(:location_width=,  :locationWidth=)  }
+  it { should have_alias(:w,                :locationWidth)   }
+  it { should have_alias(:w=,               :locationWidth=)  }
+  it { should have_alias(:location_h,       :locationHeight)  }
+  it { should have_alias(:location_h=,      :locationHeight=) }
+  it { should have_alias(:location_height,  :locationHeight)  }
+  it { should have_alias(:location_height=, :locationHeight=) }
+  it { should have_alias(:h,                :locationHeight)  }
+  it { should have_alias(:h=,               :locationHeight=) }
+  it { should have_alias(:font_name,        :fontName)        }
+  it { should have_alias(:font_name=,       :fontName=)       }
+  it { should have_alias(:font_color,       :fontColor)       }
+  it { should have_alias(:font_color=,      :fontColor=)      }
+  it { should have_alias(:font_size,        :fontSize)        }
+  it { should have_alias(:font_size=,       :fontSize=)       }
+  it { should have_alias(:font_bold,        :fontBold)        }
+  it { should have_alias(:font_bold=,       :fontBold=)       }
+  it { should have_alias(:font_italic,      :fontItalic)      }
+  it { should have_alias(:font_italic=,     :fontItalic=)     }
+  it { should have_alias(:font_underline,   :fontUnderline)   }
+  it { should have_alias(:font_underline=,  :fontUnderline=)  }
+
+end

data/spec/groupdocs/signature/field_spec.rb

@@ -0,0 +1,264 @@
+require 'spec_helper'
+
+describe GroupDocs::Signature::Field do
+
+  it_behaves_like GroupDocs::Api::Entity
+
+  describe '.get!' do
+    before(:each) do
+      mock_api_server(load_json('signature_fields_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::Field objects' do
+      fields = described_class.get!
+      fields.should be_an(Array)
+      fields.each do |field|
+        field.should be_a(GroupDocs::Signature::Field)
+      end
+    end
+  end
+
+  it { should respond_to(:id)                 }
+  it { should respond_to(:id=)                }
+  it { should respond_to(:templateId)         }
+  it { should respond_to(:templateId=)        }
+  it { should respond_to(:recipientId)        }
+  it { should respond_to(:recipientId=)       }
+  it { should respond_to(:signatureFieldId)   }
+  it { should respond_to(:signatureFieldId=)  }
+  it { should respond_to(:graphSizeW)         }
+  it { should respond_to(:graphSizeW=)        }
+  it { should respond_to(:graphSizeW)         }
+  it { should respond_to(:graphSizeW=)        }
+  it { should respond_to(:graphSizeH)         }
+  it { should respond_to(:graphSizeH=)        }
+  it { should respond_to(:graphSizeH)         }
+  it { should respond_to(:graphSizeH=)        }
+  it { should respond_to(:getDataFrom)        }
+  it { should respond_to(:getDataFrom=)       }
+  it { should respond_to(:regularExpression)  }
+  it { should respond_to(:regularExpression=) }
+  it { should respond_to(:fontName)           }
+  it { should respond_to(:fontName=)          }
+  it { should respond_to(:fontColor)          }
+  it { should respond_to(:fontColor=)         }
+  it { should respond_to(:fontSize)           }
+  it { should respond_to(:fontSize=)          }
+  it { should respond_to(:fontBold)           }
+  it { should respond_to(:fontBold=)          }
+  it { should respond_to(:fontItalic)         }
+  it { should respond_to(:fontItalic=)        }
+  it { should respond_to(:fontUnderline)      }
+  it { should respond_to(:fontUnderline=)     }
+  it { should respond_to(:isSystem)           }
+  it { should respond_to(:isSystem=)          }
+  it { should respond_to(:fieldType)          }
+  it { should respond_to(:fieldType=)         }
+  it { should respond_to(:acceptableValues)   }
+  it { should respond_to(:acceptableValues=)  }
+  it { should respond_to(:defaultValue)       }
+  it { should respond_to(:defaultValue=)      }
+  it { should respond_to(:tooltip)            }
+  it { should respond_to(:tooltip=)           }
+  it { should respond_to(:input)              }
+  it { should respond_to(:input=)             }
+  it { should respond_to(:order)              }
+  it { should respond_to(:order=)             }
+  it { should respond_to(:textRows)           }
+  it { should respond_to(:textRows=)          }
+  it { should respond_to(:textColumns)        }
+  it { should respond_to(:textColumns=)       }
+  it { should respond_to(:location)           }
+  it { should respond_to(:location=)          }
+  it { should respond_to(:locations)          }
+  it { should respond_to(:locations=)         }
+
+  it { should have_alias(:template_id,         :templateId)         }
+  it { should have_alias(:template_id=,        :templateId=)        }
+  it { should have_alias(:recipient_id,        :recipientId)        }
+  it { should have_alias(:recipient_id=,       :recipientId=)       }
+  it { should have_alias(:signature_field_id,  :signatureFieldId)   }
+  it { should have_alias(:signature_field_id=, :signatureFieldId=)  }
+  it { should have_alias(:graph_size_w,        :graphSizeW)         }
+  it { should have_alias(:graph_size_w=,       :graphSizeW=)        }
+  it { should have_alias(:graph_size_width,    :graphSizeW)         }
+  it { should have_alias(:graph_size_width=,   :graphSizeW=)        }
+  it { should have_alias(:graph_size_h,        :graphSizeH)         }
+  it { should have_alias(:graph_size_h=,       :graphSizeH=)        }
+  it { should have_alias(:graph_size_height,   :graphSizeH)         }
+  it { should have_alias(:graph_size_height=,  :graphSizeH=)        }
+  it { should have_alias(:get_data_from,       :getDataFrom)        }
+  it { should have_alias(:get_data_from=,      :getDataFrom=)       }
+  it { should have_alias(:regular_expression,  :regularExpression)  }
+  it { should have_alias(:regular_expression=, :regularExpression=) }
+  it { should have_alias(:font_name,           :fontName)           }
+  it { should have_alias(:font_name=,          :fontName=)          }
+  it { should have_alias(:font_color,          :fontColor)          }
+  it { should have_alias(:font_color=,         :fontColor=)         }
+  it { should have_alias(:font_size,           :fontSize)           }
+  it { should have_alias(:font_size=,          :fontSize=)          }
+  it { should have_alias(:font_bold,           :fontBold)           }
+  it { should have_alias(:font_bold=,          :fontBold=)          }
+  it { should have_alias(:font_italic,         :fontItalic)         }
+  it { should have_alias(:font_italic=,        :fontItalic=)        }
+  it { should have_alias(:font_underline,      :fontUnderline)      }
+  it { should have_alias(:font_underline=,     :fontUnderline=)     }
+  it { should have_alias(:is_system,           :isSystem)           }
+  it { should have_alias(:is_system=,          :isSystem=)          }
+  it { should have_alias(:acceptable_values,   :acceptableValues)   }
+  it { should have_alias(:acceptable_values=,  :acceptableValues=)  }
+  it { should have_alias(:default_value,       :defaultValue)       }
+  it { should have_alias(:default_value=,      :defaultValue=)      }
+  it { should have_alias(:text_rows,           :textRows)           }
+  it { should have_alias(:text_rows=,          :textRows=)          }
+  it { should have_alias(:text_columns,        :textColumns)        }
+  it { should have_alias(:text_columns=,       :textColumns=)       }
+
+  describe '#location=' do
+    it 'converts location to GroupDocs::Signature::Field::Location object if hash is passed' do
+      subject.location = { id: 'location1' }
+      subject.location.should be_a(GroupDocs::Signature::Field::Location)
+    end
+
+    it 'saves each location if it is GroupDocs::Signature::Field::Location object' do
+      location = GroupDocs::Signature::Field::Location.new(id: 'location')
+      subject.location = location
+      subject.location.should == location
+    end
+
+    it 'appends location to locations if it is not empty' do
+      location1 = GroupDocs::Signature::Field::Location.new(id: 'location1')
+      location2 = GroupDocs::Signature::Field::Location.new(id: 'location2')
+      subject.locations = [location1]
+      subject.location = location2
+      subject.locations.should == [location1, location2]
+    end
+
+    it 'creates locations if it is empty' do
+      subject.locations = nil
+      location = GroupDocs::Signature::Field::Location.new(id: 'location')
+      subject.location = location
+      subject.locations.should == [location]
+    end
+
+    it 'does nothing if nil is passed' do
+      lambda do
+        subject.location = nil
+      end.should_not change(subject, :location)
+    end
+  end
+
+  describe '#locations=' do
+    it 'converts each location to GroupDocs::Signature::Field::Location object if hash is passed' do
+      subject.locations = [{ id: 'location1' }]
+      locations = subject.locations
+      locations.should be_an(Array)
+      locations.each do |location|
+        location.should be_a(GroupDocs::Signature::Field::Location)
+      end
+    end
+
+    it 'saves each location if it is GroupDocs::Signature::Field::Location object' do
+      location1 = GroupDocs::Signature::Field::Location.new(id: 'location1')
+      location2 = GroupDocs::Signature::Field::Location.new(id: 'location2')
+      subject.locations = [location1, location2]
+      subject.locations.should include(location1)
+      subject.locations.should include(location2)
+    end
+
+    it 'does nothing if nil is passed' do
+      lambda do
+        subject.locations = nil
+      end.should_not change(subject, :locations)
+    end
+  end
+
+  describe '#field_type=' do
+    it 'converts field type in machine-readable format if symbol is passed' do
+      subject.field_type = :multiline
+      subject.instance_variable_get(:@fieldType).should == 3
+    end
+
+    it 'saves field type as is if not a symbol is passed' do
+      subject.field_type = 3
+      subject.instance_variable_get(:@fieldType).should == 3
+    end
+
+    it 'is aliased to #type=' do
+      subject.should have_alias(:type=, :field_type=)
+    end
+  end
+
+  describe '#field_type' do
+    it 'returns field type in human-readable format' do
+      subject.field_type = :multiline
+      subject.field_type.should == :multiline
+    end
+
+    it 'is aliased to #type' do
+      subject.should have_alias(:type, :field_type)
+    end
+  end
+
+  describe '#create!' do
+    before(:each) do
+      mock_api_server(load_json('signature_field_add'))
+    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 'uses hashed version of self as request body' do
+      subject.should_receive(:to_hash)
+      subject.create!
+    end
+
+    it 'updates identifier of field' do
+      lambda do
+        subject.create!
+      end.should change(subject, :id)
+    end
+  end
+
+  describe '#modify!' do
+    before(:each) do
+      mock_api_server(load_json('signature_field_add'))
+    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 '#delete!' do
+    before(:each) do
+      mock_api_server('{ "status": "Ok", "result": { "field": 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/form_spec.rb

@@ -0,0 +1,174 @@
+require 'spec_helper'
+
+describe GroupDocs::Signature::Form do
+
+  it_behaves_like GroupDocs::Api::Entity
+  include_examples GroupDocs::Signature::EntityMethods
+  include_examples GroupDocs::Signature::ResourceMethods
+
+  describe '.all!' do
+    before(:each) do
+      mock_api_server(load_json('forms_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::Form objects' do
+      forms = described_class.all!
+      forms.should be_an(Array)
+      forms.each do |form|
+        form.should be_a(GroupDocs::Signature::Form)
+      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(:ownerGuid)                   }
+  it { should respond_to(:ownerGuid=)                  }
+  it { should respond_to(:templateGuid)                }
+  it { should respond_to(:templateGuid=)               }
+  it { should respond_to(:createdTimeStamp)            }
+  it { should respond_to(:createdTimeStamp=)           }
+  it { should respond_to(:statusDateTime)              }
+  it { should respond_to(:statusDateTime=)             }
+  it { should respond_to(:documentsCount)              }
+  it { should respond_to(:documentsCount=)             }
+  it { should respond_to(:documentsPages)              }
+  it { should respond_to(:documentsPages=)             }
+  it { should respond_to(:participantsCount)           }
+  it { should respond_to(:participantsCount=)          }
+  it { should respond_to(:fieldsInFinalFileName)       }
+  it { should respond_to(:fieldsInFinalFileName=)      }
+  it { should respond_to(:canParticipantDownloadForm)  }
+  it { should respond_to(:canParticipantDownloadForm=) }
+  it { should respond_to(:status)                      }
+  it { should respond_to(:status=)                     }
+
+  it { should have_alias(:owner_guid, :ownerGuid)                                       }
+  it { should have_alias(:owner_guid=, :ownerGuid=)                                     }
+  it { should have_alias(:template_guid, :templateGuid)                                 }
+  it { should have_alias(:template_guid=, :templateGuid=)                               }
+  it { should have_alias(:created_time_stamp, :createdTimeStamp)                        }
+  it { should have_alias(:created_time_stamp=, :createdTimeStamp=)                      }
+  it { should have_alias(:status_date_time, :statusDateTime)                            }
+  it { should have_alias(:status_date_time=, :statusDateTime=)                          }
+  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=)                           }
+  it { should have_alias(:participants_count, :participantsCount)                       }
+  it { should have_alias(:participants_count=, :participantsCount=)                     }
+  it { should have_alias(:fields_in_final_file_name, :fieldsInFinalFileName)            }
+  it { should have_alias(:fields_in_final_file_name=, :fieldsInFinalFileName=)          }
+  it { should have_alias(:can_participant_download_form, :canParticipantDownloadForm)   }
+  it { should have_alias(:can_participant_download_form=, :canParticipantDownloadForm=) }
+
+  describe '#status' do
+    it 'converts status to human-readable format' do
+      subject.status = 1
+      subject.status.should == :in_progress
+    end
+  end
+
+  describe '#create!' do
+    let(:template) { GroupDocs::Signature::Template.new }
+
+    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')
+      end.should_not raise_error(ArgumentError)
+    end
+
+    it 'accepts options hash' do
+      lambda do
+        subject.create!(template, 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)
+    end
+
+    it 'updates identifier of entity' do
+      lambda do
+        subject.create!(template)
+      end.should change(subject, :id)
+    end
+
+    it 'raises error if template is not GroupDocs::Signature::Template object' do
+      -> { subject.create!('Template') }.should raise_error(ArgumentError)
+    end
+  end
+
+  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 '#publish!' do
+    before(:each) do
+      mock_api_server('{ "status": "Ok", "result": {}}')
+    end
+
+    it 'accepts access credentials hash' do
+      lambda do
+        subject.publish!(client_id: 'client_id', private_key: 'private_key')
+      end.should_not raise_error(ArgumentError)
+    end
+  end
+
+  describe '#complete!' do
+    before(:each) do
+      mock_api_server('{ "status": "Ok", "result": {}}')
+    end
+
+    it 'accepts access credentials hash' do
+      lambda do
+        subject.complete!(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
+end