slybroadcast 1.0.3 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5f8f6a8747476a80dcbbe3868654a7c08fc34acf
-  data.tar.gz: ad2eb126702586e1edbe0c78913a885a08f61bc2
+  metadata.gz: caaeef359ba8cfb00eea77d0203e113171ffe33c
+  data.tar.gz: 819d1f1eef95186e44dd82bddcdded3974df6693
 SHA512:
-  metadata.gz: 06decec7fae6e1a8bd101b6e2037eef0aa4d974ebb17fb8bbb4ddf1e30f36f7d8c9450817ca1b09d339dee0a2a55d5ea253c11fb39c516fb2781d119fb563b7b
-  data.tar.gz: 535a79a120af68b410b9d2f59df5ab646b6d4f77e598402a2a2707109a46b4d4b5b066a9bcb40423c307e7a0094ddd93dab354b356d44c3d395a1e6509186937
+  metadata.gz: 1b90390d2ea2c34a55613af468ec44bb5acc637ab06a35772d35f7cf0fd2f35edea8061f0a1df3141f3bbbc21055871b401935b9647e35c5c0cc202e4b8e9466
+  data.tar.gz: d66a1d8b8af92f002472a4334e353f7ce404d0708a91981fdecf240afc20cb59c18fcd5d727b00bda74a957e0805bb5a327ac85403265b4391f814f278533407

data/README.md

@@ -65,7 +65,7 @@ Campaign submission with audio file previously uploaded.
 
 ``` ruby
 
-result = Slybroadcast::Client.campaign_call_status(
+result = Slybroadcast::Client.campaign_call(
   c_phone: "+16173999981, +16173999982, +16173999983",
   c_record_audio: "Meetup1",
   c_callerID: "+16173999980",
@@ -93,7 +93,7 @@ Campaign submission using a client's audio file.
 
 ``` ruby
 
-result = Slybroadcast::Client.campaign_call_status(
+result = Slybroadcast::Client.campaign_call(
   c_phone: "+16173999981, +16173999982, +16173999983",
   c_url: "https://user_audio_url",
   c_callerID: "+16173999980",
@@ -134,7 +134,9 @@ Example
 
 ``` ruby
 
-Slybroadcast::Utilities.callback_parser(body) do |session_id, phone_number, status, failure_reason, delivery_time, carrier|
+example_body = "9996130985|9996449444|OK||2017-05-11 17:38:18|verizon wireless:6006 - svr/2"
+
+Slybroadcast::Utilities.callback_parser(example_body) do |session_id, phone_number, status, failure_reason, delivery_time, carrier|
   {
     session_id: session_id,
     phone_number: phone_number,
@@ -145,6 +147,33 @@ Slybroadcast::Utilities.callback_parser(body) do |session_id, phone_number, stat
   }
 end
 
+```
+
+### Request Status Campaign
+
+To request the call status of one phone number, the following parameters must be included. Be sure the session_id is the one received in response to your initial campaign submission.
+
+``` ruby
+
+result = Slybroadcast::Client.campaign_status(
+  session_id: "123456",
+  c_phone: "9996449444"
+)
+
+result.success?
+true
+
+result.call
+{
+  :session_id=>"123456",
+  :phone_number=>"9996449444",
+  :status=>"OK",
+  :failure_reason=>"",
+  :delivery_time=>"2017-05-11 17:38:18",
+  :carrier=>"verizon wireless:6006 - svr/2"
+}
+
+
 ```
 
 ### Pause Campaign

data/lib/slybroadcast/client.rb

@@ -2,6 +2,7 @@ require 'singleton'
 require 'uri'
 require 'net/http'
 require_relative 'exceptions'
+require_relative 'parsers/campaign_call_response'
 require_relative 'parsers/campaign_status_response'
 require_relative 'parsers/campaign_actions_response'
 require_relative 'parsers/remaining_messages_response'
@@ -28,7 +29,8 @@ module Slybroadcast
     API_URI = 'https://www.mobile-sphere.com/gateway'.freeze
     ENDPOINTS = {
       verify: 'vmb.php',
-      campaign_call_status: 'vmb.php',
+      campaign_call: 'vmb.php',
+      campaign_status: 'vmb.php',
       campaign: 'vmb.php',
       account_message_balance: 'vmb.php',
       download_audio_file: 'vmb.dla.php',
@@ -50,9 +52,15 @@ module Slybroadcast
       true
     end
 
-    def campaign_call_status(**options)
+    def campaign_call(**options)
       params = set_credentials(options)
       res = make_post(endpoint_url, params)
+      parse_response(:CampaignCallResponse, res)
+    end
+
+    def campaign_status(**options)
+      params = set_credentials(options.merge(c_option: :callstatus))
+      res = make_post(endpoint_url, params)
       parse_response(:CampaignStatusResponse, res)
     end
 

data/lib/slybroadcast/parsers/campaign_call_response.rb

@@ -0,0 +1,35 @@
+module Parsers
+  class CampaignCallResponse
+    attr_accessor :success
+    attr_accessor :error
+    attr_accessor :session_id
+    attr_accessor :number_of_phone
+
+    def initialize(body)
+      response_parse(body)
+    end
+
+    def failed?
+      not success?
+    end
+
+    def success?
+      success
+    end
+
+    private
+
+    def response_parse(body)
+      response = body.split("\n")
+      @success = response[0].strip == 'OK'
+
+      unless success
+        @error = response[1]
+      else
+        @session_id = response[1].split("=")[1]
+        @number_of_phone = response[2].split("=")[1]
+      end
+    end
+
+  end
+end

data/lib/slybroadcast/parsers/campaign_status_response.rb

@@ -2,8 +2,7 @@ module Parsers
   class CampaignStatusResponse
     attr_accessor :success
     attr_accessor :error
-    attr_accessor :session_id
-    attr_accessor :number_of_phone
+    attr_accessor :call
 
     def initialize(body)
       response_parse(body)
@@ -20,14 +19,21 @@ module Parsers
     private
 
     def response_parse(body)
-      response = body.split("\n")
-      @success = response[0].strip == 'OK'
+      @success = !body.include?('ERROR')
 
       unless success
-        @error = response[1]
+        response = body.split("\n")
+        @error = response[1].strip
       else
-        @session_id = response[1].split("=")[1]
-        @number_of_phone = response[2].split("=")[1]
+        session_id, phone_number, status, failure_reason, delivery_time, carrier = body.gsub('var=','').split('|', 6)
+        @call = {
+          session_id: session_id,
+          phone_number: phone_number,
+          status: status,
+          failure_reason: failure_reason,
+          delivery_time: delivery_time,
+          carrier: carrier
+        }
       end
     end
 

data/lib/slybroadcast/utilities.rb

@@ -4,8 +4,9 @@ module Slybroadcast
 
     #
     # Usage
+    #   example_body = "9996130985|9996449444|OK||2017-05-11 17:38:18|verizon wireless:6006 - svr/2"
     #
-    #   Slybroadcast::Utilities.callback_parser(body) do |session_id, phone_number, status, failure_reason, delivery_time, carrier|
+    #   Slybroadcast::Utilities.callback_parser(example_body) do |session_id, phone_number, status, failure_reason, delivery_time, carrier|
     #       {
     #         session_id: session_id,
     #         phone_number: phone_number,
@@ -17,14 +18,8 @@ module Slybroadcast
     #   end
     #
     def callback_parser(body)
-      response = body.split("\n")
-      response.map do |line|
-        line.delete!('\\"')
-        cols = line.split("|",6)
-        cols.compact!
-        cols.insert(3,nil) if cols.size == 5
-        yield *cols
-      end
+      session_id, phone_number, status, failure_reason, delivery_time, carrier = body.split('|', 6)
+      yield session_id, phone_number, status, failure_reason, delivery_time, carrier
     end
 
   end

data/lib/slybroadcast/version.rb

@@ -1,3 +1,3 @@
 module Slybroadcast
-  VERSION = '1.0.3'.freeze
+  VERSION = '1.0.4'.freeze
 end

data/test/client.rb

@@ -29,7 +29,7 @@ describe Slybroadcast::Client do
 
   end
 
-  describe 'campaign_call_status' do
+  describe 'campaign_call' do
 
     it 'should return session ID' do
 
@@ -37,7 +37,7 @@ describe Slybroadcast::Client do
       mocked_reponse.expect(:body, "OK\nsession ID=123456\nNumber of Phone=2")
 
       Net::HTTP.stub :post_form, mocked_reponse do
-        result = Slybroadcast::Client.campaign_call_status({})
+        result = Slybroadcast::Client.campaign_call({})
         assert_equal result.session_id, "123456"
         assert_equal result.number_of_phone, "2"
       end
@@ -51,7 +51,37 @@ describe Slybroadcast::Client do
 
       Net::HTTP.stub :post_form, mocked_reponse do
         assert_raises Slybroadcast::Exceptions::InvalidCredentials do
-          Slybroadcast::Client.campaign_call_status({})
+          Slybroadcast::Client.campaign_call({})
+        end
+      end
+
+    end
+
+  end
+
+  describe 'campaign_status' do
+
+    it 'should return session ID' do
+
+      mocked_reponse = MiniTest::Mock.new
+      mocked_reponse.expect(:body, "var=9996130985|9996449444|OK||2017-05-11 17:38:18|verizon wireless:6006 - svr/2")
+
+      Net::HTTP.stub :post_form, mocked_reponse do
+        result = Slybroadcast::Client.campaign_status({})
+        assert_equal result.call[:status], "OK"
+        assert_equal result.call[:session_id], "9996130985"
+      end
+
+    end
+
+    it 'should raise Exceptions::InvalidCredentials' do
+
+      mocked_reponse = MiniTest::Mock.new
+      mocked_reponse.expect(:body, "ERROR\nc_uid: required")
+
+      Net::HTTP.stub :post_form, mocked_reponse do
+        assert_raises Slybroadcast::Exceptions::InvalidCredentials do
+          Slybroadcast::Client.campaign_status({})
         end
       end
 

data/test/parsers.rb

@@ -24,12 +24,12 @@ describe Parsers do
 
   end
 
-  describe 'CampaignStatusResponse' do
+  describe 'CampaignCallResponse' do
 
     it 'should return session ID' do
 
       response = "OK\nSession ID=123456\nNumber of Phone=123"
-      result = Parsers::CampaignStatusResponse.new(response)
+      result = Parsers::CampaignCallResponse.new(response)
       assert result.success?
       assert_equal result.session_id, "123456"
       assert_equal result.number_of_phone, "123"
@@ -39,7 +39,7 @@ describe Parsers do
     it 'should return error description' do
 
       response = "ERROR\nc_uid: required"
-      result = Parsers::CampaignStatusResponse.new(response)
+      result = Parsers::CampaignCallResponse.new(response)
       assert result.failed?
       assert_equal result.error, "c_uid: required"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: slybroadcast
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.0.4
 platform: ruby
 authors:
 - Martin Aceto
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-11 00:00:00.000000000 Z
+date: 2017-05-12 00:00:00.000000000 Z
 dependencies: []
 description: A minimal Slybroadcast Ruby client implementation
 email:
@@ -26,6 +26,7 @@ files:
 - lib/slybroadcast/exceptions.rb
 - lib/slybroadcast/parsers/audio_file_list_response.rb
 - lib/slybroadcast/parsers/campaign_actions_response.rb
+- lib/slybroadcast/parsers/campaign_call_response.rb
 - lib/slybroadcast/parsers/campaign_status_response.rb
 - lib/slybroadcast/parsers/download_audio_file_response.rb
 - lib/slybroadcast/parsers/remaining_messages_response.rb