docusign_monitor 1.0.0.beta1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5a706c627c950f185c15a90ff568768725285f785690a9942f0b2831cfc2f9f6
+  data.tar.gz: 7afec697c7cbf634b852ca2613f2d17ccfbac8b30f1814a05df7b8de0e9c35d6
+SHA512:
+  metadata.gz: de4654e3096578aa87ad5a48256f0a26a60b193698a42437e03c5c3437d00e06cf147433db588d8e66a1e63320819df018559de035a2b1890b582ec847827f68
+  data.tar.gz: af19aa01ea42949f7494d2a05d36496037ecd8c2d38374e2b3fe1aff97caf8f1b456d908464dc9fffbaa64c3202c0c977f6e681d0ad1098d7dbfe0670011f3fc

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+# DocuSign Monitor Ruby Client Changelog
+See [DocuSign Support Center](https://support.docusign.com/en/releasenotes/) for Product Release Notes.
+
+## [v1.0.0.beta1] - DocuSign Monitor API v1 - 05/14/2021
+### Changed
+- First BETA version of Monitor API, supports DocuSign Monitor v2.0

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'rake', '~> 12.3.3'
+end

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2022- DocuSign, Inc. (https://www.docusign.com)
+
+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,80 @@
+# The Official DocuSign Monitor Client
+
+[![RubyGems version][rubygems-image]][rubygems-url]
+[![RubyGems downloads][downloads-image]][downloads-url]
+[![Build status][travis-image]][travis-url]
+
+## Requirements
+
+- Ruby 1.9+
+- Free [Developer Sandbox](https://go.docusign.com/sandbox/productshot/?elqCampaignId=16531)
+
+## Compatibility
+
+- Ruby 1.9+
+
+## Note
+
+This open-source SDK is provided for cases where you would like to make additional changes that the SDK does not provide out-of-the-box. If you simply want to use the SDK with any of the examples shown in the [Developer Center](https://developers.docusign.com/esign-rest-api/code-examples), follow the installation instructions below.
+
+## Installation
+
+### Install via your application's **Gemfile**:
+
+1. In your application's **Gemfile**, add:  
+   **gem 'docusign_monitor'**
+2. Open your preferred console.
+3. In your project directory, execute the installer by typing:  
+   **bundle install**
+
+### Manual install:
+
+1. Open your preferred console.
+2. In the console, type:  
+   **gem install docusign_monitor**
+
+### Dependencies
+
+This client has the following external dependencies:
+
+- Jwt>=1.5.2
+- Json>=2.1.0
+- Typhoeus>=1.0.1
+
+## Code Examples
+
+### Launchers
+
+DocuSign provides a sample application code referred to as a [Launcher](https://github.com/docusign/code-examples-ruby). The Launcher contains a set of 31 common use cases and associated source files. These examples use either DocuSign's [Authorization Code Grant](https://developers.docusign.com/esign-rest-api/guides/authentication/oauth2-code-grant) or [JSON Web Tokens (JWT)](https://developers.docusign.com/esign-rest-api/guides/authentication/oauth2-jsonwebtoken) flows.
+
+### Proof-of-concept applications
+
+If your goal is to create a proof-of-concept application, DocuSign provides a set of [Quick Start](https://github.com/docusign/qs-ruby) examples. The Quick Start examples are meant to be used with DocuSign's [OAuth Token Generator](https://developers.docusign.com/oauth-token-generator), which will allow you to generate tokens for the Demo/Sandbox environment only. These tokens last for eight hours and will enable you to build your proof-of-concept application without the need to fully implement an OAuth solution.
+
+## OAuth Implementations
+
+For details regarding which type of OAuth grant will work best for your DocuSign integration, see the [REST API Authentication Overview](https://developers.docusign.com/esign-rest-api/guides/authentication) guide located on the [DocuSign Developer Center](https://developers.docusign.com/esign-rest-api/guides/authentication).
+
+For security purposes, DocuSign recommends using the [Authorization Code Grant](https://developers.docusign.com/esign-rest-api/guides/authentication/oauth2-code-grant) flow.
+
+
+## Support
+
+Log issues against this client through GitHub. We also have an [active developer community on Stack Overflow](https://stackoverflow.com/questions/tagged/docusignapi).
+
+## License
+
+The DocuSign Ruby Client is licensed under the [MIT License](https://github.com/docusign/docusign-ruby-client/blob/master/LICENSE).
+
+[rubygems-image]: https://img.shields.io/gem/v/docusign_monitor.svg?style=flat
+[rubygems-url]: https://rubygems.org/gems/docusign_monitor
+[downloads-image]: https://img.shields.io/gem/dt/docusign_monitor.svg?style=flat
+[downloads-url]: https://rubygems.org/gems/docusign_monitor
+[travis-image]: https://img.shields.io/travis/docusign/docusign-monitor-ruby-client.svg?style=flat
+[travis-url]: https://travis-ci.org/docusign/docusign-monitor-ruby-client
+
+### Additional Resources
+* [DocuSign Developer Center](https://developers.docusign.com)
+* [DocuSign API on Twitter](https://twitter.com/docusignapi)
+* [DocuSign For Developers on LinkedIn](https://www.linkedin.com/showcase/docusign-for-developers/)
+* [DocuSign For Developers on YouTube](https://www.youtube.com/channel/UCJSJ2kMs_qeQotmw4-lX2NQ)

data/Rakefile

@@ -0,0 +1,8 @@
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError
+  # no rspec available
+end

data/docusign_monitor.gemspec

@@ -0,0 +1,46 @@
+# -*- encoding: utf-8 -*-
+
+=begin
+#DocuSign Monitor API
+
+#An API for an integrator to access the features of DocuSign Monitor
+
+OpenAPI spec version: v2
+Contact: devcenter@docusign.com
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+
+=end
+
+$:.push File.expand_path("../lib", __FILE__)
+require "docusign_monitor/version"
+
+Gem::Specification.new do |s|
+  s.name        = "docusign_monitor"
+  s.version     = DocuSign_Monitor::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["DocuSign"]
+  s.email       = ["devcenter@docusign.com"]
+  s.homepage    = "https://github.com/docusign/docusign-monitor-ruby-client"
+  s.summary     = "DocuSign Monitor API Ruby Gem"
+  s.description = "The DocuSign package makes integrating DocuSign into your apps and websites a super fast and painless process. The library is open sourced on GitHub, look for the docusign-monitor-ruby-client repository."
+  s.license     = "MIT"
+  s.required_ruby_version = ">= 1.9"
+
+  s.add_runtime_dependency 'jwt', '~> 2.2', '>= 2.2.1'
+  s.add_runtime_dependency 'addressable', '~> 2.7', '>= 2.7.0'
+  s.add_runtime_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'
+  s.add_runtime_dependency 'json', '~> 2.1', '>= 2.1.0'
+
+  s.add_development_dependency 'rspec', '~> 3.6', '>= 3.6.0'
+  s.add_development_dependency 'vcr', '~> 3.0', '>= 3.0.1'
+  s.add_development_dependency 'webmock', '~> 1.24', '>= 1.24.3'
+  s.add_development_dependency 'autotest', '~> 4.4', '>= 4.4.6'
+  s.add_development_dependency 'autotest-rails-pure', '~> 4.1', '>= 4.1.2'
+  s.add_development_dependency 'autotest-growl', '~> 0.2', '>= 0.2.16'
+  s.add_development_dependency 'autotest-fsevent', '~> 0.2', '>= 0.2.12'
+
+  s.files         = `find *`.split("\n").uniq.sort.select { |f| !f.empty? }
+  s.test_files    = `find spec/*`.split("\n")
+  s.executables   = []
+  s.require_paths = ["lib"]
+end

data/git_push.sh

@@ -0,0 +1,55 @@
+#!/bin/sh
+#
+# Generated by: https://github.com/swagger-api/swagger-codegen.git
+#
+# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/
+#
+# Usage example: /bin/sh ./git_push.sh wing328 swagger-petstore-perl "minor update"
+
+git_user_id=$1
+git_repo_id=$2
+release_note=$3
+
+if [ "$git_user_id" = "" ]; then
+    git_user_id="GIT_USER_ID"
+    echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id"
+fi
+
+if [ "$git_repo_id" = "" ]; then
+    git_repo_id="GIT_REPO_ID"
+    echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id"
+fi
+
+if [ "$release_note" = "" ]; then
+    release_note="Minor update"
+    echo "[INFO] No command line input provided. Set \$release_note to $release_note"
+fi
+
+# Initialize the local directory as a Git repository
+git init
+
+# Adds the files in the local repository and stages them for commit.
+git add .
+
+# Commits the tracked changes and prepares them to be pushed to a remote repository.
+git commit -m "$release_note"
+
+# Sets the new remote
+git_remote=`git remote`
+if [ "$git_remote" = "" ]; then # git remote not defined
+
+    if [ "$GIT_TOKEN" = "" ]; then
+        echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git crediential in your environment."
+        git remote add origin https://github.com/${git_user_id}/${git_repo_id}.git
+    else
+        git remote add origin https://${git_user_id}:${GIT_TOKEN}@github.com/${git_user_id}/${git_repo_id}.git
+    fi
+
+fi
+
+git pull origin master
+
+# Pushes (Forces) the changes in the local repository up to the remote repository
+echo "Git pushing to https://github.com/${git_user_id}/${git_repo_id}.git"
+git push origin master 2>&1 | grep -v 'To https'
+

data/lib/docusign_monitor.rb

@@ -0,0 +1,43 @@
+=begin
+#DocuSign Monitor API - v2
+
+#An API for an integrator to access the features of DocuSign Monitor
+
+OpenAPI spec version: v2.0
+Contact: devcenter@docusign.com
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+
+=end
+
+# Common files
+require 'docusign_monitor/client/api_client'
+require 'docusign_monitor/client/api_error'
+require 'docusign_monitor/version'
+require 'docusign_monitor/configuration'
+
+# Client Files
+require 'docusign_monitor/client/auth/oauth'
+
+# Models
+require 'docusign_monitor/models/cursored_result'
+
+# APIs
+require 'docusign_monitor/api/data_set_api'
+
+module DocuSign_Monitor
+  class << self
+    # Customize default settings for the SDK using block.
+    #   DocuSign_Monitor.configure do |config|
+    #     config.username = "xxx"
+    #     config.password = "xxx"
+    #   end
+    # If no block given, return the default Configuration object.
+    def configure
+      if block_given?
+        yield(Configuration.default)
+      else
+        Configuration.default
+      end
+    end
+  end
+end

data/lib/docusign_monitor/api/data_set_api.rb

@@ -0,0 +1,95 @@
+=begin
+#DocuSign Monitor API - v2
+
+#An API for an integrator to access the features of DocuSign Monitor
+
+OpenAPI spec version: v2.0
+Contact: devcenter@docusign.com
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+
+=end
+
+require "uri"
+
+module DocuSign_Monitor
+
+  class GetStreamOptions
+    # The cursor value to continue querying the data with. For an intial call, use empty string
+    attr_accessor :cursor
+
+    # The maximum number of records to return, minimum of 1, maximum of 2000. Defaults to 1000 if no value is provided
+    attr_accessor :limit
+
+    def self.default
+      @@default ||= GetStreamOptions.new
+    end
+  end
+
+
+  class DataSetApi
+    attr_accessor :api_client
+
+    def initialize(api_client = DataSetApi.default)
+      @api_client = api_client
+    end
+
+    # 
+    # Allows for the streaming of data as it becomes available  Required scopes: impersonation
+    # @param data_set_name The name of the dataset to stream
+    # @param version The requested API version
+    # @param DocuSign_Monitor::GetStreamOptions Options for modifying the behavior of the function.
+    # @return [CursoredResult]
+    def get_stream(data_set_name, version, options = DocuSign_Monitor::GetStreamOptions.default)
+      data, _status_code, _headers = get_stream_with_http_info(data_set_name, version, options)
+      return data
+    end
+
+    # 
+    # Allows for the streaming of data as it becomes available  Required scopes: impersonation
+    # @param data_set_name The name of the dataset to stream
+    # @param version The requested API version
+    # @param DocuSign_Monitor::GetStreamOptions Options for modifying the behavior of the function.
+    # @return [Array<(CursoredResult, Fixnum, Hash)>] CursoredResult data, response status code and response headers
+    def get_stream_with_http_info(data_set_name, version, options = DocuSign_Monitor::GetStreamOptions.default)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: DataSetApi.get_stream ..."
+      end
+      # verify the required parameter 'data_set_name' is set
+      fail ArgumentError, "Missing the required parameter 'data_set_name' when calling DataSetApi.get_stream" if data_set_name.nil?
+      # verify the required parameter 'version' is set
+      fail ArgumentError, "Missing the required parameter 'version' when calling DataSetApi.get_stream" if version.nil?
+      # resource path
+      local_var_path = "/api/v{version}/datasets/{dataSetName}/stream".sub('{format}','json').sub('{' + 'dataSetName' + '}', data_set_name.to_s).sub('{' + 'version' + '}', version.to_s)
+
+      # query parameters
+      query_params = {}
+      query_params[:'cursor'] = options.cursor if !options.cursor.nil?
+      query_params[:'limit'] = options.limit if !options.limit.nil?
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = []
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'CursoredResult')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: DataSetApi#get_stream\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/docusign_monitor/client/api_client.rb

@@ -0,0 +1,591 @@
+=begin
+#DocuSign Monitor API
+
+#An API for an integrator to access the features of DocuSign Monitor
+
+OpenAPI spec version: v2
+Contact: devcenter@docusign.com
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+
+=end
+
+require 'date'
+require 'json'
+require 'logger'
+require 'tempfile'
+require 'typhoeus'
+require 'uri'
+require 'jwt'
+require 'addressable/uri'
+
+module DocuSign_Monitor
+  class ApiClient
+    # The Configuration object holding settings to be used in the API client.
+    attr_accessor :config
+
+    # Defines the headers to be used in HTTP requests of all API calls by default.
+    #
+    # @return [Hash]
+    attr_accessor :default_headers
+
+    attr_accessor :base_path
+    attr_accessor :oauth_base_path
+
+    # Initializes the ApiClient
+    # @option config [Configuration] Configuration for initializing the object, default to Configuration.default
+    def initialize(config = Configuration.default)
+      @config = config
+      @user_agent = "Swagger-Codegen/#{VERSION}/ruby"
+      @default_headers = {
+        'Content-Type' => "application/json",
+        'User-Agent' => @user_agent
+      }
+    end
+
+    def self.default
+      @@default ||= ApiClient.new
+    end
+
+    # Call an API with given options.
+    #
+    # @return [Array<(Object, Fixnum, Hash)>] an array of 3 elements:
+    #   the data deserialized from response body (could be nil), response status code and response headers.
+    def call_api(http_method, path, opts = {})
+      request = build_request(http_method, path, opts)
+      response = request.run
+
+      if @config.debugging
+        @config.logger.debug "HTTP response body ~BEGIN~\n#{response.body}\n~END~\n"
+      end
+
+      unless response.success?
+        if response.timed_out?
+          fail ApiError.new('Connection timed out')
+        elsif response.code == 0
+          # Errors from libcurl will be made visible here
+          fail ApiError.new(:code => 0,
+                            :message => response.return_message)
+        else
+          fail ApiError.new(:code => response.code,
+                            :response_headers => response.headers,
+                            :response_body => response.body),
+               response.status_message
+        end
+      end
+
+      if opts[:return_type]
+        data = deserialize(response, opts[:return_type])
+      else
+        data = nil
+      end
+      return data, response.code, response.headers
+    end
+
+    # Builds the HTTP request
+    #
+    # @param [String] http_method HTTP method/verb (e.g. POST)
+    # @param [String] path URL path (e.g. /account/new)
+    # @option opts [Hash] :header_params Header parameters
+    # @option opts [Hash] :query_params Query parameters
+    # @option opts [Hash] :form_params Query parameters
+    # @option opts [Object] :body HTTP body (JSON/XML)
+    # @return [Typhoeus::Request] A Typhoeus Request
+    def build_request(http_method, path, opts = {})
+      url = build_request_url(path, opts)
+      http_method = http_method.to_sym.downcase
+
+      header_params = @default_headers.merge(opts[:header_params] || {})
+
+      # Add SDK default header
+      header_params.store("X-DocuSign-SDK", "Ruby")
+
+      query_params = opts[:query_params] || {}
+      form_params = opts[:form_params] || {}
+
+      update_params_for_auth! header_params, query_params, opts[:auth_names]
+
+      # set ssl_verifyhosts option based on @config.verify_ssl_host (true/false)
+      _verify_ssl_host = @config.verify_ssl_host ? 2 : 0
+
+      req_opts = {
+        :method => http_method,
+        :headers => header_params,
+        :params => query_params,
+        :params_encoding => @config.params_encoding,
+        :timeout => @config.timeout,
+        :ssl_verifypeer => @config.verify_ssl,
+        :ssl_verifyhost => _verify_ssl_host,
+        :sslcert => @config.cert_file,
+        :sslkey => @config.key_file,
+        :verbose => @config.debugging
+      }
+
+      # set custom cert, if provided
+      req_opts[:cainfo] = @config.ssl_ca_cert if @config.ssl_ca_cert
+
+      if [:post, :patch, :put, :delete].include?(http_method)
+        req_body = build_request_body(header_params, form_params, opts[:body])
+        req_opts.update :body => req_body
+        if @config.debugging
+          @config.logger.debug "HTTP request body param ~BEGIN~\n#{req_body}\n~END~\n"
+        end
+      end
+
+      Typhoeus::Request.new(url, req_opts)
+    end
+
+    # Check if the given MIME is a JSON MIME.
+    # JSON MIME examples:
+    #   application/json
+    #   application/json; charset=UTF8
+    #   APPLICATION/JSON
+    #   */*
+    # @param [String] mime MIME
+    # @return [Boolean] True if the MIME is application/json
+    def json_mime?(mime)
+       (mime == "*/*") || !(mime =~ /\Aapplication\/json(;.*)?\z/i).nil?
+    end
+
+    # Deserialize the response to the given return type.
+    #
+    # @param [Response] response HTTP response
+    # @param [String] return_type some examples: "User", "Array[User]", "Hash[String,Integer]"
+    def deserialize(response, return_type)
+      body = response.body
+      return nil if body.nil? || body.empty?
+
+      # return response body directly for String return type
+      return body if return_type == 'String'
+
+      # handle file downloading - save response body into a tmp file and return the File instance
+      return download_file(response) if return_type == 'File'
+
+      # ensuring a default content type
+      content_type = response.headers['Content-Type'] || 'application/json'
+
+      fail "Content-Type is not supported: #{content_type}" unless json_mime?(content_type)
+
+      begin
+        data = JSON.parse("[#{body}]", :symbolize_names => true)[0]
+      rescue JSON::ParserError => e
+        if %w(String Date DateTime).include?(return_type)
+          data = body
+        else
+          raise e
+        end
+      end
+
+      convert_to_type data, return_type
+    end
+
+    # Convert data to the given return type.
+    # @param [Object] data Data to be converted
+    # @param [String] return_type Return type
+    # @return [Mixed] Data in a particular type
+    def convert_to_type(data, return_type)
+      return nil if data.nil?
+      case return_type
+      when 'String'
+        data.to_s
+      when 'Integer'
+        data.to_i
+      when 'Float'
+        data.to_f
+      when 'BOOLEAN'
+        data == true
+      when 'DateTime'
+        # parse date time (expecting ISO 8601 format)
+        DateTime.parse data
+      when 'Date'
+        # parse date time (expecting ISO 8601 format)
+        Date.parse data
+      when 'Object'
+        # generic object (usually a Hash), return directly
+        data
+      when /\AArray<(.+)>\z/
+        # e.g. Array<Pet>
+        sub_type = $1
+        data.map {|item| convert_to_type(item, sub_type) }
+      when /\AHash\<String, (.+)\>\z/
+        # e.g. Hash<String, Integer>
+        sub_type = $1
+        {}.tap do |hash|
+          data.each {|k, v| hash[k] = convert_to_type(v, sub_type) }
+        end
+      else
+        # models, e.g. Pet
+        DocuSign_Monitor.const_get(return_type).new.tap do |model|
+          model.build_from_hash data
+        end
+      end
+    end
+
+    # Save response body into a file in (the defined) temporary folder, using the filename
+    # from the "Content-Disposition" header if provided, otherwise a random filename.
+    #
+    # @see Configuration#temp_folder_path
+    # @return [Tempfile] the file downloaded
+    def download_file(response)
+      content_disposition = response.headers['Content-Disposition']
+      if content_disposition and content_disposition =~ /filename=/i
+        filename = content_disposition[/filename=['"]?([^'"\s]+)['"]?/, 1]
+        prefix = sanitize_filename(filename)
+      else
+        prefix = 'download-'
+      end
+      prefix = prefix + '-' unless prefix.end_with?('-')
+
+      tempfile = nil
+      encoding = response.body.encoding
+      Tempfile.open(prefix, @config.temp_folder_path, encoding: encoding) do |file|
+        file.write(response.body)
+        tempfile = file
+      end
+      @config.logger.info "Temp file written to #{tempfile.path}, please copy the file to a proper folder "\
+                          "with e.g. `FileUtils.cp(tempfile.path, '/new/file/path')` otherwise the temp file "\
+                          "will be deleted automatically with GC. It's also recommended to delete the temp file "\
+                          "explicitly with `tempfile.delete`"
+      tempfile
+    end
+
+    # Sanitize filename by removing path.
+    # e.g. ../../sun.gif becomes sun.gif
+    #
+    # @param [String] filename the filename to be sanitized
+    # @return [String] the sanitized filename
+    def sanitize_filename(filename)
+      filename.gsub(/.*[\/\\]/, '')
+    end
+
+    def build_request_url(path, opts)
+      # Add leading and trailing slashes to path
+      path = "/#{path}".gsub(/\/+/, '/')
+      return Addressable::URI.encode("https://" + self.get_oauth_base_path + path) if opts[:oauth]
+      Addressable::URI.encode(@config.base_url + path)
+    end
+
+    # Builds the HTTP request body
+    #
+    # @param [Hash] header_params Header parameters
+    # @param [Hash] form_params Query parameters
+    # @param [Object] body HTTP body (JSON/XML)
+    # @return [String] HTTP body data in the form of string
+    def build_request_body(header_params, form_params, body)
+      # http form
+      if header_params['Content-Type'] == 'application/x-www-form-urlencoded' ||
+          header_params['Content-Type'] == 'multipart/form-data'
+        data = {}
+        form_params.each do |key, value|
+          case value
+          when File, Array, nil
+            # let typhoeus handle File, Array and nil parameters
+            data[key] = value
+          else
+            data[key] = value.to_s
+          end
+        end
+      elsif body
+        data = body.is_a?(String) ? body : body.to_json
+      else
+        data = nil
+      end
+      data
+    end
+
+    # Update hearder and query params based on authentication settings.
+    #
+    # @param [Hash] header_params Header parameters
+    # @param [Hash] query_params Query parameters
+    # @param [String] auth_names Authentication scheme name
+    def update_params_for_auth!(header_params, query_params, auth_names)
+      Array(auth_names).each do |auth_name|
+        auth_setting = @config.auth_settings[auth_name]
+        next unless auth_setting
+        case auth_setting[:in]
+        when 'header' then header_params[auth_setting[:key]] = auth_setting[:value]
+        when 'query'  then query_params[auth_setting[:key]] = auth_setting[:value]
+        else fail ArgumentError, 'Authentication token must be in `query` of `header`'
+        end
+      end
+    end
+
+    # Sets user agent in HTTP header
+    #
+    # @param [String] user_agent User agent (e.g. swagger-codegen/ruby/1.0.0)
+    def user_agent=(user_agent)
+      @user_agent = user_agent
+      @default_headers['User-Agent'] = @user_agent
+    end
+
+    # Return Accept header based on an array of accepts provided.
+    # @param [Array] accepts array for Accept
+    # @return [String] the Accept header (e.g. application/json)
+    def select_header_accept(accepts)
+      return nil if accepts.nil? || accepts.empty?
+      # use JSON when present, otherwise use all of the provided
+      json_accept = accepts.find { |s| json_mime?(s) }
+      return json_accept || accepts.join(',')
+    end
+
+    # Return Content-Type header based on an array of content types provided.
+    # @param [Array] content_types array for Content-Type
+    # @return [String] the Content-Type header  (e.g. application/json)
+    def select_header_content_type(content_types)
+      # use application/json by default
+      return 'application/json' if content_types.nil? || content_types.empty?
+      # use JSON when present, otherwise use the first one
+      json_content_type = content_types.find { |s| json_mime?(s) }
+      return json_content_type || content_types.first
+    end
+
+    # Convert object (array, hash, object, etc) to JSON string.
+    # @param [Object] model object to be converted into JSON string
+    # @return [String] JSON string representation of the object
+    def object_to_http_body(model)
+      return model if model.nil? || model.is_a?(String)
+      local_body = nil
+      if model.is_a?(Array)
+        local_body = model.map{|m| object_to_hash(m) }
+      else
+        local_body = object_to_hash(model)
+      end
+      local_body.to_json
+    end
+
+    # Convert object(non-array) to hash.
+    # @param [Object] obj object to be converted into JSON string
+    # @return [String] JSON string representation of the object
+    def object_to_hash(obj)
+      if obj.respond_to?(:to_hash)
+        obj.to_hash
+      else
+        obj
+      end
+    end
+
+    # Build parameter value according to the given collection format.
+    # @param [String] collection_format one of :csv, :ssv, :tsv, :pipes and :multi
+    def build_collection_param(param, collection_format)
+      case collection_format
+      when :csv
+        param.join(',')
+      when :ssv
+        param.join(' ')
+      when :tsv
+        param.join("\t")
+      when :pipes
+        param.join('|')
+      when :multi
+        # return the array directly as typhoeus will handle it as expected
+        param
+      else
+        fail "unknown collection format: #{collection_format.inspect}"
+      end
+    end
+
+    # Helper method to set base_path
+    # @param [String] base_path
+    def set_base_path(base_path)
+      self.base_path = base_path
+    end
+
+    # Helper method to set oauth base path
+    # @param [String] oauth_base_path if passed nil it will determined from base_path
+    def set_oauth_base_path(oauth_base_path=nil)
+      self.oauth_base_path = oauth_base_path if oauth_base_path
+      return if self.oauth_base_path
+
+      # did we need this check as we can determine it from base path
+      #raise ArgumentError.new('oAuthBasePath cannot be empty')  unless oauth_base_path
+
+      # Derive OAuth Base Path if not given
+      if self.base_path.start_with?("https://demo") or self.base_path.start_with?("http://demo")
+        self.oauth_base_path = OAuth::DEMO_OAUTH_BASE_PATH
+      elsif self.base_path.start_with?("https://stage") or self.base_path.start_with?("http://stage")
+        self.oauth_base_path = OAuth::STAGE_OAUTH_BASE_PATH
+      else
+        self.oauth_base_path = OAuth::PRODUCTION_OAUTH_BASE_PATH
+      end
+    end
+
+    # Helper method to get oauth base path
+    def get_oauth_base_path
+      if !self.oauth_base_path
+        self.set_oauth_base_path()
+      end
+
+      self.oauth_base_path
+    end
+
+    # Helper method to configure the OAuth accessCode/implicit flow parameters
+    # @param [String] client_id DocuSign OAuth Client Id(AKA Integrator Key)
+    # @param scopes The list of requested scopes.  Client applications may be scoped to a limited set of system access.
+    # @param [String] redirect_uri This determines where to deliver the response containing the authorization code
+    # @param [String] response_type Determines the response type of the authorization request, NOTE: these response types are mutually exclusive for a client application. A public/native client application may only request a response type
+    #          of "token". A private/trusted client application may only request a response type of "code".
+    # @param [String] state Allows for arbitrary state that may be useful to your application. The value in this parameter
+    #             will be round-tripped along with the response so you can make sure it didn't change.
+    # @return [String]
+    def get_authorization_uri(client_id, scopes, redirect_uri, response_type, state=nil)
+      self.oauth_base_path ||= self.get_oauth_base_path
+
+      scopes = scopes.join(' ') if scopes.kind_of?(Array)
+      scopes = OAuth::SCOPE_SIGNATURE if scopes.empty?
+
+      uri = "https://%{base_path}/oauth/auth?response_type=%{response_type}&scope=%{scopes}&client_id=%{client_id}&redirect_uri=%{redirect_uri}"
+      uri += "&state=%{state}" if state
+      uri  % {base_path: self.oauth_base_path, response_type:response_type, scopes: scopes, client_id: client_id, redirect_uri: redirect_uri, state: state}
+    end
+
+    # Request JWT User Token
+    # @param [String] client_id DocuSign OAuth Client Id(AKA Integrator Key)
+    # @param [String] user_id DocuSign user Id to be impersonated
+    # @param [String] private_key_or_filename the RSA private key
+    # @param [Number] expires_in number of seconds remaining before the JWT assertion is considered as invalid
+    # @param scopes The list of requested scopes.  Client applications may be scoped to a limited set of system access.
+    # @return [OAuth::OAuthToken]
+    def request_jwt_user_token(client_id, user_id, private_key_or_filename, expires_in = 3600,scopes=OAuth::SCOPE_SIGNATURE)
+      raise ArgumentError.new('client_id cannot be empty')  if client_id.empty?
+      raise ArgumentError.new('user_id cannot be empty')  if user_id.empty?
+      raise ArgumentError.new('private_key_or_filename cannot be empty')  if private_key_or_filename.empty?
+
+      scopes = scopes.join(' ') if scopes.kind_of?(Array)
+      scopes = OAuth::SCOPE_SIGNATURE if scopes.empty?
+      expires_in = 3600 if expires_in > 3600
+      now = Time.now.to_i
+      claim = {
+        "iss" => client_id,
+        "sub" => user_id,
+        "aud" => self.get_oauth_base_path,
+        "iat" => now,
+        "exp" => now + expires_in,
+        "scope"=> scopes
+      }
+
+      private_key = if private_key_or_filename.include?("-----BEGIN RSA PRIVATE KEY-----")
+                      private_key_or_filename
+                    else
+                      File.read(private_key_or_filename)
+                    end
+
+      private_key_bytes = OpenSSL::PKey::RSA.new private_key
+      token = JWT.encode claim, private_key_bytes, 'RS256'
+      params = {
+          :header_params => {"Content-Type" => "application/x-www-form-urlencoded"},
+          :form_params => {
+              "assertion" => token,
+              "grant_type" => OAuth::GRANT_TYPE_JWT
+          },
+          :return_type => 'OAuth::OAuthToken',
+          :oauth => true
+      }
+      data, status_code, headers = self.call_api("POST", "/oauth/token", params)
+
+
+      raise ApiError.new('Some error accrued during process') if data.nil?
+
+      self.set_default_header('Authorization', data.token_type + ' ' + data.access_token)
+      data
+    end
+
+    # Request JWT User Token
+    # @param [String] client_id DocuSign OAuth Client Id(AKA Integrator Key)
+    # @param [String] private_key_or_filename the RSA private key
+    # @param [Number] expires_in number of seconds remaining before the JWT assertion is considered as invalid
+    # @param scopes The list of requested scopes.  Client applications may be scoped to a limited set of system access.
+    # @return [OAuth::OAuthToken]
+    def request_jwt_application_token(client_id, private_key_or_filename, expires_in = 3600,scopes=OAuth::SCOPE_SIGNATURE)
+      raise ArgumentError.new('client_id cannot be empty')  if client_id.empty?
+      raise ArgumentError.new('private_key_or_filename cannot be empty')  if private_key_or_filename.empty?
+
+      scopes = scopes.join(' ') if scopes.kind_of?(Array)
+      scopes = OAuth::SCOPE_SIGNATURE if scopes.empty?
+      expires_in = 3600 if expires_in > 3600
+      now = Time.now.to_i
+      claim = {
+          "iss" => client_id,
+          "aud" => self.get_oauth_base_path,
+          "iat" => now,
+          "exp" => now + expires_in,
+          "scope"=> scopes
+      }
+      
+      private_key = if private_key_or_filename.include?("-----BEGIN RSA PRIVATE KEY-----")
+                      private_key_or_filename
+                    else
+                      File.read(private_key_or_filename)
+                    end
+
+      private_key_bytes = OpenSSL::PKey::RSA.new private_key
+      token = JWT.encode claim, private_key_bytes, 'RS256'
+      params = {
+          :header_params => {"Content-Type" => "application/x-www-form-urlencoded"},
+          :form_params => {
+              "assertion" => token,
+              "grant_type" => OAuth::GRANT_TYPE_JWT
+          },
+          :return_type => 'OAuth::OAuthToken',
+          :oauth => true
+      }
+      data, status_code, headers = self.call_api("POST", "/oauth/token", params)
+
+      raise ApiError.new('Some error accrued during process') if data.nil?
+
+      self.set_default_header('Authorization', data.token_type + ' ' + data.access_token)
+      data
+    end
+
+    # Get User Info method takes the accessToken to retrieve User Account Data.
+    # @param [String] access_token
+    # @return [OAuth::UserInfo]
+    def get_user_info(access_token)
+      raise ArgumentError.new('Cannot find a valid access token. Cannot find a valid access token.')  if access_token.empty?
+
+      params = {
+          :header_params => {"Authorization" => 'Bearer ' + access_token},
+          :return_type => 'OAuth::UserInfo',
+          :oauth => true
+      }
+      data, status_code, headers = self.call_api("GET", '/oauth/userinfo', params)
+      data
+    end
+
+    # GenerateAccessToken will exchange the authorization code for an access token and refresh tokens.
+    # @param [String] client_id DocuSign OAuth Client Id(AKA Integrator Key)
+    # @param [String] client_secret The secret key you generated when you set up the integration in DocuSign Admin console.
+    # @param [String] code The authorization code
+    def generate_access_token(client_id, client_secret, code)
+      raise ArgumentError.new('client_id cannot be empty')  if client_id.empty?
+      raise ArgumentError.new('client_secret cannot be empty')  if client_secret.empty?
+      raise ArgumentError.new('code cannot be empty')  if code.empty?
+
+      authcode = "Basic " + Base64.strict_encode64("#{client_id}:#{client_secret}")
+      params = {
+          :header_params => {
+              "Authorization" => authcode,
+              "Content-Type" => "application/x-www-form-urlencoded"
+          },
+          :form_params => {
+            "grant_type" => 'authorization_code',
+            "code" => code,
+          },
+          :return_type => 'OAuth::OAuthToken',
+          :oauth => true
+      }
+      data, status_code, headers = self.call_api("POST", '/oauth/token', params)
+      abort(data.inspect)
+
+    end
+
+    def set_access_token(token_obj)
+      self.default_headers['Authorization'] = token_obj.access_token
+    end
+
+    # Helper method to add default header params
+    # @param [String] header_name
+    # @param [String] header_value
+    def set_default_header(header_name, header_value)
+        @default_headers[header_name] = header_value
+    end
+  end
+end