docusign 0.5.0

data/lib/docusign/extensions.rb

@@ -0,0 +1,41 @@
+# AutoCamelize
+#
+# This module enables a class to automatically map
+# Ruby-esque snake_case method calls to the equivalent
+# camelCase calls. If a method with a camelCase equivalent
+# is found, we alias the snake_case method on the
+# class, to avoid tripping method_missing for the same
+# method in the future.
+
+module AutoCamelize
+  def method_missing(method_name, *args, &block)
+    ds_name = ds_equivalent(method_name)
+
+    if ds_name && respond_to?(ds_name)
+      self.class.class_eval %Q{
+        alias :#{method_name} :#{ds_name}
+      }
+
+      send method_name, *args, &block
+    else
+      super
+    end
+  end
+  
+  # Find the equivalent built-in method name, if there is one.
+  # Example:
+  # ds_equivalent('pdf_bytes') => 'pDFBytes'
+  
+  def ds_equivalent(string)
+    string = string.to_s.camelize(:lower)
+    methods.find { |m| m.downcase == string.downcase }
+  end
+end
+
+Docusign.constants.each do |c|
+  constant = Docusign.const_get c 
+  if constant.is_a? Class
+    constant.send :include, AutoCamelize
+    constant.extend AutoCamelize
+  end
+end

data/lib/docusign/tab.rb

@@ -0,0 +1,26 @@
+module Docusign
+  class Tab
+    def anchor(options = {}, &block)
+      returning anchor_builder.build(options, &block) do |a|
+        yield a if block_given?
+        self.anchor_tab_item = a
+      end
+    end
+    
+    def anchor=(options = {})
+      anchor options
+    end
+    
+    def anchor_builder
+      @anchor_builder ||= Docusign::Builder::AnchorBuilder.new
+    end
+    
+    %w(recipient document).each do |attr|
+      class_eval %Q{
+        def #{attr}=(value)
+          self.#{attr}ID = value.id
+        end
+      }
+    end
+  end
+end

data/lib/docusign/utilities.rb

@@ -0,0 +1,8 @@
+module Docusign
+  module Utilities
+    def self.instance_attributes(klass)
+      i = klass.new
+      i.instance_variables.map { |ivar| ivar.gsub /@/, '' }
+    end
+  end
+end

data/spec/docusign/builder/anchor_builder_spec.rb

@@ -0,0 +1,49 @@
+require 'spec/spec_helper'
+
+describe Docusign::Builder::AnchorBuilder do
+  describe "#initialize" do
+    it "should return a new AnchorBuilder" do
+      Docusign::Builder::AnchorBuilder.new.should be_an_instance_of(Docusign::Builder::AnchorBuilder)
+    end
+    
+    describe "#build" do
+      before(:each) do
+        @ab = Docusign::Builder::AnchorBuilder.new
+      end
+      
+      context "with no arguments" do
+        it "should return a new Docusign::AnchorTab" do
+          @ab.build.should be_an_instance_of(Docusign::AnchorTab)
+        end
+      end
+      
+      context "passing in attributes from a hash" do
+        before(:each) do
+          @anchor = @ab.build :x_offset => 2, :y_offset => 3, :anchor_tab_string => 'foo'
+        end
+        
+        it "should set attributes from the passed-in hash" do
+          @anchor.x_offset.should == 2
+          @anchor.y_offset.should == 3
+          @anchor.anchor_tab_string.should == 'foo'
+        end
+      end
+      
+      context "passing in attributes from a block" do
+        before(:each) do
+          @anchor = @ab.build do |a|
+            a.x_offset = 2
+            a.y_offset = 3
+            a.anchor_tab_string = 'foo'
+          end
+        end
+        
+        it "should set attributes from the passed-in block" do
+          @anchor.x_offset.should == 2
+          @anchor.y_offset.should == 3
+          @anchor.anchor_tab_string.should == 'foo'
+        end
+      end
+    end
+  end
+end

data/spec/docusign/builder/tab_builder_spec.rb

@@ -0,0 +1,74 @@
+require 'spec/spec_helper'
+
+describe Docusign::Builder::TabBuilder do
+  def init_tab_builder
+    @document = stub(:id => 1)
+    @recipient = stub(:id => 1)
+    @tb = Docusign::Builder::TabBuilder.new @document, @recipient
+  end
+  
+  describe "#initialize" do
+    before(:each) do
+      init_tab_builder
+    end
+    
+    it "should return an instance of itself" do
+      @tb.should be_an_instance_of(Docusign::Builder::TabBuilder)
+    end
+    
+    it "should set the document" do
+      @tb.document.should == @document
+    end
+    
+    it "should set the recipient if passed in" do
+      @tb.recipient.should == @recipient
+    end
+  end
+  
+  describe "#build" do
+    before(:each) do
+      init_tab_builder
+    end
+    
+    it "should return a new tab with no arguments" do
+      @tb.build.should be_an_instance_of(Docusign::Tab)
+    end
+    
+    it "should set attributes passed in via options" do
+      tab = @tb.build :name => 'foo', :value => 'bar'
+      
+      tab.name.should == 'foo'
+      tab.value.should == 'bar'
+    end
+    
+    it "should set attributes via block" do
+      tab = @tb.build do |t|
+        t.name  = 'foo'
+        t.value = 'bar'
+      end
+      
+      tab.name.should == 'foo'
+      tab.value.should == 'bar'
+    end
+    
+    it "should set the document and recipient" do
+      tab = @tb.build
+      tab.document_id.should == @document.id
+      tab.recipient_id.should == @recipient.id
+    end
+    
+    context "overriding document and recipient" do
+      before(:each) do
+        @tab = @tb.build :document_id => 3, :recipient_id => 2
+      end
+      
+      it "should not set a default document" do
+        @tab.document_id.should == 3
+      end
+      
+      it "should not set a default recipient" do
+        @tab.recipient_id.should == 2
+      end
+    end
+  end
+end

data/spec/docusign/document_spec.rb

@@ -0,0 +1,51 @@
+require 'spec/spec_helper'
+
+describe Docusign::Document do
+  before(:each) do
+    @d = Docusign::Document.new
+  end
+  
+  it "should create a new document" do
+    @d.should be_an_instance_of(Docusign::Document)
+  end
+  
+  it "should respond to tabs" do
+    @d.should respond_to(:tabs)
+  end
+  
+  describe "#tabs" do
+    context "with no arguments" do
+      it "should return an empty tab array" do
+        @d.tabs.should == Docusign::ArrayOfTab.new
+      end
+    end
+    
+    context "with arguments" do
+      before(:each) do
+        @tabs = @d.tabs stub(:id => 1) do |d|
+          d.tab :name => 'tab_1', :value => 'foo'
+          d.tab :name => 'tab_2', :value => 'bar'
+        end
+      end
+      
+      it "should build tabs" do
+        @tabs.all? { |t| t.is_a?(Docusign::Tab) }.should be_true
+      end
+      
+      it "should build the appropriate number of tabs" do
+        @tabs.size.should == 2
+      end
+    end
+  end
+  
+  describe "#tab" do
+    it "should build a tab" do
+      @d.tab.should be_an_instance_of(Docusign::Tab)
+    end
+    
+    it "should pass in arguments" do
+      tab = @d.tab :document_id => 1
+      tab.document_id.should == 1
+    end
+  end
+end

data/spec/spec.opts

@@ -0,0 +1,4 @@
+--color
+--format specdoc
+--loadby mtime
+--reverse

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require 'rubygems'
+require File.expand_path(File.dirname(__FILE__) + '/../lib/docusign')

data/tasks/docusign_tasks.rake

@@ -0,0 +1,30 @@
+# Generates SOAP stubs for Salesforce Enterprise API.
+# Requires a /config/salesforce/enterprise.wsdl.xml
+
+require 'rubygems'
+gem 'soap4r'
+require 'wsdl/soap/wsdl2ruby'
+
+namespace :docusign do
+  namespace :services do
+    desc "Generate SOAP stubs for Salesforce API"
+    task :generate => [:environment] do
+      wsdl_path = File.expand_path(File.dirname(__FILE__) + "/../lib/DocuSign3.0.10API.wsdl")
+      wsdl2ruby('docusign', 'Docusign', "file://#{wsdl_path}")
+    end
+  end
+end
+
+private
+
+def wsdl2ruby(name, module_name, url)
+  g = WSDL::SOAP::WSDL2Ruby.new
+  g.location = url
+  g.basedir = File.expand_path(File.dirname(__FILE__) + "/../lib/")
+  g.opt['classdef'] = name
+  g.opt['driver'] = nil
+  g.opt['module_path'] = module_name
+  g.opt['mapping_registry'] = true
+  g.opt['force'] = true
+  g.run
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification 
+name: docusign
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 5
+  - 0
+  version: 0.5.0
+platform: ruby
+authors: 
+- Leigh Caplan
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-03-20 00:00:00 -07:00
+default_executable: docusign
+dependencies: []
+
+description: |
+  A library for working with the Docusign API and associated objects.
+  Provides SOAP4R-generated proxy classes, and extends many useful classes
+  with familiar Ruby-like syntax.    
+
+email: texel1@gmail.com
+executables: 
+- docusign
+extensions: []
+
+extra_rdoc_files: 
+- README.txt
+files: 
+- .gitignore
+- History.txt
+- Manifest.txt
+- README.txt
+- Rakefile
+- VERSION
+- bin/docusign
+- docusign.gemspec
+- lib/Credential.wsdl
+- lib/DocuSign3.0.10API.wsdl
+- lib/docusign.rb
+- lib/docusign/anchor_tab.rb
+- lib/docusign/auth_header_handler.rb
+- lib/docusign/base.rb
+- lib/docusign/builder/anchor_builder.rb
+- lib/docusign/builder/base.rb
+- lib/docusign/builder/tab_builder.rb
+- lib/docusign/credential.rb
+- lib/docusign/credentialDriver.rb
+- lib/docusign/credentialMappingRegistry.rb
+- lib/docusign/document.rb
+- lib/docusign/docusign.rb
+- lib/docusign/docusignDriver.rb
+- lib/docusign/docusignMappingRegistry.rb
+- lib/docusign/extensions.rb
+- lib/docusign/tab.rb
+- lib/docusign/utilities.rb
+- spec/docusign/builder/anchor_builder_spec.rb
+- spec/docusign/builder/tab_builder_spec.rb
+- spec/docusign/document_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- tasks/docusign_tasks.rake
+- test/test_docusign.rb
+has_rdoc: true
+homepage: http://github.com/texel/docusign
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: A library for working with the Docusign API and associated objects
+test_files: 
+- spec/docusign/builder/anchor_builder_spec.rb
+- spec/docusign/builder/tab_builder_spec.rb
+- spec/docusign/document_spec.rb
+- spec/spec_helper.rb
+- test/test_docusign.rb