egree 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 287435d353b123633d8604c827611f484fe7cef5
+  data.tar.gz: 4f9c098c0618ba59e22f7fdb54e00675cb348384
+SHA512:
+  metadata.gz: 35c1cf0ef2455e02360c8a1962981ab3f2319f27636450ed3c294f5c1d78f38ba1eb84f19bc3a9da3808259b1550ff3cfb30ae865aa600cb88dd09d789727222
+  data.tar.gz: b385eaa4872e5acafb3163ca74c5d692e7056725cbcaec488ded11794d882fd859eea601e24735aad13b71795d0c70eed3cc5f93039d124d242cc44d3918d16d

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,13 @@
+language: ruby
+rvm:
+- 2.1.0
+- 2.0.0
+script: rspec spec
+addons:
+  code_climate:
+    repo_token:
+      secure: Y3b1vSaq1qa9dMTbtftg1HzUrftWkx42F2yD/8ana0nUpg3b6xrvzx3LDiEPG1nLU4R7yk+KBr1dQH+skFl2LCJQpyfqwVvFhZz67S4a/8gQfYReTZDGJELMRP6HxbFbsSNisN11a3Kg3VIutBqyU9u1vSIMPx/o8ScvxVcAqHg=
+env:
+  global:
+  - secure: CPu3hIqPCA4txUqh7aS90PR7hGURzyoqcMu0zJx4qvrtvzsI9eyEWKx7P8pXbvYUIgaGevw5GiWEMYH2axkH/74KMyAL9DsdpDA06aCxdZfs7iEaNfZY+l4MN3WCFb9WoLVL7fG+wqgvZXnV4RyLkn+W+vjdmvjY8RZ9G7/0HiE=
+  - secure: WG67hclm6kFtNQRKa/a5j2R79n4cTq7WrI+sCaxq5Nr5jvstdamaIOPtaenX7fIIakBYhX1wtGqOvlEjUzF8IpLi/fwDjn1Cb8DP8oyLhK1koeLZhegiGV3hEsne7RNiV1G8VMHfsGeJBUm2wvsWx4EdK60Ib4+ZLuw5WFMVlNg=

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in egree.gemspec
+gemspec
+gem "codeclimate-test-reporter", group: :test, require: nil

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,72 @@
+[![Build Status](https://travis-ci.org/joeljunstrom/egree-ruby.svg?branch=master)](https://travis-ci.org/joeljunstrom/egree-ruby)
+[![Code Climate](https://codeclimate.com/github/joeljunstrom/egree-ruby/badges/gpa.svg)](https://codeclimate.com/github/joeljunstrom/egree-ruby)
+
+# Egree
+
+Ruby client for the [Egree API](https://app.egree.com/apiv1).
+
+Currently the only supported actions is the `createcasecommand` and `getviewcaseurlquery`.
+
+## Usage
+
+### Creating a case
+
+```
+  egree = Egree.client username, password
+
+  signature_case = Egree::Case.new "Agreement", ["touch"]
+  signature_case.add_party Egree::Party.new({
+    name: "First Last",
+    email: "name@example.com",
+    social_security_number: "1234567890"
+  })
+  signature_case.add_document Egree::Document.new "/some/path/file.pdf"
+
+  result = egree.create_case signature_case
+
+  if result.success?
+	puts "#{signature_case.reference_id} was created."
+  else 
+	puts "There was some issues with the case"
+	result.errors.each do |error|
+      puts error
+	end
+  end
+```
+
+### Getting the signature url for a case
+
+```
+  egree = Egree.client username, password
+  result = egree.get_case_url "98d08cf5-d35d-403b-ac31-fa1ac85037a1"
+
+  if result.success?
+	puts "The url is: #{result.response}"
+  else
+	puts "Could not get signature url"
+	result.errors.each do |error|
+      puts error
+	end
+  end
+```
+  
+
+
+## Contributing
+
+1. Fork it ( http://github.com/joeljunstrom/egree/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+### Local development
+
+Create a .env file in the root directory.
+
+```
+EGREE_USERNAME=your-username
+EGREE_PASSWORD=your-password
+```
+
+This is used for the integration tests.

data/Rakefile

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

data/egree.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'egree/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "egree"
+  spec.version       = Egree::VERSION
+  spec.authors       = ["Joel Junström"]
+  spec.email         = ["joel.junstrom@oktavilla.se"]
+  spec.summary       = %q{Client for the Egree API}
+  spec.homepage      = "https://github.com/joeljunstrom/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 "faraday", "~> 0.9.0"
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "dotenv", "~> 0.11.1"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "webmock", "~> 1.18.0"
+  spec.add_development_dependency "vcr", "~> 2.9.2"
+  spec.add_development_dependency "luhn", "~> 0.1.1"
+end

data/lib/egree.rb

@@ -0,0 +1,8 @@
+require "egree/version"
+require "egree/client"
+
+module Egree
+  def self.client username, password, environment = :production
+    Client.new username, password, environment
+  end
+end

data/lib/egree/case.rb

@@ -0,0 +1,64 @@
+require "egree/reference_id"
+require "egree/serializers/case"
+
+module Egree
+  class Case
+    def self.signature_types
+      [ "sms", "electronicId", "touch" ]
+    end
+
+    def self.generate_reference_id
+      ReferenceId.generate
+    end
+
+    attr_reader :name, :signature_types
+
+    def initialize name, signature_types
+      @name = name
+      self.signature_types = signature_types
+    end
+
+    attr_writer :reference_id
+
+    def reference_id
+      @reference_id ||= self.class.generate_reference_id
+    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
+
+    def to_json
+      Serializers::Case.serialize self
+    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/egree/client.rb

@@ -0,0 +1,103 @@
+require "json"
+require "faraday"
+
+module Egree
+  class Client
+    attr_reader :username, :password
+
+    attr_accessor :environment
+
+    def initialize username, password, environment = :production
+      @username = username
+      @password = password
+      self.environment = environment
+    end
+
+    def create_case signature_case
+      post "/apiv1/createcasecommand", signature_case.to_json
+    end
+
+    def get_case_url reference_id
+      post "/apiv1/getviewcaseurlquery", reference_id.to_json
+    end
+
+    def post api_command, body = nil
+      response = make_post api_command, body
+
+      if response.success?
+        SuccessResult.new parse_success_response(response.body)
+      else
+        ErrorResult.new parse_error_response(response.body)
+      end
+    end
+
+    def host
+      hosts.fetch(self.environment, hosts[:production])
+    end
+
+    def connection
+      Faraday.new "https://#{host}" do |conn|
+        conn.adapter :net_http
+        conn.headers["Accept"] = "application/json"
+        conn.basic_auth username, password
+      end
+    end
+
+    def headers
+      connection.headers
+    end
+
+    private
+
+    def make_post url, body
+      connection.post do |request|
+        request.url url
+        request.headers["Content-Type"] = "application/json; charset=utf-8"
+        request.body = body if body
+      end
+    end
+
+    def parse_success_response body
+      begin
+        JSON.parse body
+      rescue JSON::ParserError
+        body
+      end
+    end
+
+    def parse_error_response body
+      body.scan(/<p>(.*?)<\/p>/).flatten
+    end
+
+    def hosts
+      {
+        production: "app.egree.com",
+        test: "test.underskrift.se"
+      }
+    end
+
+    class SuccessResult
+      attr_reader :response
+
+      def initialize response
+        @response = response
+      end
+
+      def success?
+        true
+      end
+    end
+
+    class ErrorResult
+      attr_reader :errors
+
+      def initialize errors = []
+        @errors = Array(errors)
+      end
+
+      def success?
+        false
+      end
+    end
+  end
+end

data/lib/egree/document.rb

@@ -0,0 +1,45 @@
+require "open-uri"
+
+module Egree
+  class Document
+    attr_reader :path
+
+    def initialize path
+      @path = path
+    end
+
+    def 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
+      open path
+    end
+  end
+end

data/lib/egree/form_field.rb

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

data/lib/egree/party.rb

@@ -0,0 +1,21 @@
+module Egree
+  class Party
+    attr_accessor :name, :email
+    attr_reader :social_security_number
+
+    def self.new_with_attributes attributes = {}
+      party = self.new
+
+      attributes.each do |name, value|
+        assignment_method_name = "#{name}="
+        party.public_send(assignment_method_name, value) if party.respond_to?(assignment_method_name)
+      end
+
+      party
+    end
+
+    def social_security_number= social_security_number
+      @social_security_number = social_security_number.to_s.gsub(/\D/, "")
+    end
+  end
+end

data/lib/egree/reference_id.rb

@@ -0,0 +1,34 @@
+require "securerandom"
+require "egree/serializers/reference_id"
+
+module Egree
+  class ReferenceId
+    include Comparable
+
+    def self.generate
+      new SecureRandom.uuid
+    end
+
+    attr_reader :id
+
+    def initialize id
+      @id = id
+    end
+
+    def to_s
+      id.to_s
+    end
+
+    def to_json
+      Serializers::ReferenceId.serialize self
+    end
+
+    def to_api_hash
+      Serializers::ReferenceId.to_api_hash self
+    end
+
+    def <=> other
+      other.is_a?(self.class) && self.id <=> other.id
+    end
+  end
+end