signable

Signifiable

Le client signable fournit une interface Ruby simple à l'API Signable.

Installation

Ajoutez cette ligne au Gemfile de votre application :

 gem 'signable'

Et puis exécutez :

 $ bundle

Ou installez-le vous-même en tant que :

 $ gem install signable

Usage

Configuration

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

Récupérer un modèle

 Signable :: Template . find 'fingerprint'

Construire un document

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

Un document peut également contenir des merge_fields (voir la documentation signable)

Construisez une fête

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

L'identifiant du groupe peut être récupéré à partir du modèle

Créer une enveloppe

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

envelope . save 

Essai

La suite de tests est RSpec et utilise VCR pour tester les appels d'API.

Les cassettes VCR sont incluses dans ce référentiel afin que vous puissiez exécuter les spécifications sans accéder à l'API Signable comme ceci :

 bundle exec rspec

Si vous devez réenregistrer les interactions entre le code Ruby et l'API Signable, vous pouvez spécifier une clé API à utiliser pour les tests :

 SIGNABLE_API_KEY = 'valid_signable_api_key' bundle exec rspec

Si votre API n'est pas valide ou est manquante, vous verrez une erreur semblable à la suivante :

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

NOTE:

• Les enregistrements du magnétoscope ont une date d'expiration, vous pourriez donc être obligé de les réenregistrer même si vous n'avez apporté aucune modification.
• La suite de tests est destructrice, veuillez donc utiliser uniquement un compte de test Signable. Le compte nécessite une ressource Modèle pour que la suite de tests puisse s'exécuter.

Pour obtenir une clé API Signable valide, connectez-vous à votre compte Signable et accédez à Paramètres de l'entreprise → API et Webhooks et cliquez sur « Ajouter une clé API » pour générer une clé. Nous vous recommandons de supprimer la clé lorsque vous en avez terminé.

Contribuer

1. Forkez-le ( http://github.com//signable/fork )
2. Créez votre branche de fonctionnalités ( git checkout -b my-new-feature )
3. Validez vos modifications ( git commit -am 'Add some feature' )
4. Pousser vers la branche ( git push origin my-new-feature )
5. Créer une nouvelle demande de tirage