paperlex 0.9.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2011 Paperlex, LLC.
+
+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,37 @@
+= Paperlex
+
+Read more at https://sandbox.api.paperlex.com.
+
+    require 'rubygems'
+    require 'paperlex'
+    
+    Paperlex.token = "b53b0c15dce176b4"
+    
+    templates =  Paperlex::Slaw.all
+    
+    nda_template = templates.first
+    
+    contract = Paperlex::Contract.create({
+      :slaw_id => nda_template.uuid,
+      :subject => "My First NDA",
+      :number_of_signers => 2,
+      :responses => {
+        :party_a => "John Smith",
+        :party_b => "Jane Smith",
+        :party_a_address => "john_smith@example.com",
+        :party_b_address => "jane_smith@example.com",
+        :confidential_duration => "1 year"
+      }
+    })
+    
+    contract.responses[:confidential_duration] = "2 years"
+    contract.responses[:state] = "New York"
+    
+    contract.save_responses
+    
+    contract.create_signer(:email => "john_smith@example.com")
+    contract.create_signer(:email => "jane_smith@example.com")
+    
+    review_session = contract.create_review_session(:email => "john_smith@example.com", :expires_in => 172800)
+    
+    puts "URL: #{review_session.url}"

data/Rakefile

@@ -0,0 +1,34 @@
+#!/usr/bin/env rake
+
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new do |t|
+  t.pattern = "./spec/**/*_spec.rb"
+end
+
+
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'PaperlexApiClient'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+task :default => :spec
+
+Bundler::GemHelper.install_tasks

data/lib/paperlex/base/base.rb

@@ -0,0 +1,39 @@
+module Paperlex
+  class Base < Hashie::Dash
+    property :uuid, :required => true
+
+    class << self
+      def parse(result)
+        if result == "null"
+          nil
+        else
+          JSON.parse(result)
+        end
+      end
+
+      def get(url, *attrs)
+        parse(RestClient.get("#{Paperlex.base_url}/#{url}?token=#{Paperlex.token}", *attrs))
+      end
+
+      def post(url, attrs = {})
+        parse(RestClient.post("#{Paperlex.base_url}/#{url}", attrs.merge(:token => Paperlex.token)))
+      end
+
+      def put(url, attrs = {})
+        parse(RestClient.put("#{Paperlex.base_url}/#{url}", attrs.merge(:token => Paperlex.token)))
+      end
+
+      def delete(url, attrs = {})
+        parse(RestClient.delete("#{Paperlex.base_url}/#{url}", attrs.merge(:token => Paperlex.token)))
+      end
+    end
+
+    def initialize(uuid, attrs = {})
+      super(uuid.is_a?(Hash) ? uuid.merge(attrs) : attrs.merge(:uuid => uuid))
+    end
+
+    def to_uuid(object)
+      object.respond_to?(:uuid) ? object.uuid : object
+    end
+  end
+end

data/lib/paperlex/base/root_object.rb

@@ -0,0 +1,33 @@
+module Paperlex
+  module RootObject
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      def collection_url
+        "#{url_name}.json"
+      end
+
+      def url_for(uuid)
+        "#{url_name}/#{uuid}.json"
+      end
+
+      def all
+        get(collection_url).map {|attrs| new(attrs) }
+      end
+
+      def find(uuid)
+        new(get(url_for(uuid)))
+      end
+    end
+
+    def to_html
+      RestClient.get(html_url(responses))
+    end
+
+    def save!(fields = nil)
+      fields ||= self.class.update_fields
+      self.class.put(self.class.url_for(uuid), short_name => Hash[fields.map {|field| [field, self[field]]}])
+      self
+    end
+  end
+end

data/lib/paperlex/base/sub_object.rb

@@ -0,0 +1,45 @@
+module Paperlex
+  module SubObject
+    extend ActiveSupport::Concern
+
+    included do
+      attr_reader :contract_uuid
+    end
+
+    module ClassMethods
+      def [](parent_uuid)
+        new(parent_uuid)
+      end
+    end
+
+    def initialize(contract_uuid)
+      @contract_uuid = contract_uuid
+    end
+
+    def new_object(attrs)
+      object_class.new(attrs.merge(:contract_uuid => contract_uuid))
+    end
+
+    def all
+      self.class.get(collection_url)
+    end
+
+    def create(attrs = {})
+      attrs.symbolize_keys!
+      attrs.assert_valid_keys(self.class.create_fields)
+      new_object(self.class.post(collection_url, short_name => attrs))
+    end
+
+    def find(uuid)
+      new_object(self.class.get(url_for(uuid)))
+    end
+
+    def update(uuid, attrs)
+      new_object(self.class.put(url_for(uuid), short_name => attrs))
+    end
+
+    def destroy(uuid)
+      self.class.delete(url_for(uuid))
+    end
+  end
+end

data/lib/paperlex/contract/responses.rb

@@ -0,0 +1,47 @@
+module Paperlex
+  class Contract < Base
+    class Responses < Base
+      attr_reader :contract_uuid
+
+      class << self
+        def [](contract_uuid)
+          new(contract_uuid)
+        end
+      end
+
+      def initialize(contract_uuid)
+        @contract_uuid = contract_uuid
+      end
+
+      def all
+        self.class.get(collection_url)
+      end
+
+      def update_all(responses)
+        self.class.post(collection_url, {:responses => responses})
+      end
+
+      def find(key)
+        self.class.get(url_for(key)).first
+      end
+
+      def update(key, value)
+        self.class.put(url_for(key), {:value => value})
+      end
+
+      def destroy(key)
+        self.class.delete(url_for(key))
+      end
+
+      private
+
+      def collection_url
+        "contracts/#{contract_uuid}/responses.json"
+      end
+
+      def url_for(key)
+        "contracts/#{contract_uuid}/responses/#{key}.json"
+      end
+    end
+  end
+end

data/lib/paperlex/contract/review_sessions.rb

@@ -0,0 +1,31 @@
+module Paperlex
+  class Contract < Base
+    class ReviewSessions < Paperlex::Base
+      include SubObject
+
+      class << self
+        def create_fields
+          [:email, :expires_at, :expires_in]
+        end
+      end
+
+      def object_class
+        Paperlex::ReviewSession
+      end
+
+      def short_name
+        :review_session
+      end
+
+      private
+
+      def collection_url
+        "contracts/#{contract_uuid}/review_sessions.json"
+      end
+
+      def url_for(uuid)
+        "contracts/#{contract_uuid}/review_sessions/#{to_uuid(uuid)}.json"
+      end
+    end
+  end
+end

data/lib/paperlex/contract/signers.rb

@@ -0,0 +1,31 @@
+module Paperlex
+  class Contract < Base
+    class Signers < Paperlex::Base
+      include SubObject
+
+      class << self
+        def create_fields
+          [:email]
+        end
+      end
+
+      def object_class
+        Paperlex::Signer
+      end
+
+      def short_name
+        :signer
+      end
+
+      private
+
+      def collection_url
+        "contracts/#{contract_uuid}/signers.json"
+      end
+
+      def url_for(uuid)
+        "contracts/#{contract_uuid}/signers/#{to_uuid(uuid)}.json"
+      end
+    end
+  end
+end

data/lib/paperlex/contract/versions.rb

@@ -0,0 +1,9 @@
+module Paperlex
+  class Contract < Base
+    class Versions < Paperlex::Versions
+      def base
+        'contracts'
+      end
+    end
+  end
+end

data/lib/paperlex/contract.rb

@@ -0,0 +1,190 @@
+module Paperlex
+  class Contract < Base
+    include RootObject
+
+    extend ActiveSupport::Autoload
+    autoload :Signers
+    autoload :Responses
+    autoload :ReviewSessions
+    autoload :Versions
+
+    # Provided by index
+    property :created_at
+    property :updated_at
+    property :subject
+
+    # Provided by show
+    property :body
+    property :current_version
+    property :locked
+    property :number_of_signers
+    property :number_of_identity_verifications
+    property :responses
+    property :signers
+    property :signatures
+    property :signature_callback_url
+    property :review_sessions
+
+    class << self
+      def update_fields
+        [:subject, :number_of_signers, :responses, :signature_callback_url, :body]
+      end
+
+      def create_fields
+        [*update_fields] << :slaw_id
+      end
+
+      def url_name
+        "contracts"
+      end
+
+      def create(attrs = {})
+        attrs.symbolize_keys!
+        signers = attrs.delete(:signers)
+        attrs.assert_valid_keys(create_fields)
+        result = new(post("contracts.json", :contract => attrs))
+        if signers.present?
+          signers.each do |email|
+            result.create_signer(:email => email)
+          end
+        end
+        result
+      end
+    end
+
+    def html_url
+      "#{Paperlex.base_url}/contracts/#{uuid}.html?#{{:token => Paperlex.token}.to_query}"
+    end
+
+    # Signers
+    def signers=(signers)
+      self[:signers] = signers.map {|signer| signer.is_a?(Paperlex::Signer) ? signer : Paperlex::Signer.new(signer.merge(:contract_uuid => uuid)) }
+    end
+
+    def create_signer(attrs = {})
+      signer = Signers[uuid].create(attrs)
+      self.signers << signer
+      signer
+    end
+
+    def fetch_signers
+      self.signers = Signers[uuid].all
+      signers
+    end
+
+    def fetch_signer(signer)
+      remove_signer!(signer)
+      new_signer = Signers[uuid].find(signer)
+      self.signers << new_signer
+      new_signer
+    end
+
+    def update_signer(signer, attrs)
+      remove_signer!(signer)
+      updated_signer = Signers[uuid].update(signer, attrs)
+      self.signers << updated_signer
+      updated_signer
+    end
+
+    def delete_signer(signer)
+      remove_signer!(signer)
+      Signers[uuid].destroy(signer)
+    end
+
+    # Review Sessions
+    def review_sessions=(review_sessions)
+      self[:review_sessions] = review_sessions.map {|session| session.is_a?(Paperlex::ReviewSession) ? session : Paperlex::ReviewSession.new(session.merge(:contract_uuid => uuid)) }
+    end
+
+    def review_sessions
+      self[:review_sessions] ||= []
+    end
+
+    def create_review_session(attrs = {})
+      session = ReviewSessions[uuid].create(attrs)
+      self.review_sessions << session
+      session
+    end
+
+    def fetch_review_sessions
+      self.review_sessions = ReviewSessions[uuid].all
+      review_sessions
+    end
+
+    def fetch_review_session(review_session_uuid)
+      remove_review_session!(review_session_uuid)
+      new_session = ReviewSessions[uuid].find(review_session_uuid)
+      self.review_sessions << new_session
+      new_session
+    end
+
+    def update_review_session(review_session_uuid, attrs)
+      remove_review_session!(review_session_uuid)
+      updated_session = ReviewSessions[uuid].update(review_session_uuid, attrs)
+      self.review_sessions << updated_session
+      updated_session
+    end
+
+    def delete_review_session(review_session_uuid)
+      remove_review_session!(review_session_uuid)
+      ReviewSessions[uuid].destroy(review_session_uuid)
+    end
+
+    # Versions
+    def versions
+      Versions[uuid].all.map {|version| Version.new(version) }
+    end
+
+    def at_version(version_index)
+      self.class.new(Versions[uuid].find(version_index))
+    end
+    alias_method :version_at, :at_version
+
+    def revert_to_version(version_index)
+      self.class.new(Versions[uuid].revert_to(version_index))
+    end
+
+    # Responses
+    def responses
+      self[:responses] ||= {}
+    end
+
+    def fetch_responses
+      self.responses = Responses[uuid].all
+    end
+
+    def fetch_response(key)
+      self.responses[key] = Responses[uuid].find(key)
+    end
+
+    def save_responses
+      Responses[uuid].update_all(responses)
+    end
+
+    def save_response(key)
+      Responses[uuid].update(key, responses[key])
+    end
+
+    def delete_response(key)
+      Responses[uuid].destroy(key)
+      self.responses.delete(key)
+      responses
+    end
+
+    private
+
+    def short_name
+      :contract
+    end
+
+    def remove_signer!(signer_to_remove)
+      signer_uuid = to_uuid(signer_to_remove)
+      signers.delete_if {|signer| signer['uuid'] == signer_uuid }
+    end
+
+    def remove_review_session!(review_session_to_remove)
+      review_session_uuid = to_uuid(review_session_to_remove)
+      review_sessions.delete_if {|review_session| review_session['uuid'] == review_session_uuid }
+    end
+  end
+end

data/lib/paperlex/review_session.rb

@@ -0,0 +1,9 @@
+module Paperlex
+  class ReviewSession < Base
+    property :expires_at, :required => true
+    property :token, :required => true
+    property :url, :required => true
+    property :email, :required => true
+    property :contract_uuid, :required => true
+  end
+end

data/lib/paperlex/signer.rb

@@ -0,0 +1,6 @@
+module Paperlex
+  class Signer < Base
+    property :contract_uuid, :required => true
+    property :email, :required => true
+  end
+end

data/lib/paperlex/slaw/versions.rb

@@ -0,0 +1,9 @@
+module Paperlex
+  class Slaw < Base
+    class Versions < Paperlex::Versions
+      def base
+        'slaws'
+      end
+    end
+  end
+end

data/lib/paperlex/slaw.rb

@@ -0,0 +1,62 @@
+module Paperlex
+  class Slaw < Base
+    include RootObject
+
+    extend ActiveSupport::Autoload
+    autoload :Versions
+
+    property :public
+    property :name
+    property :description
+    property :body
+    property :response_keys
+
+    class << self
+      def url_name
+        "slaws"
+      end
+
+      def update_fields
+        [:name, :body, :description]
+      end
+      alias :create_fields :update_fields
+
+      def create(attrs = {})
+        attrs.symbolize_keys!
+        attrs.assert_valid_keys(create_fields)
+        attrs = post(collection_url, :slaw => attrs)
+        new(attrs)
+      end
+    end
+
+    def html_url(responses)
+      params = {:token => Paperlex.token}
+      params[:responses] = responses if responses.present?
+      "#{Paperlex.base_url}/slaws/#{uuid}.html?#{params.to_query}"
+    end
+
+    def destroy
+      self.class.delete(self.class.url_for(uuid))
+    end
+
+    # Versions
+    def versions
+      Paperlex::Slaw::Versions[uuid].all.map {|version| Version.new(version) }
+    end
+
+    def at_version(version_index)
+      self.class.new(Paperlex::Slaw::Versions[uuid].find(version_index))
+    end
+    alias_method :version_at, :at_version
+
+    def revert_to_version(version_index)
+      self.class.new(Paperlex::Slaw::Versions[uuid].revert_to(version_index))
+    end
+
+    private
+
+    def short_name
+      :slaw
+    end
+  end
+end

data/lib/paperlex/version.rb

@@ -0,0 +1,3 @@
+module Paperlex
+  VERSION = "0.9.1"
+end

data/lib/paperlex/versions.rb

@@ -0,0 +1,37 @@
+module Paperlex
+  class Versions < Base
+    class << self
+      def [](uuid)
+        new(uuid)
+      end
+    end
+
+    attr_reader :uuid
+
+    def initialize(uuid)
+      @uuid = uuid
+    end
+
+    def all
+      self.class.get(collection_url)
+    end
+
+    def find(version_index)
+      self.class.get(url_for(version_index))
+    end
+
+    def revert_to(version_index)
+      self.class.post("#{base}/#{uuid}/versions/#{version_index}/revert.json")
+    end
+
+    private
+
+    def collection_url
+      "#{base}/#{uuid}/versions.json"
+    end
+
+    def url_for(version_index)
+      "#{base}/#{uuid}/versions/#{version_index}.json"
+    end
+  end
+end

data/lib/paperlex.rb

@@ -0,0 +1,44 @@
+require 'active_support/dependencies/autoload'
+require 'active_support/concern'
+require 'active_support/core_ext/module/delegation'
+require 'active_support/core_ext/hash/keys'
+require 'active_support/core_ext/object/to_query'
+require 'active_support/core_ext/object/blank'
+require 'hashie/dash'
+require 'rest-client'
+require 'json'
+require 'configatron'
+
+module Paperlex
+  extend ActiveSupport::Autoload
+
+  autoload_under 'base' do
+    autoload :Base
+    autoload :RootObject
+    autoload :SubObject
+  end
+  autoload :Contract
+  autoload :Slaw
+  autoload :ReviewSession
+  autoload :Signer
+  autoload :Versions
+
+  class Version < Hashie::Dash
+    property :version, :required => true
+    property :event, :required => true
+  end
+
+  SANDBOX_URL = 'https://sandbox.api.paperlex.com/v1'
+  LIVE_URL = 'https://api.paperlex.com/v1'
+
+  class << self
+    delegate :configure_from_hash, :base_url, :token, :base_url=, :token=, :to => :configatron
+
+    def live!
+      self.base_url = LIVE_URL
+    end
+  end
+
+  configatron.set_default(:base_url, SANDBOX_URL)
+  configatron.set_default(:token, nil)
+end

data/lib/paperlex_api_client.rb

@@ -0,0 +1 @@
+require 'paperlex'

data/lib/tasks/paperlex_api_client_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :paperlex_api_client do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,153 @@
+--- !ruby/object:Gem::Specification
+name: paperlex
+version: !ruby/object:Gem::Version
+  version: 0.9.1
+  prerelease: 
+platform: ruby
+authors:
+- Paperlex
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-11-30 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: &70306626911860 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70306626911860
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: &70306626908260 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70306626908260
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: &70306626907380 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70306626907380
+- !ruby/object:Gem::Dependency
+  name: configatron
+  requirement: &70306626904780 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70306626904780
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &70306626903080 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *70306626903080
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70306626901940 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70306626901940
+- !ruby/object:Gem::Dependency
+  name: faker
+  requirement: &70306626900680 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70306626900680
+- !ruby/object:Gem::Dependency
+  name: fakeweb
+  requirement: &70306626899580 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70306626899580
+description: Dead-simple Legal Documents
+email:
+- api-help@paperlex.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/paperlex/base/base.rb
+- lib/paperlex/base/root_object.rb
+- lib/paperlex/base/sub_object.rb
+- lib/paperlex/contract/responses.rb
+- lib/paperlex/contract/review_sessions.rb
+- lib/paperlex/contract/signers.rb
+- lib/paperlex/contract/versions.rb
+- lib/paperlex/contract.rb
+- lib/paperlex/review_session.rb
+- lib/paperlex/signer.rb
+- lib/paperlex/slaw/versions.rb
+- lib/paperlex/slaw.rb
+- lib/paperlex/version.rb
+- lib/paperlex/versions.rb
+- lib/paperlex.rb
+- lib/paperlex_api_client.rb
+- lib/tasks/paperlex_api_client_tasks.rake
+- MIT-LICENSE
+- Rakefile
+- README.rdoc
+homepage: https://api.paperlex.com/
+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.10
+signing_key: 
+specification_version: 3
+summary: A Paperlex API client in Ruby
+test_files: []