➖ em-http-request

pboling · pboling · commit a27962aabe45 · 2025-09-12T18:18:31.000-06:00
- lazy Loaded so it can be optional, since some systems fail to install it, and it doesn't seem maintained
diff --git a/.idea/oauth.iml b/.idea/oauth.iml
diff --git a/.rubocop_gradual.lock b/.rubocop_gradual.lock
@@ -34,11 +34,11 @@
   "lib/oauth/tokens/consumer_token.rb:3696415131": [
     [9, 5, 155, "Style/ClassMethodsDefinitions: Use `class << self` to define a class method.", 349576019]
   ],
-  "oauth.gemspec:108374725": [
+  "oauth.gemspec:3033391650": [
     [133, 3, 56, "Gemspec/DependencyVersion: Dependency version specification is required.", 644892567],
-    [154, 3, 40, "Gemspec/DependencyVersion: Dependency version specification is required.", 2300588954],
-    [156, 3, 44, "Gemspec/DependencyVersion: Dependency version specification is required.", 1905290578],
-    [157, 3, 46, "Gemspec/DependencyVersion: Dependency version specification is required.", 4289565910]
+    [153, 3, 40, "Gemspec/DependencyVersion: Dependency version specification is required.", 2300588954],
+    [155, 3, 44, "Gemspec/DependencyVersion: Dependency version specification is required.", 1905290578],
+    [156, 3, 46, "Gemspec/DependencyVersion: Dependency version specification is required.", 4289565910]
   ],
   "spec/oauth/backwards_compatibility_spec.rb:4041711732": [
     [3, 16, 25, "RSpec/DescribeClass: The first argument to describe should be the class or module being tested.", 3956042931]
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -23,6 +23,8 @@ Please file a bug if you notice a violation of semantic versioning.
 - converted minitest => rspec
 ### Deprecated
 ### Removed
+- dependency on em-http-request
+  - now lazy Loaded so it can be optional, since some systems fail to install it, and it doesn't seem maintained
 ### Fixed
 ### Security
 
diff --git a/Gemfile.lock b/Gemfile.lock
@@ -162,7 +162,7 @@ GEM
     pp (0.6.2)
       prettyprint
     prettyprint (0.2.0)
-    prism (1.4.0)
+    prism (1.5.0)
     psych (5.2.6)
       date
       stringio
@@ -301,7 +301,7 @@ GEM
     snaky_hash (2.0.3)
       hashie (>= 0.1.0, < 6)
       version_gem (>= 1.1.8, < 3)
-    standard (1.51.0)
+    standard (1.51.1)
       language_server-protocol (~> 3.17.0.2)
       lint_roller (~> 1.0)
       rubocop (~> 1.80.2)
diff --git a/gemfiles/modular/optional.gemfile b/gemfiles/modular/optional.gemfile
@@ -1 +1,7 @@
 # Optional dependencies are not depended on directly, but may be used if present.
+
+# em-http-request depends on http_parser.rb, which is supposed to be,
+# but appears to not be, compatible with JRuby.
+# http_parser.rb is highly unmaintained, with no responses on issues for 2 years.
+# em-http-request is even less maintained, with no releases in 5 years.
+gem "em-http-request", "~> 1.1.7" # ruby >= 0
diff --git a/lib/oauth/client/em_http.rb b/lib/oauth/client/em_http.rb
@@ -1,123 +1,126 @@
 # frozen_string_literal: true
 
-require "em-http"
 require "oauth/helper"
-require "oauth/request_proxy/em_http_request"
+require "oauth/optional"
 
-# Extensions for em-http so that we can use consumer.sign! with an EventMachine::HttpClient
-# instance. This is purely syntactic sugar.
-module EventMachine
-  class HttpClient
-    attr_reader :oauth_helper
+if OAuth::Optional.em_http_available?
+  require "oauth/request_proxy/em_http_request"
 
-    # Add the OAuth information to an HTTP request. Depending on the <tt>options[:scheme]</tt> setting
-    # this may add a header, additional query string parameters, or additional POST body parameters.
-    # The default scheme is +header+, in which the OAuth parameters as put into the +Authorization+
-    # header.
-    #
-    # * http - Configured Net::HTTP instance, ignored in this scenario except for getting host.
-    # * consumer - OAuth::Consumer instance
-    # * token - OAuth::Token instance
-    # * options - Request-specific options (e.g. +request_uri+, +consumer+, +token+, +scheme+,
-    #   +signature_method+, +nonce+, +timestamp+)
-    #
-    # This method also modifies the <tt>User-Agent</tt> header to add the OAuth gem version.
-    #
-    # See Also: {OAuth core spec version 1.0, section 5.4.1}[http://oauth.net/core/1.0#rfc.section.5.4.1]
-    def oauth!(http, consumer = nil, token = nil, options = {})
-      options = {
-        request_uri: normalized_oauth_uri(http),
-        consumer: consumer,
-        token: token,
-        scheme: "header",
-        signature_method: nil,
-        nonce: nil,
-        timestamp: nil,
-      }.merge(options)
+  # Extensions for em-http so that we can use consumer.sign! with an EventMachine::HttpClient
+  # instance. This is purely syntactic sugar.
+  module EventMachine
+    class HttpClient
+      attr_reader :oauth_helper
 
-      @oauth_helper = OAuth::Client::Helper.new(self, options)
-      __send__(:"set_oauth_#{options[:scheme]}")
-    end
+      # Add the OAuth information to an HTTP request. Depending on the <tt>options[:scheme]</tt> setting
+      # this may add a header, additional query string parameters, or additional POST body parameters.
+      # The default scheme is +header+, in which the OAuth parameters as put into the +Authorization+
+      # header.
+      #
+      # * http - Configured Net::HTTP instance, ignored in this scenario except for getting host.
+      # * consumer - OAuth::Consumer instance
+      # * token - OAuth::Token instance
+      # * options - Request-specific options (e.g. +request_uri+, +consumer+, +token+, +scheme+,
+      #   +signature_method+, +nonce+, +timestamp+)
+      #
+      # This method also modifies the <tt>User-Agent</tt> header to add the OAuth gem version.
+      #
+      # See Also: {OAuth core spec version 1.0, section 5.4.1}[http://oauth.net/core/1.0#rfc.section.5.4.1]
+      def oauth!(http, consumer = nil, token = nil, options = {})
+        options = {
+          request_uri: normalized_oauth_uri(http),
+          consumer: consumer,
+          token: token,
+          scheme: "header",
+          signature_method: nil,
+          nonce: nil,
+          timestamp: nil,
+        }.merge(options)
 
-    # Create a string suitable for signing for an HTTP request. This process involves parameter
-    # normalization as specified in the OAuth specification. The exact normalization also depends
-    # on the <tt>options[:scheme]</tt> being used so this must match what will be used for the request
-    # itself. The default scheme is +header+, in which the OAuth parameters as put into the +Authorization+
-    # header.
-    #
-    # * http - Configured Net::HTTP instance
-    # * consumer - OAuth::Consumer instance
-    # * token - OAuth::Token instance
-    # * options - Request-specific options (e.g. +request_uri+, +consumer+, +token+, +scheme+,
-    #   +signature_method+, +nonce+, +timestamp+)
-    #
-    # See Also: {OAuth core spec version 1.0, section 9.1.1}[http://oauth.net/core/1.0#rfc.section.9.1.1]
-    def signature_base_string(http, consumer = nil, token = nil, options = {})
-      options = {
-        request_uri: normalized_oauth_uri(http),
-        consumer: consumer,
-        token: token,
-        scheme: "header",
-        signature_method: nil,
-        nonce: nil,
-        timestamp: nil,
-      }.merge(options)
+        @oauth_helper = OAuth::Client::Helper.new(self, options)
+        __send__(:"set_oauth_#{options[:scheme]}")
+      end
 
-      OAuth::Client::Helper.new(self, options).signature_base_string
-    end
+      # Create a string suitable for signing for an HTTP request. This process involves parameter
+      # normalization as specified in the OAuth specification. The exact normalization also depends
+      # on the <tt>options[:scheme]</tt> being used so this must match what will be used for the request
+      # itself. The default scheme is +header+, in which the OAuth parameters as put into the +Authorization+
+      # header.
+      #
+      # * http - Configured Net::HTTP instance
+      # * consumer - OAuth::Consumer instance
+      # * token - OAuth::Token instance
+      # * options - Request-specific options (e.g. +request_uri+, +consumer+, +token+, +scheme+,
+      #   +signature_method+, +nonce+, +timestamp+)
+      #
+      # See Also: {OAuth core spec version 1.0, section 9.1.1}[http://oauth.net/core/1.0#rfc.section.9.1.1]
+      def signature_base_string(http, consumer = nil, token = nil, options = {})
+        options = {
+          request_uri: normalized_oauth_uri(http),
+          consumer: consumer,
+          token: token,
+          scheme: "header",
+          signature_method: nil,
+          nonce: nil,
+          timestamp: nil,
+        }.merge(options)
 
-    # This code was lifted from the em-http-request because it was removed from
-    # the gem June 19, 2010
-    # see: https://github.com/igrigorik/em-http-request/commit/d536fc17d56dbe55c487eab01e2ff9382a62598b
-    def normalize_uri
-      @normalized_uri ||= begin
-        uri = @conn.dup
-        encoded_query = encode_query(@conn, @req[:query])
-        path, query = encoded_query.split("?", 2)
-        uri.query = query unless encoded_query.empty?
-        uri.path = path
-        uri
+        OAuth::Client::Helper.new(self, options).signature_base_string
       end
-    end
 
-    protected
+      # This code was lifted from the em-http-request because it was removed from
+      # the gem June 19, 2010
+      # see: https://github.com/igrigorik/em-http-request/commit/d536fc17d56dbe55c487eab01e2ff9382a62598b
+      def normalize_uri
+        @normalized_uri ||= begin
+          uri = @conn.dup
+          encoded_query = encode_query(@conn, @req[:query])
+          path, query = encoded_query.split("?", 2)
+          uri.query = query unless encoded_query.empty?
+          uri.path = path
+          uri
+        end
+      end
+
+      protected
 
-    def combine_query(path, query, uri_query)
-      combined_query = if query.is_a?(Hash)
-        query.map { |k, v| encode_param(k, v) }.join("&")
-      else
-        query.to_s
+      def combine_query(path, query, uri_query)
+        combined_query = if query.is_a?(Hash)
+          query.map { |k, v| encode_param(k, v) }.join("&")
+        else
+          query.to_s
+        end
+        combined_query = [combined_query, uri_query].reject(&:empty?).join("&") unless uri_query.to_s.empty?
+        combined_query.to_s.empty? ? path : "#{path}?#{combined_query}"
       end
-      combined_query = [combined_query, uri_query].reject(&:empty?).join("&") unless uri_query.to_s.empty?
-      combined_query.to_s.empty? ? path : "#{path}?#{combined_query}"
-    end
 
-    # Since we expect to get the host etc details from the http instance (...),
-    # we create a fake url here. Surely this is a horrible, horrible idea?
-    def normalized_oauth_uri(http)
-      uri = URI.parse(normalize_uri.path)
-      uri.host = http.address
-      uri.port = http.port
+      # Since we expect to get the host etc details from the http instance (...),
+      # we create a fake url here. Surely this is a horrible, horrible idea?
+      def normalized_oauth_uri(http)
+        uri = URI.parse(normalize_uri.path)
+        uri.host = http.address
+        uri.port = http.port
 
-      uri.scheme = if http.respond_to?(:use_ssl?) && http.use_ssl?
-        "https"
-      else
-        "http"
+        uri.scheme = if http.respond_to?(:use_ssl?) && http.use_ssl?
+          "https"
+        else
+          "http"
+        end
+        uri.to_s
       end
-      uri.to_s
-    end
 
-    def set_oauth_header
-      req[:head] ||= {}
-      req[:head].merge!("Authorization" => @oauth_helper.header)
-    end
+      def set_oauth_header
+        req[:head] ||= {}
+        req[:head].merge!("Authorization" => @oauth_helper.header)
+      end
 
-    def set_oauth_body
-      raise NotImplementedError, "please use the set_oauth_header method instead"
-    end
+      def set_oauth_body
+        raise NotImplementedError, "please use the set_oauth_header method instead"
+      end
 
-    def set_oauth_query_string
-      raise NotImplementedError, "please use the set_oauth_header method instead"
+      def set_oauth_query_string
+        raise NotImplementedError, "please use the set_oauth_header method instead"
+      end
     end
   end
 end
diff --git a/lib/oauth/optional.rb b/lib/oauth/optional.rb
@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module OAuth
+  # Helpers for optional, lazily loaded integrations.
+  module Optional
+    class << self
+      # Try to load EventMachine HTTP client support provided by em-http-request.
+      #
+      # Returns true if available, false if the dependency is not installed.
+      # Never raises LoadError.
+      def em_http_available?
+        # em-http-request provides "em-http" entrypoint
+        require "em-http"
+        true
+      rescue LoadError
+        false
+      end
+    end
+  end
+end
diff --git a/lib/oauth/request_proxy/em_http_request.rb b/lib/oauth/request_proxy/em_http_request.rb
diff --git a/oauth.gemspec b/oauth.gemspec
