esignlive 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 690f9fc0393b137aa929588d75311ffc286dca3f
+  data.tar.gz: 323c49e69175515eb0e8c24ada6f61ccb387723d
+SHA512:
+  metadata.gz: 05a7a8ce0cd291f2b9209184e8cf49cde51c42d3d78c6d9d403cdf73c7ee158678de97874afaf349d583e3fe8f829a921c4336877459db0993453d4e5b404c15
+  data.tar.gz: c3c702289879dd6e7bf04d8269832d7d578e233afa36438f08632269a2f535b61a0d1365f378e92f3570340823ac676ca32929864011674822c4e5e8faed1d92

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2016 Bo Jacobson
+
+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.md

@@ -0,0 +1,82 @@
+#eSignLive Client
+
+[![Build Status](https://travis-ci.org/bjacobson26/esignlive.svg?branch=master)](https://travis-ci.org/bjacobson26/esignlive)
+[![Code Climate](https://codeclimate.com/github/bjacobson26/esignlive/badges/gpa.svg)](https://codeclimate.com/github/bjacobson26/esignlive)
+
+## Usage
+
+###Create a client
+
+```ruby
+client = ESignLive::Client.new(api_key: your_api_key)
+```
+###Make some API calls
+
+#####Get all packages in your account
+```ruby
+packages = client.get_packages
+```
+
+#####Get a package:
+```ruby
+package = client.get_package(package_id: your_package_id)
+```
+#####API Calls
+- authentication_token(package_id:)
+- sender_authentication_token(package_id:)
+- signer_authentication_token(signer_id:,package_id:)
+- get_packages
+- get_package(package_id:)
+- get_signing_status(package_id:)
+- get_document(package_id: document_id:, pdf: false)
+- get_roles(package_id)
+- update_role_signer(package_id:, role_id:, email:, first_name:, last_name:)
+- create_package(opts={})
+- create_package_from_template(template_id:, opts: {})
+- send_package(package_id:)
+- signing_url(package_id:, role_id:)
+- remove_document_from_package(document_id:, package_id:)
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+  gem 'esignlive'
+```
+
+  And then execute:
+
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install esignlive
+```
+
+## Contributing
+####Submit a pull request
+
+1. Fork the repo.
+
+2. Push to your fork and submit a pull request.
+
+
+####Syntax:
+
+ - Two spaces, no tabs.
+ - No trailing whitespace. Blank lines should not have any space.
+ - Prefer &&, || over and, or.
+ - MyClass.my_method(my_arg) not my_method( my_arg ) or my_method my_arg.
+ - a = b and not a=b.
+ - Follow the conventions you see used in the source already.
+
+
+##TODO
+ - More API calls
+ - Tests
+
+## License
+  The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,34 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Esignlivefairy'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/lib/esignlive.rb

@@ -0,0 +1,4 @@
+require 'esignlive/client'
+module ESignLive
+  # Your code goes here...
+end

data/lib/esignlive/api/calls.rb

@@ -0,0 +1,176 @@
+require 'httparty'
+
+module ESignLive
+  module API
+    module Calls
+      URL = "https://sandbox.esignlive.com/api/packages"
+      AUTH_URL = "https://sandbox.esignlive.com/api/authenticationTokens"
+      SENDER_AUTH_URL = "https://sandbox.esignlive.com/api/senderAuthenticationTokens"
+      SIGNER_AUTH_URL = "https://sandbox.esignlive.com/api/signerAuthenticationTokens"
+      PACKAGE_DEFAULTS = {
+        name: "New Package #{Time.now}",
+        language: "en",
+        email_message: "Documents to sign!",
+        description: "Document(s) require your signature",
+        visibility: "ACCOUNT",
+        settings: {
+          ceremony: {
+            inPerson: false
+          }
+        },
+        autocomplete: true
+      }
+
+      def authentication_token(package_id:)
+        ::HTTParty.post(
+          AUTH_URL,
+          body: { packageId: package_id }.to_json,
+          headers: headers
+        ).parsed_response
+      end
+
+      def sender_authentication_token(package_id:)
+        ::HTTParty.post(
+          SENDER_AUTH_URL,
+          body: { packageId: package_id }.to_json,
+          headers: headers
+        ).parsed_response
+      end
+
+      def signer_authentication_token(signer_id:, package_id:)
+        ::HTTParty.post(
+          SIGNER_AUTH_URL,
+          body: {
+            signerId: signer_id,
+            sipackageId: package_id
+          }.to_json,
+          headers: headers
+        ).parsed_response
+      end
+
+      def get_packages
+        ::HTTParty.get(
+          URL,
+          headers: headers
+        ).parsed_response
+      end
+
+      def get_package(package_id:)
+        ::HTTParty.get(
+          "#{URL}/#{package_id}",
+          headers: headers
+        ).parsed_response
+      end
+
+      def get_signing_status(package_id:)
+        ::HTTParty.get(
+          "#{URL}/#{package_id}/signingStatus",
+          headers: headers
+        ).parsed_response
+      end
+
+      def get_document(package_id:, document_id:, pdf: false)
+        endpoint = "#{URL}/#{package_id}/documents/#{document_id}"
+        pdf ? url = "#{endpoint}/pdf" : url = endpoint
+        ::HTTParty.get(
+          url,
+          headers: headers
+        ).parsed_response
+      end
+
+      def get_roles(package_id:)
+        ::HTTParty.get(
+          "#{URL}/#{package_id}/roles",
+          headers: headers
+        ).parsed_response["results"]
+      end
+
+      def get_role(package_id:, role_id:)
+        ::HTTParty.get(
+          "#{URL}/#{package_id}/roles/#{role_id}",
+          headers: headers
+        ).parsed_response
+      end
+
+      def update_role_signer(package_id:, role_id:, email:, first_name:, last_name:)
+        body = {
+          signers: [
+            {
+              email: email,
+              firstName: first_name,
+              lastName: last_name
+            }
+          ]
+        }
+        ::HTTParty.put(
+         "#{URL}/#{package_id}/roles/#{role_id}",
+          body: body.to_json,
+          headers: headers
+        ).parsed_response
+      end
+
+      def create_package(opts: {})
+        body = package_hash(opts)
+        if opts[:sender].is_a? Hash
+          sender_hash = {
+            sender: {
+              lastName: sender_opts[:last_name],
+              firstName: sender_opts[:first_name],
+              email: sender_opts[:email]
+            }
+          }
+          body.merge!(sender_hash)
+        end
+        ::HTTParty.post(
+          URL,
+          body: body.to_json,
+          headers: headers
+        ).parsed_response
+      end
+
+      def create_package_from_template(template_id:, opts: {})
+        ::HTTParty.post(
+          "https://sandbox.esignlive.com/api/packages/#{template_id}/clone",
+          headers: headers,
+          body: package_hash(opts).to_json
+        ).parsed_response
+      end
+
+      def send_package(package_id:)
+        ::HTTParty.post(
+          "#{URL}/#{package_id}",
+          body: { status: "SENT" }.to_json,
+          headers: headers
+        )
+        true
+      end
+
+      def remove_document_from_package(document_id:, package_id:)
+        ::HTTParty.delete(
+          "#{URL}/#{package_id}/documents/#{document_id}",
+          headers: headers
+        ).parsed_response
+      end
+
+      def signing_url(package_id:, role_id:)
+        ::HTTParty.get(
+          "#{URL}/#{package_id}/roles/#{role_id}/signingUrl",
+          headers: headers
+        ).parsed_response["url"]
+      end
+
+      def package_hash(opts)
+        {
+          type: "PACKAGE",
+          name:         opts[:name]          || PACKAGE_DEFAULTS[:name],
+          language:     opts[:language]      || PACKAGE_DEFAULTS[:language],
+          emailMessage: opts[:email_message] || PACKAGE_DEFAULTS[:email_message],
+          description:  opts[:description]   || PACKAGE_DEFAULTS[:description],
+          autocomplete: opts[:autocomplete]  || PACKAGE_DEFAULTS[:autocomplete],
+          settings:     opts[:settings]      || PACKAGE_DEFAULTS[:settings],
+          visibility:   opts[:visibility]    || PACKAGE_DEFAULTS[:visibility]
+        }
+      end
+    end
+  end
+end

data/lib/esignlive/client.rb

@@ -0,0 +1,22 @@
+require 'esignlive/api/calls'
+
+module ESignLive
+  class Client
+    include ESignLive::API::Calls
+
+    attr_reader :headers
+
+    def initialize(api_key:)
+      @headers = create_headers(api_key)
+    end
+
+    private
+
+    def create_headers(api_key)
+      {
+        'Content-Type' => 'application/json',
+        'Authorization' => "Basic #{api_key}"
+      }
+    end
+  end
+end

data/lib/esignlive/version.rb

@@ -0,0 +1,3 @@
+module ESignLive
+  VERSION = '0.1.1'
+end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification
+name: esignlive
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Bo Jacobson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-10-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+description: A Ruby interface to the eSignLive REST API
+email:
+- bjacobson26@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/esignlive.rb
+- lib/esignlive/api/calls.rb
+- lib/esignlive/client.rb
+- lib/esignlive/version.rb
+homepage: https://github.com/bjacobson26/esignlive
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: A Ruby client for eSignLive's REST API
+test_files: []