send_sonar 1.1.0 → 2.0.0

data/lib/send_sonar/exceptions.rb

@@ -24,7 +24,7 @@ module SendSonar
     end
 
     def inspect
-      @original_exception.inspect
+      "#{self.class.name}: #{@original_exception.to_s}: #{@original_exception.http_body}"
     end
 
     def to_s
@@ -39,9 +39,11 @@ module SendSonar
   class UnknownRequestError < RequestException; end
   class RequestTimeout < RequestException; end
   class ConnectionRefused < RequestException; end
+  class TokenOrPublishableKeyNotFound < RequestException; end
 
   class Customer < OpenStruct; end
   class Message < OpenStruct; end
+  class Response < OpenStruct; end
 
   module Exceptions
     EXCEPTIONS_MAP = {
@@ -49,7 +51,8 @@ module SendSonar
       "No Active Subscription" => NoActiveSubscription,
       "Api Disabled For Company" => ApiDisabledForCompany,
       "Request Timed Out" => RequestTimeout,
-      "Invalid Phone Number" => InvalidPhoneNumber
+      "Invalid Phone Number" => InvalidPhoneNumber,
+      "Token or publishable_key not found" => TokenOrPublishableKeyNotFound
     }
   end
 end

data/lib/send_sonar/version.rb

@@ -1,3 +1,3 @@
 module SendSonar
-  VERSION = "1.1.0"
+  VERSION = "2.0.0"
 end

data/send_sonar.gemspec

@@ -18,12 +18,12 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.3"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "vcr", "~> 2.6"
-  spec.add_development_dependency "webmock", "~> 1.1"
-  spec.add_development_dependency "json"
+  spec.add_development_dependency "bundler", "~> 1.15", ">= 1.15.4"
+  spec.add_development_dependency "rake", "~> 12.1"
+  spec.add_development_dependency "rspec", "~> 3.6"
+  spec.add_development_dependency "vcr", "~> 3.0", ">= 3.0.3"
+  spec.add_development_dependency "webmock", "~> 3.0", ">= 3.0.1"
+  spec.add_development_dependency "json", "~> 2.1"
 
-  spec.add_runtime_dependency "rest-client", '~> 1.6'
+  spec.add_runtime_dependency "rest-client", "~> 2.0", ">= 2.0.2"
 end

data/spec/integrations/simple_desk_spec.rb

@@ -31,13 +31,13 @@ describe 'SendSonar' do
     end
   end
 
-  shared_examples "a mature, error handling gem" do |context|
+  shared_examples 'a mature, error handling gem' do |context|
     context 'with an invalid token' do
       let(:token) { 'FAKE_TOKEN' }
 
-      it 'raises a BadToken error' do
+      it 'raises a BadToken exception' do
         VCR.use_cassette("#{cassette_group}_bad_token") do
-          expect { response }.to raise_error(SendSonar::BadToken, 'SendSonar::BadToken')
+          expect { response }.to raise_exception(SendSonar::BadToken, 'SendSonar::BadToken')
         end
       end
     end
@@ -45,9 +45,9 @@ describe 'SendSonar' do
     context 'with an inactive subscription' do
       let(:token) { 'tKux9Vwkt0UuTVJqGUO80MGJHCAeebpe' }
 
-      it 'raises a BadToken error' do
+      it 'raises a NoActiveSubscription exception' do
         VCR.use_cassette("#{cassette_group}_no_subscription") do
-          expect { response }.to raise_error(SendSonar::NoActiveSubscription, 'SendSonar::NoActiveSubscription')
+          expect { response }.to raise_exception(SendSonar::NoActiveSubscription, 'SendSonar::NoActiveSubscription')
         end
       end
     end
@@ -55,9 +55,9 @@ describe 'SendSonar' do
     context 'with disabled API' do
       let(:token) { 'ts9mOO_O5Dc7TOBaEAQym-00RGEl3Uel' }
 
-      it 'raises a BadToken error' do
+      it 'raises an ApiDisabledForCompany error' do
         VCR.use_cassette("#{cassette_group}_api_disabled") do
-          expect { response }.to raise_error(SendSonar::ApiDisabledForCompany, 'SendSonar::ApiDisabledForCompany')
+          expect { response }.to raise_exception(SendSonar::ApiDisabledForCompany, 'SendSonar::ApiDisabledForCompany')
         end
       end
     end
@@ -72,28 +72,28 @@ describe 'SendSonar' do
       end
     end
 
-    let(:cassette_group) { "add_customer" }
+    let(:cassette_group) { 'add_customer' }
     let(:response) { SendSonar.add_customer(params) }
     let(:token) { '3Z9L8xFjeNmXL7Yn-pFJUBoxkVWBbl5o' }
     let(:params) do
-      { :phone_number => "5555555557",
-        :email => "user@example.com",
-        :first_name => "john",
-        :last_name => "doe",
-        :properties => { :great_customer => "true" } }
+      { :phone_number => '5555555557',
+        :email => 'user@example.com',
+        :first_name => 'john',
+        :last_name => 'doe',
+        :properties => { :great_customer => 'true' } }
     end
 
-    it_behaves_like "a mature, error handling gem"
+    it_behaves_like 'a mature, error handling gem'
 
     context 'with invalid params' do
       let(:params) do
-        { :phone_numbah => "5555555558" }
+        { :phone_numbah => '5555555558' }
       end
 
-      it 'raises a BadRequest error with hint' do
-        VCR.use_cassette("add_customer_bad_params") do
-          expect { response }.to raise_error(SendSonar::BadRequest,
-            '400 Bad Request: {"error":"phone_number is missing"}')
+      it 'raises a BadRequest exception with hint' do
+        VCR.use_cassette('add_customer_bad_params') do
+          expect { response }.to raise_exception(SendSonar::BadRequest,
+            'SendSonar::BadRequest: 400 Bad Request: {"error":"phone_number is missing"}')
         end
       end
     end
@@ -101,10 +101,10 @@ describe 'SendSonar' do
     context 'with an invalid phone number' do
       let(:token) { 'tKux9Vwkt0UuTVJqGUO80MGJHCAeebpe' }
 
-      it 'raises a Invalid Phone Number error' do
+      it 'raises a BadRequest exception with Invalid Phone Number error message' do
         VCR.use_cassette("#{cassette_group}_invalid_phone_number") do
-          expect { response }.to raise_error(SendSonar::BadRequest,
-            '400 Bad Request: {"error":"Invalid Phone Number"}')
+          expect { response }.to raise_exception(SendSonar::BadRequest,
+            'SendSonar::BadRequest: 400 Bad Request: {"error":"Invalid Phone Number"}')
         end
       end
     end
@@ -119,16 +119,60 @@ describe 'SendSonar' do
       it 'includes the expected attributes' do
         VCR.use_cassette('add_customer') do
           customer = response
-          expect(customer.phone_number).to eq("5555555557")
-          expect(customer.email).to eq("user@example.com")
-          expect(customer.first_name).to eq("john")
-          expect(customer.last_name).to eq("doe")
-          expect(customer.properties).to eq({ "great_customer" => "true" })
+          expect(customer.phone_number).to eq('5555555557')
+          expect(customer.email).to eq('user@example.com')
+          expect(customer.first_name).to eq('john')
+          expect(customer.last_name).to eq('doe')
+          expect(customer.properties).to eq({ 'great_customer' => 'true' })
         end
       end
     end
   end
 
+  describe '.add_update_customer' do
+    before do
+      SendSonar.configure do |config|
+        config.token = token
+        config.env = :sandbox
+      end
+    end
+
+    let(:response) { SendSonar.add_update_customer(params) }
+    let(:token) { '99siwE4WRn6bg_B_ktm6h2w6Kez0JYLL' }
+    let(:phone_number) { '+13105555555' }
+    let(:email) { 'five@example.com' }
+    let(:first_name) { 'Five' }
+    let(:last_name) { 'Example' }
+    let(:properties) { { 'great_customer' => 'true' } }
+    let(:params) do
+      { :phone_number => phone_number,
+        :email => email,
+        :first_name => first_name,
+        :last_name => last_name,
+        :properties => properties }
+    end
+
+    context 'with proper param, active subscription' do
+      it 'returns a customer' do
+        VCR.use_cassette('add_update_customer') do
+          expect(response).to be_a(SendSonar::Customer)
+        end
+      end
+
+      it 'includes the expected attributes' do
+        VCR.use_cassette('add_update_customer') do
+          customer = response
+          expect(customer.phone_number).to eq(phone_number)
+          expect(customer.email).to eq(email)
+          expect(customer.first_name).to eq(first_name)
+          expect(customer.last_name).to eq(last_name)
+          expect(customer.properties).to eq(properties)
+        end
+      end
+    end
+
+  end
+
   describe '.message_customer' do
     before do
       SendSonar.configure do |config|
@@ -137,24 +181,24 @@ describe 'SendSonar' do
       end
     end
 
-    let(:cassette_group) { "message_customer" }
+    let(:cassette_group) { 'message_customer' }
     let(:response) { SendSonar.message_customer(params) }
     let(:token) { '3Z9L8xFjeNmXL7Yn-pFJUBoxkVWBbl5o' }
     let(:params) do
-      { :to => "5555555557", :text => "this is the message text" }
+      { :to => '5555555557', :text => 'this is the message text' }
     end
 
-    it_behaves_like "a mature, error handling gem"
+    it_behaves_like 'a mature, error handling gem'
 
     context 'with invalid params' do
       let(:params) do
-        { :toz => "5555555558" }
+        { :toz => '5555555558' }
       end
 
-      it 'raises a BadRequest error with hint' do
-        VCR.use_cassette("message_customer_bad_params") do
-          expect { response }.to raise_error(SendSonar::BadRequest,
-            '400 Bad Request: {"error":"text is missing, to is missing"}')
+      it 'raises a BadRequest exception with hint' do
+        VCR.use_cassette('message_customer_bad_params') do
+          expect { response }.to raise_exception(SendSonar::BadRequest,
+            'SendSonar::BadRequest: 400 Bad Request: {"error":"text is missing, to is missing"}')
         end
       end
     end
@@ -162,10 +206,10 @@ describe 'SendSonar' do
     context 'with an invalid phone number' do
       let(:token) { 'tKux9Vwkt0UuTVJqGUO80MGJHCAeebpe' }
 
-      it 'raises a Invalid Phone Number error' do
+      it 'raises a BadRequest exception with Invalid Phone Number error message' do
         VCR.use_cassette("#{cassette_group}_invalid_phone_number") do
-          expect { response }.to raise_error(SendSonar::BadRequest,
-            '400 Bad Request: {"error":"Invalid Phone Number"}')
+          expect { response }.to raise_exception(SendSonar::BadRequest,
+            'SendSonar::BadRequest: 400 Bad Request: {"error":"Invalid Phone Number"}')
         end
       end
     end
@@ -180,11 +224,234 @@ describe 'SendSonar' do
       it 'includes the expected attributes' do
         VCR.use_cassette('message_customer') do
           message = response
-          expect(message.to).to eq("5555555557")
-          expect(message.text).to eq("this is the message text")
-          expect(message.status).to eq("queued")
+          expect(message.to).to eq('5555555557')
+          expect(message.text).to eq('this is the message text')
+          expect(message.status).to eq('queued')
+        end
+      end
+    end
+  end
+
+  shared_examples 'an error receiving gem' do |context|
+    context 'with an invalid token' do
+      let(:token) { 'FAKE_TOKEN' }
+
+      it 'raises a BadToken exception' do
+        VCR.use_cassette("#{cassette_group}_bad_token") do
+          expect { response }.to raise_exception(SendSonar::TokenOrPublishableKeyNotFound, 'SendSonar::TokenOrPublishableKeyNotFound')
+        end
+      end
+    end
+  end
+
+  describe '.send_campaign' do
+    before do
+      SendSonar.configure do |config|
+        config.token = token
+        config.env = :sandbox
+      end
+    end
+
+    let(:cassette_group) { 'send_campaign' }
+    let(:response) { SendSonar.send_campaign(params) }
+    let(:token) { '99siwE4WRn6bg_B_ktm6h2w6Kez0JYLL' }
+    let(:recepient_number) { '+13105551111' }
+    let(:params) do
+      { :to => recepient_number, :campaign_id => 'test_d0Bu23' }
+    end
+
+    context 'with proper params, active subscription' do
+      it 'returns a campaign sent receipt' do
+        VCR.use_cassette('send_campaign') do
+          expect(response).to be_a(SendSonar::Response)
+        end
+      end
+
+      it 'includes the expected attributes' do
+        VCR.use_cassette('send_campaign') do
+          campaign_sent = response
+          expect(campaign_sent.to).to eq(recepient_number)
+          expect(campaign_sent.text).to eq('sent')
+          expect(campaign_sent.status).to eq('queued')
+        end
+      end
+    end
+
+    it_behaves_like 'an error receiving gem'
+  end
+
+  describe '.close_customer' do
+    before do
+      SendSonar.configure do |config|
+        config.token = token
+        config.env = :sandbox
+      end
+    end
+
+    let(:cassette_group) { 'close_customer' }
+    let(:response) { SendSonar.close_customer(params) }
+    let(:token) { '99siwE4WRn6bg_B_ktm6h2w6Kez0JYLL' }
+    let(:params) do
+      { :phone_number => '+13105551111' }
+    end
+
+    context 'with proper param, active subscription' do
+      it 'returns a customer closed status' do
+        VCR.use_cassette('close_customer') do
+          expect(response).to be_a(SendSonar::Response)
+        end
+      end
+
+      it 'includes the expected attributes' do
+        VCR.use_cassette('close_customer') do
+          customer_closed = response
+          expect(customer_closed.success).to eq(true)
+        end
+      end
+    end
+
+    it_behaves_like 'an error receiving gem'
+  end
+
+  describe '.delete_customer_property' do
+    before do
+      SendSonar.configure do |config|
+        config.token = token
+        config.env = :sandbox
+      end
+    end
+
+    let(:cassette_group) { 'delete_customer_property' }
+    let(:response) { SendSonar.delete_customer_property(params) }
+    let(:token) { '99siwE4WRn6bg_B_ktm6h2w6Kez0JYLL' }
+    let(:phone_number) { '+13105551111' }
+    let(:email) { 'one@example.com' }
+
+    context 'using phone_number param' do
+      let(:property_name) { 'foo' }
+      let(:params) do
+        { :phone_number => phone_number, :property_name => property_name }
+      end
+      it 'returns a customer property deleted' do
+        VCR.use_cassette('delete_customer_property_with_phone_number') do
+          expect(response).to be_a(SendSonar::Response)
+        end
+      end
+
+      it 'includes the expected attributes' do
+        VCR.use_cassette('delete_customer_property_with_phone_number') do
+          customer_property_deleted = response
+          expect(customer_property_deleted.phone_number).to eq(phone_number)
+          expect(customer_property_deleted.email).to eq(email)
+          expect(customer_property_deleted.property_name).to eq(property_name)
+          expect(customer_property_deleted.phone_number).to eq(phone_number)
+          expect(customer_property_deleted.deleted).to eq(true)
+        end
+      end
+
+      it_behaves_like 'an error receiving gem'
+    end
+
+    context 'using email param' do
+      let(:property_name) { 'bar' }
+      let(:params) do
+        { :email => email, :property_name => property_name }
+      end
+      it 'returns a customer property deleted' do
+        VCR.use_cassette('delete_customer_property_with_email') do
+          expect(response).to be_a(SendSonar::Response)
+        end
+      end
+
+      it 'includes the expected attributes' do
+        VCR.use_cassette('delete_customer_property_with_email') do
+          customer_property_deleted = response
+          expect(customer_property_deleted.phone_number).to eq(phone_number)
+          expect(customer_property_deleted.email).to eq(email)
+          expect(customer_property_deleted.property_name).to eq(property_name)
+          expect(customer_property_deleted.phone_number).to eq(phone_number)
+          expect(customer_property_deleted.deleted).to eq(true)
+        end
+      end
+    end
+  end
+
+  describe '.get_customer' do
+    before do
+      SendSonar.configure do |config|
+        config.token = token
+        config.env = :sandbox
+      end
+    end
+
+    let(:cassette_group) { 'get_customer' }
+    let(:response) { SendSonar.get_customer(params) }
+    let(:token) { '99siwE4WRn6bg_B_ktm6h2w6Kez0JYLL' }
+    let(:phone_number) { '+13105551111' }
+    let(:params) do
+      { :phone_number => phone_number }
+    end
+
+    context 'with proper param, active subscription' do
+      it 'returns a customer' do
+        VCR.use_cassette('get_customer') do
+          expect(response).to be_a(SendSonar::Customer)
+        end
+      end
+
+      it 'includes the expected attributes' do
+        VCR.use_cassette('get_customer') do
+          customer = response
+          expect(customer.phone_number).to eq(phone_number)
+          expect(customer).to respond_to(:first_name)
+          expect(customer).to respond_to(:last_name)
+          expect(customer).to respond_to(:email)
+          expect(customer).to respond_to(:assigned_phone_number)
+          expect(customer).to respond_to(:subscribed)
+          expect(customer).to respond_to(:unsubscribed_at)
+          expect(customer).to respond_to(:properties)
         end
       end
     end
+
+    it_behaves_like 'an error receiving gem'
   end
+
+  describe '.available_phone_number' do
+    before do
+      SendSonar.configure do |config|
+        config.publishable_key = publishable_key
+        config.env = :sandbox
+      end
+    end
+
+    let(:response) { SendSonar.available_phone_number }
+    let(:publishable_key) { 'f77a884d-4c52-4369-90c2-22a3d5607c24' }
+
+    context 'with proper param, active subscription' do
+      it 'returns an available number' do
+        VCR.use_cassette('available_phone_number') do
+          expect(response).to be_a(SendSonar::Response)
+        end
+      end
+
+      it 'includes the expected attributes' do
+        VCR.use_cassette('available_phone_number') do
+          available_number = response
+          expect(available_number).to respond_to(:available_number)
+        end
+      end
+    end
+
+    context 'with an invalid publishable key' do
+      let(:publishable_key) { 'BAD_PUBLISHABLE_KEY' }
+
+      it 'raises a TokenOrPublishableKeyNotFound exception' do
+        VCR.use_cassette('available_phone_number_bad_publishable_key') do
+          expect { response }.to raise_exception(SendSonar::TokenOrPublishableKeyNotFound, 'SendSonar::TokenOrPublishableKeyNotFound')
+        end
+      end
+    end
+  end
+
 end