signable

Assinável

O cliente assinável fornece uma interface Ruby simples para a API Signable.

Instalação

Adicione esta linha ao Gemfile da sua aplicação:

 gem 'signable'

E então execute:

 $ bundle

Ou instale você mesmo como:

 $ gem install signable

Uso

Configuração

 Signable . configure do | config |
  config . base_url = ENV . fetch ( 'SIGNABLE_BASE_URL' )
  config . api_key  = ENV . fetch ( 'SIGNABLE_API_KEY' )
end

Recuperar um modelo

 Signable :: Template . find 'fingerprint'

Crie um documento

 Signable :: Document . new ( template_fingerprint : fingerprint , title : title )

Um documento também pode conter merge_fields (ver documentação assinável)

Construa uma festa

 Signable :: Party . new ( id : id , name : 'name' , email : 'email' )

O ID da festa pode ser recuperado do modelo

Crie um envelope

 envelope = Signable :: Envelope . new title : 'title' , redirect_url : 'https://www.autoenrolment.co.uk'
envelope . documents = documents
envelope . parties = parties

envelope . save 

Teste

O conjunto de testes é RSpec e usa VCR para testar chamadas de API.

As fitas do videocassete estão incluídas neste repositório para que você possa executar as especificações sem acessar a API Signable da seguinte forma:

 bundle exec rspec

Se precisar regravar as interações entre o código Ruby e a API Signable, você pode especificar uma chave de API para os testes usarem da seguinte forma:

 SIGNABLE_API_KEY = 'valid_signable_api_key' bundle exec rspec

Se você tiver uma API inválida ou ausente, verá um erro como este:

 Authentication failed . Either the API Key or password was blank .

OBSERVAÇÃO:

• As gravações do videocassete têm um prazo de validade, então você pode ser forçado a regravá-las mesmo que não tenha feito nenhuma alteração.
• O conjunto de testes é destrutivo, portanto, use apenas uma conta de teste Signable. A conta requer um recurso de modelo para que o conjunto de testes seja executado.

Para obter uma chave de API Signable válida, faça login em sua conta Signable e navegue até Configurações da empresa → Api e Webhooks e clique em "Adicionar chave de API" para gerar uma chave. Recomendamos que você exclua a chave quando terminar.

Contribuindo

1. Bifurque ( http://github.com//signable/fork )
2. Crie sua ramificação de recursos ( git checkout -b my-new-feature )
3. Confirme suas alterações ( git commit -am 'Add some feature' )
4. Empurre para o branch ( git push origin my-new-feature )
5. Criar nova solicitação pull