Add deprecations

Author: laurynas

CHANGELOG.md

@@ -12,14 +12,15 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - `detect_batch` method for batch detections
 
 ### Changed
-- Switched to v3 API which uses updated language detection model
-- ⚠️ `simple_detect` method renamed to `detect_code`
+- Switched to v3 API which uses an updated language detection model
 - ⚠️ `detect` method result fields are `language` and `score`
-- ⚠️ `detect` method no longer accept arrays - use `detect_batch` instead
-- ⚠️ `user_status` method renamed to `account_status`
+- ⚠️ `detect` for batch detection is deprecated, use `detect_batch` instead
+- ⚠️ `simple_detect` deprecated, use `detect_code` instead
+- ⚠️ `user_status` deprecated, use `account_status` instead
+- ⚠️ `configuration` deprecated, use `config` instead
 - ⚠️ Proxy URL configured using `config.proxy`
-- HTTPS is used by default. Removed secure mode configuration.
-- Client connection is reused. If you change configuration after client is initialized, you need to reset client using `DetectLanguage.client = nil`.
+- Client connection is reused. If you change configuration after the client is initialized, you need to reset client using `DetectLanguage.client = nil`.
 
 ### Removed
+- Secure mode configuration. HTTPS is always used.
 - Ruby 1.x support

lib/detect_language.rb

@@ -23,16 +23,27 @@ def client=(client)
       Thread.current[:detect_language_client] = client
     end
 
+    # @param query String
+    # @return [Array<Hash>] Array of language detections
     def detect(query)
+      if query.is_a?(Array)
+        warn '[DEPRECATED] `DetectLanguage.detect` with an array of queries is deprecated. Use `DetectLanguage.detect_batch` instead.'
+        return detect_batch(query)
+      end
+
       client.post('detect', q: query)
     end
 
+    # @param queries Array<String> Array of queries to detect languages for
+    # @return [Array<Array<Hash>>] Array of language detections for each query
     def detect_batch(queries)
       raise(ArgumentError, 'Expected an Array of queries') unless queries.is_a?(Array)
 
       client.post('detect-batch', q: queries)
     end
 
+    # @param text String
+    # @return [String, nil] Detected language code or nil if no detection found
     def detect_code(text)
       detections = detect(text)
 
@@ -41,12 +52,34 @@ def detect_code(text)
       detections[0]['language']
     end
 
+    # @return [Hash] Account status information
     def account_status
       client.get('account/status')
     end
 
+    # @return [Array<Hash>] List of supported languages
     def languages
       client.get('languages')
     end
+
+    ### DEPRECATED METHODS
+
+    # @deprecated Use `DetectLanguage.config` instead
+    def configuration
+      warn '[DEPRECATED] `DetectLanguage.configuration` is deprecated. Use `DetectLanguage.config` instead.'
+      config
+    end
+
+    # @deprecated Use `detect_code` instead
+    def simple_detect(text)
+      warn '[DEPRECATED] `DetectLanguage.simple_detect` is deprecated. Use `DetectLanguage.detect_code` instead.'
+      detect_code(text)
+    end
+
+    # @deprecated Use `DetectLanguage.account_status` instead
+    def user_status
+      warn '[DEPRECATED] `DetectLanguage.user_status` is deprecated. Use `DetectLanguage.account_status` instead.'
+      account_status
+    end
   end
 end

spec/lib/detect_language_spec.rb

@@ -16,6 +16,15 @@
     it { is_expected.to be_a(DetectLanguage::Configuration) }
   end
 
+  describe '.configuration' do
+    subject { described_class.configuration }
+
+    it 'delegates to config' do
+      expect(described_class).to receive(:config)
+      expect { subject }.to output(/DEPRECATED/).to_stderr
+    end
+  end
+
   describe '.detect' do
     subject { described_class.detect(query) }
 
@@ -35,6 +44,23 @@
       end
     end
 
+    context 'with array of queries' do
+      let(:query) { ['Hello world', 'Bonjour le monde'] }
+      let(:result) { double }
+
+      before do
+        allow(described_class).to receive(:detect_batch).with(query).and_return(result)
+      end
+
+      it 'delegates to detect_batch' do
+        expect(subject).to be(result)
+      end
+
+      it 'issues a deprecation warning' do
+        expect { described_class.detect(query) }.to output(/DEPRECATED/).to_stderr
+      end
+    end
+
     context 'invalid api key' do
       let(:api_key) { 'invalid' }
 
@@ -111,6 +137,15 @@
     end
   end
 
+  describe '.user_status' do
+    subject { described_class.user_status }
+
+    it 'delegates to account_status' do
+      expect(described_class).to receive(:account_status)
+      expect { subject }.to output(/DEPRECATED/).to_stderr
+    end
+  end
+
   describe '.languages' do
     subject { DetectLanguage.languages }