wsc_sdk 1.3.1

data/examples/transcoders/start_and_wait.rb

@@ -0,0 +1,50 @@
+####> This code and all components © 2015 – 2019 Wowza Media Systems, LLC. All rights reserved.
+####> This code is licensed pursuant to the BSD 3-Clause License.
+
+require "wsc_sdk"
+require_relative "../client"  # Get our client
+require_relative "../helpers" # Include some helpers to make the code more direct
+
+# Ensure the args passed in are present
+arguments         = ask_for_arguments(__FILE__, transcoder_id: nil)
+
+# Extract some data into convenience variables
+transcoders       = $client.transcoders
+transcoder_id     = arguments[0]
+
+# Request the transcoder object
+transcoder        = transcoders.find(transcoder_id)
+
+# Handle an API error (in the helpers.rb file)
+handle_api_error(transcoder, "There was an error finding the transcoder") unless transcoder.success?
+
+# Get the result of starting the transcoder.  We add a code block, which
+# instructs the SDK to enter a wait loop, and periodically polls the API
+# for the transcoder state until either the `started` state is returned or
+# the timeout period is reached.
+state             = transcoder.start do |wait_state, transcoder_state|
+  # This code will execute each time the state of the transcoder is polled
+  # during the wait loop.  You can check the wait_state to determine what the
+  # outcomes of each request are.
+
+  if wait_state == :waiting
+    # We're still waiting for the started state to be returned
+    puts "Waiting..."
+  elsif wait_state == :complete
+    # We've successfully started the transcoder, so output the completed state
+    # Defined in helpers.rb
+    output_model_attributes(transcoder_state, "Completed Transcoder State:")
+  elsif wait_state == :timeout
+    # A timeout occurs if the start state isn't reached within the timeout
+    # limit, which defaults to 30 seconds.
+
+    puts "TIMEOUT: Could not start the transcoder within the timeout period."
+  end
+end
+
+# Handle an API error.  (In the helpers.rb file)
+handle_api_error(state, "There was an error starting the transcoder") unless state.success?
+
+# Output the transcoder state
+# Defined in helpers.rb
+output_model_attributes(state, "Final Transcoder State:")

data/examples/transcoders/state.rb

@@ -0,0 +1,33 @@
+####> This code and all components © 2015 – 2019 Wowza Media Systems, LLC. All rights reserved.
+####> This code is licensed pursuant to the BSD 3-Clause License.
+
+require "wsc_sdk"
+require_relative "../client"  # Get our client
+require_relative "../helpers" # Include some helpers to make the code more direct
+
+# Ensure the args passed in are present
+arguments         = ask_for_arguments(__FILE__, transcoder_id: nil)
+
+# Extract some data into convenience variables
+transcoders       = $client.transcoders
+transcoder_id     = arguments[0]
+
+# Request the transcoder object
+transcoder        = transcoders.find(transcoder_id)
+
+# Handle an API error (in the helpers.rb file)
+handle_api_error(transcoder, "There was an error finding the transcoder") unless transcoder.success?
+
+# Get the result of stopping the transcoder
+#
+# NOTE: You can also stop and wait for the transcoder state to transition to
+# a stopped state.  See the `stop_and_wait` example.
+#
+state             = transcoder.state
+
+# Handle an API error (in the helpers.rb file)
+handle_api_error(state, "There was an error getting the transcoder state") unless state.success?
+
+# Output the transcoder state
+# Defined in helpers.rb
+output_model_attributes(state, "Transcoder State:")

data/examples/transcoders/stats.rb

@@ -0,0 +1,43 @@
+####> This code and all components © 2015 – 2019 Wowza Media Systems, LLC. All rights reserved.
+####> This code is licensed pursuant to the BSD 3-Clause License.
+
+require "wsc_sdk"
+require_relative "../client"  # Get our client
+require_relative "../helpers" # Include some helpers to make the code more direct
+
+# Ensure the args passed in are present
+arguments         = ask_for_arguments(__FILE__, transcoder_id: nil)
+
+# Extract some data into convenience variables
+transcoders       = $client.transcoders
+transcoder_id     = arguments[0]
+
+# Request the transcoder object
+transcoder        = transcoders.find(transcoder_id)
+
+# Handle an API error (in the helpers.rb file)
+handle_api_error(transcoder, "There was an error finding the transcoder") unless transcoder.success?
+
+# Request the transcoder state
+state             = transcoder.state
+
+# Handle an API error (in the helpers.rb file)
+handle_api_error(state, "There was an error getting the transcoder state") unless state.success?
+
+# Ensure the transcoder is started
+if state.state != 'started'
+  # Start the transcoder and wait
+  result = transcoder.start do |wait_state, transcoder_state|
+    puts "Waiting for transcoder to start"
+  end
+end
+
+# Request the current statistics from the transcoder
+stats             = transcoder.stats
+
+# Handle an API error (in the helpers.rb file)
+handle_api_error(stats, "There was an error getting the transcoder stats") unless stats.success?
+
+# Output the current transcoder statistics
+# Defined in helpers.rb
+output_model_attributes(stats, "Transcoder Stats:")

data/examples/transcoders/stop.rb

@@ -0,0 +1,33 @@
+####> This code and all components © 2015 – 2019 Wowza Media Systems, LLC. All rights reserved.
+####> This code is licensed pursuant to the BSD 3-Clause License.
+
+require "wsc_sdk"
+require_relative "../client"  # Get our client
+require_relative "../helpers" # Include some helpers to make the code more direct
+
+# Ensure the args passed in are present
+arguments         = ask_for_arguments(__FILE__, transcoder_id: nil)
+
+# Extract some data into convenience variables
+transcoders       = $client.transcoders
+transcoder_id     = arguments[0]
+
+# Request the transcoder object
+transcoder        = transcoders.find(transcoder_id)
+
+# Handle an API error (in the helpers.rb file)
+handle_api_error(transcoder, "There was an error finding the transcoder") unless transcoder.success?
+
+# Get the result of stopping the transcoder
+#
+# NOTE: You can also stop and wait for the transcoder state to transition to
+# a stopped state.  See the `stop_and_wait` example.
+#
+state             = transcoder.stop
+
+# Handle an API error (in the helpers.rb file)
+handle_api_error(state, "There was an error getting the transcoder state") unless state.success?
+
+# Output the transcoder state
+# Defined in helpers.rb
+output_model_attributes(state, "Transcoder State:")

data/examples/transcoders/stop_and_wait.rb

@@ -0,0 +1,50 @@
+####> This code and all components © 2015 – 2019 Wowza Media Systems, LLC. All rights reserved.
+####> This code is licensed pursuant to the BSD 3-Clause License.
+
+require "wsc_sdk"
+require_relative "../client"  # Get our client
+require_relative "../helpers" # Include some helpers to make the code more direct
+
+# Ensure the args passed in are present
+arguments         = ask_for_arguments(__FILE__, transcoder_id: nil)
+
+# Extract some data into convenience variables
+transcoders       = $client.transcoders
+transcoder_id     = arguments[0]
+
+# Request the transcoder object
+transcoder        = transcoders.find(transcoder_id)
+
+# Handle an API error (in the helpers.rb file)
+handle_api_error(transcoder, "There was an error finding the transcoder") unless transcoder.success?
+
+# Get the result of stopping the transcoder.  We add a code block, which
+# instructs the SDK to enter a wait loop and periodically polls the API
+# for the transcoder state until either the `stopped` state is returned or
+# the timeout period is reached.
+state             = transcoder.stop do |wait_state, transcoder_state|
+  # This code will execute each time the state of the transcoder is polled
+  # during the wait loop.  You can check the wait_state to determine what the
+  # outcomes of each request are.
+
+  if wait_state == :waiting
+    # We're still waiting for the stopped state to be returned
+    puts "Waiting..."
+  elsif wait_state == :complete
+    # We've successfully stopped the transcoder, so output the completed state
+    # Defined in helpers.rb
+    output_model_attributes(transcoder_state, "Transcoder State:")
+  elsif wait_state == :timeout
+    # A timeout occurs if the stop state isn't reached within the timeout
+    # limit, which defaults to 30 seconds.
+
+    puts "TIMEOUT: Could not stop the transcoder within the timeout period."
+  end
+end
+
+# Handle an API error (in the helpers.rb file)
+handle_api_error(state, "There was an error stopping the transcoder") unless state.success?
+
+# Output the transcoder state
+# Defined in helpers.rb
+output_model_attributes(state, "Transcoder State:")

data/examples/transcoders/thumbnail_url.rb

@@ -0,0 +1,46 @@
+####> This code and all components © 2015 – 2019 Wowza Media Systems, LLC. All rights reserved.
+####> This code is licensed pursuant to the BSD 3-Clause License.
+
+require "wsc_sdk"
+require_relative "../client"  # Get our client
+require_relative "../helpers" # Include some helpers to make the code more direct
+
+# Ensure the args passed in are present
+arguments         = ask_for_arguments(__FILE__, transcoder_id: nil)
+
+# Extract some data into convenience variables
+transcoders       = $client.transcoders
+transcoder_id     = arguments[0]
+
+# Request the transcoder object
+transcoder        = transcoders.find(transcoder_id)
+
+# Handle an API error (in the helpers.rb file)
+handle_api_error(transcoder, "There was an error finding the transcoder") unless transcoder.success?
+
+# Request the transcoder state
+state             = transcoder.state
+
+# Handle an API error (in the helpers.rb file)
+handle_api_error(state, "There was an error getting the transcoder state") unless state.success?
+
+# Ensure the transcoder is started
+if state.state != 'started'
+  # Start the transcoder and wait
+  state = transcoder.start do |wait_state, transcoder_state|
+    puts "Waiting for transcoder to start"
+  end
+
+  # Handle an API error (in the helpers.rb file)
+  handle_api_error(state, "There was an error starting the transcoder") unless state.success?
+end
+
+# Request the thumbnail url
+thumbnail         = transcoder.thumbnail_url
+
+# Handle an API error (in the helpers.rb file)
+handle_api_error(thumbnail, "There was an error getting the transcoder thumbnail url") unless thumbnail.success?
+
+# Output the thumbnail URL
+# Defined in helpers.rb
+output_model_attributes(thumbnail, "Transcoder Thumbnail:")

data/examples/transcoders/update.rb

@@ -0,0 +1,43 @@
+####> This code and all components © 2015 – 2019 Wowza Media Systems, LLC. All rights reserved.
+####> This code is licensed pursuant to the BSD 3-Clause License.
+
+require "wsc_sdk"
+require_relative "../client"  # Get our client
+require_relative "../helpers" # Include some helpers to make the code more direct
+
+# Ensure the args passed in are present
+arguments         = ask_for_arguments(__FILE__, transcoder_id: nil, new_transcoder_name: nil)
+
+# Extract some data into convenience variables
+transcoders       = $client.transcoders
+transcoder_id     = arguments[0]
+transcoder_name   = arguments[1]
+
+# Request the transcoder object
+transcoder        = transcoders.find(transcoder_id)
+
+# Handle an API error (in the helpers.rb file)
+handle_api_error(transcoder, "There was an error finding the transcoder") unless transcoder.success?
+
+# Update the transcoder
+transcoder.name   = transcoder_name
+
+# If the transcoder is invalid, output the messages and exit
+unless (transcoder.valid?)
+  puts "Transcoder is invalid:"
+
+  transcoder.errors.each do |field, message|
+    puts " - #{field}: #{message}"
+  end
+  exit
+end
+
+# Get the result of saving the object to the API
+saved             = transcoder.save
+
+# Handle an API error (in the helpers.rb file)
+handle_api_error(saved, "There was an error saving the transcoder") unless saved.success?
+
+# Output the transcoder details
+# Defined in helpers.rb
+output_model_attributes(transcoder, "Transcoder: #{transcoder.name}")

data/lib/wsc_sdk.rb

@@ -0,0 +1,81 @@
+####> This code and all components © 2015 – 2019 Wowza Media Systems, LLC. All rights reserved.
+####> This code is licensed pursuant to the BSD 3-Clause License.
+
+# The root path of the SDK code base.
+WSC_SDK_ROOT_PATH = File.expand_path(File.join(File.dirname(__FILE__), ".."))
+
+# The ./lib path of the SDK code base
+WSC_SDK_LIB_PATH  = File.join(WSC_SDK_ROOT_PATH, "lib")
+
+# The ./lib/wsc_sdk path of the SDK code base
+WSC_SDK_PATH      = File.join(WSC_SDK_LIB_PATH, "wsc_sdk")
+
+require 'logger'
+require 'httparty'
+require 'active_support/core_ext/hash'
+require 'active_support/core_ext/string'
+
+require "wsc_sdk/constants"
+require "wsc_sdk/errors"
+require "wsc_sdk/configuration"
+require "wsc_sdk/client"
+require "wsc_sdk/schema"
+require "wsc_sdk/schema_attribute"
+
+Dir[File.join(WSC_SDK_PATH, "modules", "**", "*.rb")].each{ |f| require f }
+
+require "wsc_sdk/enums"
+Dir[File.join(WSC_SDK_PATH, "attributes", "**", "*.rb")].each{ |f| require f }
+Dir[File.join(WSC_SDK_PATH, "enums", "**", "*.rb")].each{ |f| require f }
+
+require "wsc_sdk/model"
+require "wsc_sdk/pagination"
+require "wsc_sdk/model_list"
+Dir[File.join(WSC_SDK_PATH, "models", "**", "*.rb")].each{ |f| require f }
+
+require "wsc_sdk/model_template"
+Dir[File.join(WSC_SDK_PATH, "templates", "**", "*.rb")].each{ |f| require f }
+
+require "wsc_sdk/endpoint"
+Dir[File.join(WSC_SDK_PATH, "endpoints", "**", "*.rb")].each{ |f| require f }
+
+
+module WscSdk
+
+  # Generate class level attributes for the WscSdk module.
+  #
+  class << self
+    attr_writer :configuration
+  end
+
+  # Get the SDK configuration object.
+  #
+  # @return [WscSdk::Configuration]
+  #     The SDK configuration object.
+  #
+  def self.configuration
+    @configuration ||= WscSdk::Configuration.new
+  end
+
+  # Provides a mechanism to configure the SDK given a block.
+  #
+  # @yield [configuration]
+  #   Gives a configuration object to the block so it can be setup properly.
+  #
+  # @yieldparam configuration [WscSdk::Configuration]
+  #   The SDK configuration object.
+  #
+  def self.configure
+    yield(configuration)
+  end
+
+  # Returns an instance of the client configured using the SDK configuration
+  #
+  # @return [WscSdk::Client]
+  #   An instance of the client object configured using the SDK configuration.
+  #
+  def self.client
+    @client ||= WscSdk::Client.configured_instance
+  end
+
+end

data/lib/wsc_sdk/client.rb

@@ -0,0 +1,417 @@
+####> This code and all components © 2015 – 2019 Wowza Media Systems, LLC. All rights reserved.
+####> This code is licensed pursuant to the BSD 3-Clause License.
+
+module WscSdk
+
+  # A client to manage credentials and act as an entrypoint for the SDK and all
+  # API interactions.
+  #
+  # @example Usage
+  #
+  #   !!!ruby
+  #   api_key     = "[your-api-key]"
+  #   access_key  = "[your-api-access-key]"
+  #   client      = WscSdk::Client.new(api_key, access_key)
+  #
+  # @example Usage with Environment Variables: Shell Config
+  #
+  #   !!!bash
+  #   export WSC_API_KEY=[your-api-key]
+  #   export WSC_API_ACCESS_KEY=[your-api-access-key]
+  #
+  # @example Usage with Environment Variables: Client Config
+  #
+  #   !!!ruby
+  #   client      = WscSdk::Client.new()
+  #
+  class Client
+    include HTTParty
+
+    # Maximum number of requests to execute per second.
+    MAX_REQUESTS_PER_SECOND = 5
+
+    base_uri WscSdk::HOSTNAME
+
+    attr_accessor :api_key, :access_key, :path_version, :hostname, :base_path, :logger
+
+    attr_reader :last_request_time
+
+    # Create a new instance of the client.
+    #
+    # @param options    [Hash]
+    #   A hash of options.
+    #
+    # @option options [String] :api_key
+    #   The account's API key.  Used to generated signatures for the API request
+    #   headers.
+    #
+    # @option options [String] :access_key
+    #   The account's access key.  Used to identify the profile making the
+    #   API requests.
+    #
+    # @option options [String] :hostname
+    #   The hostname to use when generating requests to the API.
+    #
+    # @option options [Logger] :logger
+    #   The logger to use when generating log output in the SDK.
+    #
+    # @option options [String] :version
+    #   The version of the API to use when generating requests to the API.
+    #
+    def initialize(options={})
+      @api_key        = options.fetch(:api_key,     WscSdk.configuration.api_key)
+      @access_key     = options.fetch(:access_key,  WscSdk.configuration.access_key)
+      @hostname       = options.fetch(:hostname,    WscSdk.configuration.hostname)
+      @path_version   = options.fetch(:version,     WscSdk.configuration.version)
+      @base_path      = ["", "api", @path_version].join("/")
+      @logger         = options.fetch(:logger,      WscSdk.configuration.logger)
+      self.class.base_uri(@hostname)
+    end
+
+
+    # Get the fully qualified request path for an API request.
+    #
+    # @param path [String]
+    #   The path of the API request.
+    #
+    # @return [String]
+    #   The fully qualified request path.
+    #
+    def full_request_path(path)
+      [ base_path, path ].join("/")
+    end
+
+
+    # Outputs the details of the client as a string.
+    #
+    # @return [String] The details of the client.
+    #
+    def to_s
+      "WSC SDK Client > hostname: #{hostname} | version: #{path_version} | base_path: #{base_path}"
+    end
+    #---------------------------------------------------------------------------
+    #  ___         _           _     _
+    # | __|_ _  __| |_ __  ___(_)_ _| |_ ___
+    # | _|| ' \/ _` | '_ \/ _ \ | ' \  _(_-<
+    # |___|_||_\__,_| .__/\___/_|_||_\__/__/
+    #               |_|
+    #---------------------------------------------------------------------------
+
+    # Access the /transcoders endpoints
+    #
+    # @return [Wsc::Endpoints::Transcoders]
+    #   An instance of the Transcoders endpoint class.
+    #
+    def live_streams
+      WscSdk::Endpoints::LiveStreams.new(self)
+    end
+
+    # Access the /stream_targets endpoints
+    #
+    # @return [Wsc::Endpoints::StreamTargets]
+    #   An instance of the StreamTargets endpoint class.
+    #
+    def stream_targets
+      WscSdk::Endpoints::StreamTargets.new(self)
+    end
+
+    # Access the /transcoders endpoints
+    #
+    # @return [Wsc::Endpoints::Transcoders]
+    #   An instance of the Transcoders endpoint class.
+    #
+    def transcoders
+      WscSdk::Endpoints::Transcoders.new(self)
+    end
+
+    #---------------------------------------------------------------------------
+    #  ___                      _     _  _              _ _ _
+    # | _ \___ __ _ _  _ ___ __| |_  | || |__ _ _ _  __| | (_)_ _  __ _
+    # |   / -_) _` | || / -_|_-<  _| | __ / _` | ' \/ _` | | | ' \/ _` |
+    # |_|_\___\__, |\_,_\___/__/\__| |_||_\__,_|_||_\__,_|_|_|_||_\__, |
+    #            |_|                                              |___/
+    #---------------------------------------------------------------------------
+
+
+    # Make a GET request against the API.
+    #
+    # @param path     [String]
+    #   The path to request.
+    #
+    # @param options  [Hash]
+    #   A hash of options.
+    #
+    def get(path, options={})
+      send_request(:get, path, options)
+    end
+
+    # Make a POST request against the API.
+    #
+    # @param path     [String]
+    #   The path to request.
+    #
+    # @param options  [Hash]
+    #   A hash of options.
+    #
+    def post(path, options={})
+      send_request(:post, path, options)
+    end
+
+    # Make a GET request against the API.
+    #
+    # @param path     [String]
+    #   The path to request.
+    #
+    # @param options  [Hash]
+    #   A hash of options.
+    #
+    def put(path, options={})
+      send_request(:put, path, options)
+    end
+
+    # Make a GET request against the API.
+    #
+    # @param path     [String]
+    #   The path to request.
+    #
+    # @param options  [Hash]
+    #   A hash of options.
+    #
+    def patch(path, options={})
+      send_request(:patch, path, options)
+    end
+
+    # Make a GET request against the API.
+    #
+    # @param path     [String]
+    #   The path to request.
+    #
+    # @param options  [Hash]
+    #   A hash of options.
+    #
+    def delete(path, options={})
+      send_request(:delete, path, options)
+    end
+
+    # A generic way to request against an endpoint in the API
+    #
+    # @param method [Symbol]
+    #   The method to use to formulate the request.
+    #
+    # @param path [String]
+    #   The path to the endpoint.  This shoudl not include the protocol, domain
+    #   or base path information.  Only the endpoint path itself.
+    #
+    # @param body [Hash]
+    #   A Hash of payload data to send in the request.  This data will not be
+    #   presented in the request if it's a GET or DELETE method.
+    #
+    def request_endpoint(method, path, body={})
+      begin
+        options = {}
+        options = { body: body } unless [:get, :delete].include?(method)
+        response = send_request(method, path, options)
+        return nil if response.body.to_s.empty?
+
+        begin
+          data = JSON.parse(response.body)
+          return data
+        rescue JSON::ParserError => jpe
+          return build_exception_response(500, "Bad JSON returned by request: [#{method.to_s.upcase}] #{path}", jpe)
+        end
+      rescue Exception => e
+        # return build_exception_response(500, "Exception while requesting endpoint: [#{method.to_s.upcase}] #{path}", e)
+        raise e
+      end
+    end
+
+    # Builds a structured hash to respond to an exception in the request_endpoint
+    # method
+    #
+    # @param status [Integer]
+    #   The status code of the response
+    #
+    # @param title [String]
+    #   The title of the exception
+    #
+    # @param exception [Exception]
+    #   The exception to relay in the message.
+    #
+    private def build_exception_response(status, title, exception)
+      {
+        "meta" => {
+          "status"      => status,
+          "code"        => "ERR-#{status}-#{exception.class.name.gsub("::", "-")}",
+          "title"       => title,
+          "message"     => exception.message,
+          "description" => exception.backtrace[0..5].join(" | ")
+        }
+      }
+    end
+
+    # Get the correct headers for an API request, including the properly formed
+    # signed authentication headers.
+    #
+    # @param request_path [String]
+    #   The request path to generate the headers for.
+    #
+    # @param options      [Hash]
+    #   A hash of options
+    #
+    # @option options [Time] :timestamp
+    #   The timestamp of the request.
+    #
+    # @option options [String] :content_type
+    #   ("multipart/form-data") The content type to return in the headers.
+    #
+    # @return [Hash]
+    #   A hash of request headers.
+    #
+    def generate_headers(request_path, options={})
+      timestamp     = options.fetch(:timestamp, Time.now.to_i)
+      request_path  = request_path.split("?").first.chomp("/")
+      data          = "#{timestamp}:#{request_path}:#{api_key}"
+      signature     = OpenSSL::HMAC.hexdigest("SHA256", api_key, data)
+      content_type  = options.fetch(:content_type, "multipart/form-data")
+
+      {
+        'User-Agent'      => WscSdk::USER_AGENT,
+        'Wsc-Access-Key'  => access_key,
+        'Wsc-Timestamp'   => timestamp.to_s,
+        'Wsc-Signature'   => signature,
+        'Content-Type'    => content_type
+      }
+    end
+
+    # Generate a set of request params for an API request
+    #
+    # @param options [Hash]
+    #   A hash of options.
+    #
+    # @option options [Hash] :params
+    #   A hash of query params or body content to be sent in the request.
+    #
+    # @option options [Hash] :pagination
+    #   Pagination configuration options.
+    #
+    # @option options [Hash] :filters
+    #   Filter configuration options.
+    #
+    def request_params(options={})
+      pagination  = options.fetch(:pagination, nil)
+      filters     = options.fetch(:filters, nil)
+      params      = options.fetch(:params, {})
+
+      if pagination
+        params[:page] = pagination.fetch(:page, 1)
+        params[:per_page] = pagination.fetch(:per_page, 25)
+      end
+
+      if filters
+        if filters.is_a?(Hash)
+          filter_index = 0
+          filters.each do |key, value|
+            params["filter[#{filter_index}][field]"] = key
+            params["filter[#{filter_index}][eq]"] = value
+            filter_index += 1
+          end
+        end
+      end
+
+      params
+    end
+
+    # Get debug information about the client configuration
+    #
+    def info
+      {
+        access_key:     ("#{access_key[0..5]}****#{access_key[-6..-1]}" rescue "invalid"),
+        api_key:        ("#{api_key[0..5]}****#{api_key[-6..-1]}" rescue "invalid"),
+        base_path:      base_path,
+        hostname:       hostname,
+        path_version:   path_version,
+        logger:         (logger.class.name rescue "nil"),
+        logger_level:   (logger.level rescue "nil"),
+        throttle:       MAX_REQUESTS_PER_SECOND,
+        user_agent:     WscSdk::USER_AGENT
+      }
+    end
+
+    # Send a request to the API.
+    #
+    # @param method   [Symbol]
+    #   The method verb for the request (:get, :post, :put, :patch, :delete)
+    #
+    # @param path     [String]
+    #   The API path to request.
+    #
+    # @param options  [Hash]
+    #   A hash of options.
+    #
+    # @option options [Hash] :params
+    #   A hash of query params or body content to be sent in the request.
+    #
+    # @option options [Hash] :pagination
+    #   Pagination configuration options.
+    #
+    # @option options [Hash] :filters
+    #   Filter configuration options.
+    #
+    private def send_request(method, path, options={})
+      wait_time = 0
+      unless @last_request_time.nil?
+        delay_time  = 1.0/MAX_REQUESTS_PER_SECOND
+        elapsed     = Time.now.to_f - @last_request_time.to_f
+        wait_time   = delay_time - elapsed
+        wait_time   = 0   if wait_time < 0
+        sleep(wait_time)  if wait_time > 0
+      end
+      @last_request_time = Time.now.to_f
+
+      data          = {}
+      full_path     = full_request_path(path)
+      headers       = options.fetch(:headers, {})
+      content_type  = headers.fetch(:content_type, "application/json")
+
+      case method.to_sym
+      when :get
+        data[:query]  = request_params(options)
+        data.delete(:query) if data[:query].empty?
+      else
+        data[:body]   = options[:body].to_json
+      end
+
+      data[:headers] = generate_headers(full_path, content_type: content_type)
+
+      logger.debug("[WSC SDK] Endpoint Request  : [#{method.to_s.upcase}] #{hostname}#{full_path} #{data}")
+
+      # Send the HTTParty call for the provided method.
+      response = self.class.send(method.to_sym, full_path, data)
+      logger.debug("[WSC SDK] Endpoint Response : [#{response.code}] #{response.body} | Throttle: #{wait_time}s")
+      response
+    end
+
+    # Get an instance of the Client built using the SDK configuration object.
+    #
+    # @return [WscSdk::Client]
+    #   The configured instance of the client.
+    #
+    def self.configured_instance
+      @@client_instance ||= WscSdk::Client.new
+    end
+
+    # Convert a file to a base64 encoded string.
+    #
+    # @param file_path [String]
+    #   A valid path to a file that should be converted to base64 encoding
+    #
+    # @return [String]
+    #   The base64 encoded string that represents the file.
+    #
+    # @raise []
+    def self.file_to_base64(file_path)
+      raise ArgumentError.new("Could not convert the specified file to Base64, the file couldn't be found: #{file_path}") unless File.exists?(file_path)
+      Base64.encode64(File.open(file_path, "rb").read)
+    end
+  end
+end