assently 1.0.0.beta1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 933080f44f336e051125aa02137fbb9ce032f19b
+  data.tar.gz: 4ba7f86ccd3e8466e4926c10fa394f078f9cce25
+SHA512:
+  metadata.gz: 3862f68bb0b1756e8bfc6934dc0d8a7e07d4a7593dbd1551a42899489b80a444e644bc811d35080fe13613e62585276ba4c1b07b0763a6e9106b294f66ddf0aa
+  data.tar.gz: f8e1f8e5d1ef32f5bf33c8ab6852f2131bfcecbfadf445f319e8140db471f9ef3e28f1ff3906cd5a0bd57f9826580b1e683838aed1e199a1340a74abd9312a80

data/.gitignore

@@ -0,0 +1,20 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+.env
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+bin/
+.DS_Store

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--warnings
+--require spec_helper

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.4.0

data/.travis.yml

@@ -0,0 +1,15 @@
+language: ruby
+rvm:
+- 2.4.0
+- 2.3.3
+script: rspec spec
+addons:
+  code_climate:
+    repo_token:
+      secure: MYIsQJ3/wQ6xBYaWCwgG1HRyrH7MH4vME+ACEbM9poMun6jgvFu7Unc0eGpjMxzytophN5o7j0LTc6xxNCMCz6UGFK8Y7RP9/fii6bLFdqROS7jrxYf6tFwKXO4bAhhOZdZjyuYEFiRxImNHPXka+ap4vOnP/QW3D8l94lrAyoM=
+after_success:
+- bundle exec codeclimate-test-reporter
+env:
+  global:
+  - secure: NOH9DBJdldYSVadf2zAYPtP7Nke3k4rdrsXv2uBLelHwuZhmrRRprdgM2h3igheiq2j/OcbZSZeNgLMWY06A+RhxQzUOKUDBFcUs9QL23xgKFZcRi3YNqhhLC/LRXo4gmpL4J7OFJqMySTlaIWHRFqLJoFdoHTut3YKAChea4xE=
+  - secure: KQ/hQWZ1UTkbrfBUqy5qU/tw1YVpPSNtMnsNuammiBq9xJL2hkwIBiOwKmnC6rb48KhkCGCSmKU1CLvsqmAEncwF8vBXzrFPgQdg7JQN9Wn0gb2ESCnhfIP0rFfoKLZI9YVP3SB8YsfODlfNJwjKhAqsI6mCoQ/jN7yX8bvfnlM=

data/Gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :test do
+  gem "simplecov"
+  gem "codeclimate-test-reporter", "~> 1.0.0"
+  gem "pry"
+end
+

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Joel Junström
+
+MIT License
+
+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,124 @@
+[![Build Status](https://travis-ci.org/Oktavilla/egree-ruby.svg?branch=master)](https://travis-ci.org/Oktavilla/egree-ruby)
+[![Code Climate](https://codeclimate.com/github/Oktavilla/egree-ruby/badges/gpa.svg)](https://codeclimate.com/github/Oktavilla/egree-ruby)
+[![Test Coverage](https://codeclimate.com/github/Oktavilla/egree-ruby/badges/coverage.svg)](https://codeclimate.com/github/Oktavilla/egree-ruby)
+[![Gem Version](https://badge.fury.io/rb/egree.svg)](http://badge.fury.io/rb/egree)
+
+# Assently API Client
+
+Ruby client for the [Assently API v2](https://assently.com/). Check out [the official API documentation here](https://app.assently.com/api/).
+
+### Supported API calls 
+
+| API call   | Supported |
+|----------|:-------------:|
+| `createcase` | ✔️ |
+| `sendcase` | ✔️|
+| `getcase` | ✔️|
+| `createcasefromtemplate ` | |
+| `updatecase ` | |
+| `remindcase ` | |
+| `deletecase ` | |
+| `recallcase ` | |
+| `findcases ` | |
+| `findtemplates ` | |
+| `getdocumentdata ` | |
+| `createagent ` | |
+| `createssoticket ` | |
+
+Missing something? Contributions are very welcome! 😘 
+
+## Installation
+
+Include the gem in your `Gemfile`:
+
+```ruby
+gem "assently"
+```
+
+## Usage
+
+### Environment
+
+When creating a client instance you can choose to use either Assently's `production` (default when not specified) or `test` environment. The host `app.assently.com` is used for production and `test.assently.com` is used for test when constructing the API commands. Test environment is specified like this:
+
+```ruby
+Assently.client ENV["ASSENTLY_API_KEY"], ENV["ASSENTLY_API_SECRET"], :test
+```
+
+### Creating a case
+
+```ruby
+assently = Assently.client assently_api_key, assently_api_secret
+
+case_id = SecureRandom.uuid
+
+signature_case = Assently::Case.new "Agreement", ["electronicid"], id: case_id
+signature_case.add_party Assently::Party.new_with_attributes({
+  name: "First Last",
+  email: "name@example.com",
+  social_security_number: "1234567890"
+})
+signature_case.add_document Assently::Document.new "/some/path/file.pdf"
+
+event_subscription = Assently::CaseEventSubscription.new ["finished", "expired"], "https://example.com/my-endpoint"
+
+result = assently.create_case(signature_case, {
+  # Callback for document events
+  event_callback: event_subscription,
+  # User ends up here after finishing the signing process
+  continue: {
+    url: "http://example.com/user-endpoint",
+    auto: true
+  },
+  # User ends up here when cancelling, at the moment there is no cancel callback
+  cancel_url: "http://example.com/user-canceled"
+})
+
+if result.success?
+  puts "#{signature_case.id} was created."
+else 
+  puts "There was some issues with the case"
+  result.errors.each do |error|
+    puts error
+  end
+end
+```
+
+### Making a case available for signing
+
+```ruby
+assently = Assently.client API_KEY, API_SECRET
+result = assently.get_case case_id
+
+if result.success?
+  assently.send_case case_id
+  
+  signing_case = assently.get_case case_id
+  
+  puts "Sign it here: #{signing_case.response["Parties"].first["PartyUrl"]}"
+else
+  puts "Could not get signature url"
+  result.errors.each do |error|
+    puts error
+  end
+end
+```
+  
+### Local development
+
+Create a `.env` file in the root directory to run the integration tests against your Assently test environment.
+
+```sh
+ASSENTLY_API_KEY=your-api-key
+ASSENTLY_API_KEY=your-api-secret
+```
+
+
+## Contributing
+
+Contributions is more than welcome!
+
+Just create a fork and submit a pull request.
+
+Please adhere to the coding standards used in the project and add tests.
+

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/assently.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'assently/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "assently"
+  spec.version       = Assently::VERSION
+  spec.authors       = ["Joel Junström"]
+  spec.email         = ["joel.junstrom@oktavilla.se"]
+  spec.summary       = %q{Client for the Assently APIv2}
+  spec.homepage      = "https://github.com/Oktavilla/egree-ruby"
+  spec.license       = "MIT"
+
+  spec.required_ruby_version = "~> 2.0"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "http", "~> 2.2"
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "dotenv", "~> 2.1"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "webmock", "~> 2.3"
+  spec.add_development_dependency "vcr", "~> 3.0"
+  spec.add_development_dependency "luhn", "~> 1.0"
+end

data/lib/assently/api_mappers/case_event_subscription_mapper.rb

@@ -0,0 +1,12 @@
+module Assently
+  module ApiMappers
+    module CaseEventSubscriptionMapper
+      def self.to_api case_event_subscription
+        {
+          "Events" => case_event_subscription.events,
+          "Url" => case_event_subscription.url
+        }
+      end
+    end
+  end
+end

data/lib/assently/api_mappers/case_mapper.rb

@@ -0,0 +1,23 @@
+require "json"
+require "assently/api_mappers/party_mapper"
+require "assently/api_mappers/document_mapper"
+
+module Assently
+  module ApiMappers
+    module CaseMapper
+      def self.to_api signature_case
+        {
+          "Id" => signature_case.id,
+          "Name" => signature_case.name,
+          "Documents" => signature_case.documents.map { |document|
+            Assently::ApiMappers::DocumentMapper.to_api(document)
+          },
+          "Parties" => signature_case.parties.map { |party|
+            Assently::ApiMappers::PartyMapper.to_api(party)
+          },
+          "AllowedSignatureTypes" => signature_case.signature_types
+        }
+      end
+    end
+  end
+end

data/lib/assently/api_mappers/case_options_mapper.rb

@@ -0,0 +1,74 @@
+require "assently/api_mappers/case_event_subscription_mapper"
+
+module Assently
+  class InvalidCaseOptionError < ArgumentError; end
+
+  module ApiMappers
+    module CaseOptionsMapper
+      def self.to_api options = {}, mappers = self.mappers
+        options.reduce({}) do |api_hash, (client_key, value)|
+          if mappers.key?(client_key)
+            api_hash.merge(self.map(client_key, value, mappers))
+          else
+            api_hash
+          end
+        end || {}
+      end
+
+      private
+
+      LOCALES = ->(locale) {
+        {
+          "sv" => "sv-SE",
+          "fi" => "fi-FI",
+          "en" => "en-US"
+        }.fetch(locale) { raise Assently::InvalidCaseOptionError.new("Unknown locale: #{locale}") }
+      }
+
+      def self.map client_key, value, mappers = self.mappers
+        mapper = mappers[client_key]
+
+        if mapper.respond_to?(:call)
+          mapper.call value
+        else
+          { mapper => value }
+        end
+      end
+
+      def self.mappers
+        {
+          name_alias: "NameAlias",
+          agent_username: "AgentUsername",
+          visibility: "Visibility",
+          description: "Description",
+          send_sign_request_email_to_parties: "SendSignRequestEmailToParties",
+          send_finish_email_to_creator: "SendFinishEmailToCreator",
+          send_finish_email_to_parties: "SendFinishEmailToParties",
+          send_recall_email_to_parties: "SendRecallEmailToParties",
+          cancel_url: "CancelUrl",
+          procedure: "Procedure",
+          locale: ->(value) {
+            { "Culture" => LOCALES.call(value) }
+          },
+          continue: ->(options) {
+            CaseOptionsMapper.to_api options, name: "ContinueName", url: "ContinueUrl", auto: "ContinueAuto"
+          },
+          sign_in_sequence: "SignInSequence",
+          identity_check: "IdentityCheck",
+          merge_on_send: "MergeOnSend",
+          expire_after_days: "ExpireAfterDays",
+          expire_on: ->(value) {
+            { "ExpireOn" => value.iso8601 }
+          },
+          remind_ander_days: "RemindAfterDays",
+          template_id: "TemplateId",
+          is_editable: "IsEditable",
+          event_callback: ->(value) {
+            { "EventCallback" => CaseEventSubscriptionMapper.to_api(value) }
+          },
+          meta_data: "MetaData"
+        }
+      end
+    end
+  end
+end

data/lib/assently/api_mappers/document_mapper.rb

@@ -0,0 +1,19 @@
+require "assently/api_mappers/form_field_mapper"
+
+module Assently
+  module ApiMappers
+    module DocumentMapper
+      def self.to_api document
+        {
+          "Filename" => document.filename,
+          "Data" => document.data,
+          "ContentType" => document.content_type,
+          "Size" => document.size,
+          "FormFields" => document.form_fields.map { |form_field|
+            Assently::ApiMappers::FormFieldMapper.to_api(form_field)
+          }
+        }
+      end
+    end
+  end
+end

data/lib/assently/api_mappers/form_field_mapper.rb

@@ -0,0 +1,12 @@
+module Assently
+  module ApiMappers
+    module FormFieldMapper
+      def self.to_api form_field
+        {
+          "Name" => form_field.name,
+          "Value" => form_field.value
+        }
+      end
+    end
+  end
+end

data/lib/assently/api_mappers/party_mapper.rb

@@ -0,0 +1,13 @@
+module Assently
+  module ApiMappers
+    module PartyMapper
+      def self.to_api party
+        {
+          "Name" => party.name,
+          "EmailAddress" => party.email,
+          "SocialSecurityNumber" => party.social_security_number
+        }
+      end
+    end
+  end
+end

data/lib/assently/case.rb

@@ -0,0 +1,50 @@
+require "assently/id_generator"
+
+module Assently
+  class Case
+    def self.signature_types
+      [ "sms", "electronicid", "touch", "quickintent", "signbyhand" ]
+    end
+
+    attr_reader :name, :signature_types, :id
+
+    def initialize name, signature_types, id: nil
+      @name = name
+      @id = id || IdGenerator.generate
+      self.signature_types = signature_types
+    end
+
+    def signature_types= signature_types
+      types = Array(signature_types)
+
+      unknown_types = types - Case.signature_types
+      if unknown_types.any?
+        raise unknown_signature_type_error(unknown_types)
+      end
+
+      @signature_types = types
+    end
+
+    def add_party party
+      self.parties << party
+    end
+
+    def parties
+      @parties ||= []
+    end
+
+    def add_document document
+      self.documents << document
+    end
+
+    def documents
+      @documents ||= []
+    end
+
+    private
+
+    def unknown_signature_type_error types
+      ArgumentError.new("Unknown signature types: #{types.join(", ")}. Valid types are: #{Case.signature_types.join(", ")}")
+    end
+  end
+end

data/lib/assently/case_event_subscription.rb

@@ -0,0 +1,29 @@
+module Assently
+  class CaseEventSubscription
+    attr_reader :events, :url
+
+    def self.events
+      [ "created", "sent", "recalled", "finished", "rejected", "expired", "deleted", "signatureadded", "approvalrequested", "reminded" ]
+    end
+
+    def initialize(events, url)
+      self.events = events
+      @url = url
+    end
+
+    def events= events
+      unknown_events = events - CaseEventSubscription.events
+      if unknown_events.any?
+        raise unknown_event_error(unknown_events)
+      end
+
+      @events = events
+    end
+
+    private
+
+    def unknown_event_error events
+      ArgumentError.new("Unknown events: #{events.join(", ")}. Valid events are: #{CaseEventSubscription.events.join(", ")}")
+    end
+  end
+end

data/lib/assently/client.rb

@@ -0,0 +1,129 @@
+require "json"
+require "http"
+
+require "assently/serializers/case_serializer"
+
+module Assently
+  class Client
+    attr_reader :api_key, :api_secret
+
+    attr_accessor :environment
+
+    def initialize api_key, api_secret, environment = :production
+      @api_key = api_key
+      @api_secret = api_secret
+      self.environment = environment
+    end
+
+    def create_case signature_case, options = {}
+      signature_case_json = Assently::Serializers::CaseSerializer.serialize signature_case, options
+
+      post "/api/v2/createcase", signature_case_json
+    end
+
+    def send_case id
+      post "/api/v2/sendcase", JSON.pretty_generate({ id: id })
+    end
+
+    def get_case id
+      get "/api/v2/getcase", { id: id }
+    end
+
+    def post api_command, body = nil
+      make_response make_post(api_command, body)
+    end
+
+    def get api_command, parameters = {}
+      make_response make_get(api_command, parameters)
+    end
+
+    def host
+      hosts.fetch(self.environment, hosts[:production])
+    end
+
+    def connection
+      HTTP.
+        headers(accept: "application/json").
+        basic_auth(user: api_key, pass: api_secret)
+    end
+
+    def headers
+      connection.headers
+    end
+
+    private
+
+    def api_base_url
+      "https://#{host}"
+    end
+
+    def api_url path
+      URI.join(api_base_url, path)
+    end
+
+    def make_response response
+      if response.status.success?
+        SuccessResult.new response.body.to_s
+      else
+        ErrorResult.new response.body.to_s
+      end
+    end
+
+    def make_post path, body
+      connection.
+        headers(content_type: "application/json; charset=utf-8").
+        post api_url(path), body: body
+    end
+
+    def make_get path, parameters
+      connection.get api_url(path), params: parameters
+    end
+
+    def hosts
+      {
+        production: "app.assently.com",
+        test: "test.assently.com"
+      }
+    end
+
+    class SuccessResult
+      attr_reader :raw
+
+      def initialize response
+        @raw = response
+      end
+
+      def response
+        begin
+          JSON.parse raw
+        rescue JSON::ParserError
+          raw
+        end
+      end
+
+      def success?
+        true
+      end
+    end
+
+    class ErrorResult
+      attr_reader :raw
+
+      def initialize response
+        @raw = response
+      end
+
+      def errors
+        begin
+          Array(JSON.parse(raw)["error"].values.join(" "))
+        rescue JSON::ParserError
+          raw
+        end
+      end
+
+      def success?
+        false
+      end
+    end
+  end
+end

data/lib/assently/document.rb

@@ -0,0 +1,64 @@
+require "open-uri"
+require "base64"
+
+module Assently
+  class CouldNotFetchDocumentError < StandardError
+  end
+
+  class Document
+    attr_reader :path, :username, :password
+
+    def initialize path, filename: nil, username: nil, password: nil
+      @path = path
+      @filename = filename
+      @username = username
+      @password = password
+    end
+
+    def filename
+      @filename || File.basename(path)
+    end
+
+    def size
+      file.size
+    end
+
+    def content_type
+      "application/pdf"
+    end
+
+    def data
+      Base64.encode64 file_contents
+    end
+
+    def add_form_field form_field
+      self.form_fields << form_field
+    end
+
+    def form_fields
+      @form_fields ||= []
+    end
+
+    private
+
+    def file_contents
+      file.read
+    end
+
+    def file
+      begin
+        open path, authentication_params
+      rescue OpenURI::HTTPError => error
+        raise Assently::CouldNotFetchDocumentError.new("Could not get url #{path} (#{error.message})")
+      end
+    end
+
+    def authentication_params
+      if username && password
+        { http_basic_authentication: [ username, password ] }
+      else
+        {}
+      end
+    end
+  end
+end

data/lib/assently/form_field.rb

@@ -0,0 +1,3 @@
+module Assently
+  FormField = Struct.new :name, :value
+end