docusign_rest 0.0.1

data/lib/docusign_rest/configuration.rb

@@ -0,0 +1,49 @@
+module DocusignRest
+  module Configuration
+    VALID_CONNECTION_KEYS  = [:endpoint, :api_version, :user_agent, :method].freeze
+    VALID_OPTIONS_KEYS     = [:username, :password, :integrator_key, :account_id, :format].freeze
+    VALID_CONFIG_KEYS      = VALID_CONNECTION_KEYS + VALID_OPTIONS_KEYS
+
+    DEFAULT_ENDPOINT       = 'https://demo.docusign.net/restapi'
+    DEFAULT_API_VERSION    = 'v1'
+    DEFAULT_USER_AGENT     = "DocusignRest API Ruby Gem #{DocusignRest::VERSION}".freeze
+    DEFAULT_METHOD         = :get
+
+    DEFAULT_USERNAME       = nil
+    DEFAULT_PASSWORD       = nil
+    DEFAULT_INTEGRATOR_KEY = nil
+    DEFAULT_ACCOUNT_ID     = nil
+    DEFAULT_FORMAT         = :json
+
+    # Build accessor methods for every config options so we can do this, for example:
+    #   DocusignRest.format = :xml
+    attr_accessor *VALID_CONFIG_KEYS
+
+    # Make sure we have the default values set when we get 'extended'
+    def self.extended(base)
+      base.reset
+    end
+
+    def reset
+      self.endpoint       = DEFAULT_ENDPOINT
+      self.api_version    = DEFAULT_API_VERSION
+      self.user_agent     = DEFAULT_USER_AGENT
+      self.method         = DEFAULT_METHOD
+
+      self.username       = DEFAULT_USERNAME
+      self.password       = DEFAULT_PASSWORD
+      self.integrator_key = DEFAULT_INTEGRATOR_KEY
+      self.account_id     = DEFAULT_ACCOUNT_ID
+      self.format         = DEFAULT_FORMAT
+    end
+
+    # Allow configuration via a block
+    def configure
+      yield self
+    end
+
+    def options
+      Hash[ * VALID_CONFIG_KEYS.map { |key| [key, send(key)] }.flatten ]
+    end
+  end
+end

data/lib/docusign_rest/railtie.rb

@@ -0,0 +1,11 @@
+require 'docusign_rest'
+require 'rails'
+module DocusignRest
+  class Railtie < Rails::Railtie
+    railtie_name :docusign_rest
+
+    rake_tasks do
+      load 'tasks/docusign_task.rake'
+    end
+  end
+end

data/lib/docusign_rest/version.rb

@@ -0,0 +1,3 @@
+module DocusignRest
+  VERSION = "0.0.1"
+end

data/lib/multipart_post/parts.rb

@@ -0,0 +1,13 @@
+require 'multipart_post'
+require 'parts'
+
+Parts::ParamPart.class_eval do
+  def build_part(boundary, name, value)
+    part = "\r\n" #Add a leading carriage return line feed (not sure why DocuSign requires this)
+    part << "--#{boundary}\r\n"
+    part << "Content-Type: application/json\r\n" #Add the content type which isn't present in the multipart-post gem, but DocuSign requires
+    part << "Content-Disposition: form-data; name=\"#{name.to_s}\"\r\n"
+    part << "\r\n"
+    part << "#{value}\r\n"
+  end
+end

data/lib/tasks/docusign_task.rake

@@ -0,0 +1,76 @@
+require 'docusign_rest'
+
+namespace :docusign_rest do
+  desc "Retrive account_id from the API"
+  task :generate_config do
+    def ask(message)
+      STDOUT.print message
+      STDIN.gets.chomp
+    end
+
+    STDOUT.puts %Q{
+Please do the following:
+------------------------
+1) Login or register for an account at demo.docusign.net
+     ...or their production url if applicable
+2) Click 'Preferences' in the upper right corner of the page
+3) Click 'API' in far lower left corner of the menu
+4) Request a new 'Integrator Key' via the web interface
+     * You will use this key in one of the next steps to retrieve your 'accountId'\n\n}
+
+    username = ask('Please enter your DocuSign username: ')
+    password = ask('Please enter your DocuSign password: ')
+    integrator_key = ask('Please enter your DocuSign integrator key: ')
+
+    DocusignRest.configure do |config|
+      config.username       = username
+      config.password       = password
+      config.integrator_key = integrator_key
+    end
+
+    # initialize a client and request the accountId
+    client = DocusignRest::Client.new
+    acct_id = client.get_account_id
+
+    puts ""
+
+    # construct the configure block for the user with his or her credentials and accountId
+    config = %Q{# This file was generated by the docusign_rest:generate_config rake task.
+# You can run 'rake docusign_rest:generate_config' as many times as you need
+# to replace the content of this file with a new config.
+
+require 'docusign_rest'
+
+DocusignRest.configure do |config|
+  config.username       = '#{username}'
+  config.password       = '#{password}'
+  config.integrator_key = '#{integrator_key}'
+  config.account_id     = '#{acct_id}'
+end\n\n}
+
+    # write the initializer for the user
+    if defined?(Rails)
+      docusign_initializer_path = Rails.root.join("config/initializers/docusign_rest.rb")
+    else
+      docusign_initializer_path = "test/docusign_login_config.rb"
+    end
+
+    File.open(docusign_initializer_path, 'w') { |f| f.write(config) }
+    # read the initializer file into a var for comparison to the config block above
+    docusign_initializer_content = File.open(docusign_initializer_path) { |io| io.read }
+
+    # if they match tell the user we wrote the file, otherwise tell them to do it themselves
+    if docusign_initializer_content.include?(config)
+      if defined?(Rails)
+        puts "The following block of code was added to config/initializers/docusign_rest.rb\n\n"
+      else
+        puts "The following block of code was added to test/docusign_login_config.rb\n\n"
+      end
+      puts config
+    else
+      puts %Q{The config file was not able to be automatically created for you.
+Please create it at config/initializers/docusign_rest.rb and add the following content:\n\n}
+      puts config
+    end
+  end
+end

data/lib/tasks/docusign_task.rb

@@ -0,0 +1,5 @@
+require 'rake'
+require 'json'
+
+Rake.application.rake_require '../lib/tasks/docusign_task'
+Rake.application['docusign_rest:generate_config'].invoke

data/test/docusign_rest/client_test.rb

@@ -0,0 +1,191 @@
+require 'helper'
+
+describe DocusignRest::Client do
+
+  before do
+    @keys = DocusignRest::Configuration::VALID_CONFIG_KEYS
+  end
+
+  describe 'with module configuration' do
+    before do
+      DocusignRest.configure do |config|
+        @keys.each do |key|
+          config.send("#{key}=", key)
+        end
+      end
+    end
+
+    after do
+      DocusignRest.reset
+    end
+
+    it "should inherit module configuration" do
+      api = DocusignRest::Client.new
+      @keys.each do |key|
+        api.send(key).must_equal key
+      end
+    end
+
+    describe 'with class configuration' do
+      before do
+        @config = {
+          :username       => 'un',
+          :password       => 'pd',
+          :integrator_key => 'ik',
+          :account_id     => 'ai',
+          :format         => 'fm',
+          :endpoint       => 'ep',
+          :api_version    => 'av',
+          :user_agent     => 'ua',
+          :method         => 'md',
+        }
+      end
+
+      it 'should override module configuration' do
+        api = DocusignRest::Client.new(@config)
+        @keys.each do |key|
+          api.send(key).must_equal @config[key]
+        end
+      end
+
+      it 'should override module configuration after' do
+        api = DocusignRest::Client.new
+
+        @config.each do |key, value|
+          api.send("#{key}=", value)
+        end
+
+        @keys.each do |key|
+          api.send("#{key}").must_equal @config[key]
+        end
+      end
+    end
+  end
+
+  describe 'client' do
+    before do
+      # Note: to configure the client please run the docusign_task.rb file:
+      #
+      #     $ ruby lib/tasks/docusign_task.rb
+      #
+      # which will populate the test/docusign_login_config.rb file
+      @client = DocusignRest::Client.new
+    end
+
+    it "should allow access to the auth headers after initialization" do
+      @client.must_respond_to :docusign_authentication_headers
+    end
+
+    it "should allow access to the acct_id after initialization" do
+      @client.must_respond_to :acct_id
+    end
+
+    it "should allow creating an envelope from a document" do
+      VCR.use_cassette("create_envelope/from_document", record: :once) do
+        response = @client.create_envelope_from_document(
+          email: {
+            subject: "test email subject",
+            body: "this is the email body and it's large!"
+          },
+          # If embedded is set to true  in the signers array below, emails
+          # don't go out and you can embed the signature page in an iFrame
+          # by using the get_recipient_view method. You can choose 'false' or
+          # simply omit the option as I show in the second signer hash.
+          signers: [
+            {
+              embedded: true,
+              name: 'Test Guy',
+              email: 'someone@gmail.com'
+            },
+            {
+              #embedded: true,
+              name: 'Test Girl',
+              email: 'someone+else@gmail.com'
+            }
+          ],
+          files: [
+            {path: 'test.pdf', name: 'test.pdf'},
+            {path: 'test2.pdf', name: 'test2.pdf'}
+          ],
+          status: 'sent'
+        )
+        response = JSON.parse(response.body)
+        response["status"].must_equal "sent"
+      end
+    end
+
+    describe "embedded signing" do
+      before do
+        # create the template dynamically
+        VCR.use_cassette("create_template", record: :once)  do
+          response = @client.create_template(
+            description: 'Cool Description',
+            name: "Cool Template Name",
+            signers: [
+              {
+                embedded: true,
+                name: 'jon',
+                email: 'someone@gmail.com',
+                role_name: 'Issuer',
+                anchor_string: 'sign here',
+                sign_here_tab_text: 'Issuer, Please Sign Here',
+                template_locked: true, #doesn't seem to do anything
+                template_required: true, #doesn't seem to do anything
+                email_notification: false #FIXME if signer is setup as 'embedded' initial email notifications don't go out, but even when I set up a signer as non-embedded this setting didn't seem to make the email notifications actually stop...
+              }
+            ],
+            files: [
+              {path: 'test.pdf', name: 'test.pdf'}
+            ]
+          )
+          @template_response = JSON.parse(response.body)
+        end
+
+        # use the templateId to get the envelopeId
+        VCR.use_cassette("create_envelope/from_template", record: :once)  do
+          response = @client.create_envelope_from_template(
+            status: 'sent',
+            email: {
+              subject: "The test email subject envelope",
+              body: "Envelope body content here"
+            },
+            template_id: @template_response["templateId"],
+            signers: [
+              {
+                embedded: true,
+                name: 'jon',
+                email: 'someone@gmail.com',
+                role_name: 'Issuer'
+              }
+            ]
+          )
+          @envelope_response = JSON.parse(response.body)
+        end
+      end
+
+      it "should return a URL for embedded signing" do
+        #ensure template was created
+        @template_response["templateId"].wont_be_nil
+        @template_response["name"].must_equal "Cool Template Name"
+
+        #ensure creating an envelope from a dynamic template did not error
+        @envelope_response["errorCode"].must_be_nil
+
+        #return the URL for embedded signing
+        VCR.use_cassette("get_recipient_view", record: :once)  do
+          response = @client.get_recipient_view(
+            envelope_id: @envelope_response["envelopeId"],
+            name: 'jon',
+            email: 'someone@gmail.com',
+            return_url: 'http://google.com'
+          )
+          @view_recipient_response = JSON.parse(response.body)
+          puts @view_recipient_response["url"]
+        end
+      end
+
+    end
+
+  end
+
+end

data/test/docusign_rest/configuration_test.rb

@@ -0,0 +1,24 @@
+require 'helper'
+
+describe 'configuration' do
+  after do
+    DocusignRest.reset
+  end
+
+  describe '.configure' do
+    DocusignRest::Configuration::VALID_CONFIG_KEYS.each do |key|
+      it "should set the #{key}" do
+        DocusignRest.configure do |config|
+          config.send("#{key}=", key)
+          DocusignRest.send(key).must_equal key
+        end
+      end
+
+      describe '.key' do
+        it "should return default value for #{key}" do
+          DocusignRest.send(key).must_equal DocusignRest::Configuration.const_get("DEFAULT_#{key.upcase}")
+        end
+      end
+    end
+  end
+end

data/test/docusign_rest/docusign_rest_test.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+describe DocusignRest do
+  it "should have a version" do
+    DocusignRest::VERSION.wont_be_nil
+  end
+end

data/test/helper.rb

@@ -0,0 +1,12 @@
+require 'docusign_rest'
+require 'minitest/spec'
+require 'minitest/autorun'
+require 'turn'
+require 'json'
+require 'vcr'
+require 'docusign_login_config'
+
+VCR.configure do |c|
+  c.cassette_library_dir = "test/fixtures/vcr"
+  c.hook_into :fakeweb
+end

metadata

@@ -0,0 +1,200 @@
+--- !ruby/object:Gem::Specification
+name: docusign_rest
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Jon Kinney
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-06-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: multipart-post
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.1.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.1.5
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: turn
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: fakeweb
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Hooks a Rails app up to the DocuSign service through the DocuSign REST
+  API
+email:
+- jonkinney@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- docusign_rest.gemspec
+- example.rb
+- lib/docusign_rest.rb
+- lib/docusign_rest/client.rb
+- lib/docusign_rest/configuration.rb
+- lib/docusign_rest/railtie.rb
+- lib/docusign_rest/version.rb
+- lib/multipart_post/parts.rb
+- lib/tasks/docusign_task.rake
+- lib/tasks/docusign_task.rb
+- test.pdf
+- test/docusign_rest/client_test.rb
+- test/docusign_rest/configuration_test.rb
+- test/docusign_rest/docusign_rest_test.rb
+- test/helper.rb
+- test2.pdf
+homepage: https://github.com/j2fly/docusign_rest
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Use this gem to embed signing of documents in a Rails app through the DocuSign
+  REST API
+test_files:
+- test/docusign_rest/client_test.rb
+- test/docusign_rest/configuration_test.rb
+- test/docusign_rest/docusign_rest_test.rb
+- test/helper.rb