docusign_api 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4df1bf27cc287812b975f9a49d270e6b5eef34b7
+  data.tar.gz: 51c7aa4d33323198f5a395f7bc931a67e35471af
+SHA512:
+  metadata.gz: e9ff45481e64f365778e5122037b31da24ef48de241b16ec90a2b94cba3908cb9b42a4e646a19af8987507ab24e57ac073a0193ed5963cb791a171bf63e7ca30
+  data.tar.gz: dd70488419a4ddec308ff6af4563867d347a7ed16bf1293e306e086227dc51b06bd85552b8b9f2bd4580888c98b43464adb79c4565c75634a522e19dc48a0b66

data/.ruby-version

@@ -0,0 +1 @@
+2.3.0

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in docusign_api.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,54 @@
+PATH
+  remote: .
+  specs:
+    docusign_api (0.1.0)
+      capistrano (~> 3.1)
+      curb (< 0.9)
+      sshkit (~> 1.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.4.0)
+    airbrussh (1.0.1)
+      sshkit (>= 1.6.1, != 1.7.0)
+    capistrano (3.5.0)
+      airbrussh (>= 1.0.0)
+      capistrano-harrow
+      i18n
+      rake (>= 10.0.0)
+      sshkit (>= 1.9.0)
+    capistrano-harrow (0.3.2)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    curb (0.8.8)
+    hashdiff (0.3.0)
+    i18n (0.7.0)
+    metaclass (0.0.4)
+    minitest (5.8.4)
+    mocha (1.1.0)
+      metaclass (~> 0.0.1)
+    net-scp (1.2.1)
+      net-ssh (>= 2.6.5)
+    net-ssh (3.1.1)
+    rake (11.1.2)
+    safe_yaml (1.0.4)
+    sshkit (1.10.0)
+      net-scp (>= 1.1.2)
+      net-ssh (>= 2.8.0)
+    webmock (1.22.3)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  docusign_api!
+  minitest (~> 5.8)
+  mocha (~> 1.1)
+  webmock (= 1.22.3)
+
+BUNDLED WITH
+   1.11.2

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Open Listings, Buy a home without a realtor and get a
+50% commission refund
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,96 @@
+# docusign_api
+
+A simple ruby gem for using the DocuSign REST API with libcurl.
+
+## Usage
+Add to your Gemfile:
+
+```ruby
+gem 'docusign_api'
+```
+
+Initialize with your credentials, either inline or set a constant called `DOCUSIGN`
+
+```ruby
+  @api = DocusignApi.new username: 'username', password: 'password', integrator_key: 'abc1234', login_url: 'https://demo.docusign.net/restapi/v2/login_information'
+```
+
+Use the API, the DocusignApi instance will return a [curb](https://github.com/taf2/curb) response.
+
+The library will log you in when initialized and will prefix the pathname with the correct endpoint for your account determined by the login process.
+
+Examples:
+
+### GET
+Get a list of your account's templates
+```ruby
+  c = @api.get '/templates'
+
+  puts c.response_code
+  puts JSON::parse(c.body)
+```
+
+### POST
+Create an envelope from a template
+```ruby
+  h = {
+    emailSubject: email_subject,
+    status: 'created',
+    templateRoles: [],
+    compositeTemplates: [{
+      serverTemplates: [
+        {
+          sequence: '1',
+          templateId: template_id
+        }
+      ],
+      document: {
+        name: 'document name',
+        documentId: document_id,
+        documentBase64: Base64.encode64(File.read(pdf)),
+        documentFields: [
+          { name: 'field1', value: 'value1' },
+          { name: 'field2', value: 'value2' }
+        ]
+      }
+    }]
+  }
+
+  c = @api.post '/envelopes', h.to_json
+
+  puts c.response_code
+  puts JSON::parse(c.body)
+```
+
+### PUT
+Change envelope recipients
+```ruby
+  h = {
+    signers: { roleName: 'signer', email: 'test@test.com', name: 'Recipient Name', recipientId: '1' }
+  }
+  c = @api.put '/envelopes/123/recipients', h.to_json
+
+  puts c.response_code
+  puts JSON::parse(c.body)
+```
+
+### DELETE
+Delete envelope recipients
+```ruby
+  h = {
+    signers: [{ recipientId: '1' }]
+  }
+  c = @api.delete '/envelopes/123/recipients', h.to_json
+
+  puts c.response_code
+  puts JSON::parse(c.body)
+```
+
+## DocuSign REST API Docs
+https://www.docusign.com/p/RESTAPIGuide/RESTAPIGuide.htm
+
+## Source Code
+This project was created and is maintained by [Open Listings Engineering](https://www.openlistings.com) <engineering@openlistings.com>
+
+## Contributing
+Contributions are welcome via pull request.  Please write tests, thanks!

data/Rakefile

@@ -0,0 +1,8 @@
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+end
+
+desc "Run tests"
+task default: :test

data/docusign_api.gemspec

@@ -0,0 +1,23 @@
+Gem::Specification.new do |gem|
+  gem.name        = 'docusign_api'
+  gem.version     = '0.1.1'
+  gem.date        = '2016-04-25'
+  gem.summary     = "A ruby gem for using the DocuSign REST API with libcurl"
+  gem.description = "A ruby gem for using the DocuSign REST API with libcurl"
+  gem.authors     = ["Open Listings Engineering"]
+  gem.email       = 'engineering@openlistings.com'
+  gem.homepage    = 'https://github.com/openlistings/docusign_api'
+  gem.license     = 'MIT'
+
+  gem.files         = `git ls-files`.split($/)
+  gem.test_files    = gem.files.grep(%r{^(test)/})
+  gem.require_paths = ['lib']
+
+  gem.add_dependency 'capistrano', '~> 3.1'
+  gem.add_dependency 'sshkit', '~> 1.2'
+  gem.add_dependency 'curb', '< 0.9'
+
+  gem.add_development_dependency 'minitest', '~> 5.8'
+  gem.add_development_dependency 'mocha', '~> 1.1'
+  gem.add_development_dependency 'webmock', '1.22.3'
+end

data/lib/docusign_api.rb

@@ -0,0 +1,110 @@
+class DocusignApi
+  def initialize( opts = {} )
+    @username = opts[:username] || docusign_const(:username)
+    @password = opts[:password] || docusign_const(:password)
+    @integrator_key = opts[:integrator_key] || docusign_const(:integrator_key)
+    @login_url = opts[:login_url] || docusign_const(:login_url)
+
+    fail "please initialize with Docusign credentials: username, password, integrator_key" unless @username && @password && @integrator_key && @login_url
+
+    @proxy_host = opts[:proxy_host]
+    login
+  end
+
+  def get( path )
+    perform( path, :get)
+  end
+
+  def post( path, body )
+    perform( path, :post, body: body )
+  end
+
+  def put( path, body, opts = {} )
+    perform( path, :put, opts.merge(body: body) )
+  end
+
+  def delete( path, body = nil )
+    perform( path, :delete, body: body )
+  end
+
+private
+
+  def auth_headers
+    {
+      'X-DocuSign-Authentication' => %{
+        <DocuSignCredentials>
+          <Username>#{@username}</Username>
+          <Password>#{@password}</Password>
+          <IntegratorKey>#{@integrator_key}</IntegratorKey>
+        </DocuSignCredentials>
+      }
+    }
+  end
+
+  def docusign_const(key)
+    DOCUSIGN[key] if defined?(DOCUSIGN)
+  end
+
+  def perform( path, method, opts = {} )
+    fail DocusignApi::UnexpectedResponseBody, "body should be nil or a JSON string" if opts[:body] && !opts[:body].is_a?(String)
+    url = full_url(path)
+
+    c = Curl::Easy.new(url)
+    c.ssl_verify_peer = false if @proxy_host
+    c.headers = default_headers
+
+    case method
+    when :put, :delete
+      c.put_data = opts[:body]
+    when :post
+      c.multipart_form_post = !!opts[:multipart_form_post]
+      c.post_body = opts[:body]
+    end
+
+    c.http(method)
+
+    c
+  end
+
+  def full_url( path )
+    defined?(@base_url) && @base_url ? File.join(base_url, path) : path
+  end
+
+  def base_url
+    if @proxy_host && @base_url
+      @base_url.gsub(%r|[^/]+\.docusign\.net|, @proxy_host)
+    else
+      @base_url
+    end
+  end
+
+  def login
+    c = get(login_url)
+
+    fail DocusignApi::LoginFailed, "Login failed: #{[c.response_code, c.body].inspect}" unless 200 == c.response_code
+    login_response = JSON::parse(c.body)
+    @base_url = login_response['loginAccounts'][0]['baseUrl']
+  end
+
+  def login_url
+    if @proxy_host
+      @login_url.gsub(%r|[^/]+\.docusign\.net|, @proxy_host)
+    else
+      @login_url
+    end
+  end
+
+  def default_headers
+    {
+      'Content-Type' => 'application/json',
+      'Accept' => 'application/json'
+    }.merge(auth_headers)
+  end
+
+end
+
+class DocusignApi::LoginFailed < StandardError
+end
+
+class DocusignApi::UnexpectedResponseBody < StandardError
+end

data/test/data/login_information.json

@@ -0,0 +1,12 @@
+{
+	"loginAccounts": [{
+		"name": "Docusign API User",
+		"accountId": "1234567",
+		"baseUrl": "https://demo.docusign.net/restapi/v2/accounts/1234567",
+		"isDefault": "true",
+		"userName": "Docusign User",
+		"userId": "111111ee-41fd-4331-975e-123e51234eff",
+		"email": "nobody@e.e",
+		"siteDescription": ""
+	}]
+}

data/test/test_docusign_api.rb

@@ -0,0 +1,51 @@
+require 'test_helper'
+
+require 'docusign_api'
+
+class DocusignApiTest < Minitest::Test
+  def setup
+    stub_docusign_login
+    @api = DocusignApi.new username: 'username', password: 'password', integrator_key: '12345', login_url: 'https://demo.docusign.net/restapi/v2/login_information'
+  end
+
+  def test_get
+    url = File.join(DOCUSIGN_ACCOUNT_BASE_URL, 'templates')
+    @req = stub_request(:get, url).
+      with(headers: DOCUSIGN_DEFAULT_HEADERS).
+      to_return( status: 200, body: '{}' )
+
+    @api.get '/templates'
+    assert_requested @req
+  end
+
+  def test_post
+    url = File.join(DOCUSIGN_ACCOUNT_BASE_URL, 'templates')
+    @req = stub_request(:post, url).
+      with(headers: DOCUSIGN_DEFAULT_HEADERS, body: '{}').
+      to_return( status: 200, body: '{}' )
+
+    @api.post '/templates', '{}'
+    assert_requested @req
+  end
+
+  def test_put
+    url = File.join(DOCUSIGN_ACCOUNT_BASE_URL, 'templates')
+    @req = stub_request(:put, url).
+    with(headers: DOCUSIGN_DEFAULT_HEADERS, body: '{}').
+    to_return( status: 200, body: '{}' )
+
+    @api.put '/templates', '{}'
+    assert_requested @req
+  end
+
+  def test_delete
+    url = File.join(DOCUSIGN_ACCOUNT_BASE_URL, 'templates')
+    @req = stub_request(:delete, url).
+      with(headers: DOCUSIGN_DEFAULT_HEADERS).
+      to_return( status: 200, body: '{}' )
+
+    @api.delete '/templates', '{}'
+    assert_requested @req
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,21 @@
+require 'minitest/autorun'
+require 'mocha/mini_test'
+
+require 'webmock'
+require 'webmock/minitest'
+include WebMock::API
+
+DOCUSIGN_ACCOUNT_BASE_URL = 'https://demo.docusign.net/restapi/v2/accounts/1234567'.freeze
+DOCUSIGN_LOGIN_URL = 'https://demo.docusign.net/restapi/v2/login_information'.freeze
+DOCUSIGN_DEFAULT_HEADERS = {
+  'Accept'=>'application/json',
+  'Content-Type'=>'application/json',
+  'X-Docusign-Authentication' => \
+    %r|<DocuSignCredentials>.*<Username>.+</Username>.*<Password>.+</Password>.*<IntegratorKey>.+</IntegratorKey>.*</DocuSignCredentials>|m
+}.freeze
+
+def stub_docusign_login
+  stub_request(:get, DOCUSIGN_LOGIN_URL).
+    with(headers: DOCUSIGN_DEFAULT_HEADERS).
+    to_return(status: 200, body: File.read('test/data/login_information.json'))
+end

metadata

@@ -0,0 +1,141 @@
+--- !ruby/object:Gem::Specification
+name: docusign_api
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Open Listings Engineering
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-04-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: capistrano
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: sshkit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: curb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.8'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.22.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.22.3
+description: A ruby gem for using the DocuSign REST API with libcurl
+email: engineering@openlistings.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".ruby-version"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- docusign_api.gemspec
+- lib/docusign_api.rb
+- test/data/login_information.json
+- test/test_docusign_api.rb
+- test/test_helper.rb
+homepage: https://github.com/openlistings/docusign_api
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: A ruby gem for using the DocuSign REST API with libcurl
+test_files:
+- test/data/login_information.json
+- test/test_docusign_api.rb
+- test/test_helper.rb