smartwaiver-sdk 4.0.0 → 4.2.0

data/spec/smartwaiver-sdk/keys_client_spec.rb

@@ -0,0 +1,41 @@
+dir = File.dirname(__FILE__)
+require "#{dir}/../spec_helper"
+require "#{dir}/../../lib/smartwaiver-sdk/keys_client"
+
+describe SmartwaiverKeysClient do
+  attr_reader :client, :api_key
+
+  before do
+    FakeWeb.allow_net_connect = false
+    @api_key = "apikey"
+    @client = SmartwaiverKeysClient.new(@api_key)
+  end
+
+  describe "keys" do
+    it "#initialize" do
+      expect(@client).to be_kind_of(SmartwaiverKeysClient)
+    end
+
+    it "#create" do
+      label = 'Ruby SDK'
+
+      path="#{API_URL}/v4/keys/published"
+      FakeWeb.register_uri(:post, path, :body => json_keys_create_results)
+
+      response = @client.create(label)
+      expect(response[:published_keys][:newKey][:key]).to eq("SPoyAc7mNHK8L6Yaq2s2Bu8UMcBEoyTvDeizmj94p6")
+      expect(response[:published_keys][:newKey][:label]).to eq(label)
+      expect(response[:published_keys][:keys].length).to eq(1)
+    end
+
+    it "#list" do
+      path="#{API_URL}/v4/keys/published"
+      FakeWeb.register_uri(:get, path, :body => json_keys_list_results)
+
+      response = @client.list
+      expect(response[:published_keys][:keys].length).to eq(1)
+      expect(response[:published_keys][:keys][0][:key]).to eq("SPoyAc7mNHK8L6Yaq2s2Bu8UMcBEoyTvDeizmj94p6")
+      expect(response[:published_keys][:keys][0][:label]).to eq("Ruby SDK")
+    end
+  end
+end

data/spec/smartwaiver-sdk/search_client_spec.rb

@@ -0,0 +1,55 @@
+dir = File.dirname(__FILE__)
+require "#{dir}/../spec_helper"
+require "#{dir}/../../lib/smartwaiver-sdk/search_client"
+
+describe SmartwaiverSearchClient do
+  attr_reader :client, :api_key
+
+  before do
+    FakeWeb.allow_net_connect = false
+    @api_key = "apikey"
+    @client = SmartwaiverSearchClient.new(@api_key)
+  end
+
+  describe "keys" do
+    it "#initialize" do
+      expect(@client).to be_kind_of(SmartwaiverSearchClient)
+    end
+
+    it "#search empty" do
+      path="#{API_URL}/v4/search"
+      FakeWeb.register_uri(:get, path, :body => json_search_1_results)
+
+      response = @client.search()
+
+      expect(response[:search][:guid]).to eq("6jebdfxzvrdkd")
+      expect(response[:search][:count]).to eq(652)
+      expect(response[:search][:pages]).to eq(7)
+      expect(response[:search][:pageSize]).to eq(100)
+    end
+
+    it "#search all params" do
+      path="#{API_URL}/v4/search?templateId=xyz&fromDts=2018-01-01&toDts=2018-02-01&firstName=Rocky&lastName=RockChuck&verified=true&sort=asc&tag=new+customer"
+
+      FakeWeb.register_uri(:get, path, :body => json_search_1_results)
+
+      response = @client.search('xyz','2018-01-01', '2018-02-01','Rocky','RockChuck',true, SmartwaiverSearchClient::SEARCH_SORT_ASC, 'new customer')
+
+      expect(response[:search][:guid]).to eq("6jebdfxzvrdkd")
+      expect(response[:search][:count]).to eq(652)
+      expect(response[:search][:pages]).to eq(7)
+      expect(response[:search][:pageSize]).to eq(100)
+    end
+
+    it "#results" do
+
+      path="#{API_URL}/v4/search/6jebdfxzvrdkd/results?page=1"
+
+      FakeWeb.register_uri(:get, path, :body => json_search_2_results)
+
+      response = @client.results('6jebdfxzvrdkd', 1)
+      expect(response[:search_results].length).to eq(1)
+    end
+
+  end
+end

data/spec/smartwaiver-sdk/user_client_spec.rb

@@ -0,0 +1,30 @@
+dir = File.dirname(__FILE__)
+require "#{dir}/../spec_helper"
+require "#{dir}/../../lib/smartwaiver-sdk/user_client"
+
+describe SmartwaiverUserClient do
+  attr_reader :client, :api_key
+
+  before do
+    FakeWeb.allow_net_connect = false
+    @api_key = "apikey"
+    @client = SmartwaiverUserClient.new(@api_key)
+  end
+
+  describe "user settings" do
+    it "#initialize" do
+      expect(@client).to be_kind_of(SmartwaiverUserClient)
+    end
+
+    it "#settings" do
+      path="#{API_URL}/v4/settings"
+      FakeWeb.register_uri(:get, path, :body => json_user_settings_results)
+
+      response = @client.settings()
+
+      expect(response[:settings][:console][:staticExpiration]).to eq("never")
+      expect(response[:settings][:console][:rollingExpiration]).to eq("never")
+      expect(response[:settings][:console][:rollingExpirationTime]).to eq("signed")
+    end
+  end
+end

data/spec/smartwaiver-sdk/waiver_client_spec.rb

@@ -53,5 +53,39 @@ describe SmartwaiverWaiverClient do
       @client.get(waiver_id, true)
     end
 
+    it "#photos" do
+      waiver_id = "6jebdfxzvrdkd"
+      path = "#{API_URL}/v4/waivers/#{waiver_id}/photos"
+      FakeWeb.register_uri(:get, path, :body => json_waiver_photos_results)
+      result = @client.photos(waiver_id)
+
+      expect(result[:photos][:waiverId]).to eq(waiver_id)
+      expect(result[:photos][:templateId]).to eq("sprswrvh2keeh")
+      expect(result[:photos][:title]).to eq("Smartwaiver Demo Waiver")
+
+      expect(result[:photos][:photos].length).to eq(1)
+      expect(result[:photos][:photos][0][:type]).to eq("kiosk")
+      expect(result[:photos][:photos][0][:tag]).to eq("IP: 192.168.2.0")
+      expect(result[:photos][:photos][0][:fileType]).to eq("jpg")
+      expect(result[:photos][:photos][0][:photoId]).to eq("CwLeDjffgDoGHua")
+      expect(result[:photos][:photos][0][:photo]).to eq("BASE64 ENCODED PHOTO")
+    end
+
+    it "#signatures" do
+      waiver_id = "6jebdfxzvrdkd"
+      path = "#{API_URL}/v4/waivers/#{waiver_id}/signatures"
+      FakeWeb.register_uri(:get, path, :body => json_waiver_signatures_results)
+      result = @client.signatures(waiver_id)
+
+      expect(result[:signatures][:waiverId]).to eq(waiver_id)
+      expect(result[:signatures][:templateId]).to eq("sprswrvh2keeh")
+      expect(result[:signatures][:title]).to eq("Smartwaiver Demo Waiver")
+
+      expect(result[:signatures][:signatures][:participants].length).to eq(1)
+      expect(result[:signatures][:signatures][:guardian].length).to eq(1)
+      expect(result[:signatures][:signatures][:bodySignatures].length).to eq(1)
+      expect(result[:signatures][:signatures][:bodyInitials].length).to eq(1)
+    end
+
   end
 end

data/spec/smartwaiver-sdk/webhook_client_spec.rb

@@ -36,5 +36,22 @@ describe SmartwaiverWebhookClient do
       expect(response[:webhooks][:emailValidationRequired]).to eq(email_validation_required)
     end
 
+    it "#delete" do
+      path="#{API_URL}/v4/webhooks/configure"
+      FakeWeb.register_uri(:delete, path, :body => json_webhook_delete_results)
+
+      response = @client.delete
+
+      expect(response[:webhooks]).to eq({})
+    end
+
+    it "#resend" do
+      waiver_id = 'xyz'
+      path="#{API_URL}/v4/webhooks/resend/#{waiver_id}"
+      FakeWeb.register_uri(:put, path, :body => json_webhook_resend_results)
+
+      response = @client.resend(waiver_id)
+      expect(response[:webhooks_resend][:success]).to eq(true)
+    end
   end
 end

data/spec/smartwaiver-sdk/webhook_queues_client_spec.rb

@@ -0,0 +1,75 @@
+dir = File.dirname(__FILE__)
+require "#{dir}/../spec_helper"
+require "#{dir}/../../lib/smartwaiver-sdk/webhook_queues_client"
+
+describe SmartwaiverWebhookQueuesClient do
+  attr_reader :client, :api_key
+
+  before do
+    FakeWeb.allow_net_connect = false
+    @api_key = "apikey"
+    @client = SmartwaiverWebhookQueuesClient.new(@api_key)
+  end
+
+  describe "webhook_queues" do
+    it "#initialize" do
+      expect(@client).to be_kind_of(SmartwaiverWebhookQueuesClient)
+    end
+
+    it "#information" do
+      path="#{API_URL}/v4/webhooks/queues"
+      FakeWeb.register_uri(:get, path, :body => json_webhook_queues_information_results)
+
+      response = @client.information
+      expect(response[:type]).to eq('api_webhook_all_queue_message_count')
+      expect(response[:api_webhook_all_queue_message_count][:account][:messagesTotal]).to eq(2)
+      expect(response[:api_webhook_all_queue_message_count][:'template-4fc7d12601941'][:messagesTotal]).to eq(4)
+    end
+
+    it "#get_message"  do
+        path="#{API_URL}/v4/webhooks/queues/account"
+        FakeWeb.register_uri(:get, path, :body => json_webhook_queues_get_message_results)
+
+        response = @client.get_message
+        expect(response[:type]).to eq('api_webhook_account_message_get')
+        expect(response[:api_webhook_account_message_get][:messageId]).to eq('9d58e8fc-6353-4ceb-b0a3-5412f3d05e28')
+        expect(response[:api_webhook_account_message_get][:payload][:unique_id]).to eq('xyz')
+        expect(response[:api_webhook_account_message_get][:payload][:event]).to eq('new-waiver')
+    end
+
+    it "#delete_message"  do
+      message_id = 'x-y-z'
+      path="#{API_URL}/v4/webhooks/queues/account/#{message_id}"
+      FakeWeb.register_uri(:delete, path, :body => json_webhook_queues_delete_message_results)
+
+      response = @client.delete_message(message_id)
+      expect(response[:type]).to eq('api_webhook_account_message_delete')
+      expect(response[:api_webhook_account_message_delete][:success]).to eq(true)
+    end
+
+    it "#get_template_message"  do
+      template_id = 't1'
+      path="#{API_URL}/v4/webhooks/queues/template/#{template_id}"
+      FakeWeb.register_uri(:get, path, :body => json_webhook_queues_template_get_message_results)
+
+      response = @client.get_template_message(template_id)
+      expect(response[:type]).to eq('api_webhook_template_message_get')
+      expect(response[:api_webhook_template_message_get][:messageId]).to eq('9d58e8fc-6353-4ceb-b0a3-5412f3d05e28')
+      expect(response[:api_webhook_template_message_get][:payload][:unique_id]).to eq('xyz')
+      expect(response[:api_webhook_template_message_get][:payload][:event]).to eq('new-waiver')
+    end
+
+    it "#delete_template_message"  do
+      template_id = 't1'
+      message_id = 'x-y-z'
+      path="#{API_URL}/v4/webhooks/queues/template/#{template_id}/#{message_id}"
+      FakeWeb.register_uri(:delete, path, :body => json_webhook_queues_template_delete_message_results)
+
+      response = @client.delete_template_message(template_id, message_id)
+
+      expect(response[:type]).to eq('api_webhook_template_message_delete')
+      expect(response[:api_webhook_template_message_delete][:success]).to eq(true)
+    end
+
+  end
+end

data/spec/spec_helper.rb

@@ -17,7 +17,7 @@ end
 
 def json_api_version_results
   json = <<JAVASCRIPT
-{"version": "4.0.0"}
+{"version": "4.2.0"}
 JAVASCRIPT
   json
 end
@@ -40,6 +40,106 @@ def json_webhook_configure_results
 JAVASCRIPT
 end
 
+def json_webhook_delete_results
+  json = <<JAVASCRIPT
+{"version":4, "id":"8e82fa534da14b76a05013644ee735d2", "ts":"2017-01-17T15:46:58+00:00", "type":"webhooks", "webhooks":{}}
+JAVASCRIPT
+end
+
+def json_webhook_resend_results
+  json = <<JAVASCRIPT
+{"version":4, "id":"8e82fa534da14b76a05013644ee735d2", "ts":"2017-01-17T15:46:58+00:00", "type":"webhooks_resend", "webhooks_resend":{"success":true}}
+JAVASCRIPT
+end
+
+
+
+def json_webhook_queues_information_results
+  json = <<JAVASCRIPT
+{
+    "version" : 4,
+    "id" : "a0256461ca244278b412ab3238f5efd2",
+    "ts" : "2017-01-24T11:14:25+00:00",
+    "type" : "api_webhook_all_queue_message_count",
+    "api_webhook_all_queue_message_count" : {
+        "account": {
+            "messagesTotal": 2,
+            "messagesNotVisible": 0,
+            "messagesDelayed": 0
+        },
+        "template-4fc7d12601941": {
+            "messagesTotal": 4,
+            "messagesNotVisible": 2,
+            "messagesDelayed": 0
+        }
+    }
+}
+JAVASCRIPT
+end
+
+def json_webhook_queues_get_message_results
+  json = <<JAVASCRIPT
+{
+    "version" : 4,
+    "id" : "a0256461ca244278b412ab3238f5efd2",
+    "ts" : "2017-01-24T11:14:25+00:00",
+    "type" : "api_webhook_account_message_get",
+    "api_webhook_account_message_get" : {
+        "messageId": "9d58e8fc-6353-4ceb-b0a3-5412f3d05e28",
+        "payload": {
+            "unique_id": "xyz",
+            "event": "new-waiver"
+        }
+    }
+}
+JAVASCRIPT
+end
+
+def json_webhook_queues_delete_message_results
+  json = <<JAVASCRIPT
+{
+    "version" : 4,
+    "id" : "a0256461ca244278b412ab3238f5efd2",
+    "ts" : "2017-01-24T11:14:25+00:00",
+    "type" : "api_webhook_account_message_delete",
+    "api_webhook_account_message_delete" : {
+        "success": true
+    }
+}
+JAVASCRIPT
+end
+
+def json_webhook_queues_template_get_message_results
+  json = <<JAVASCRIPT
+{
+    "version" : 4,
+    "id" : "a0256461ca244278b412ab3238f5efd2",
+    "ts" : "2017-01-24T11:14:25+00:00",
+    "type" : "api_webhook_template_message_get",
+    "api_webhook_template_message_get" : {
+        "messageId": "9d58e8fc-6353-4ceb-b0a3-5412f3d05e28",
+        "payload": {
+            "unique_id": "xyz",
+            "event": "new-waiver"
+        }
+    }
+}
+JAVASCRIPT
+end
+
+def json_webhook_queues_template_delete_message_results
+  json = <<JAVASCRIPT
+{
+    "version" : 4,
+    "id" : "a0256461ca244278b412ab3238f5efd2",
+    "ts" : "2017-01-24T11:14:25+00:00",
+    "type" : "api_webhook_template_message_delete",
+    "api_webhook_template_message_delete" : {
+        "success": true
+    }
+}
+JAVASCRIPT
+end
 
 def json_template_list_results
   json = <<JAVASCRIPT
@@ -127,3 +227,235 @@ def json_waiver_single_results
 }
 JAVASCRIPT
 end
+
+def json_waiver_photos_results
+  json = <<JAVASCRIPT
+{
+    "version" : 4,
+    "id" : "a0256461ca244278b412ab3238f5efd2",
+    "ts" : "2017-01-24T11:14:25+00:00",
+    "type" : "photos",
+    "photos" : {
+        "waiverId": "6jebdfxzvrdkd",
+        "templateId": "sprswrvh2keeh",
+        "title": "Smartwaiver Demo Waiver",
+        "createdOn": "2017-01-24 13:12:29",
+        "photos": [
+            {
+                "type": "kiosk",
+                "date": "2017-01-01 00:00:00",
+                "tag": "IP: 192.168.2.0",
+                "fileType": "jpg",
+                "photoId": "CwLeDjffgDoGHua",
+                "photo": "BASE64 ENCODED PHOTO"
+            }
+        ]
+    }
+}
+JAVASCRIPT
+  json
+end
+
+def json_waiver_signatures_results
+  json = <<JAVASCRIPT
+{
+    "version" : 4,
+    "id" : "a0256461ca244278b412ab3238f5efd2",
+    "ts" : "2017-01-24T11:14:25+00:00",
+    "type" : "signatures",
+    "signatures" : {
+        "waiverId": "6jebdfxzvrdkd",
+        "templateId": "sprswrvh2keeh",
+        "title": "Smartwaiver Demo Waiver",
+        "createdOn": "2017-01-24 13:12:29",
+        "signatures": {
+            "participants": [
+                "BASE64 ENCODED IMAGE STRING"
+            ],
+            "guardian": [
+                "BASE64 ENCODED IMAGE STRING"
+            ],
+            "bodySignatures": [
+                "BASE64 ENCODED IMAGE STRING"
+            ],
+            "bodyInitials": [
+                "BASE64 ENCODED IMAGE STRING"
+            ]
+        }
+    }
+}
+JAVASCRIPT
+  json
+end
+
+
+def json_dynamic_template_default
+  '{"template":{"meta":{},"header":{},"body":{},"participants":{"adults":true},"standardQuestions":{},"guardian":{},"electronicConsent":{},"styling":{},"completion":{},"signatures":{},"processing":{}},"data":{"adult":true,"participants":[],"guardian":{"participant":false}}}'
+end
+
+def json_keys_create_results
+  json = <<JAVASCRIPT
+{"version" : 4,"id" : "a0256461ca244278b412ab3238f5efd2","ts" : "2017-01-24T11:14:25+00:00","type" : "published_keys",
+    "published_keys" : {
+        "newKey": {
+            "createdAt": "2017-01-24T11:14:25Z",
+            "key" : "SPoyAc7mNHK8L6Yaq2s2Bu8UMcBEoyTvDeizmj94p6",
+            "label" : "Ruby SDK"
+        },
+        "keys" : [
+            {
+                "createdAt": "2017-01-24T11:14:25Z",
+                "key" : "SPoyAc7mNHK8L6Yaq2s2Bu8UMcBEoyTvDeizmj94p6",
+                "label" : "demo"
+            }
+        ]
+    }
+}
+JAVASCRIPT
+  json
+end
+
+def json_keys_list_results
+  json = <<JAVASCRIPT
+{
+    "version" : 4,"id" : "a0256461ca244278b412ab3238f5efd2","ts" : "2017-01-24T11:14:25Z","type" : "published_keys",
+    "published_keys" : {
+        "keys" : [
+            {
+                "createdAt": "2017-01-24T11:14:25Z",
+                "key" : "SPoyAc7mNHK8L6Yaq2s2Bu8UMcBEoyTvDeizmj94p6",
+                "label" : "Ruby SDK"
+            }
+        ]
+    }
+}
+JAVASCRIPT
+  json
+end
+
+def json_search_1_results
+  json = <<JAVASCRIPT
+  {
+      "version" : 4,
+      "id" : "a0256461ca244278b412ab3238f5efd2",
+      "ts" : "2017-01-24T11:14:25+00:00",
+      "type" : "search",
+      "search" : {
+          "guid": "6jebdfxzvrdkd",
+      "count": 652,
+      "pages": 7,
+      "pageSize": 100
+      }
+  }
+JAVASCRIPT
+  json
+end
+
+def json_search_2_results
+  json = <<JAVASCRIPT
+{
+    "version" : 4,
+    "id" : "a0256461ca244278b412ab3238f5efd2",
+    "ts" : "2017-01-24T11:14:25+00:00",
+    "type" : "search_results",
+    "search_results" : [
+        {
+            "waiverId": "6jebdfxzvrdkd",
+            "templateId": "sprswrvh2keeh",
+            "title": "Smartwaiver Demo Waiver",
+            "createdOn": "2017-01-24 13:12:29",
+            "expirationDate": "",
+            "expired": false,
+            "verified": true,
+            "kiosk": true,
+            "firstName": "Kyle",
+            "middleName": "",
+            "lastName": "Smith II",
+            "dob": "2008-12-25",
+            "clientIP": "192.0.2.0",
+            "email":"example@smartwaiver.com",
+            "marketingAllowed": false,
+            "addressLineOne": "626 NW Arizona Ave.",
+            "addressLineTwo": "Suite 2",
+            "addressCity": "Bend",
+            "addressState": "OR",
+            "addressZip": "97703",
+            "addressCountry": "US",
+            "emergencyContactName": "Mary Smith",
+            "emergencyContactPhone": "111-111-1111",
+            "insuranceCarrier": "My Insurance",
+            "insurancePolicyNumber": "1234567",
+            "driversLicenseNumber": "9876543",
+            "driversLicenseState": "OR",
+            "tags": [
+                "Green Team"
+            ],
+            "flags": {
+                "displayText": "Have you received our orientation?",
+                "reason": "was not selected"
+            },
+            "participants": [
+                {
+                    "firstName": "Kyle",
+                    "middleName": "",
+                    "lastName": "Smith II",
+                    "dob": "2008-12-25",
+                    "isMinor": true,
+                    "gender": "Male",
+                    "phone": "",
+                    "tags": ["YES"],
+                    "customParticipantFields" : {
+                        "bk3xydss4e9dy" : {
+                            "value" : "YES",
+                            "displayText" : "Is this participant ready to have fun?"
+                        }
+                    },
+                    "flags": [
+                        {
+                            "displayText": "Are you excited?",
+                            "reason": "was not selected"
+                        }
+                    ]
+                }
+            ],
+            "pdf": "Base64 Encoded PDF",
+            "photos": 1,
+            "guardian": {
+                "firstName": "Kyle",
+                "middleName": "",
+                "lastName": "Smith I",
+                "phone": "555-555-5555",
+                "dob": "1970-12-25"
+            },
+            "customWaiverFields" : {
+                "ha5bs1jy5wdop" : {
+                    "value" : "A friend",
+                    "displayText" : "How did you hear about Smartwaiver?"
+                }
+            }
+        }
+    ]
+}
+JAVASCRIPT
+  json
+end
+
+def json_user_settings_results
+  json = <<JAVASCRIPT
+{
+    "version" : 4,
+    "id" : "a0256461ca244278b412ab3238f5efd2",
+    "ts" : "2017-01-24T11:14:25Z",
+    "type" : "settings",
+    "settings" : {
+        "console" : {
+            "staticExpiration" : "never",
+            "rollingExpiration" : "never",
+            "rollingExpirationTime" : "signed"
+        }
+    }
+}
+JAVASCRIPT
+  json
+end
+