PandaDoc

PandaDoc gem is a simple wrapper for PandaDoc.com API. Please check the official API documenation for more details.

Installation

Add this line to your application's Gemfile:

gem'panda_doc'

And then execute:

$ bundle

Or install it yourself as:

$ gem install panda_doc

Configuration

Both API-Key and oAuth2.0 access token authentications are supported.

PandaDoc.configuredo |config|
config.api_key="api key"end

PandaDoc.configuredo |config|
config.access_token="an access token"end

Usage

Every response wrapped into a ruby object with values coerced in corresponding types.

Creating a document

document=PandaDoc::Document.create(name: "Sample Document",url: "url_to_a_document",recipients: [{email: "john.appleseed@yourdomain.com",first_name: "John",last_name: "Appleseed",role: "Signer",default: false}],fields: {field_id: {title: "Field 1"}})document.uuid# => "oovHPtkwDqEAvaKmdud"document.name# => "Sample Document"document.status# => "uploaded"document.created_at# => #<DateTime: 2016-02-03T14:56:21-08:00>document.updated_at# => #<DateTime: 2016-02-03T14:56:21-08:00>

Creating a document from attached file (API)

file=UploadIO.new("/path/to/file.pdf","application/pdf")document=PandaDoc::Document.create(name: "Sample Document",file: file,recipients: [{email: "john.appleseed@yourdomain.com",first_name: "John",last_name: "Appleseed",role: "Signer",default: false}],fields: {field_id: {title: "Field 1"}})

Creating a document from a template (API)

document=PandaDoc::Document.create(name: "Sample Document",template_uuid: "uuid_of_the_template",recipients: [{email: "john.appleseed@yourdomain.com",first_name: "John",last_name: "Appleseed",role: "Signer",default: false}],tokens: [{name: "Token.Name",value: "Token Value"},{name: "Token.AnotherName",value: "2021"}],fields: {field_id: {value: "Field 1"}})

Getting a document status (API)

document=PandaDoc::Document.find("UUID")document.status# => "draft"document.updated_at# => <DateTime: 2016-02-03T17:41:00-08:00>

Getting a document details (API)

document=PandaDoc::Document.details("UUID")document.tokens=>[#<PandaDoc::Objects::Token name="Token.Name" value="Token Value">,#<PandaDoc::Objects::Token name="token.another_name" value="2021">]document.fields=>[#<PandaDoc::Objects::Field uuid="...>,#<PandaDoc::Objects::Field uuid="...>]

Sending a document (API)

PandaDoc::Document.send("UUID",message: "A message to include into the email")

Creating a View Session

session=PandaDoc::Document.session("UUID",recipient: "john.applessed@yourdoamin.com",lifetime: 300)session.id# => "adssdAvyDXBS"session.expires_at# => #<DateTime: 2016-02-03T14:56:21-08:00>

Downloading a document (API)

response=PandaDoc::Document.download("uuid")file=File.open("document.pdf","w")do |f|
response.bodyend

Listing document sections (API)

sections=PandaDoc::DocumentSection.list("document_uuid")sections.results.eachdo |section|
putssection.uuidputssection.nameputssection.statusend

Creating a document section (API)

section=PandaDoc::DocumentSection.create("document_uuid",name: "Section Name",file: file)section.uuid# => "section_uuid"section.name# => "Section Name"section.status# => "uploaded"

Deleting a document section (API)

PandaDoc::DocumentSection.delete("document_uuid","section_uuid")

Error handling

If an error occurs during an API request it will be wrapped into a plain ruby object as well.

beginPandaDoc::Document.create(name: "Sample Document")rescuePandaDoc::FailureResult=>eputse.detailputse.responseend

Debugging

You can configure a logger if you need to debug your requests/responses

require'logger'PandaDoc.configuredo |config|
config.logger=Logger.new(STDOUT)end

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/opti/panda_doc.

1. Fork it ( https://github.com/opti/panda_doc/fork )
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create a new Pull Request

License

The gem is available as open source under the terms of the MIT License.