docusign_click 1.0.0.beta → 1.1.0

data/lib/docusign_click/api_client.rb

@@ -0,0 +1,382 @@
+=begin
+#DocuSign Click API
+
+#DocuSign Click lets you capture consent to standard agreement terms with a single click: terms and conditions, terms of service, terms of use, privacy policies, and more. The Click API lets you include this customizable clickwrap solution in your DocuSign integrations.
+
+OpenAPI spec version: v1
+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_Click
+  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
+
+    # 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/1.1.0/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)
+      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_Click.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)
+      # Add leading and trailing slashes to path
+      path = "/#{path}".gsub(/\/+/, '/')
+      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
+  end
+end

data/lib/docusign_click/api_error.rb

@@ -0,0 +1,37 @@
+=begin
+#DocuSign Click API
+
+#DocuSign Click lets you capture consent to standard agreement terms with a single click: terms and conditions, terms of service, terms of use, privacy policies, and more. The Click API lets you include this customizable clickwrap solution in your DocuSign integrations.
+
+OpenAPI spec version: v1
+Contact: devcenter@docusign.com
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+
+=end
+
+module DocuSign_Click
+  class ApiError < StandardError
+    attr_reader :code, :response_headers, :response_body
+
+    # Usage examples:
+    #   ApiError.new
+    #   ApiError.new("message")
+    #   ApiError.new(:code => 500, :response_headers => {}, :response_body => "")
+    #   ApiError.new(:code => 404, :message => "Not Found")
+    def initialize(arg = nil)
+      if arg.is_a? Hash
+        if arg.key?(:message) || arg.key?('message')
+          super(arg[:message] || arg['message'])
+        else
+          super arg
+        end
+
+        arg.each do |k, v|
+          instance_variable_set "@#{k}", v
+        end
+      else
+        super arg
+      end
+    end
+  end
+end

data/lib/docusign_click/client/api_client.rb

@@ -1,9 +1,9 @@
 =begin
-#DocuSign Click REST API
+#DocuSign Click API
 
-#An API for an integrator to access the features of DocuSign Click
+#DocuSign Click lets you capture consent to standard agreement terms with a single click: terms and conditions, terms of service, terms of use, privacy policies, and more. The Click API lets you include this customizable clickwrap solution in your DocuSign integrations.
 
-OpenAPI spec version: v2
+OpenAPI spec version: v1
 Contact: devcenter@docusign.com
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 
@@ -16,6 +16,7 @@ require 'tempfile'
 require 'typhoeus'
 require 'uri'
 require 'jwt'
+require 'addressable/uri'
 
 module DocuSign_Click
   class ApiClient
@@ -34,7 +35,7 @@ module DocuSign_Click
     # @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"
+      @user_agent = "Swagger-Codegen/1.1.0/ruby"
       @default_headers = {
         'Content-Type' => "application/json",
         'User-Agent' => @user_agent
@@ -259,8 +260,8 @@ module DocuSign_Click
     def build_request_url(path, opts)
       # Add leading and trailing slashes to path
       path = "/#{path}".gsub(/\/+/, '/')
-      return URI.encode("https://" + self.get_oauth_base_path + path) if opts[:oauth]
-      URI.encode(@config.base_url + path)
+      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
@@ -391,8 +392,11 @@ module DocuSign_Click
     # 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
+      if oauth_base_path
+        raise ArgumentError.new('OAuth base path should only include domain name (without https://)')  if oauth_base_path.include? "//"
+        self.oauth_base_path = oauth_base_path
+        return
+      end
 
       # did we need this check as we can determine it from base path
       #raise ArgumentError.new('oAuthBasePath cannot be empty')  unless oauth_base_path
@@ -571,13 +575,14 @@ module DocuSign_Click
           :return_type => 'OAuth::OAuthToken',
           :oauth => true
       }
-      data, status_code, headers = self.call_api("POST", '/oauth/token', params)
-      abort(data.inspect)
+      
+      token, status_code, headers = self.call_api("POST", '/oauth/token', params)
 
-    end
+      if status_code == 200
+        self.default_headers.store('Authorization', "#{token.token_type} #{token.access_token}")
 
-    def set_access_token(token_obj)
-      self.default_headers['Authorization'] = token_obj.access_token
+        token
+      end
     end
 
     # Helper method to add default header params
@@ -587,4 +592,4 @@ module DocuSign_Click
         @default_headers[header_name] = header_value
     end
   end
-end
+end

data/lib/docusign_click/client/api_error.rb

@@ -1,9 +1,9 @@
 =begin
-#DocuSign Click REST API
+#DocuSign Click API
 
-#The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign.
+#DocuSign Click lets you capture consent to standard agreement terms with a single click: terms and conditions, terms of service, terms of use, privacy policies, and more. The Click API lets you include this customizable clickwrap solution in your DocuSign integrations.
 
-OpenAPI spec version: v2
+OpenAPI spec version: v1
 Contact: devcenter@docusign.com
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 

data/lib/docusign_click/client/auth/oauth.rb

@@ -1058,4 +1058,4 @@ module DocuSign_Click
 
     end
   end
-end
+end

data/lib/docusign_click/configuration.rb

@@ -10,6 +10,7 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 =end
 
 require 'uri'
+require 'addressable/uri'
 
 module DocuSign_Click
   class Configuration
@@ -168,7 +169,7 @@ module DocuSign_Click
 
     def base_url
       url = "#{scheme}://#{[host, base_path].join('/').gsub(/\/+/, '/')}".sub(/\/+\z/, '')
-      URI.encode(url)
+      Addressable::URI.encode(url)
     end
 
     # Gets API key (with prefix if set).

data/lib/docusign_click/models/clickwrap_request.rb

@@ -25,7 +25,10 @@ module DocuSign_Click
     attr_accessor :fields_to_null
 
     # 
-    attr_accessor :is_majorversion
+    attr_accessor :is_major_version
+
+    # 
+    attr_accessor :is_shared
 
     # 
     attr_accessor :name
@@ -54,7 +57,8 @@ module DocuSign_Click
         :'display_settings' => :'displaySettings',
         :'documents' => :'documents',
         :'fields_to_null' => :'fieldsToNull',
-        :'is_majorversion' => :'isMajorversion',
+        :'is_major_version' => :'isMajorVersion',
+        :'is_shared' => :'isShared',
         :'name' => :'name',
         :'require_reacceptance' => :'requireReacceptance',
         :'scheduled_date' => :'scheduledDate',
@@ -72,7 +76,8 @@ module DocuSign_Click
         :'display_settings' => :'DisplaySettings',
         :'documents' => :'Array<Document>',
         :'fields_to_null' => :'String',
-        :'is_majorversion' => :'BOOLEAN',
+        :'is_major_version' => :'BOOLEAN',
+        :'is_shared' => :'BOOLEAN',
         :'name' => :'String',
         :'require_reacceptance' => :'BOOLEAN',
         :'scheduled_date' => :'Object',
@@ -109,8 +114,12 @@ module DocuSign_Click
         self.fields_to_null = attributes[:'fieldsToNull']
       end
 
-      if attributes.has_key?(:'isMajorversion')
-        self.is_majorversion = attributes[:'isMajorversion']
+      if attributes.has_key?(:'isMajorVersion')
+        self.is_major_version = attributes[:'isMajorVersion']
+      end
+
+      if attributes.has_key?(:'isShared')
+        self.is_shared = attributes[:'isShared']
       end
 
       if attributes.has_key?(:'name')
@@ -164,7 +173,8 @@ module DocuSign_Click
           display_settings == o.display_settings &&
           documents == o.documents &&
           fields_to_null == o.fields_to_null &&
-          is_majorversion == o.is_majorversion &&
+          is_major_version == o.is_major_version &&
+          is_shared == o.is_shared &&
           name == o.name &&
           require_reacceptance == o.require_reacceptance &&
           scheduled_date == o.scheduled_date &&
@@ -183,7 +193,7 @@ module DocuSign_Click
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [clickwrap_name, display_settings, documents, fields_to_null, is_majorversion, name, require_reacceptance, scheduled_date, scheduled_reacceptance, status, transfer_from_user_id, transfer_to_user_id].hash
+      [clickwrap_name, display_settings, documents, fields_to_null, is_major_version, is_shared, name, require_reacceptance, scheduled_date, scheduled_reacceptance, status, transfer_from_user_id, transfer_to_user_id].hash
     end
 
     # Builds the object from hash

data/lib/docusign_click/models/display_settings.rb

@@ -49,9 +49,6 @@ module DocuSign_Click
     # 
     attr_accessor :has_decline_button
 
-    # 
-    attr_accessor :host_origin
-
     # 
     attr_accessor :must_read
 
@@ -82,7 +79,6 @@ module DocuSign_Click
         :'downloadable' => :'downloadable',
         :'format' => :'format',
         :'has_decline_button' => :'hasDeclineButton',
-        :'host_origin' => :'hostOrigin',
         :'must_read' => :'mustRead',
         :'must_view' => :'mustView',
         :'record_decline_responses' => :'recordDeclineResponses',
@@ -106,7 +102,6 @@ module DocuSign_Click
         :'downloadable' => :'BOOLEAN',
         :'format' => :'String',
         :'has_decline_button' => :'BOOLEAN',
-        :'host_origin' => :'String',
         :'must_read' => :'BOOLEAN',
         :'must_view' => :'BOOLEAN',
         :'record_decline_responses' => :'BOOLEAN',
@@ -173,10 +168,6 @@ module DocuSign_Click
         self.has_decline_button = attributes[:'hasDeclineButton']
       end
 
-      if attributes.has_key?(:'hostOrigin')
-        self.host_origin = attributes[:'hostOrigin']
-      end
-
       if attributes.has_key?(:'mustRead')
         self.must_read = attributes[:'mustRead']
       end
@@ -228,7 +219,6 @@ module DocuSign_Click
           downloadable == o.downloadable &&
           format == o.format &&
           has_decline_button == o.has_decline_button &&
-          host_origin == o.host_origin &&
           must_read == o.must_read &&
           must_view == o.must_view &&
           record_decline_responses == o.record_decline_responses &&
@@ -245,7 +235,7 @@ module DocuSign_Click
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [action_button_alignment, allow_client_only, allowed_hosts, brand_id, consent_button_text, consent_text, decline_button_text, display_name, document_display, downloadable, format, has_decline_button, host_origin, must_read, must_view, record_decline_responses, require_accept, send_to_email].hash
+      [action_button_alignment, allow_client_only, allowed_hosts, brand_id, consent_button_text, consent_text, decline_button_text, display_name, document_display, downloadable, format, has_decline_button, must_read, must_view, record_decline_responses, require_accept, send_to_email].hash
     end
 
     # Builds the object from hash