Merge pull request #1 from microsoft/feature/user-agent

- adds a user agent handler

Author: baywet

CHANGELOG.md

@@ -11,6 +11,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Changed
 
+## [0.10.0] - 2023-01-06
+
+### Added
+
+- Added a user agent handler to add the product to the request header.
+
 ## [0.9.0] - 2022-12-30
 
 ### Added

lib/microsoft_kiota_faraday.rb

@@ -4,6 +4,8 @@
 require_relative 'microsoft_kiota_faraday/middleware/response_handler_option'
 require_relative 'microsoft_kiota_faraday/middleware/parameters_name_decoding_option'
 require_relative 'microsoft_kiota_faraday/middleware/parameters_name_decoding_handler'
+require_relative 'microsoft_kiota_faraday/middleware/user_agent_option'
+require_relative 'microsoft_kiota_faraday/middleware/user_agent_handler'
 require_relative 'microsoft_kiota_faraday/kiota_client_factory'
 require_relative 'microsoft_kiota_faraday/faraday_request_adapter'
 

lib/microsoft_kiota_faraday/kiota_client_factory.rb

@@ -1,11 +1,13 @@
 require 'net/https'
 require 'faraday'
 require_relative 'middleware/parameters_name_decoding_handler'
+require_relative 'middleware/user_agent_handler'
 module MicrosoftKiotaFaraday
     class KiotaClientFactory
         def self.get_default_middleware()
             return [
-                MicrosoftKiotaFaraday::Middleware::ParametersNameDecodingHandler
+                MicrosoftKiotaFaraday::Middleware::ParametersNameDecodingHandler,
+                MicrosoftKiotaFaraday::Middleware::UserAgentHandler
             ]
         end
 

lib/microsoft_kiota_faraday/middleware/user_agent_handler.rb

@@ -0,0 +1,24 @@
+require 'faraday'
+require_relative 'user_agent_option'
+module MicrosoftKiotaFaraday
+    module Middleware
+        class UserAgentHandler < Faraday::Middleware
+            @@default_option = UserAgentOption.new
+			@@user_agent_key = "User-Agent"
+			def call(request_env)
+                request_option = request_env[:request][:context][@@default_option.get_key] unless request_env[:request].nil? || request_env[:request][:context].nil?
+                request_option = @@default_option if request_option.nil?
+                unless request_env[:request_headers].nil? || !request_option.enabled || request_option.product_name.nil? || request_option.product_name.empty? || request_option.product_version.nil? || request_option.product_version.empty? then
+                    existing_value = request_env[:request_headers][@@user_agent_key]
+					additional_value = "#{request_option.product_name}/#{request_option.product_version}"
+					if !existing_value || existing_value.empty? then
+						request_env[:request_headers][@@user_agent_key] = additional_value
+					elsif !existing_value.include? additional_value then
+						request_env[:request_headers][@@user_agent_key] = "#{existing_value} #{additional_value}"
+					end
+                end
+                @app.call(request_env) unless @app.nil?
+            end
+		end
+	end
+end

lib/microsoft_kiota_faraday/middleware/user_agent_option.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+require 'microsoft_kiota_abstractions'
+require_relative '../version.rb'
+module MicrosoftKiotaFaraday
+    module Middleware
+        class UserAgentOption
+            include MicrosoftKiotaAbstractions::RequestOption
+            attr_accessor :enabled, :product_name, :product_version
+			def initialize()
+				@enabled = true
+				@product_name = "kiota-ruby"
+				@product_version = MicrosoftKiotaFaraday::VERSION
+			end
+
+			def get_key()
+                "userAgent"
+            end
+		end
+	end
+end

lib/microsoft_kiota_faraday/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module MicrosoftKiotaFaraday
-  VERSION = '0.9.0'
+  VERSION = '0.10.0'
 end

spec/user_agent_handler_spec.rb

@@ -0,0 +1,44 @@
+require 'faraday'
+
+# frozen_string_literal: true
+RSpec.describe MicrosoftKiotaFaraday do
+	user_agent_key = "User-Agent"
+	url = "https://graph.microsoft.com/v1.0/users"
+    it "adds the user agent product" do
+        handler = MicrosoftKiotaFaraday::Middleware::UserAgentHandler.new()
+        env = {
+            url: URI.parse(url),
+            request_headers: {}
+        }
+        handler.call(env)
+        expect(env[:request_headers][user_agent_key].split("/")[0]).to eq("kiota-ruby")
+    end
+
+    it "adds the user agent product once" do
+        handler = MicrosoftKiotaFaraday::Middleware::UserAgentHandler.new()
+        env = {
+            url: URI.parse(url),
+            request_headers: {}
+        }
+        handler.call(env)
+        handler.call(env)
+        expect(env[:request_headers][user_agent_key].split("kiota-ruby").length).to eq(2)
+    end
+    it "doesnt add the header when disabled" do
+        handler = MicrosoftKiotaFaraday::Middleware::UserAgentHandler.new()
+		opt = MicrosoftKiotaFaraday::Middleware::UserAgentOption.new()
+		opt.enabled = false
+        env = {
+            url: URI.parse(url),
+            request_headers: {},
+			request: {
+				context: {
+					opt.get_key => opt
+				}
+			}
+        }
+        handler.call(env)
+        handler.call(env)
+        expect(env[:request_headers][user_agent_key]).to be_nil
+    end
+end