legalizer 0.2.2

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,10 @@
+source "http://rubygems.org"
+gem "json", ">= 1.4.6"
+gem "oauth", ">= 0.4.4"
+
+group :development do
+  gem "shoulda", ">= 0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.1"
+  gem "rcov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,24 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    git (1.2.5)
+    jeweler (1.5.1)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    json (1.4.6)
+    oauth (0.4.4)
+    rake (0.8.7)
+    rcov (0.9.9)
+    shoulda (2.11.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  jeweler (~> 1.5.1)
+  json (>= 1.4.6)
+  oauth (>= 0.4.4)
+  rcov
+  shoulda

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Darby Frey
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,73 @@
+= legalizer
+
+* http://github.com/darbyfrey/legalizer
+
+== DESCRIPTION:
+
+Legalizer is a simple API wrapper around the RightSignature document signature service.  It's still early in development, but you can:
+* Find and get details on Contracts
+* Search for available Templates
+* Prepare and send a contract for signature
+
+== EXAMPLES:
+
+Establish a connection:
+
+  legalizer = Legalizer({
+    :oauth_key => 'YOUR OAUTH KEY', 
+    :oauth_secret => 'YOUR OAUTH SECRET', 
+    :access_token => 'YOUR ACCESS TOKEN', 
+    :access_secret => 'YOUR ACCESS SECRET'})
+
+List all available templates:
+
+  legalizer.find.all_templates
+
+List recently created contracts:
+
+  legalizer.find.all_contracts
+
+You can also find a contract by RightSignature's document id:
+
+  legalizer.find.contract(id)
+
+Or template id
+
+  legalizer.find.template(id)
+
+Sending is simplified right now, but will be enhanced later. For now you can just send a template to an email address with these parameters:
+
+  template = legalizer.find.template(id)
+  template.send('SUBJECT LINE', 'SENDERS NAME', 'SENDERS EMAIL','RECIPIENTS NAME','RECIPIENTS EMAIL','TAG')
+
+== REQUIREMENTS:
+
+* oauth
+* json
+
+== INSTALL:
+
+* gem install leaglizer
+
+== LICENSE:
+
+Copyright (c) 2010 Darby Frey
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,53 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "legalizer"
+  gem.homepage = "http://github.com/darbyfrey/legalizer"
+  gem.license = "MIT"
+  gem.summary = %Q{A simple ruby wrapper around the RightSignature API}
+  gem.description = %Q{}
+  gem.email = "darbyfrey@gmail.com"
+  gem.authors = ["Darby Frey"]
+  # Include your dependencies below. Runtime dependencies are required when using your gem,
+  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
+  #  gem.add_runtime_dependency 'jabber4r', '> 0.1'
+  #  gem.add_development_dependency 'rspec', '> 1.2.3'
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "legalizer #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.2.2

data/legalizer.gemspec

@@ -0,0 +1,79 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{legalizer}
+  s.version = "0.2.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Darby Frey"]
+  s.date = %q{2010-12-07}
+  s.description = %q{}
+  s.email = %q{darbyfrey@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "legalizer.gemspec",
+    "lib/legalizer.rb",
+    "lib/legalizer/base.rb",
+    "lib/legalizer/config.rb",
+    "lib/legalizer/document.rb",
+    "lib/legalizer/document/contract.rb",
+    "lib/legalizer/document/template.rb",
+    "lib/legalizer/find.rb",
+    "script/console",
+    "script/destroy",
+    "script/generate",
+    "test/helper.rb",
+    "test/test_legalizer.rb"
+  ]
+  s.homepage = %q{http://github.com/darbyfrey/legalizer}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{A simple ruby wrapper around the RightSignature API}
+  s.test_files = [
+    "test/helper.rb",
+    "test/test_legalizer.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<json>, [">= 1.4.6"])
+      s.add_runtime_dependency(%q<oauth>, [">= 0.4.4"])
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.5.1"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+    else
+      s.add_dependency(%q<json>, [">= 1.4.6"])
+      s.add_dependency(%q<oauth>, [">= 0.4.4"])
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.5.1"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<json>, [">= 1.4.6"])
+    s.add_dependency(%q<oauth>, [">= 0.4.4"])
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.5.1"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+  end
+end
+

data/lib/legalizer.rb

@@ -0,0 +1,21 @@
+$:.unshift(File.dirname(__FILE__)) unless
+$:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+# require 'soap/wsdlDriver'
+require 'oauth'
+require 'json'
+require 'ostruct'
+
+module Legalizer
+  VERSION = '0.0.1'
+end
+
+require 'legalizer/base'
+require 'legalizer/config'
+require 'legalizer/find'
+require 'legalizer/document'
+require 'legalizer/document/template'
+require 'legalizer/document/contract'
+
+def Legalizer(options={})
+  Legalizer::Base.new(options)
+end

data/lib/legalizer/base.rb

@@ -0,0 +1,37 @@
+module Legalizer
+  class Base
+    def initialize(options={})
+      if options[:config].is_a? Legalizer::Config
+        @config = options[:config]
+        @connection = options[:config].connection
+        @token = options[:config].token
+      else
+        @config = Legalizer::Config.new(options)
+      end
+    end
+
+    def connection
+      @config.connection
+    end
+    
+    def token
+      @config.token
+    end
+
+    def config
+      @config
+    end
+
+    def templates
+      Legalizer::Template.new({:config => @config})
+    end
+
+    def contracts
+      Legalizer::Contract.new({:config => @config})
+    end
+
+    def find
+      Legalizer::Find.new({:config => @config})
+    end
+  end
+end

data/lib/legalizer/config.rb

@@ -0,0 +1,17 @@
+module Legalizer
+  class Config
+    attr_reader :connection, :token
+    def initialize(options={})
+      @connection = OAuth::Consumer.new(options[:oauth_key], options[:oauth_secret], {
+        :site               => "https://rightsignature.com",
+        :scheme             => :header,
+        :http_method        => :post,
+        :request_token_path => "/oauth/request_token",
+        :access_token_path  => "/oauth/access_token",
+        :authorize_path     => "/oauth/authorize"
+      })
+      
+      @token = OAuth::Token.new(options[:access_token], options[:access_secret])
+    end
+  end
+end

data/lib/legalizer/document.rb

@@ -0,0 +1,24 @@
+module Legalizer
+  class Document < Base
+    def initialize(options={})
+      super(options)
+      @source = options[:object]
+    end
+
+    def source
+      @source
+    end
+
+    def id
+      @source.documentKey
+    end
+
+    def to_s
+      @source.name
+    end
+
+    def to_struct
+      OpenStruct.new @source
+    end
+  end
+end

data/lib/legalizer/document/contract.rb

@@ -0,0 +1,8 @@
+module Legalizer
+  class Contract < Document
+    def initialize(options={})
+      super(options)
+      @source = options[:object]
+    end
+  end
+end

data/lib/legalizer/document/template.rb

@@ -0,0 +1,41 @@
+module Legalizer
+  class Template < Document
+    def initialize(options={})
+      super(options)
+      @source = options[:object]
+    end
+
+    def send(subject, sender_name, sender_email, recipient_name, recipient_email, tag)
+      template_guid = self.source["guid"]
+      package = @config.connection.request(:get, "/api/templates/#{template_guid}/prepackage.json", @config.token, {})
+      package_guid = JSON.parse(package.body)["template"]["guid"]
+      xml = build_xml(package_guid, subject, sender_name, sender_email, recipient_name, recipient_email, tag)
+      response = JSON.parse(@config.connection.request(:post, '/api/templates.json', @config.token, {}, xml, { 'Content-Type' => 'application/xml' }).body)
+      response["document"]["guid"]
+    end
+
+    private
+      def build_xml(guid, subject, sender_name, sender_email, recipient_name, recipient_email, tag)
+        "<template>
+          <guid>#{guid}</guid>
+          <subject>#{subject}</subject>
+          <action>send</action>
+          <roles>
+            <role role_name='Document Sender'>
+                <name>#{sender_name}</name>
+                <email>#{sender_email}</email>
+            </role>
+            <role role_name='Client'>
+                <name>#{recipient_name}</name>
+                <email>#{recipient_email}</email>
+            </role>
+          </roles>
+          <tags>
+              <tag>
+                  <value>#{tag}</value>
+              </tag>
+          </tags>
+        </template>"
+      end
+  end
+end

data/lib/legalizer/find.rb

@@ -0,0 +1,31 @@
+module Legalizer
+  class Find < Base
+    def contract(contract_id)
+      result = JSON.parse(@connection.request(:get, "/api/documents/#{contract_id}.json", @token, {}).body)["document"]
+      Legalizer::Contract.new({:config => @config, :object => result})
+    end
+
+    def all_contracts
+      contracts = []
+      result = JSON.parse(@connection.request(:get, '/api/documents.json', @token, {}).body)["page"]["documents"]
+      result.each do |contract|
+        contracts << Legalizer::Contract.new({:config => @config, :object => contract})
+      end
+      contracts
+    end
+
+    def template(template_id)
+      result = JSON.parse(@connection.request(:get, "/api/templates/#{template_id}.json", @token, {}).body)["template"]
+      Legalizer::Template.new({:config => @config, :object => result})
+    end
+
+    def all_templates
+      templates = []
+      result = JSON.parse(@connection.request(:get, '/api/templates.json', @token, {}).body)["templates"]
+      result.each do |contract|
+        templates << Legalizer::Template.new({:config => @config, :object => contract})
+      end
+      templates
+    end
+  end
+end

data/script/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# File: script/console
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+
+libs =  " -r irb/completion"
+# Perhaps use a console_lib to store any extra methods I may want available in the cosole
+# libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
+libs <<  " -r #{File.dirname(__FILE__) + '/../lib/legalizer.rb'}"
+puts "Loading legalizer gem"
+exec "#{irb} #{libs} --simple-prompt"

data/script/destroy

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/destroy'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Destroy.new.run(ARGV)

data/script/generate

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/generate'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Generate.new.run(ARGV)

data/test/helper.rb

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'legalizer'
+
+class Test::Unit::TestCase
+end

data/test/test_legalizer.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestLegalizer < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

metadata

@@ -0,0 +1,179 @@
+--- !ruby/object:Gem::Specification 
+name: legalizer
+version: !ruby/object:Gem::Version 
+  hash: 19
+  prerelease: false
+  segments: 
+  - 0
+  - 2
+  - 2
+  version: 0.2.2
+platform: ruby
+authors: 
+- Darby Frey
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-12-07 00:00:00 -06:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :runtime
+  name: json
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 11
+        segments: 
+        - 1
+        - 4
+        - 6
+        version: 1.4.6
+  requirement: *id001
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :runtime
+  name: oauth
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 0
+        - 4
+        - 4
+        version: 0.4.4
+  requirement: *id002
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :development
+  name: shoulda
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id003
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :development
+  name: bundler
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  requirement: *id004
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :development
+  name: jeweler
+  version_requirements: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 1
+        segments: 
+        - 1
+        - 5
+        - 1
+        version: 1.5.1
+  requirement: *id005
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :development
+  name: rcov
+  version_requirements: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id006
+description: ""
+email: darbyfrey@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- .document
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- legalizer.gemspec
+- lib/legalizer.rb
+- lib/legalizer/base.rb
+- lib/legalizer/config.rb
+- lib/legalizer/document.rb
+- lib/legalizer/document/contract.rb
+- lib/legalizer/document/template.rb
+- lib/legalizer/find.rb
+- script/console
+- script/destroy
+- script/generate
+- test/helper.rb
+- test/test_legalizer.rb
+has_rdoc: true
+homepage: http://github.com/darbyfrey/legalizer
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: A simple ruby wrapper around the RightSignature API
+test_files: 
+- test/helper.rb
+- test/test_legalizer.rb