📝 Rename api_key to source_token (#4)

Author: simonrozsival

Rakefile

@@ -14,7 +14,7 @@ def puts_with_level(message, level = :info)
   end
 end
 
-task :test_the_pipes, [:api_key] do |t, args|
+task :test_the_pipes, [:source_token] do |t, args|
   support_email = "[email protected]"
   # Do not modify below this line. It's important to keep the `Logtail::Logger`
   # because it provides an API for logging structured data and capturing context.
@@ -26,7 +26,7 @@ task :test_the_pipes, [:api_key] do |t, args|
 
   current_context = Logtail::CurrentContext.instance.snapshot
   entry = Logtail::LogEntry.new(:info, Time.now, nil, "Testing the pipes (click the inspect icon to view more details)", current_context, nil)
-  http_device = Logtail::LogDevices::HTTP.new(args.api_key, flush_continuously: false)
+  http_device = Logtail::LogDevices::HTTP.new(args.source_token, flush_continuously: false)
   response = http_device.deliver_one(entry)
   if response.is_a?(Exception)
     message = <<~HEREDOC

lib/logtail/log_devices/http.rb

@@ -36,7 +36,7 @@ class HTTP
       # you can drop the log messages instead by passing a {DroppingSizedQueue} via the
       # `:request_queue` option.
       #
-      # @param api_key [String] The API key provided to you after you add your application to
+      # @param source_token [String] The API key provided to you after you add your application to
       #   [Logtail](https://logtail.com).
       # @param [Hash] options the options to create a HTTP log device with.
       # @option attributes [Symbol] :batch_size (1000) Determines the maximum of log lines in
@@ -64,13 +64,13 @@ class HTTP
       #   The default is set via {LOGTAIL_HOST}.
       #
       # @example Basic usage
-      #   Logtail::Logger.new(Logtail::LogDevices::HTTP.new("my_logtail_api_key"))
+      #   Logtail::Logger.new(Logtail::LogDevices::HTTP.new("my_logtail_source_token"))
       #
       # @example Apply back pressure instead of dropping messages
-      #   http_log_device = Logtail::LogDevices::HTTP.new("my_logtail_api_key", request_queue: SizedQueue.new(25))
+      #   http_log_device = Logtail::LogDevices::HTTP.new("my_logtail_source_token", request_queue: SizedQueue.new(25))
       #   Logtail::Logger.new(http_log_device)
-      def initialize(api_key, options = {})
-        @api_key = api_key || raise(ArgumentError.new("The api_key parameter cannot be blank"))
+      def initialize(source_token, options = {})
+        @source_token = source_token || raise(ArgumentError.new("The source_token parameter cannot be blank"))
         @logtail_host = options[:logtail_host] || ENV['LOGTAIL_HOST'] || LOGTAIL_HOST
         @logtail_port = options[:logtail_port] || ENV['LOGTAIL_PORT'] || LOGTAIL_PORT
         @logtail_scheme = options[:logtail_scheme] || ENV['LOGTAIL_SCHEME'] || LOGTAIL_SCHEME
@@ -168,7 +168,7 @@ def verify_delivery!
         end
 
         raise <<-MESSAGE
-        
+
 Log delivery failed! No request was made.
 
 You can enable internal debug logging with the following:
@@ -361,7 +361,7 @@ def deliver_requests(conn)
 
         # Builds the `Authorization` header value for HTTP delivery to the Logtail API.
         def authorization_payload
-          "Bearer #{@api_key}"
+          "Bearer #{@source_token}"
         end
     end
   end

lib/logtail/logger.rb

@@ -135,15 +135,15 @@ def call(severity, time, progname, msg)
     #   logger = Logtail::Logger.new(STDOUT)
     #
     # @example Logging to the Logtail HTTP device
-    #   http_device = Logtail::LogDevices::HTTP.new("my-logtail-api-key")
+    #   http_device = Logtail::LogDevices::HTTP.new("my-logtail-source-token")
     #   logger = Logtail::Logger.new(http_device)
     #
     # @example Logging to a file (with rotation)
     #   file_device = Logger::LogDevice.new("path/to/file.log")
     #   logger = Logtail::Logger.new(file_device)
     #
     # @example Logging to a file and the Logtail HTTP device (multiple log devices)
-    #   http_device = Logtail::LogDevices::HTTP.new("my-logtail-api-key")
+    #   http_device = Logtail::LogDevices::HTTP.new("my-logtail-source-token")
     #   file_logger = ::Logger.new("path/to/file.log")
     #   logger = Logtail::Logger.new(http_device, file_logger)
     def initialize(*io_devices_and_loggers)

spec/logtail/logger_spec.rb

@@ -161,7 +161,7 @@
     end
 
     context "with the HTTP log device" do
-      let(:io) { Logtail::LogDevices::HTTP.new("my_key") }
+      let(:io) { Logtail::LogDevices::HTTP.new("my_source_token") }
 
       it "should use the PassThroughFormatter" do
         expect(logger.formatter).to be_kind_of(Logtail::Logger::PassThroughFormatter)
@@ -189,7 +189,7 @@
 
   describe "#formatter=" do
     it "should not allow changing the formatter when the device is HTTP" do
-      http_device = Logtail::LogDevices::HTTP.new("api_key")
+      http_device = Logtail::LogDevices::HTTP.new("source_token")
       logger = Logtail::Logger.new(http_device)
       expect { logger.formatter = ::Logger::Formatter.new }.to raise_error(ArgumentError)
     end