ObsoleteClient to handle instantiations of clients from old library (t…

…wilio#341)

* ObsoleteClient to handle instantiations of clients from old library

* Added pre-commit hook

Makefile

@@ -1,8 +1,8 @@
-.PHONY: test lint-changed lint docs
+.PHONY: githooks test lint-changed lint docs
 
 CHANGED_RUBY_FILES = $(shell git status --porcelain | grep ".rb" | awk -F ' ' '{print $2}' | tr '\n' ' ')
 
-install:
+install: githooks
 	bundle install; bundle exec rake install
 
 test-install:
@@ -17,6 +17,10 @@ docs:
 lint:
 	rubocop --cache true --parallel
 
+githooks:
+	cp githooks/pre-commit .git/hooks/pre-commit
+	chmod +x .git/hooks/pre-commit
+
 authors:
 	echo "Authors\n=======\n\nA huge thanks to all of our contributors:\n\n" > AUTHORS.md
 	git log --raw | grep "^Author: " | cut -d ' ' -f2- | cut -d '<' -f1 | sed 's/^/- /' | sort | uniq >> AUTHORS.md

githooks/pre-commit

@@ -0,0 +1 @@
+make test

lib/twilio-ruby/framework/error.rb

@@ -26,5 +26,8 @@ def to_s
         "[HTTP #{status_code}] #{code} : #{message}"
       end
     end
+
+    class ObsoleteError < StandardError
+    end
   end
 end

lib/twilio-ruby/framework/obsolete_client.rb

@@ -0,0 +1,10 @@
+module Twilio
+  module REST
+    class ObsoleteClient
+      def initialize(*)
+        raise ObsoleteError, "#{self.class} has been removed from this version of the library. "\
+                             'Please refer to current documentation for guidance.'
+      end
+    end
+  end
+end

lib/twilio-ruby/rest/client.rb

@@ -365,5 +365,33 @@ def to_s
         "#<Twilio::REST::Client #{@account_sid}>"
       end
     end
+
+    ##
+    # Dummy client which provides no functionality. Please use Twilio::REST::Client instead.
+    class BaseClient < ObsoleteClient; end
+
+    ##
+    # Dummy client which provides no functionality. Please use Twilio::REST::Client instead.
+    class IpMessagingClient < ObsoleteClient; end
+
+    ##
+    # Dummy client which provides no functionality. Please use Twilio::REST::Client instead.
+    class LookupsClient < ObsoleteClient; end
+
+    ##
+    # Dummy client which provides no functionality. Please use Twilio::REST::Client instead.
+    class MonitorClient < ObsoleteClient; end
+
+    ##
+    # Dummy client which provides no functionality. Please use Twilio::REST::Client instead.
+    class PricingClient < ObsoleteClient; end
+
+    ##
+    # Dummy client which provides no functionality. Please use Twilio::REST::Client instead.
+    class TaskRouterClient < ObsoleteClient; end
+
+    ##
+    # Dummy client which provides no functionality. Please use Twilio::REST::Client instead.
+    class TrunkingClient < ObsoleteClient; end
   end
 end

spec/rest/client_spec.rb

@@ -0,0 +1,49 @@
+require 'spec_helper'
+
+describe Twilio::REST::ObsoleteClient do
+  it 'raise an exception' do
+    expect { Twilio::REST::ObsoleteClient.new }.to raise_error(Twilio::REST::ObsoleteError)
+  end
+end
+
+describe Twilio::REST::BaseClient do
+  it 'raise an exception' do
+    expect { Twilio::REST::BaseClient.new }.to raise_error(Twilio::REST::ObsoleteError)
+  end
+end
+
+describe Twilio::REST::IpMessagingClient do
+  it 'raise an exception' do
+    expect { Twilio::REST::IpMessagingClient.new }.to raise_error(Twilio::REST::ObsoleteError)
+  end
+end
+
+describe Twilio::REST::LookupsClient do
+  it 'raise an exception' do
+    expect { Twilio::REST::LookupsClient.new }.to raise_error(Twilio::REST::ObsoleteError)
+  end
+end
+
+describe Twilio::REST::MonitorClient do
+  it 'raise an exception' do
+    expect { Twilio::REST::MonitorClient.new }.to raise_error(Twilio::REST::ObsoleteError)
+  end
+end
+
+describe Twilio::REST::PricingClient do
+  it 'raise an exception' do
+    expect { Twilio::REST::PricingClient.new }.to raise_error(Twilio::REST::ObsoleteError)
+  end
+end
+
+describe Twilio::REST::TaskRouterClient do
+  it 'raise an exception' do
+    expect { Twilio::REST::TaskRouterClient.new }.to raise_error(Twilio::REST::ObsoleteError)
+  end
+end
+
+describe Twilio::REST::TrunkingClient do
+  it 'raise an exception' do
+    expect { Twilio::REST::TrunkingClient.new }.to raise_error(Twilio::REST::ObsoleteError)
+  end
+end