Deprecate Twitter::REST::Client#middleware= and #connection_options

.rubocop.yml

@@ -10,7 +10,7 @@ ParameterLists:
   CountKeywordArgs: true
 
 ClassLength:
-  Max: 85
+  Max: 90
 
 LineLength:
   Enabled: false

lib/twitter/rest/client.rb

@@ -19,9 +19,16 @@ module REST
     class Client < Twitter::Client
       include Twitter::REST::API
       attr_accessor :bearer_token
-      attr_writer :connection_options, :middleware
       ENDPOINT = 'https://api.twitter.com'
 
+      # @param connection_options [Hash]
+      # @return [Hash]
+      def connection_options=(connection_options)
+        warn "#{Kernel.caller.first}: [DEPRECATION] Twitter::REST::Client#connection_options= is deprecated and will be removed in version 6.0.0."
+        @connection_options = connection_options
+      end
+
+      # @return [Hash]
       def connection_options
         @connection_options ||= {
           :builder => middleware,
@@ -36,6 +43,13 @@ def connection_options
         }
       end
 
+      # @params middleware [Faraday::RackBuilder]
+      # @return [Faraday::RackBuilder]
+      def middleware=(middleware)
+        warn "#{Kernel.caller.first}: [DEPRECATION] Twitter::REST::Client#middleware= is deprecated and will be removed in version 6.0.0."
+        @middleware = middleware
+      end
+
       # @note Faraday's middleware stack implementation is comparable to that of Rack middleware.  The order of middleware is important: the first middleware on the list wraps all others, while the last middleware is the innermost one.
       # @see https://github.com/technoweenie/faraday#advanced-middleware-usage
       # @see http://mislav.uniqpath.com/2011/07/faraday-advanced-http/

lib/twitter/user.rb

@@ -33,7 +33,6 @@ class User < Twitter::BasicUser
     alias_method :tweeted?, :status?
 
     class << self
-
     private
 
       # Dynamically define a method for entity URIs

spec/helper.rb

@@ -65,3 +65,15 @@ def fixture_path
 def fixture(file)
   File.new(fixture_path + '/' + file)
 end
+
+def capture_warning
+  begin
+    old_stderr = $stderr
+    $stderr = StringIO.new
+    yield
+    result = $stderr.string
+  ensure
+    $stderr = old_stderr
+  end
+  result
+end

spec/twitter/rest/client_spec.rb

@@ -65,6 +65,36 @@
     end
   end
 
+  describe '#connection_options=' do
+    it 'sets connection options' do
+      capture_warning do
+        @client.connection_options = 'connection options'
+      end
+      expect(@client.connection_options).to eq('connection options')
+    end
+    it 'outputs a warning' do
+      warning = capture_warning do
+        @client.connection_options = nil
+      end
+      expect(warning).to match(/\[DEPRECATION\] Twitter::REST::Client#connection_options= is deprecated and will be removed in version 6\.0\.0\.$/)
+    end
+  end
+
+  describe '#middleware=' do
+    it 'sets middleware' do
+      capture_warning do
+        @client.middleware = 'middleware'
+      end
+      expect(@client.middleware).to eq 'middleware'
+    end
+    it 'outputs a warning' do
+      warning = capture_warning do
+        @client.middleware = nil
+      end
+      expect(warning).to match(/\[DEPRECATION\] Twitter::REST::Client#middleware= is deprecated and will be removed in version 6\.0\.0\.$/)
+    end
+  end
+
   describe '#credentials?' do
     it 'returns true if all credentials are present' do
       client = Twitter::REST::Client.new(:consumer_key => 'CK', :consumer_secret => 'CS', :access_token => 'AT', :access_token_secret => 'AS')