docusign 0.5.0

data/lib/docusign.rb

@@ -0,0 +1,40 @@
+# Copyright (C) DocuSign, Inc.  All rights reserved.
+# 
+# This source code is intended only as a supplement to DocuSign SDK 
+# and/or on-line documentation.
+# 
+# This sample is designed to demonstrate DocuSign features and is not intended 
+# for production use. Code and policy for a production application must be 
+# developed to meet the specific data and security requirements of the 
+# application.
+# 
+# THIS CODE AND INFORMATION ARE PROVIDED "AS IS" WITHOUT WARRANTY OF ANY
+# KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND/OR FITNESS FOR A
+# PARTICULAR PURPOSE.
+		 
+$LOAD_PATH << File.expand_path(File.dirname(__FILE__))
+ 
+gem 'soap4r'
+require 'active_support'
+
+require 'docusign/utilities'
+
+require 'docusign/docusign'
+require 'docusign/docusignMappingRegistry'
+require 'docusign/docusignDriver'
+require 'docusign/base'
+require 'docusign/auth_header_handler'
+require 'docusign/credential'
+require 'docusign/credentialDriver'
+require 'docusign/credentialMappingRegistry'
+
+require 'docusign/document'
+require 'docusign/tab'
+require 'docusign/anchor_tab'
+
+require 'docusign/builder/base'
+require 'docusign/builder/tab_builder'
+require 'docusign/builder/anchor_builder'
+
+require 'docusign/extensions'

data/lib/docusign/anchor_tab.rb

@@ -0,0 +1,5 @@
+module Docusign
+  class AnchorTab
+    alias_attribute :string, :anchorTabString
+  end
+end

data/lib/docusign/auth_header_handler.rb

@@ -0,0 +1,36 @@
+# Copyright (C) DocuSign, Inc.  All rights reserved.
+# 
+# This source code is intended only as a supplement to DocuSign SDK 
+# and/or on-line documentation.
+# 
+# This sample is designed to demonstrate DocuSign features and is not intended 
+# for production use. Code and policy for a production application must be 
+# developed to meet the specific data and security requirements of the 
+# application.
+# 
+# THIS CODE AND INFORMATION ARE PROVIDED "AS IS" WITHOUT WARRANTY OF ANY
+# KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND/OR FITNESS FOR A
+# PARTICULAR PURPOSE.
+
+require 'soap/header/simplehandler'
+
+module Docusign
+  class AuthHeaderHandler < SOAP::Header::SimpleHandler
+    NAMESPACE = 'http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd'
+    
+    attr_accessor :attributes
+
+    def initialize(options={})
+      self.attributes = options
+      
+      super(XSD::QName.new(NAMESPACE, 'Security'))
+    end
+
+    def on_simple_outbound
+      if attributes[:user_name] && attributes[:password]
+        {"UsernameToken" => {"Username" => attributes[:user_name], "Password" => attributes[:password]}}
+      end
+    end
+  end
+end

data/lib/docusign/base.rb

@@ -0,0 +1,46 @@
+# Copyright (C) DocuSign, Inc.  All rights reserved.
+# 
+# This source code is intended only as a supplement to DocuSign SDK 
+# and/or on-line documentation.
+# 
+# This sample is designed to demonstrate DocuSign features and is not intended 
+# for production use. Code and policy for a production application must be 
+# developed to meet the specific data and security requirements of the 
+# application.
+# 
+# THIS CODE AND INFORMATION ARE PROVIDED "AS IS" WITHOUT WARRANTY OF ANY
+# KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND/OR FITNESS FOR A
+# PARTICULAR PURPOSE.
+
+module Docusign
+  class Base
+    
+    class << self    
+      def login(options={})
+        
+        connection  = Docusign::APIServiceSoap.new
+        header = AuthHeaderHandler.new(
+          :user_name => options.delete(:user_name), 
+          :password  => options.delete(:password)
+        )
+        
+        connection.headerhandler << header
+        
+        options.each do |key, value|
+          connection.send("#{key}=", value)
+        end
+        
+        connection
+      end
+      
+      def credentials(email, password, endpoint_url=nil)
+        
+        connection = Docusign::Credential::CredentialSoap.new
+        connection.endpoint_url = endpoint_url if endpoint_url
+        
+        connection.login(:email => email, :password => password).loginResult        
+      end
+    end
+  end
+end

data/lib/docusign/builder/anchor_builder.rb

@@ -0,0 +1,7 @@
+module Docusign
+  module Builder
+    class AnchorBuilder < Docusign::Builder::Base      
+      self.builder_class = Docusign::AnchorTab
+    end
+  end
+end

data/lib/docusign/builder/base.rb

@@ -0,0 +1,27 @@
+module Docusign
+  module Builder
+    class Base
+      class << self
+        attr_accessor :builder_class
+      end
+      
+      attr_accessor :object
+      
+      def initialize(*args, &block); end
+      
+      def build(options = {}, &block)
+        returning self.object = builder_class.new do |o|
+          options.each do |key, value|
+            o.send "#{key}=", value
+          end
+
+          yield o if block_given?
+        end
+      end
+      
+      def builder_class
+        self.class.builder_class
+      end
+    end
+  end
+end

data/lib/docusign/builder/tab_builder.rb

@@ -0,0 +1,26 @@
+require 'docusign'
+
+module Docusign
+  module Builder
+    class TabBuilder < Docusign::Builder::Base
+      attr_accessor :document, :recipient
+      
+      self.builder_class = Docusign::Tab
+
+      def initialize(document = nil, recipient = nil)
+        super
+        self.document, self.recipient = document, recipient
+      end
+
+      def build(options = {}, &block)
+        anchor_options = options.delete(:anchor)
+        
+        returning super(options, &block) do |tab|
+          tab.anchor anchor_options if anchor_options && !tab.anchor_tab_item
+          tab.document_id  ||= document.id  if document
+          tab.recipient_id ||= recipient.id if recipient
+        end
+      end
+    end
+  end
+end

data/lib/docusign/credential.rb

@@ -0,0 +1,136 @@
+require 'xsd/qname'
+
+module Docusign; module Credential
+
+
+# {http://www.docusign.net/API/Credential}ArrayOfAccount
+class ArrayOfAccount < ::Array
+
+  # {http://www.docusign.net/API/Credential}Account
+  #   accountID - SOAP::SOAPString
+  #   accountName - SOAP::SOAPString
+  #   userID - SOAP::SOAPString
+  #   userName - SOAP::SOAPString
+  #   email - SOAP::SOAPString
+  class Account
+    attr_accessor :accountID
+    attr_accessor :accountName
+    attr_accessor :userID
+    attr_accessor :userName
+    attr_accessor :email
+
+    def initialize(accountID = nil, accountName = nil, userID = nil, userName = nil, email = nil)
+      @accountID = accountID
+      @accountName = accountName
+      @userID = userID
+      @userName = userName
+      @email = email
+    end
+  end
+end
+
+# {http://www.docusign.net/API/Credential}ErrorCode
+class ErrorCode < ::String
+  Account_Lacks_Permissions = ErrorCode.new("Account_Lacks_Permissions")
+  Success = ErrorCode.new("Success")
+  Unspecified_Error = ErrorCode.new("Unspecified_Error")
+  User_Authentication_Failed = ErrorCode.new("User_Authentication_Failed")
+  User_Does_Not_Exist_In_System = ErrorCode.new("User_Does_Not_Exist_In_System")
+  User_Lacks_Permissions = ErrorCode.new("User_Lacks_Permissions")
+end
+
+# {http://www.docusign.net/API/Credential}Ping
+class Ping
+  def initialize
+  end
+end
+
+# {http://www.docusign.net/API/Credential}PingResponse
+#   pingResult - SOAP::SOAPBoolean
+class PingResponse
+  attr_accessor :pingResult
+
+  def initialize(pingResult = nil)
+    @pingResult = pingResult
+  end
+end
+
+# {http://www.docusign.net/API/Credential}Login
+#   email - SOAP::SOAPString
+#   password - SOAP::SOAPString
+class Login
+  attr_accessor :email
+  attr_accessor :password
+
+  def initialize(email = nil, password = nil)
+    @email = email
+    @password = password
+  end
+end
+
+# {http://www.docusign.net/API/Credential}LoginResponse
+#   loginResult - Docusign::Credential::LoginResponse::LoginResult
+class LoginResponse
+
+  # inner class for member: LoginResult
+  # {http://www.docusign.net/API/Credential}LoginResult
+  #   success - SOAP::SOAPBoolean
+  #   errorCode - Docusign::Credential::ErrorCode
+  #   authenticationMessage - SOAP::SOAPString
+  #   accounts - Docusign::Credential::ArrayOfAccount
+  class LoginResult
+    attr_accessor :success
+    attr_accessor :errorCode
+    attr_accessor :authenticationMessage
+    attr_accessor :accounts
+
+    def initialize(success = nil, errorCode = nil, authenticationMessage = nil, accounts = nil)
+      @success = success
+      @errorCode = errorCode
+      @authenticationMessage = authenticationMessage
+      @accounts = accounts
+    end
+    
+    def success?
+      @success
+    end
+  end
+
+  attr_accessor :loginResult
+
+  def initialize(loginResult = nil)
+    @loginResult = loginResult
+  end
+end
+
+# {http://www.docusign.net/API/Credential}GetAuthenticationToken
+#   email - SOAP::SOAPString
+#   password - SOAP::SOAPString
+#   accountID - SOAP::SOAPString
+#   goToEnvelopeID - SOAP::SOAPString
+class GetAuthenticationToken
+  attr_accessor :email
+  attr_accessor :password
+  attr_accessor :accountID
+  attr_accessor :goToEnvelopeID
+
+  def initialize(email = nil, password = nil, accountID = nil, goToEnvelopeID = nil)
+    @email = email
+    @password = password
+    @accountID = accountID
+    @goToEnvelopeID = goToEnvelopeID
+  end
+end
+
+# {http://www.docusign.net/API/Credential}GetAuthenticationTokenResponse
+#   getAuthenticationTokenResult - SOAP::SOAPString
+class GetAuthenticationTokenResponse
+  attr_accessor :getAuthenticationTokenResult
+
+  def initialize(getAuthenticationTokenResult = nil)
+    @getAuthenticationTokenResult = getAuthenticationTokenResult
+  end
+end
+
+
+end; end

data/lib/docusign/credentialDriver.rb

@@ -0,0 +1,65 @@
+require 'soap/rpc/driver'
+
+module Docusign::Credential
+
+class CredentialSoap < ::SOAP::RPC::Driver
+  DefaultEndpointUrl = "https://demo.docusign.net/api/3.0/Credential.asmx"
+
+  Methods = [
+    [ "http://www.docusign.net/API/Credential/Ping",
+      "ping",
+      [ ["in", "parameters", ["::SOAP::SOAPElement", "http://www.docusign.net/API/Credential", "Ping"]],
+        ["out", "parameters", ["::SOAP::SOAPElement", "http://www.docusign.net/API/Credential", "PingResponse"]] ],
+      { :request_style =>  :document, :request_use =>  :literal,
+        :response_style => :document, :response_use => :literal,
+        :faults => {} }
+    ],
+    [ "http://www.docusign.net/API/Credential/Login",
+      "login",
+      [ ["in", "parameters", ["::SOAP::SOAPElement", "http://www.docusign.net/API/Credential", "Login"]],
+        ["out", "parameters", ["::SOAP::SOAPElement", "http://www.docusign.net/API/Credential", "LoginResponse"]] ],
+      { :request_style =>  :document, :request_use =>  :literal,
+        :response_style => :document, :response_use => :literal,
+        :faults => {} }
+    ],
+    [ "http://www.docusign.net/API/Credential/GetAuthenticationToken",
+      "getAuthenticationToken",
+      [ ["in", "parameters", ["::SOAP::SOAPElement", "http://www.docusign.net/API/Credential", "GetAuthenticationToken"]],
+        ["out", "parameters", ["::SOAP::SOAPElement", "http://www.docusign.net/API/Credential", "GetAuthenticationTokenResponse"]] ],
+      { :request_style =>  :document, :request_use =>  :literal,
+        :response_style => :document, :response_use => :literal,
+        :faults => {} }
+    ]
+  ]
+
+  def initialize(endpoint_url = nil)
+    endpoint_url ||= DefaultEndpointUrl
+    super(endpoint_url, nil)
+    self.mapping_registry = DefaultMappingRegistry::EncodedRegistry
+    self.literal_mapping_registry = DefaultMappingRegistry::LiteralRegistry
+    init_methods
+  end
+
+private
+
+  def init_methods
+    Methods.each do |definitions|
+      opt = definitions.last
+      if opt[:request_style] == :document
+        add_document_operation(*definitions)
+      else
+        add_rpc_operation(*definitions)
+        qname = definitions[0]
+        name = definitions[2]
+        if qname.name != name and qname.name.capitalize == name.capitalize
+          ::SOAP::Mapping.define_singleton_method(self, qname.name) do |*arg|
+            __send__(name, *arg)
+          end
+        end
+      end
+    end
+  end
+end
+
+
+end

data/lib/docusign/credentialMappingRegistry.rb

@@ -0,0 +1,128 @@
+require 'soap/mapping'
+
+module Docusign; module Credential
+
+module DefaultMappingRegistry
+  EncodedRegistry = ::SOAP::Mapping::EncodedRegistry.new
+  LiteralRegistry = ::SOAP::Mapping::LiteralRegistry.new
+  NsCredential = "http://www.docusign.net/API/Credential"
+
+  EncodedRegistry.register(
+    :class => Docusign::Credential::ArrayOfAccount,
+    :schema_type => XSD::QName.new(NsCredential, "ArrayOfAccount"),
+    :schema_element => [
+      ["account", ["Docusign::Credential::ArrayOfAccount::Account[]", XSD::QName.new(NsCredential, "Account")], [0, nil]]
+    ]
+  )
+
+  EncodedRegistry.register(
+    :class => Docusign::Credential::ArrayOfAccount::Account,
+    :schema_name => XSD::QName.new(NsCredential, "Account"),
+    :is_anonymous => true,
+    :schema_qualified => true,
+    :schema_element => [
+      ["accountID", ["SOAP::SOAPString", XSD::QName.new(NsCredential, "AccountID")], [0, 1]],
+      ["accountName", ["SOAP::SOAPString", XSD::QName.new(NsCredential, "AccountName")], [0, 1]],
+      ["userID", ["SOAP::SOAPString", XSD::QName.new(NsCredential, "UserID")], [0, 1]],
+      ["userName", ["SOAP::SOAPString", XSD::QName.new(NsCredential, "UserName")], [0, 1]],
+      ["email", ["SOAP::SOAPString", XSD::QName.new(NsCredential, "Email")], [0, 1]]
+    ]
+  )
+
+  EncodedRegistry.register(
+    :class => Docusign::Credential::ErrorCode,
+    :schema_type => XSD::QName.new(NsCredential, "ErrorCode")
+  )
+
+  LiteralRegistry.register(
+    :class => Docusign::Credential::ArrayOfAccount,
+    :schema_type => XSD::QName.new(NsCredential, "ArrayOfAccount"),
+    :schema_element => [
+      ["account", ["Docusign::Credential::ArrayOfAccount::Account[]", XSD::QName.new(NsCredential, "Account")], [0, nil]]
+    ]
+  )
+
+  LiteralRegistry.register(
+    :class => Docusign::Credential::ArrayOfAccount::Account,
+    :schema_name => XSD::QName.new(NsCredential, "Account"),
+    :is_anonymous => true,
+    :schema_qualified => true,
+    :schema_element => [
+      ["accountID", ["SOAP::SOAPString", XSD::QName.new(NsCredential, "AccountID")], [0, 1]],
+      ["accountName", ["SOAP::SOAPString", XSD::QName.new(NsCredential, "AccountName")], [0, 1]],
+      ["userID", ["SOAP::SOAPString", XSD::QName.new(NsCredential, "UserID")], [0, 1]],
+      ["userName", ["SOAP::SOAPString", XSD::QName.new(NsCredential, "UserName")], [0, 1]],
+      ["email", ["SOAP::SOAPString", XSD::QName.new(NsCredential, "Email")], [0, 1]]
+    ]
+  )
+
+  LiteralRegistry.register(
+    :class => Docusign::Credential::ErrorCode,
+    :schema_type => XSD::QName.new(NsCredential, "ErrorCode")
+  )
+
+  LiteralRegistry.register(
+    :class => Docusign::Credential::Ping,
+    :schema_name => XSD::QName.new(NsCredential, "Ping"),
+    :schema_element => []
+  )
+
+  LiteralRegistry.register(
+    :class => Docusign::Credential::PingResponse,
+    :schema_name => XSD::QName.new(NsCredential, "PingResponse"),
+    :schema_element => [
+      ["pingResult", ["SOAP::SOAPBoolean", XSD::QName.new(NsCredential, "PingResult")]]
+    ]
+  )
+
+  LiteralRegistry.register(
+    :class => Docusign::Credential::Login,
+    :schema_name => XSD::QName.new(NsCredential, "Login"),
+    :schema_element => [
+      ["email", ["SOAP::SOAPString", XSD::QName.new(NsCredential, "Email")], [0, 1]],
+      ["password", ["SOAP::SOAPString", XSD::QName.new(NsCredential, "Password")], [0, 1]]
+    ]
+  )
+
+  LiteralRegistry.register(
+    :class => Docusign::Credential::LoginResponse,
+    :schema_name => XSD::QName.new(NsCredential, "LoginResponse"),
+    :schema_element => [
+      ["loginResult", ["Docusign::Credential::LoginResponse::LoginResult", XSD::QName.new(NsCredential, "LoginResult")], [0, 1]]
+    ]
+  )
+
+  LiteralRegistry.register(
+    :class => Docusign::Credential::LoginResponse::LoginResult,
+    :schema_name => XSD::QName.new(NsCredential, "LoginResult"),
+    :is_anonymous => true,
+    :schema_qualified => true,
+    :schema_element => [
+      ["success", ["SOAP::SOAPBoolean", XSD::QName.new(NsCredential, "Success")]],
+      ["errorCode", ["Docusign::Credential::ErrorCode", XSD::QName.new(NsCredential, "ErrorCode")], [0, 1]],
+      ["authenticationMessage", ["SOAP::SOAPString", XSD::QName.new(NsCredential, "AuthenticationMessage")], [0, 1]],
+      ["accounts", ["Docusign::Credential::ArrayOfAccount", XSD::QName.new(NsCredential, "Accounts")], [0, 1]]
+    ]
+  )
+
+  LiteralRegistry.register(
+    :class => Docusign::Credential::GetAuthenticationToken,
+    :schema_name => XSD::QName.new(NsCredential, "GetAuthenticationToken"),
+    :schema_element => [
+      ["email", ["SOAP::SOAPString", XSD::QName.new(NsCredential, "Email")], [0, 1]],
+      ["password", ["SOAP::SOAPString", XSD::QName.new(NsCredential, "Password")], [0, 1]],
+      ["accountID", ["SOAP::SOAPString", XSD::QName.new(NsCredential, "AccountID")], [0, 1]],
+      ["goToEnvelopeID", ["SOAP::SOAPString", XSD::QName.new(NsCredential, "GoToEnvelopeID")], [0, 1]]
+    ]
+  )
+
+  LiteralRegistry.register(
+    :class => Docusign::Credential::GetAuthenticationTokenResponse,
+    :schema_name => XSD::QName.new(NsCredential, "GetAuthenticationTokenResponse"),
+    :schema_element => [
+      ["getAuthenticationTokenResult", ["SOAP::SOAPString", XSD::QName.new(NsCredential, "GetAuthenticationTokenResult")], [0, 1]]
+    ]
+  )
+end
+
+end; end