smartwaiver-sdk 4.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f7db8097383e5239cf525bdf325c02b7115a2154
+  data.tar.gz: de13abd5f6f4a0a9c9ada27ebdf613433c8e0b74
+SHA512:
+  metadata.gz: 478a58a44cca53de3bc84cfd123cabb198fe17c4605018db4c963ffd1f3163984e0e79f9af168c8d22ac888ea45ca519172d8c99724058e4740c76f115fcbcdf
+  data.tar.gz: f0e8475bbb8a6b3668447b2e0d230f5ef1e074ca1d751f5e76b20d0f4909317d46329c021a66ad19ed4c747e511de918971490c2f1983a7f513db5a3edba23cf

data/Gemfile

@@ -0,0 +1,8 @@
+source "http://rubygems.org"
+
+
+group :test, :development do
+  gem 'rspec'
+  gem 'rr'
+  gem 'fakeweb'
+end

data/README.md

@@ -0,0 +1,402 @@
+![](https://d362q4tvy1elxj.cloudfront.net/header_logoheader.png)
+RUBY-SDK
+==========
+
+Table of Contents
+=================
+
+  * [Table of contents](#table-of-contents)
+  * [Installation](#installation)
+  * [Getting Started](#getting-started)
+    * [Retrieve a Specific Template](#retrieve-a-specific-template)
+    * [List all Signed Waivers](#list-all-signed-waivers)
+    * [Retrieve a Specific Waiver](#retrieve-a-specific-waiver)
+    * [Retrieve/Set Webhook Config](#retrieveset-webhook-configuration)
+  * [Exception Handling](#exception-handling)
+    * [Status Codes](#status-codes)
+  * [Advanced](#advanced)
+    * [Authentication](#authentication)
+
+Installation
+==========
+
+    gem install smartwaiver-sdk
+
+Alternatively, you may install the SDK from the github repo:
+
+    git clone https://www.github.com/smartwaivercom/ruby-sdk
+
+Getting Started
+==========
+
+All that is required to start using the SDK is a Smartwaiver account and the API Key for that account.
+In all of the examples you will need to put the API Key into the code wherever it says: `[INSERT API KEY]`
+
+If running the examples from the project without installing the gem, you will need to set the RUBYLIB path.
+
+    export RUBYLIB=/Users/<user_name>/workspace/ruby-sdk/lib/smartwaiver-sdk
+
+
+It's time to start making requests.
+A good first request is to list all waiver templates for your account.
+Here is the code to do that:
+
+```ruby
+require 'smartwaiver-sdk/template_client'
+# The API Key for your account
+api_key = '[INSERT API KEY]'
+
+# Set up your Smartwaiver client using your API Key
+client = SmartwaiverTemplateClient.new(api_key)
+
+# Now request a list of all the waiver templates
+results = client.list
+```
+
+That's it! You've just requested all waiver templates in your account.
+But, now it's time to do something with them.
+Let's loop through those templates and print out the ID and Title of each template:
+
+```ruby
+result[:templates].each do |template|
+  puts "#{template[:templateId]}: #{template[:title]}"
+end
+```
+
+Awesome! For more details on all the different properties a waiver template has, check out [template_properties.rb](examples/templates/template_properties.rb)
+
+Now that you've got your first request, check out the sections below to accomplish specific actions.
+
+Retrieve a Specific Template
+---------
+
+First let's set up the template client.
+Make sure to put in your account's API Key where it says `[INSERT API KEY]`
+
+```ruby
+require 'smartwaiver-sdk/template_client'
+# The API Key for your account
+api_key = '[INSERT API KEY]'
+
+# Set up your Smartwaiver client using your API Key
+client = SmartwaiverTemplateClient.new(api_key)
+```
+
+Now we can request information about a specific template.
+To do this we need the template ID.
+If you don't know a template ID for your account, try listing all waiver templates for you account, as shown [here](#getting-started), and copying one of the ID's that is printed out.
+Once we have a template ID we can execute a request to get the information about the template:
+
+```ruby
+# The unique ID of the template to be retrieved
+template_id = '[INSERT TEMPLATE ID]'
+
+# Retrieve a specific template (SmartwaiverTemplate object)
+template = client.get(template_id)
+```
+
+Now let's print out some information about this template.
+
+```ruby
+# Access properties of the template
+puts "List single template:"
+puts "#{template[:templateId]}: #{template[:title]}"
+```
+
+To see all the different properties a waiver template has, check out [template_properties.rb](examples/templates/template_properties.rb)
+
+List All Signed Waivers
+----------
+
+First let's set up the basic Smartwaiver waiver client. Make sure to put in your account's API Key where it says `[INSERT API KEY]`
+
+```ruby
+require 'smartwaiver-sdk/waiver_client'
+# The API Key for your account
+api_key = '[INSERT API KEY]'
+
+# Set up your Smartwaiver client using your API Key
+client = SmartwaiverWaiverClient.new(api_key)
+```
+
+Now we can request signed waivers from your account.
+
+```ruby
+# Get a list of summaries of waivers
+waiver_summaries = client.list
+```
+
+With this done, we can iterate over the returned summaries to see what is stored.
+The default limit is 20, which means if you have more than 20 in your account, only the most recent 20 will be returned
+
+```ruby
+puts "List all waivers:"
+waiver_summaries[:waivers].each do |waiver|
+  puts "#{waiver[:waiverId]}: #{waiver[:title]}"
+end
+```
+
+To see all the different properties a waiver summary has, check out [waiver_summary_properties.rb](examples/waivers/waiver_summary_properties.rb)
+
+Once we have a waiver summary, we can access all the detailed information about the waiver. To do that look [here](#retrieve-a-specific-waiver).
+
+But, we can also restrict our query with some parameters.
+For example, what if we only want to return 5 waivers, (the default is 20).
+Here is the code to do that:
+
+```ruby
+# Set the limit
+limit = 5
+
+# Get a list of summaries of waivers
+waiver_summaries = client.list(limit)
+```
+
+Or what if we only want any waivers that have not been verified (either by email or at the kiosk)?
+
+```ruby
+# Set the limit
+limit = 5
+
+# Set the verified parameter
+verified = false
+
+# Get a list of summaries of waivers
+waiver_summaries = client.list(limit, verified)
+```
+
+What other parameters can you use? Here is an example using all of them:
+
+```ruby
+# An example limiting the parameters
+limit = 5                                      # Limit number returned to 5
+verified = true                                # Limit only to waivers that were signed at a kiosk or verified over email
+template_id = '[INSERT TEMPLATE ID]'           # Limit query to waivers of this template ID
+from_dts = '2016-11-01T00:00:00'               # Limit to waivers signed in November of 2016
+to_dts = '2016-12-01T00:00:00'
+
+# Get a list of summaries of waivers
+waiver_summaries = client.list(limit, verified, template_id, from_dts, to_dts)
+```
+
+These examples are also available in [list_all_waivers.rb](examples/waivers/list_all_waivers.rb)
+
+###Parameter Options
+
+| Parameter Name | Default Value | Accepted Values   | Notes                                                                                 |
+| -------------- | ------------- | ----------------- | ------------------------------------------------------------------------------------- |
+| limit          | 20            | 1 - 100           | Limit number of returned waivers                                                      |
+| verified       | null          | true/false/null   | Limit selection to waiver that have been verified (true), not (false), or both (null) | 
+| templateId     |               | Valid Template ID | Limit signed waivers to only this template                                            |
+| fromDts        |               | ISO 8601 Date     | Limit to signed waivers between from and to dates (requires toDts)                    |
+| toDts          |               | ISO 8601 Date     | Limit to signed waivers between from and to dates (requires fromDts)                  |
+
+Retrieve a Specific Waiver
+----------
+
+What if we want to retrieve a specific waiver?
+All we need for that is a waiver ID.
+If you don't have a waiver ID to use, you can get a list of signed waivers in your account [here](#list-all-signed-waivers)
+
+First let's set up the basic Smartwaiver object. Make sure to put in your account's API Key where it says `[INSERT API KEY]`
+
+```ruby
+require 'smartwaiver-sdk/waiver_client'
+# The API Key for your account
+api_key = '[INSERT API KEY]'
+
+# Set up your Smartwaiver client using your API Key
+client = SmartwaiverWaiverClient.new(api_key)
+```
+
+Now, we can request the information about a specific waiver.
+Make sure to put your waiver ID in where it says `[INSERT WAIVER ID]`
+
+```ruby
+# The unique ID of the signed waiver to be retrieved
+waiver_id = '[INSERT WAIVER ID]'
+
+# Get a specific waiver
+result = client.get(waiver_id)
+```
+
+The waiver object has many different properties that can be accessed.
+For example, we can print out the waiver ID and title of the waiver.
+
+```ruby
+# Access properties of waiver
+waiver = result[:waiver]
+puts "List single waiver:"
+puts "#{waiver[:waiverId]}: #{waiver[:title]}"
+```
+
+To see a full list of all properties that a waiver object contains, check out [waiver_properties.rb](examples/waivers/waiver_properties.rb)
+
+We can also request that the PDF of the signed waiver as a Base 64 Encoded string be included. Here is the request to do that:
+
+```ruby
+# The unique ID of the signed waiver to be retrieved
+waiver_id = '[INSERT WAIVER ID]'
+
+pdf = true
+
+# Get the waiver object
+result = client.get(waiver_id, pdf)
+```
+
+The code provided here is also combined in to one example in [retrieve_single_waiver.rb](examples/waivers/retrieve_single_waiver.rb)
+
+Retrieve/Set Webhook Configuration
+----------
+
+You can both retrieve and set your account's webhook configuration through this SDK with a couple simple calls.
+To view your current webhook settings, we first need to set a Smartwaiver object.
+Make sure to put in your account's API Key where it says `[INSERT API KEY]`
+
+```ruby
+require 'smartwaiver-sdk/webhook_client'
+# The API Key for your account
+api_key = '[INSERT API KEY]'
+
+# Set up your Smartwaiver client using your API Key
+client = SmartwaiverWebhookClient.new(api_key)
+```
+
+Now, it's easy to request the webhook configuration:
+
+```ruby
+# Get the current webhook settings
+result = client.configuration
+```
+
+And, now we can print out the information:
+
+```ruby
+# Access the webhook config
+puts "Endpoint: #{result[:webhooks][:endpoint]}"
+puts "EmailValidationRequired: #{result[:webhooks][:emailValidationRequired]}"
+```
+
+The Email Validation Required is whether the webhook will fire before, after, or before and after a waiver is verified.
+The endpoint is simply the endpoint URL for the webhook.
+
+And changing your webhook configuration is just as easy.
+The new configuration will be returned from the request and can be access just like the read request above.
+
+```ruby
+# The new values to set
+endpoint = 'http://endpoint.example.org'
+email_validation_required = SmartwaiverWebhookClient::WEBHOOK_AFTER_EMAIL_ONLY
+
+# Set the webhook to new values
+result = client.configure(end_point, send_after_email_only)
+
+# Access the new webhook config
+webhook = result[:webhooks]
+puts "Successfully set new configuration."
+puts "Endpoint: #{webhook[:endpoint]}"
+puts "EmailValidationRequired: #{webhook[:emailValidationRequired]}"
+```
+
+This code is also provided in [retrieve_webhooks.rb](examples/webhooks/retrieve_webhooks.rb)
+and [set_webhooks.rb](examples/webhooks/set_webhooks.rb)
+
+Exception Handling
+==========
+
+There are three types of exceptions int the SDK:
+ * A <b>BadAPIKeyError</b> occurs if the API key is incorrect or missing.
+ * A <b>BadFormatError</b> occurs when trying to update the webhook configuration with incorrect data.
+ * All other types of errors will be a <b>RemoteServerError</b> which is thrown by the API server.  The message returned explains the problem.
+ 
+Here is an example of catching an HTTP exception. First we set up the Smartwaiver account:
+
+```ruby
+require 'waiver_client'
+
+# The API Key for your account
+api_key='[INSERT API KEY]'
+
+# The unique ID of the signed waiver to be retrieved
+
+client = SmartwaiverWaiverClient.new(api_key)
+```
+
+Next, we attempt to get a waiver that does not exist:
+
+```ruby
+# The Waiver ID to access
+waiver_id='InvalidWaiverId'
+
+# Try to get the waiver object
+result = client.get(waiver_id)
+```
+
+This will throw an exception because a waiver with that ID does not exist. So let's change the code to catch that exception:
+
+```ruby
+begin
+  # use default parameters
+  result = client.get(waiver_id)
+
+  waiver = result[:waiver]
+  puts "List single waiver:"
+  puts "#{waiver[:waiverId]}: #{waiver[:title]}"
+
+  result = client.get(waiver_id, true)
+
+  waiver = result[:waiver]
+  puts "PDF:"
+  puts "#{waiver[:pdf]}"
+
+rescue SmartwaiverSDK::BadAPIKeyError=>bad
+  puts "API Key error: #{bad.message}"
+rescue Exception=>e
+  puts "Exception thrown.  Error during waiver retrieval: #{e.message}"
+end
+```
+
+But there is lot's of useful information in the exception object. Let's print some of that out too:
+
+```ruby
+# The code will be the HTTP Status Code returned
+puts "Error Message: #{e.message}"
+
+# Also included in the exception is the header information returned about
+# the response.
+puts "API Version: #{e.result[:version]}"
+puts "UUID: #{e.result[:id]}"
+puts "Timestamp: #{e.result[:ts]}"
+```
+
+Status Codes
+----------
+
+The code of the exception will match the HTTP Status Code of the response and the message will be an informative string informing on what exactly was wrong with the request.
+
+Possible status codes and their meanings:
+
+| Status Code | Error Name            | Description                                                                                                                       |
+| ----------- | --------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
+| 400         | Parameter Error       | Indicates that something was wrong with the parameters of the request (e.g. extra parameters, missing required parameters, etc.). |
+| 401         | Unauthorized          | Indicates the request was missing an API Key or contained an invalid API Key.                                                     |
+| 402         | Data Error            | Indicates that the parameters of the request was valid, but the data in those parameters was not.                                 |
+| 404         | Not Found             | Indicates that whatever was being searched for (specific waiver, etc.) could not be found.                                        |
+| 406         | Wrong Content Type    | Indicates that the Content Type of the request is inappropriate for the request.                                                   |
+| 500         | Internal Server Error | Indicates that the server encountered an internal error while processing the request.                                             |
+
+Advanced
+==========
+
+This section contains notes about several more ways to use the SDK that are slightly more low level.
+
+
+Authentication
+----------
+
+If you are making custom requests you must include the proper authentication.
+The Smartwaiver API expects a header called 'sw-api-key' to contain the API for the account you are accessing.
+
+    sw-api-key: [INSERT API KEY]
+
+If you do not have a Smartwaiver API key go [here](https://www.smartwaiver.com/p/API) to find out how to create one. 

data/Rakefile

@@ -0,0 +1,8 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |task|
+  task.rspec_opts = '-c -f d'
+end
+task :default => :spec

data/lib/smartwaiver-sdk.rb

@@ -0,0 +1,10 @@
+
+dir = File.dirname(__FILE__)
+
+require 'net/https'
+require 'uri'
+require 'cgi'
+
+require "#{dir}/smartwaiver-sdk/smartwaiver_errors"
+require "#{dir}/smartwaiver-sdk/smartwaiver_base"
+require "#{dir}/smartwaiver-sdk/smartwaiver_version"

data/lib/smartwaiver-sdk/smartwaiver_base.rb

@@ -0,0 +1,125 @@
+#
+# Copyright 2017 Smartwaiver
+#
+# Licensed under the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License. You may obtain
+# a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+# License for the specific language governing permissions and limitations
+# under the License.
+
+require 'json'
+require 'net/http'
+require 'smartwaiver-sdk/smartwaiver_version'
+require 'smartwaiver-sdk/smartwaiver_errors'
+
+module SmartwaiverSDK
+
+  class SmartwaiverBase
+    DEFAULT_API_ENDPOINT = 'https://api.smartwaiver.com'
+    HEADER_API_KEY = 'sw-api-key'
+    HTTP_READ_TIMEOUT = 60
+
+    HTTP_GET = "GET"
+    HTTP_POST = "POST"
+    HTTP_PUT = "PUT"
+
+    def initialize(api_key, api_endpoint = DEFAULT_API_ENDPOINT)
+      @api_endpoint = api_endpoint
+      @api_key = api_key
+      @http = nil
+      @http_read_timeout = HTTP_READ_TIMEOUT
+      init_http_connection(@api_endpoint)
+    end
+
+    def api_version
+      make_api_request("/version")
+    end
+
+    def format_iso_time(time)
+      time.strftime("%Y-%m-%dT%H:%M:%SZ")
+    end
+
+    def read_timeout(s)
+      if s > 0 and s < 600
+        @http_read_timeout = s
+      end
+    end
+
+    private
+
+    def init_http_connection(target_server)
+      if (@http and @http.started?)
+        @http.finish
+      end
+      @last_init_time = Time.now.utc
+      endpoint_url = URI.parse(target_server)
+      @http = Net::HTTP.start(endpoint_url.host, endpoint_url.port, {:use_ssl => true, :read_timeout => @http_read_timeout})
+      @http
+    end
+
+    def common_http_headers
+      {'User-Agent' => SmartwaiverSDK::Info.get_user_agent, HEADER_API_KEY => @api_key}
+    end
+
+    def rest_post_headers
+      {"Content-Type" => "application/json"}
+    end
+
+    def make_api_request(path, request_type=HTTP_GET, data='')
+      if (@last_init_time < Time.now.utc - 60)
+        init_http_connection(@api_endpoint)
+      end
+
+      headers = common_http_headers
+      case request_type
+        when HTTP_GET
+          response = @http.request_get(path, headers)
+        when HTTP_PUT
+          headers = common_http_headers.merge(rest_post_headers)
+          response = @http.request_put(path, data, headers)
+        when HTTP_POST
+          headers = common_http_headers.merge(rest_post_headers)
+          response = @http.request_post(path, data, headers)
+      end
+      check_response(response)
+    end
+
+    def check_response(response)
+      response_data = parse_response_body(response.body)
+      case response
+        when Net::HTTPSuccess
+          return response_data
+        when Net::HTTPUnauthorized
+          raise SmartwaiverSDK::BadAPIKeyError.new("#{response.code.to_s}:#{response_data[:message]}", response_data)
+        when Net::HTTPNotAcceptable
+          raise SmartwaiverSDK::BadFormatError.new("#{response.code.to_s}:#{response_data[:message]}", response_data)
+        when Net::HTTPClientError, Net::HTTPServerError
+          raise SmartwaiverSDK::RemoteServerError.new("#{response.code.to_s}:#{response_data[:message]}", response_data)
+        else
+          raise SmartwaiverSDK::RemoteServerError.new("#{response_data[:message]}", response_data)
+      end
+    end
+
+    def parse_response_body(body)
+      begin
+        return JSON.parse(body, :symbolize_names => :symbolize_names)
+      rescue JSON::ParserError => e
+        return base_response_params.merge!({:message => e.message})
+      end
+    end
+
+    def base_response_params
+      {:version => 0,
+       :id => "",
+       :ts => "1970-01-01T00:00:00+00:00",
+       :type => ""
+      }
+    end
+  end
+end

data/lib/smartwaiver-sdk/smartwaiver_errors.rb

@@ -0,0 +1,35 @@
+#
+# Copyright 2017 Smartwaiver
+#
+# Licensed under the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License. You may obtain
+# a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+# License for the specific language governing permissions and limitations
+# under the License.
+
+module SmartwaiverSDK
+
+  class SmartwaiverError < StandardError
+    attr_reader :result
+    def initialize(message, result={})
+      super(message)
+      @result = result
+    end
+  end
+
+  class BadAPIKeyError < SmartwaiverError
+  end
+
+  class BadFormatError < SmartwaiverError
+  end
+
+  class RemoteServerError < SmartwaiverError
+  end
+
+end

data/lib/smartwaiver-sdk/smartwaiver_version.rb

@@ -0,0 +1,28 @@
+#
+# Copyright 2017 Smartwaiver
+#
+# Licensed under the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License. You may obtain
+# a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+# License for the specific language governing permissions and limitations
+# under the License.
+
+module SmartwaiverSDK
+  VERSION = "4.0.0"
+
+  class Info
+    @@ClientVersion = SmartwaiverSDK::VERSION
+    @@RubyVersion = RUBY_VERSION
+    @@UserAgent = "SmartwaiverAPI:#{@@ClientVersion}-Ruby:#{@@RubyVersion}";
+
+    def self.get_user_agent
+      return @@UserAgent
+    end
+  end
+end

data/lib/smartwaiver-sdk/template_client.rb

@@ -0,0 +1,42 @@
+#
+# Copyright 2017 Smartwaiver
+#
+# Licensed under the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License. You may obtain
+# a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+# License for the specific language governing permissions and limitations
+# under the License.
+
+require 'smartwaiver-sdk/smartwaiver_base'
+
+class SmartwaiverTemplateClient < SmartwaiverSDK::SmartwaiverBase
+
+  def initialize(api_key, api_endpoint = DEFAULT_API_ENDPOINT)
+    super(api_key, api_endpoint)
+    @rest_endpoints = define_rest_endpoints
+  end
+
+  def list
+    path =  @rest_endpoints[:configure]
+    make_api_request(path, HTTP_GET)
+  end
+
+  def get(template_id)
+    path =  "#{@rest_endpoints[:configure]}/#{template_id}"
+    make_api_request(path, HTTP_GET)
+  end
+
+  private
+
+  def define_rest_endpoints
+    {
+        :configure => "/v4/templates"
+    }
+  end
+end

data/lib/smartwaiver-sdk/waiver_client.rb

@@ -0,0 +1,55 @@
+#
+# Copyright 2017 Smartwaiver
+#
+# Licensed under the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License. You may obtain
+# a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+# License for the specific language governing permissions and limitations
+# under the License.
+
+require 'smartwaiver-sdk/smartwaiver_base'
+
+class SmartwaiverWaiverClient < SmartwaiverSDK::SmartwaiverBase
+
+  def initialize(api_key, api_endpoint = DEFAULT_API_ENDPOINT)
+    super(api_key, api_endpoint)
+    @rest_endpoints = define_rest_endpoints
+  end
+
+  def list(limit = 20, verified = nil, template_id = '', from_dts = '', to_dts = '')
+    path = "#{@rest_endpoints[:waivers]}?limit=#{limit}"
+    if !verified.nil?
+      path = "#{path}&verified=" + (verified ? 'true' : 'false')
+    end
+    if !template_id.empty?
+      path = "#{path}&templateId=#{template_id}"
+    end
+    if !from_dts.empty?
+      path = "#{path}&fromDts=#{from_dts}"
+    end
+    if !to_dts.empty?
+      path = "#{path}&toDts=#{to_dts}"
+    end
+    make_api_request(path, HTTP_GET)
+  end
+
+  def get(waiver_id, pdf=false)
+    path =  "#{@rest_endpoints[:waivers]}/#{waiver_id}?pdf=" + (pdf ? 'true' : 'false')
+    make_api_request(path, HTTP_GET)
+  end
+
+  private
+
+  def define_rest_endpoints
+    {
+        :waivers => "/v4/waivers"
+    }
+  end
+end
+

data/lib/smartwaiver-sdk/webhook_client.rb

@@ -0,0 +1,47 @@
+#
+# Copyright 2017 Smartwaiver
+#
+# Licensed under the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License. You may obtain
+# a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+# License for the specific language governing permissions and limitations
+# under the License.
+
+require 'smartwaiver-sdk/smartwaiver_base'
+
+class SmartwaiverWebhookClient < SmartwaiverSDK::SmartwaiverBase
+
+  WEBHOOK_AFTER_EMAIL_ONLY = 'yes'
+  WEBHOOK_BEFORE_EMAIL_ONLY = 'no'
+  WEBHOOK_BEFORE_AND_AFTER_EMAIL = 'both'
+
+  def initialize(api_key, api_endpoint = DEFAULT_API_ENDPOINT)
+    super(api_key, api_endpoint)
+    @rest_endpoints = define_rest_endpoints
+  end
+
+  def configuration
+    path =  @rest_endpoints[:configure]
+    make_api_request(path, HTTP_GET)
+  end
+
+  def configure(endpoint, email_validation_required)
+    path =  @rest_endpoints[:configure]
+    json = {:endpoint => endpoint, :emailValidationRequired => email_validation_required}.to_json
+    make_api_request(path, HTTP_PUT, json)
+  end
+
+  private
+
+  def define_rest_endpoints
+    {
+        :configure => "/v4/webhooks/configure"
+    }
+  end
+end

data/spec/smartwaiver-sdk/base_spec.rb

@@ -0,0 +1,203 @@
+
+dir = File.dirname(__FILE__)
+require "#{dir}/../spec_helper"
+require "#{dir}/../../lib/smartwaiver-sdk/smartwaiver_base"
+
+class SmartwaiverTest < SmartwaiverSDK::SmartwaiverBase
+  def get_test(path)
+    make_api_request(path, HTTP_GET)
+  end
+
+  def post_test(path, data)
+    make_api_request(path, HTTP_POST, data)
+  end
+
+  def put_test(path, data)
+    make_api_request(path, HTTP_PUT, data)
+  end
+
+  def parse_response_body_test(data)
+    parse_response_body(data)
+  end
+
+  def check_response_test(response)
+    check_response(response)
+  end
+
+end
+
+describe SmartwaiverSDK::SmartwaiverBase do
+
+  before do
+    FakeWeb.allow_net_connect = false
+    @api_key = "apikey"
+  end
+
+  describe "smartwaiver base object set up correctly" do
+    it "has correct headers and accepts a custom endpoint" do
+      test_endpoint = 'https://testapi.smartwaiver.com'
+      client = SmartwaiverSDK::SmartwaiverBase.new(@api_key, test_endpoint)
+      expect(client.instance_eval('@http').address).to eq("testapi.smartwaiver.com")
+    end
+  end
+
+  describe "#version" do
+    it "retrieves the current version of the API" do
+      FakeWeb.register_uri(:get, "https://api.smartwaiver.com/version", :body => json_api_version_results)
+      client = SmartwaiverSDK::SmartwaiverBase.new(@api_key)
+      version = client.api_version
+
+      expect(version[:version]).to eq(SmartwaiverSDK::VERSION)
+    end
+  end
+
+  describe "#make_api_request" do
+    before do
+      @client = SmartwaiverTest.new(@api_key)
+    end
+
+    it "GET" do
+      path = "#{API_URL}/get_test"
+      FakeWeb.register_uri(:get, path, :body => json_base_results)
+      @client.get_test(path)
+
+      request = FakeWeb.last_request
+      expect(request.method).to eq("GET")
+      expect(request.body).to eq(nil)
+      request.each_header do |key, value|
+        case key
+          when "user-agent"
+            expect(value).to match(/^SmartwaiverAPI*/)
+          when "sw-api-key"
+            expect(value).to eq(@api_key)
+        end
+      end
+    end
+
+    it "POST" do
+      path = "#{API_URL}/post_test"
+      data = "{\"json\":\"data\"}"
+      FakeWeb.register_uri(:post, path, :body => json_base_results)
+      @client.post_test(path, data)
+
+      request = FakeWeb.last_request
+      expect(request.method).to eq("POST")
+      expect(request.body).to eq(data)
+      request.each_header do |key, value|
+        case key
+          when "user-agent"
+            expect(value).to match(/^SmartwaiverAPI*/)
+          when "sw-api-key"
+            expect(value).to eq(@api_key)
+          when "content-type"
+            expect(value).to eq("application/json")
+        end
+      end
+    end
+
+    it "PUT" do
+      path = "#{API_URL}/put_test"
+      data = "{\"json\":\"data\"}"
+      FakeWeb.register_uri(:put, path, :body => json_base_results)
+      @client.put_test(path, data)
+
+      request = FakeWeb.last_request
+      expect(request.method).to eq("PUT")
+      expect(request.body).to eq(data)
+      request.each_header do |key, value|
+        case key
+          when "user-agent"
+            expect(value).to match(/^SmartwaiverAPI*/)
+          when "sw-api-key"
+            expect(value).to eq(@api_key)
+          when "content-type"
+            expect(value).to eq("application/json")
+        end
+      end
+    end
+  end
+
+  describe "#parse_response_body" do
+    before do
+      @client = SmartwaiverTest.new(@api_key)
+    end
+
+    it "parses valid json" do
+      json = '{"version":4, "id":"8e82fa534da14b76a05013644ee735d2", "ts":"2017-01-17T15:46:58+00:00", "type":"test"}'
+      data = @client.parse_response_body_test(json)
+
+      expect(data[:version]).to eq(4)
+      expect(data[:id]).to eq("8e82fa534da14b76a05013644ee735d2")
+      expect(data[:ts]).to eq("2017-01-17T15:46:58+00:00")
+      expect(data[:type]).to eq("test")
+    end
+
+    it "returns base parameters if json is invalid" do
+      json = 'bad-json'
+      data = @client.parse_response_body_test(json)
+
+      expect(data[:version]).to eq(0)
+      expect(data[:id]).to eq("")
+      expect(data[:ts]).to eq("1970-01-01T00:00:00+00:00")
+      expect(data[:type]).to eq("")
+    end
+  end
+
+  describe "#check_response" do
+    it "HTTP 200" do
+      path = "#{API_URL}/get_test"
+      FakeWeb.register_uri(:get, path, :body => json_base_results)
+      uri = URI.parse(path)
+      Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |req|
+        response = req.get('/get_test')
+        @client = SmartwaiverTest.new(@api_key)
+        expect {@client.check_response_test(response)}.to_not raise_error
+      end
+    end
+
+    it "HTTP Unauthorized" do
+      path = "#{API_URL}/error_test"
+      FakeWeb.register_uri(:get, path, :body => json_base_results, :status => ["401", "Unauthorized"])
+      uri = URI.parse(path)
+      Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |req|
+        response = req.get('/error_test')
+        @client = SmartwaiverTest.new(@api_key)
+        expect {@client.check_response_test(response)}.to raise_error(SmartwaiverSDK::BadAPIKeyError)
+      end
+
+    end
+
+    it "HTTP NotAcceptable" do
+      path = "#{API_URL}/error_test"
+      FakeWeb.register_uri(:get, path, :body => json_base_results, :status => ["406", "Not Acceptable"])
+      uri = URI.parse(path)
+      Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |req|
+        response = req.get('/error_test')
+        @client = SmartwaiverTest.new(@api_key)
+        expect {@client.check_response_test(response)}.to raise_error(SmartwaiverSDK::BadFormatError)
+      end
+    end
+
+    it "HTTP Client Error" do
+      path = "#{API_URL}/error_test"
+      FakeWeb.register_uri(:get, path, :body => json_base_results, :status => ["404", "Not Found"])
+      uri = URI.parse(path)
+      Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |req|
+        response = req.get('/error_test')
+        @client = SmartwaiverTest.new(@api_key)
+        expect {@client.check_response_test(response)}.to raise_error(SmartwaiverSDK::RemoteServerError)
+      end
+    end
+
+    it "HTTP Server Error" do
+      path = "#{API_URL}/error_test"
+      FakeWeb.register_uri(:get, path, :body => json_base_results, :status => ["500", "Internal Server Error"])
+      uri = URI.parse(path)
+      Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |req|
+        response = req.get('/error_test')
+        @client = SmartwaiverTest.new(@api_key)
+        expect {@client.check_response_test(response)}.to raise_error(SmartwaiverSDK::RemoteServerError)
+      end
+    end
+  end
+end

data/spec/smartwaiver-sdk/template_client_spec.rb

@@ -0,0 +1,35 @@
+dir = File.dirname(__FILE__)
+require "#{dir}/../spec_helper"
+require "#{dir}/../../lib/smartwaiver-sdk/template_client"
+
+describe SmartwaiverTemplateClient do
+  attr_reader :client, :api_key
+
+  before do
+    FakeWeb.allow_net_connect = false
+    @api_key = "apikey"
+    @client = SmartwaiverTemplateClient.new(@api_key)
+  end
+
+  describe "templates" do
+    it "#initialize" do
+      expect(@client).to be_kind_of(SmartwaiverTemplateClient)
+    end
+
+    it "#list" do
+      path = "#{API_URL}/v4/templates"
+      FakeWeb.register_uri(:get, path, :body => json_template_list_results)
+      result = @client.list
+
+      expect(result[:templates].length).to eq(3)
+    end
+
+    it "#get" do
+      template_id = "586ffe15134bc"
+      path = "#{API_URL}/v4/templates/#{template_id}"
+      FakeWeb.register_uri(:get, path, :body => json_template_single_results)
+      result = @client.get(template_id)
+      expect(result[:template][:templateId]).to eq(template_id)
+    end
+  end
+end

data/spec/smartwaiver-sdk/waiver_client_spec.rb

@@ -0,0 +1,57 @@
+dir = File.dirname(__FILE__)
+require "#{dir}/../spec_helper"
+require "#{dir}/../../lib/smartwaiver-sdk/waiver_client"
+
+describe SmartwaiverWaiverClient do
+  attr_reader :client, :api_key
+
+  before do
+    FakeWeb.allow_net_connect = false
+    @api_key = "apikey"
+    @client = SmartwaiverWaiverClient.new(@api_key)
+  end
+
+  describe "waivers" do
+    it "#initialize" do
+      expect(@client).to be_kind_of(SmartwaiverWaiverClient)
+    end
+
+    it "#list all default values" do
+      path = "#{API_URL}/v4/waivers?limit=20"
+      FakeWeb.register_uri(:get, path, :body => json_waiver_list_results)
+      result = @client.list
+      expect(result[:waivers].length).to eq(3)
+    end
+
+    it "#list with all values specified" do
+      limit = 3
+      verified = true
+      template_id = "586ffe15134bd"
+      from_dts = '2017-01-01T00:00:00Z'
+      to_dts = '2017-02-01T00:00:00Z'
+
+      path = "#{API_URL}/v4/waivers?limit=#{limit}&verified=#{verified}&templateId=#{template_id}&fromDts=#{from_dts}&toDts=#{to_dts}"
+      FakeWeb.register_uri(:get, path, :body => json_waiver_list_results)
+      @client.list(limit, verified, template_id, from_dts, to_dts)
+    end
+
+    it "#get without pdf" do
+      waiver_id = "Vzy8f6gnCWVcQBURdydwPT"
+      path = "#{API_URL}/v4/waivers/#{waiver_id}?pdf=false"
+      FakeWeb.register_uri(:get, path, :body => json_waiver_single_results)
+      result = @client.get(waiver_id)
+
+      expect(result[:waiver][:waiverId]).to eq(waiver_id)
+      expect(result[:waiver][:participants].length).to eq(2)
+      expect(result[:waiver][:customWaiverFields][:"58458759da897"][:value]).to eq ("Testing")
+    end
+
+    it "#get with pdf" do
+      waiver_id = "Vzy8f6gnCWVcQBURdydwPT"
+      path = "#{API_URL}/v4/waivers/#{waiver_id}?pdf=true"
+      FakeWeb.register_uri(:get, path, :body => json_waiver_single_results)
+      @client.get(waiver_id, true)
+    end
+
+  end
+end

data/spec/smartwaiver-sdk/webhook_client_spec.rb

@@ -0,0 +1,40 @@
+dir = File.dirname(__FILE__)
+require "#{dir}/../spec_helper"
+require "#{dir}/../../lib/smartwaiver-sdk/webhook_client"
+
+describe SmartwaiverWebhookClient do
+  attr_reader :client, :api_key
+
+  before do
+    FakeWeb.allow_net_connect = false
+    @api_key = "apikey"
+    @client = SmartwaiverWebhookClient.new(@api_key)
+  end
+
+  describe "webhooks" do
+    it "#initialize" do
+      expect(@client).to be_kind_of(SmartwaiverWebhookClient)
+    end
+
+    it "#configuration" do
+      path="#{API_URL}/v4/webhooks/configure"
+      FakeWeb.register_uri(:get, path, :body => json_webhook_configuration_results)
+
+      response = @client.configuration
+      expect(response[:webhooks].length).to eq(2)
+    end
+
+    it "#configure" do
+      endpoint="http://requestb.in/1ajthro1"
+      email_validation_required="yes"
+
+      path="#{API_URL}/v4/webhooks/configure"
+      FakeWeb.register_uri(:put, path, :body => json_webhook_configuration_results)
+
+      response = @client.configure(endpoint, email_validation_required)
+      expect(response[:webhooks][:endpoint]).to eq(endpoint)
+      expect(response[:webhooks][:emailValidationRequired]).to eq(email_validation_required)
+    end
+
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,129 @@
+dir = File.dirname(__FILE__)
+
+require 'rubygems'
+require 'fakeweb'
+require 'rr'
+require 'json'
+
+$LOAD_PATH << "#{dir}/../lib/smartwaiver-sdk"
+require 'smartwaiver_base'
+require 'smartwaiver_errors'
+
+API_URL = 'https://api.smartwaiver.com'
+
+def json_parse(data)
+  JSON.parse(data, :symbolize_names => true)
+end
+
+def json_api_version_results
+  json = <<JAVASCRIPT
+{"version": "4.0.0"}
+JAVASCRIPT
+  json
+end
+
+def json_base_results
+  json = <<JAVASCRIPT
+{"version":4, "id":"8e82fa534da14b76a05013644ee735d2", "ts":"2017-01-17T15:46:58+00:00", "type":""}
+JAVASCRIPT
+end
+
+def json_webhook_configuration_results
+  json = <<JAVASCRIPT
+{"version":4, "id":"8e82fa534da14b76a05013644ee735d2", "ts":"2017-01-17T15:46:58+00:00", "type":"webhooks", "webhooks":{"endpoint":"http://requestb.in/1ajthro1", "emailValidationRequired":"yes"}}
+JAVASCRIPT
+end
+
+def json_webhook_configure_results
+  json = <<JAVASCRIPT
+{"version":4, "id":"8e82fa534da14b76a05013644ee735d2", "ts":"2017-01-17T15:46:58+00:00", "type":"webhooks", "webhooks":{"endpoint":"http://requestb.in/1ajthro2", "emailValidationRequired":"yes"}}
+JAVASCRIPT
+end
+
+
+def json_template_list_results
+  json = <<JAVASCRIPT
+{"version":4,"id":"05928f4b1b3849c9a73aca257808f1d5","ts":"2017-01-17T22:33:56+00:00","type":"templates","templates":
+  [{"templateId":"586ffe15134bc","title":"Template 1","publishedVersion":1,"publishedOn":"2017-01-06 20:33:35","webUrl":"https:\/\/www.smartwaiver.com\/w\/586ffe15134bc\/web\/","kioskUrl":"https:\/\/www.smartwaiver.com\/w\/586ffe15134bc\/kiosk\/"},
+   {"templateId":"5845e3a0add4d","title":"Template 2","publishedVersion":3,"publishedOn":"2017-01-05 20:33:35","webUrl":"https:\/\/www.smartwaiver.com\/w\/5845e3a0add4d\/web\/","kioskUrl":"https:\/\/www.smartwaiver.com\/w\/5845e3a0add4d\/kiosk\/"},
+   {"templateId":"56ce3bb69c748","title":"Template 3","publishedVersion":4,"publishedOn":"2016-02-24 23:34:37","webUrl":"https:\/\/www.smartwaiver.com\/w\/56ce3bb69c748\/web\/","kioskUrl":"https:\/\/www.smartwaiver.com\/w\/56ce3bb69c748\/kiosk\/"}
+  ]
+}
+JAVASCRIPT
+end
+
+def json_template_single_results
+  json = <<JAVASCRIPT
+{"version":4,"id":"81b24d6b6c364ead9af037c5652b897e","ts":"2017-01-19T01:02:36+00:00","type":"template","template":{"templateId":"586ffe15134bc","title":"Template 1","publishedVersion":1,"publishedOn":"2017-01-06 20:33:35","webUrl":"https:\/\/www.smartwaiver.com\/w\/586ffe15134bc\/web\/","kioskUrl":"https:\/\/www.smartwaiver.com\/w\/586ffe15134bc\/kiosk\/"}}
+JAVASCRIPT
+end
+
+def json_waiver_list_results
+  json = <<JAVASCRIPT
+{"version":4,"id":"f73838873a6b470d804ff2cfe002e0de","ts":"2017-01-19T01:18:42+00:00","type":"waivers","waivers":
+  [{"waiverId":"Vzy8f6gnCWVcQBURdydwPT","templateId":"586ffe15134bc","title":"Template 1","createdOn":"2017-01-06 21:28:13","expirationDate":"","expired":false,"verified":true,"kiosk":true,"firstName":"John","middleName":"","lastName":"Doe","dob":"1987-06-09","isMinor":false,"tags":[]},
+   {"waiverId":"ko4C4rcUvHe3VnfKJ2Cmr6","templateId":"586ffe15134bc","title":"Template 1","createdOn":"2017-01-06 21:25:26","expirationDate":"","expired":false,"verified":true,"kiosk":true,"firstName":"Jane","middleName":"","lastName":"Doe","dob":"1983-07-01","isMinor":false,"tags":[]},
+   {"waiverId":"VUey8JHxC4ED2r7jiWszNE","templateId":"586ffe15134bc","title":"Template 1","createdOn":"2017-01-06 20:39:03","expirationDate":"","expired":false,"verified":true,"kiosk":true,"firstName":"Jimmy","middleName":"","lastName":"Smith","dob":"1980-03-07","isMinor":false,"tags":[]}
+  ]}
+JAVASCRIPT
+end
+
+def json_waiver_single_results
+  json = <<JAVASCRIPT
+{"version":4,"id":"7730a96154874baca44ec7ac3444ebee","ts":"2017-01-19T01:22:50+00:00","type":"waiver","waiver":
+    {"waiverId":"Vzy8f6gnCWVcQBURdydwPT",
+     "templateId":"586ffe15134bc",
+     "title":"Template 1",
+     "createdOn":"2016-12-05 19:58:42",
+     "expirationDate":"",
+     "expired":false,
+     "verified":true,
+     "kiosk":false,
+     "firstName":"Jane",
+     "middleName":"L",
+     "lastName":"Smith",
+     "dob":"2004-07-01",
+     "isMinor":true,
+     "tags":[],
+     "participants":[
+       {"firstName":"Jane",
+        "middleName":"L",
+        "lastName":"Smith",
+        "dob":"2004-07-01",
+        "isMinor":true,
+        "gender":"Female",
+        "phone":"888-555-1214",
+        "tags":[],
+        "customParticipantFields":{"58458713a384a":{"value":"Short","displayText":"Custom text for minor"}}
+       },
+       {"firstName":"Joe",
+        "middleName":"",
+        "lastName":"Smith",
+        "dob":"1969-02-02",
+        "isMinor":false,
+        "gender":"Male",
+        "phone":"888-555-1213",
+        "tags":[],
+        "customParticipantFields":{"58458713a384a":{"value":"Hello World","displayText":"Custom text for minor"}}}
+     ],
+     "customWaiverFields":{"58458759da897":{"value":"Testing","displayText":"Question at waiver fields"}},
+     "guardian":null,
+     "email":"cs@smartwaiver.com",
+     "marketingAllowed":true,
+     "addressLineOne":"123 Main St",
+     "addressLineTwo":"",
+     "addressCity":"Bend",
+     "addressState":"OR",
+     "addressZip":"97703",
+     "addressCountry":"US",
+     "emergencyContactName":"John Doe",
+     "emergencyContactPhone":"888-555-1212",
+     "insuranceCarrier":"BlueCross",
+     "insurancePolicyNumber":"X001234",
+     "driversLicenseNumber":"C1234324",
+     "driversLicenseState":"CA",
+     "clientIP":"127.0.0.1",
+     "pdf":""}
+}
+JAVASCRIPT
+end

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification
+name: smartwaiver-sdk
+version: !ruby/object:Gem::Version
+  version: 4.0.0
+platform: ruby
+authors:
+- Smartwaiver
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-01-24 00:00:00.000000000 Z
+dependencies: []
+description: The Smartwaiver SDK uses version 4 of the Smartwaiver API
+email:
+- cs@smartwaiver.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- README.md
+- Rakefile
+- lib/smartwaiver-sdk.rb
+- lib/smartwaiver-sdk/smartwaiver_base.rb
+- lib/smartwaiver-sdk/smartwaiver_errors.rb
+- lib/smartwaiver-sdk/smartwaiver_version.rb
+- lib/smartwaiver-sdk/template_client.rb
+- lib/smartwaiver-sdk/waiver_client.rb
+- lib/smartwaiver-sdk/webhook_client.rb
+- spec/smartwaiver-sdk/base_spec.rb
+- spec/smartwaiver-sdk/template_client_spec.rb
+- spec/smartwaiver-sdk/waiver_client_spec.rb
+- spec/smartwaiver-sdk/webhook_client_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/smartwaivercom/ruby-sdk
+licenses:
+- Apache-2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+- lib/smartwaiver-sdk
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: smartwaiver-sdk
+rubygems_version: 2.6.8
+signing_key: 
+specification_version: 4
+summary: Smartwaiver SDK for version 4 of the API
+test_files:
+- spec/smartwaiver-sdk/base_spec.rb
+- spec/smartwaiver-sdk/template_client_spec.rb
+- spec/smartwaiver-sdk/waiver_client_spec.rb
+- spec/smartwaiver-sdk/webhook_client_spec.rb
+- spec/spec_helper.rb