module Supercast
Constants
- VERSION
Attributes
Public Class Methods
The location of a file containing a bundle of CA certificates. By default the library will use an included bundle that can successfully validate Supercast
certificates.
# File lib/supercast.rb, line 72 def self.ca_bundle_path @ca_bundle_path end
# File lib/supercast.rb, line 76 def self.ca_bundle_path=(path) @ca_bundle_path = path # empty this field so a new store is initialized @ca_store = nil end
A certificate store initialized from the the bundle in ca_bundle_path and which is used to validate TLS on every request.
This was added to the give the gem “pseudo thread safety” in that it seems when initiating many parallel requests marshaling the certificate store is the most likely point of failure. Any program attempting to leverage this pseudo safety should make a call to this method (i.e. `Supercast.ca_store`) in their initialization code because it marshals lazily and is itself not thread safe.
# File lib/supercast.rb, line 92 def self.ca_store @ca_store ||= begin store = OpenSSL::X509::Store.new store.add_file(ca_bundle_path) store end end
When set prompts the library to log some extra information to $stdout and $stderr about what it's doing. For example, it'll produce information about requests, responses, and errors that are received. Valid log levels are `debug` and `info`, with `debug` being a little more verbose in places.
Use of this configuration is only useful when `.logger` is not set. When it is, the decision what levels to print is entirely deferred to the logger.
# File lib/supercast.rb, line 112 def self.log_level @log_level end
# File lib/supercast.rb, line 116 def self.log_level=(val) raise ArgumentError, 'log_level should only be set to `nil`, `debug` or `info`' if !val.nil? && ![LEVEL_DEBUG, LEVEL_ERROR, LEVEL_INFO].include?(val) @log_level = val end
Sets a logger to which logging output will be sent. The logger should support the same interface as the `Logger` class that's part of Ruby's standard library (hint, anything in `Rails.logger` will likely be suitable).
If `.logger` is set, the value of `.log_level` is ignored. The decision on what levels to print is entirely deferred to the logger.
# File lib/supercast.rb, line 129 def self.logger @logger end
# File lib/supercast.rb, line 133 def self.logger=(val) @logger = val end
# File lib/supercast.rb, line 137 def self.max_network_retries @max_network_retries end
# File lib/supercast.rb, line 141 def self.max_network_retries=(val) @max_network_retries = val.to_i end