class DocusignApi

Public Class Methods

new( opts = {} ) click to toggle source

# File lib/docusign_api.rb, line 2
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

Public Instance Methods

delete( path, body = nil ) click to toggle source

# File lib/docusign_api.rb, line 26
def delete( path, body = nil )
  perform( path, :delete, body: body )
end

get( path ) click to toggle source

# File lib/docusign_api.rb, line 14
def get( path )
  perform( path, :get)
end

post( path, body ) click to toggle source

# File lib/docusign_api.rb, line 18
def post( path, body )
  perform( path, :post, body: body )
end

put( path, body, opts = {} ) click to toggle source

# File lib/docusign_api.rb, line 22
def put( path, body, opts = {} )
  perform( path, :put, opts.merge(body: body) )
end

Private Instance Methods

auth_headers() click to toggle source

# File lib/docusign_api.rb, line 32
def auth_headers
  {
    'X-DocuSign-Authentication' => %{
      <DocuSignCredentials>
        <Username>#{@username}</Username>
        <Password>#{@password}</Password>
        <IntegratorKey>#{@integrator_key}</IntegratorKey>
      </DocuSignCredentials>
    }
  }
end

base_url() click to toggle source

# File lib/docusign_api.rb, line 73
def base_url
  if @proxy_host && @base_url
    @base_url.gsub(%r|[^/]+\.docusign\.net|, @proxy_host)
  else
    @base_url
  end
end

default_headers() click to toggle source

# File lib/docusign_api.rb, line 97
def default_headers
  {
    'Content-Type' => 'application/json',
    'Accept' => 'application/json'
  }.merge(auth_headers)
end

docusign_const(key) click to toggle source

# File lib/docusign_api.rb, line 44
def docusign_const(key)
  DOCUSIGN[key] if defined?(DOCUSIGN)
end

full_url( path ) click to toggle source

# File lib/docusign_api.rb, line 69
def full_url( path )
  defined?(@base_url) && @base_url ? File.join(base_url, path) : path
end

# File lib/docusign_api.rb, line 81
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

login_url() click to toggle source

# File lib/docusign_api.rb, line 89
def login_url
  if @proxy_host
    @login_url.gsub(%r|[^/]+\.docusign\.net|, @proxy_host)
  else
    @login_url
  end
end

perform( path, method, opts = {} ) click to toggle source

# File lib/docusign_api.rb, line 48
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