docusign 0.5.4 → 0.6.0

data/README.rdoc

@@ -0,0 +1,84 @@
+= docusign
+
+http://www.docusign.com
+http://www.github.com/texel/docusign
+
+== Description
+
+A library for communicating with the Docusign API via SOAP.
+
+== Making An API Call
+
+  connection = Docusign::Base.login(
+    :user_name    => 'your_user_name',
+    :password     => 'your_password',
+    :endpoint_url => 'http://demo.docusign.net/API/3.0'
+  )
+
+  connection.request_status :envelope_id => '12345'
+
+== Install
+
+1. $ gem update --system (this is only necessary if you don't have rubygems 1.3.6 or newer)
+2. $ gem install docusign
+
+== AutoCamelize
+
+The Docusign gem supports calling methods using both camelCase and snake_case. Methods in snake_case
+that don't exist on a Docusign module class or instance are automatically aliased to their camelCase
+equivalent, if one exists. Hence, the following two examples are functionally identical:
+
+  connection.request_status :envelopeID => '12345'
+  connection.requestStatus :envelopeID => '12345'
+
+== Builder syntax
+
+To ease common tasks, some builder methods are included. For example, you can generate tabs for a
+document for a particular recipient from the document itself:
+
+  recipient = Docusign::Recipient.new # You may want to set some attributes of the recipient as well.
+  document  = Docusign::Document.new
+
+  tabs = document.tabs recipient do |d|
+    d.tab :name => 'email', :value => email, :page => 1, :x => 190, :y => 186
+    d.tab :name => 'phone', :value => phone, :anchor => {:string => 'Phone:',  :x_offset => 200, :y_offset => -2}
+    d.tab :type => Docusign::TabTypeCode::FullName, :page => 1, :x => 190, :y => 118
+  end
+  
+These tabs will be pre-populated with both the document's and recipient's id.
+Note that passing in a recipient to the builder is optional- you can still specify or override the recipient
+for an individual tab:
+
+  tabs = document.tabs do |d|
+    d.tab :recipient => signer_1, :name => 'email', :value => email, :page => 1, :x => 190, :y => 186
+    d.tab :recipient => signer_2, :name => 'email', :value => email, :page => 1, :x => 190, :y => 186
+  end
+  
+You can also use block syntax for the tabs themselves:
+
+  tabs = document.tabs recipient do |d|
+    d.tab do |t|
+      t.name = 'phone'
+      t.anchor do |a|
+        a.string = 'Phone'
+        a.x_offset = 200
+      end
+    end
+  end
+
+== License
+
+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.

data/VERSION

@@ -1 +1 @@
-0.5.4
+0.6.0

data/docusign.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{docusign}
-  s.version = "0.5.4"
+  s.version = "0.6.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Leigh Caplan"]
-  s.date = %q{2010-03-27}
+  s.date = %q{2010-04-13}
   s.default_executable = %q{docusign}
   s.description = %q{A library for working with the Docusign API and associated objects.
 Provides SOAP4R-generated proxy classes, and extends many useful classes
@@ -18,12 +18,12 @@ with familiar Ruby-like syntax.
   s.email = %q{texel1@gmail.com}
   s.executables = ["docusign"]
   s.extra_rdoc_files = [
-    "README.txt"
+    "README.rdoc"
   ]
   s.files = [
     ".gitignore",
      "History.txt",
-     "README.txt",
+     "README.rdoc",
      "Rakefile",
      "VERSION",
      "bin/docusign",
@@ -45,6 +45,7 @@ with familiar Ruby-like syntax.
      "lib/docusign/docusignDriver.rb",
      "lib/docusign/docusignMappingRegistry.rb",
      "lib/docusign/extensions.rb",
+     "lib/docusign/integrators_key_auth_header_handler.rb",
      "lib/docusign/request_recipient_token_client_urls.rb",
      "lib/docusign/tab.rb",
      "lib/docusign/utilities.rb",

data/lib/docusign.rb

@@ -25,6 +25,7 @@ require 'docusign/docusignMappingRegistry'
 require 'docusign/docusignDriver'
 require 'docusign/base'
 require 'docusign/auth_header_handler'
+require 'docusign/integrators_key_auth_header_handler'
 require 'docusign/credential'
 require 'docusign/credentialDriver'
 require 'docusign/credentialMappingRegistry'

data/lib/docusign/base.rb

@@ -20,10 +20,19 @@ module Docusign
       def login(options={})
         
         connection  = Docusign::APIServiceSoap.new
-        header = AuthHeaderHandler.new(
-          :user_name => options.delete(:user_name), 
-          :password  => options.delete(:password)
-        )
+        
+        if options[:integrators_key]
+          header = IntegratorsKeyAuthHeaderHandler.new(
+            :email           => options.delete(:email),
+            :integrators_key => options.delete(:integrators_key),
+            :password        => options.delete(:password)
+          )
+        else
+          header = AuthHeaderHandler.new(
+            :user_name => options.delete(:user_name), 
+            :password  => options.delete(:password)
+          )
+        end
         
         connection.headerhandler << header
         

data/lib/docusign/extensions.rb

@@ -6,6 +6,24 @@
 # is found, we alias the snake_case method on the
 # class, to avoid tripping method_missing for the same
 # method in the future.
+module ConstEnhancements
+  def const_descendants
+    constants.reject { |c| c == 'Enumerator' }.inject([]) do |collection, constant|
+      c = const_get(constant)
+      collection << c
+      
+      if [Module, Class].include?(c.class)
+        collection + c.const_descendants
+      else
+        collection
+      end
+    end
+  end
+end
+
+[Module, Class].each do |i|
+  i.send :include, ConstEnhancements
+end
 
 module AutoCamelize
   def method_missing(method_name, *args, &block)
@@ -34,8 +52,12 @@ module AutoCamelize
   end
 end
 
-Docusign.constants.each do |c|
-  constant = Docusign.const_get c 
+constants = Docusign.constants
+
+# Recursively collect nested credential constants
+constants = constants.map { |c| Docusign.const_get(c) } + Docusign::Credential.const_descendants
+
+constants.each do |constant|
   if constant.is_a? Class
     constant.send :include, AutoCamelize
     constant.extend AutoCamelize

data/lib/docusign/integrators_key_auth_header_handler.rb

@@ -0,0 +1,41 @@
+# 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 IntegratorsKeyAuthHeaderHandler < 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[:integrators_key] && attributes[:email]
+        {
+          'UsernameToken' => {
+            'Username' => "[#{attributes[:integrators_key]}]#{attributes[:email]}", 
+            'Password' => attributes[:password]
+          }
+        }
+      end
+    end
+  end
+end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 5
-  - 4
-  version: 0.5.4
+  - 6
+  - 0
+  version: 0.6.0
 platform: ruby
 authors: 
 - Leigh Caplan
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-03-27 00:00:00 -07:00
+date: 2010-04-13 00:00:00 -07:00
 default_executable: docusign
 dependencies: []
 
@@ -29,11 +29,11 @@ executables:
 extensions: []
 
 extra_rdoc_files: 
-- README.txt
+- README.rdoc
 files: 
 - .gitignore
 - History.txt
-- README.txt
+- README.rdoc
 - Rakefile
 - VERSION
 - bin/docusign
@@ -55,6 +55,7 @@ files:
 - lib/docusign/docusignDriver.rb
 - lib/docusign/docusignMappingRegistry.rb
 - lib/docusign/extensions.rb
+- lib/docusign/integrators_key_auth_header_handler.rb
 - lib/docusign/request_recipient_token_client_urls.rb
 - lib/docusign/tab.rb
 - lib/docusign/utilities.rb

data/README.txt

@@ -1,43 +0,0 @@
-= docusign
-
-http://www.docusign.com
-http://www.github.com/texel/docusign
-
-== DESCRIPTION:
-
-A library for communicating with the Docusign API via SOAP.
-
-== SYNOPSIS:
-
-connection = Docusign::Base.login(
-  :user_name    => 'your_user_name',
-  :password     => 'your_password',
-  :endpoint_url => 'http://demo.docusign.net/API/3.0'
-)
-
-connection.requestStatus :envelopeID => '12345'
-
-== INSTALL:
-1) $ gem sources -a http://gems.github.com (you only have to do this once)
-2) $ sudo gem install texel-docusign
-
-== TO DOCUMENT:
-- AutoCamelize
-- Tab/Anchor Builders
-
-== LICENSE:
-
-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.