assently 1.0.0.beta1

data/lib/assently/id_generator.rb

@@ -0,0 +1,10 @@
+require "securerandom"
+
+module Assently
+  class IdGenerator
+
+    def self.generate
+      SecureRandom.uuid
+    end
+  end
+end

data/lib/assently/party.rb

@@ -0,0 +1,21 @@
+module Assently
+  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/assently/serializers/case_serializer.rb

@@ -0,0 +1,15 @@
+require "json"
+require "assently/api_mappers/case_mapper"
+require "assently/api_mappers/case_options_mapper"
+
+module Assently
+  module Serializers
+    module CaseSerializer
+      def self.serialize signature_case, options = {}
+        signature_case_api_hash = Assently::ApiMappers::CaseMapper.to_api signature_case
+        options_api_hash = Assently::ApiMappers::CaseOptionsMapper.to_api options
+        JSON.pretty_generate signature_case_api_hash.merge(options_api_hash)
+      end
+    end
+  end
+end

data/lib/assently/version.rb

@@ -0,0 +1,3 @@
+module Assently
+  VERSION = "1.0.0.beta1"
+end

data/lib/assently.rb

@@ -0,0 +1,14 @@
+require "assently/case"
+require "assently/client"
+require "assently/document"
+require "assently/form_field"
+require "assently/party"
+require "assently/id_generator"
+require "assently/version"
+require "assently/case_event_subscription"
+
+module Assently
+  def self.client api_key, api_secret, environment = :production
+    Client.new api_key, api_secret, environment
+  end
+end

data/spec/assently/api_mappers/case_event_subscription_mapper_spec.rb

@@ -0,0 +1,23 @@
+require "spec_helper"
+require "assently/case_event_subscription"
+require "assently/api_mappers/case_event_subscription_mapper"
+
+module Assently
+  module ApiMappers
+    RSpec.describe CaseEventSubscriptionMapper do
+      describe ".to_api" do
+        it "creates a hash that matches the api's expected format" do
+          case_event_subscription = CaseEventSubscription.new(
+            ["created", "sent"],
+            "http://example.com"
+          )
+
+          expect(CaseEventSubscriptionMapper.to_api(case_event_subscription)).to eq({
+            "Events" => ["created", "sent"],
+            "Url" => "http://example.com"
+          })
+        end
+      end
+    end
+  end
+end

data/spec/assently/api_mappers/case_mapper_spec.rb

@@ -0,0 +1,34 @@
+require "spec_helper"
+
+require "assently/case"
+require "assently/api_mappers/case_mapper"
+
+module Assently
+  module ApiMappers
+    RSpec.describe CaseMapper do
+      describe "#to_api" do
+        it "maps the case into an has that complies with the expected format" do
+          party = double "Party"
+          document = double "Document"
+
+          signature_case = Assently::Case.new "Agreement", ["electronicid"]
+          signature_case.add_party party
+          signature_case.add_document document
+
+          expect(Assently::ApiMappers::PartyMapper).to receive(:to_api).with(party).and_return(party: "on")
+          expect(Assently::ApiMappers::DocumentMapper).to receive(:to_api).with(document).and_return(document: "on")
+
+          api_hash = CaseMapper.to_api signature_case
+
+          expect(api_hash).to eq({
+            "Id" => signature_case.id,
+            "Name" => "Agreement",
+            "Documents" => [{ document: "on" }],
+            "Parties" => [{ party: "on" }],
+            "AllowedSignatureTypes" => ["electronicid"]
+          })
+        end
+      end
+    end
+  end
+end

data/spec/assently/api_mappers/case_options_mapper_spec.rb

@@ -0,0 +1,92 @@
+require "spec_helper"
+require "assently/api_mappers/case_options_mapper"
+
+module Assently
+  module ApiMappers
+    RSpec.describe CaseOptionsMapper do
+      describe "#to_api" do
+        it "translates event_callback to EventCallback object" do
+          event_callback = double "CaseEventSubscription", events: ["finished"], url: "http://example.com"
+          event_callback_representation = {
+            "EventCallback" => {
+              "Events" => ["finished"],
+              "Url" => "http://example.com"
+            }
+          }
+          expect(CaseOptionsMapper.to_api(event_callback: event_callback)).to eq(event_callback_representation)
+        end
+
+        it "translates cancel_url to CancelUrl" do
+          expect(CaseOptionsMapper.to_api(cancel_url: "http://example.com")).to eq({
+            "CancelUrl" => "http://example.com"
+          })
+        end
+
+        it "translates procedure to Procedure" do
+          expect(CaseOptionsMapper.to_api(procedure: "form")).to eq({
+            "Procedure" => "form"
+          })
+        end
+
+        describe "locale" do
+          it "translates locale to Culture allowing sv, fi and en" do
+            { "sv" => "sv-SE", "fi" => "fi-FI", "en" => "en-US" }.each do |key, locale|
+              expect(CaseOptionsMapper.to_api(locale: key)).to eq({
+                "Culture" => locale
+              })
+            end
+          end
+
+          it "raises an InvalidCaseOptionError for unkown locales" do
+            expect{ CaseOptionsMapper.to_api(locale: "unknown") }.to raise_error{
+              Assently::InvalidCaseOptionError
+            }
+          end
+        end
+
+        describe "continue" do
+          it "translates name" do
+            options = { continue: { name: "The label" } }
+
+            expect(CaseOptionsMapper.to_api(options)).to eq({
+              "ContinueName" => "The label"
+            })
+          end
+
+          it "translates url" do
+            options = { continue: { url: "http://example.com/where-to-go" } }
+
+            expect(CaseOptionsMapper.to_api(options)).to eq({
+              "ContinueUrl" => "http://example.com/where-to-go"
+            })
+          end
+
+          it "translates auto" do
+            options = { continue: { auto: true } }
+
+            expect(CaseOptionsMapper.to_api(options)).to eq({
+              "ContinueAuto" => true
+            })
+          end
+        end
+
+        it "ignores unknown keys" do
+          expect(CaseOptionsMapper.to_api({
+            locale: "sv",
+            unknown: "Some value"
+          })).to eq({
+            "Culture" => "sv-SE"
+          })
+        end
+      end
+
+      it "formats expire on date" do
+        expire_date = DateTime.new 2017,1,31
+
+        expect(CaseOptionsMapper.to_api({ expire_on: expire_date })).to eq({
+          "ExpireOn" => "2017-01-31T00:00:00+00:00"
+        })
+      end
+    end
+  end
+end

data/spec/assently/api_mappers/document_mapper_spec.rb

@@ -0,0 +1,35 @@
+require "spec_helper"
+require "assently/api_mappers/document_mapper"
+
+module Assently
+  module ApiMappers
+    RSpec.describe DocumentMapper do
+      describe ".to_api" do
+        it "creates a hash that matches the api's expected format" do
+          form_field = double "FormField"
+
+          document = double("Document", {
+            filename: "agreement.pdf",
+            size: 123,
+            data: "encoded-data",
+            content_type: "application/pdf",
+            form_fields: [form_field]
+          })
+
+          expect(Assently::ApiMappers::FormFieldMapper).to receive(:to_api).with(form_field).and_return({
+            name: "FieldKey",
+            value: "FieldValue"
+          })
+
+          expect(DocumentMapper.to_api(document)).to eq({
+            "Filename" => "agreement.pdf",
+            "Data" => "encoded-data",
+            "ContentType" => "application/pdf",
+            "Size" => 123,
+            "FormFields" => [{ name: "FieldKey", value: "FieldValue" }]
+          })
+        end
+      end
+    end
+  end
+end

data/spec/assently/api_mappers/form_field_mapper_spec.rb

@@ -0,0 +1,19 @@
+require "spec_helper"
+
+require "assently/api_mappers/form_field_mapper"
+require "assently/form_field"
+
+module Assently
+  module ApiMappers
+    RSpec.describe FormFieldMapper do
+      specify ".to_api" do
+        form_field = Assently::FormField.new "The name", "The Value"
+
+        expect(FormFieldMapper.to_api(form_field)).to eq({
+          "Name" => "The name",
+          "Value" => "The Value"
+        })
+      end
+    end
+  end
+end

data/spec/assently/api_mappers/party_mapper_spec.rb

@@ -0,0 +1,24 @@
+require "spec_helper"
+require "assently/api_mappers/party_mapper"
+
+module Assently
+  module ApiMappers
+    RSpec.describe PartyMapper do
+      describe ".to_api" do
+        it "creates a hash that matches the api's expected format" do
+          party = double("Party", {
+            name: "First Last",
+            email: "first-last@example.com",
+            social_security_number: "1234567890"
+          })
+
+          expect(PartyMapper.to_api(party)).to eq({
+            "Name" => "First Last",
+            "EmailAddress" => "first-last@example.com",
+            "SocialSecurityNumber" => "1234567890"
+          })
+        end
+      end
+    end
+  end
+end

data/spec/assently/case_event_subscription_spec.rb

@@ -0,0 +1,18 @@
+require "spec_helper"
+require "assently/case_event_subscription"
+
+module Assently
+  RSpec.describe CaseEventSubscription do
+    describe "events" do
+      it "accepts a valid event" do
+        case_event_subscription = CaseEventSubscription.new([CaseEventSubscription.events.first], 'http://test.com')
+
+        expect(case_event_subscription.events.first).to eq(CaseEventSubscription.events.first)
+      end
+
+      it "throws an error if it is an unknown event" do |variable|
+        expect{ CaseEventSubscription.new(['invalid_event'], 'http://test.com') }.to raise_error(ArgumentError)
+      end
+    end
+  end
+end

data/spec/assently/case_spec.rb

@@ -0,0 +1,68 @@
+require "spec_helper"
+require "assently/case"
+
+module Assently
+  RSpec.describe Case do
+    let :signature_case do
+      Case.new "Agreement", Case.signature_types
+    end
+
+    it "requires a name" do
+      expect(signature_case.name).to eq "Agreement"
+    end
+
+    describe "#id" do
+      it "creates a unique id" do
+        expect(Assently::IdGenerator).to receive(:generate).and_return "very-random"
+
+        expect(signature_case.id).to eq "very-random"
+      end
+
+      it "does not change the id after created" do
+        last_id = signature_case.id
+
+        expect(signature_case.id).to eq last_id
+      end
+
+      it "does not share id between instances" do
+        expect(signature_case.id).to_not eq Case.new("Agreement", Case.signature_types).id
+      end
+
+      it "can be overwritten on initialize" do
+        signature_case = Case.new "Agreement", Case.signature_types, id: "my-special-id"
+
+        expect(signature_case.id).to eq "my-special-id"
+      end
+    end
+
+    describe "signature types" do
+      it "requires at least one valid signature type" do
+        signature_case = Case.new "Agreement", Case.signature_types.first
+
+        expect(signature_case.signature_types).to eq [ Case.signature_types.first ]
+      end
+
+      it "throws an error if it is an unknown signature type" do
+        expect{ Case.new("Agreement", "unknown type") }.to raise_error(ArgumentError)
+      end
+    end
+
+    it "adds a party" do
+      signature_case = Case.new "Agreement", Case.signature_types
+
+      party = double "Party"
+      signature_case.add_party party
+
+      expect(signature_case.parties).to eq [party]
+    end
+
+    it "adds a document" do
+      signature_case = Case.new "Agreement", Case.signature_types
+
+      document = double "Document"
+      signature_case.add_document document
+
+      expect(signature_case.documents).to eq [document]
+    end
+  end
+end

data/spec/assently/client/create_case_spec.rb

@@ -0,0 +1,55 @@
+require "luhn"
+require "spec_helper"
+
+require "assently/client"
+require "assently/case"
+require "assently/document"
+require "assently/party"
+
+module Assently
+  describe Assently::Client do
+    describe "#create_case" do
+      let :client do
+        Assently::Client.new ENV["ASSENTLY_API_KEY"], ENV["ASSENTLY_API_KEY"], :test
+      end
+
+      it "sends the create case command with a json representation of the case" do
+        allow(client).to receive :post
+
+        signature_case = double "Case"
+        options = { locale: "sv" }
+
+        expect(Assently::Serializers::CaseSerializer).to receive(:serialize).with(signature_case, options).and_return "case-json"
+
+        client.create_case signature_case, options
+
+        expect(client).to have_received(:post).with "/api/v2/createcase", "case-json"
+      end
+
+      describe "with a valid case", vcr: { cassette_name: "Assently_Client/_create_case/valid_case" } do
+        it "returns a successful result object" do
+          signature_case = Assently::Case.new "Agreement", ["touch"]
+          signature_case.add_party Assently::Party.new_with_attributes({
+            name: "First Last",
+            email: "name@example.com",
+            social_security_number: Luhn::CivicNumber.generate
+          })
+          signature_case.add_document Assently::Document.new(File.join(Dir.pwd, "spec/fixtures/agreement.pdf"))
+
+          result = client.create_case(signature_case, {
+            continue: {
+              name: "Back to the site",
+              url: "http://example.com/thanks",
+              auto: true
+            },
+            cancel_url: "http://example.com/sorry",
+            procedure: "form",
+            locale: "sv"
+          })
+
+          expect(result.success?).to be true
+        end
+      end
+    end
+  end
+end

data/spec/assently/client/get_case_spec.rb

@@ -0,0 +1,84 @@
+require "luhn"
+require "securerandom"
+require "spec_helper"
+
+require "assently/client"
+require "assently/case"
+require "assently/document"
+require "assently/party"
+
+module Assently
+  describe Assently::Client do
+    let :client do
+      Assently::Client.new ENV["ASSENTLY_API_KEY"], ENV["ASSENTLY_API_SECRET"], :test
+    end
+
+    describe "#get_case" do
+      describe "with a case_id as argument" do
+        it "sends the getcase query with the case id json" do
+          allow(client).to receive :get
+
+          case_id = SecureRandom.uuid
+
+          client.get_case case_id
+
+          expect(client).to have_received(:get).with "/api/v2/getcase", id: case_id
+        end
+      end
+
+      describe "when the case exists", vcr: { cassette_name: "Assently_Client/_get_case/case_exists" } do
+        let (:case_id) { "my-case-id" }
+
+        before do
+          create_case case_id
+        end
+
+        describe "result" do
+          it "is successful" do
+            result = client.get_case case_id
+
+            expect(result.success?).to be true
+          end
+
+          it "has the url" do
+            result = client.get_case case_id
+
+            expect(result).to be_a Assently::Client::SuccessResult
+            expect(result.response["Parties"].first["PartyUrl"]).to match(/\Ahttps:\/\/test.assently.com\/c\/.*\z/)
+          end
+        end
+      end
+
+      describe "when there is no matching case" do
+        describe "result", vcr: { cassette_name: "Assently_Client/_get_case/case_missing" } do
+          it "is not successfull" do
+            result = client.get_case "missing-case"
+
+            expect(result.success?).to be false
+          end
+
+          it "has the error" do
+            result = client.get_case "missing-case"
+
+            expect(result.errors[0]).to eq "EX404 Not Found Request parameters may not be well formed"
+          end
+        end
+      end
+    end
+
+    private
+
+    def create_case case_id = nil
+      signature_case = Assently::Case.new "Agreement", ["touch"], id: case_id
+      signature_case.add_party Assently::Party.new_with_attributes({
+        name: "First Last",
+        email: "name@example.com",
+        social_security_number: Luhn::CivicNumber.generate
+      })
+      signature_case.add_document Assently::Document.new(File.join(Dir.pwd, "spec/fixtures/agreement.pdf"))
+
+      client.create_case signature_case
+    end
+  end
+end
+