slybroadcast 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a3c77a059de695a7af878b28e80f5060c6d7fff7
-  data.tar.gz: d73febfd602e36ecfd3501453e76aafa12c41c8e
+  metadata.gz: 5f8f6a8747476a80dcbbe3868654a7c08fc34acf
+  data.tar.gz: ad2eb126702586e1edbe0c78913a885a08f61bc2
 SHA512:
-  metadata.gz: af3a8ad55c236b749d858baa6fb5f4f75164c7f62164711904820b09b658cca9b0705b266757c4b9a9204c9d3fa1310f32a4bcc3f2a6f9976875a9257c2a8492
-  data.tar.gz: 41e33725cfacceebe8f69cdc1a841f09a38fd26a8ee2146571b49ed7a733c9d2b024878cbdd33179eb7795a39b1cce0d2f57caa0626d0796fbfb2dcfe5490cfd
+  metadata.gz: 06decec7fae6e1a8bd101b6e2037eef0aa4d974ebb17fb8bbb4ddf1e30f36f7d8c9450817ca1b09d339dee0a2a55d5ea253c11fb39c516fb2781d119fb563b7b
+  data.tar.gz: 535a79a120af68b410b9d2f59df5ab646b6d4f77e598402a2a2707109a46b4d4b5b066a9bcb40423c307e7a0094ddd93dab354b356d44c3d395a1e6509186937

data/README.md

@@ -1,18 +1,28 @@
 slybroadcast
 =========
 
-A minimal Slybroadcast Ruby client implementation
+A minimal Slybroadcast Ruby client implementation. Based on Slybroadcast API Version 2.1
+
+See slybroadcast.com for information about this product.
 
 Usage
 -----------
 
 ``` ruby
 
-require './lib/slybroadcast'
+require 'slybroadcast'
 Slybroadcast::Client.credentials = { c_uid: 'example@email.com',  c_password: 'xxx'  }
 
 ```
 
+or
+
+``` ruby
+
+Slybroadcast::Client.verify({ c_uid: 'user@example.com', c_password: 'secret' })
+
+```
+
 ### Verify Username and Password
 
 To verify your slybroadcast Username and Password.
@@ -32,6 +42,25 @@ false
 
 ### Send a Campaign
 
+Posibles Params
+
+Param name   | Definition    | Example
+------------ | ------------- | -----------
+*c_uid* | Your Email Address | value="admin@mobile-sphere.com"
+*c_password* | Your Password | value="12345678"
+*c_url* | URL for audio file if recorded elsewhere | value="http://www.yoursite.com/wav"
+*c_audio* | Audio file type (WAV or Mp3) | value="WAV"
+*c_record_audio* | Audio file name if recorded through the Slybroadcast Recording Center | name="MeetupRecording1"
+*c_phone* | Destination phone numbers | MAX: 10,000 per submission | value="6173999980,6173999981"
+*session_id* | Session/Campaign ID | value="9123456789"
+*c_callerID* | Caller ID of campaign | value="6173999980"
+*c_date* | Date/Time of delivery (EST) YYYY-MM-DD HH:MM:SS Must use military time format | value="2015-12-31 15:00:00" value="now"
+*mobile_only* | Campaign sent to mobile numbers only | value="1"
+*c_endtime* | End Time for campaign (EST) HH:MM:SS | Must use military time format value="17:59:59"
+*c_sys_audio_name* | Use ONLY if sending the system file name of your audio file | value="r18904b140407197964.wav"
+*c_dispo_url* | URL that will receive call status post backs | value=https://www.yoursite.com/results"
+
+
 Campaign submission with audio file previously uploaded.
 
 ``` ruby
@@ -89,6 +118,35 @@ result.error
 
 ```
 
+To receive a status of each call, MobileSphere uses webhook. The POST HTTP Form method is used. Clients should provide a URL to which each call status data can be posted automatically. This is optional.
+
+Example: *c_dispo_url* = "https://www.yoursite.com/results"
+
+If *c_dispo_url* is provided, each call status is sent back using POST
+and you can use Slybroadcast::Utilities.callback_parser to parse this
+POST
+
+Posible response :
+
+session_id, phone_number, status, failure_reason, delivery_time, carrier
+
+Example
+
+``` ruby
+
+Slybroadcast::Utilities.callback_parser(body) do |session_id, phone_number, status, failure_reason, delivery_time, carrier|
+  {
+    session_id: session_id,
+    phone_number: phone_number,
+    status: status,
+    failure_reason: failure_reason,
+    delivery_time: delivery_time,
+    carrier: carrier
+  }
+end
+
+```
+
 ### Pause Campaign
 
 To temporarily pause a campaign or session, but not cancel it.

data/lib/slybroadcast.rb

@@ -1 +1,2 @@
 require_relative 'slybroadcast/client'
+require_relative 'slybroadcast/utilities'

data/lib/slybroadcast/client.rb

@@ -29,9 +29,7 @@ module Slybroadcast
     ENDPOINTS = {
       verify: 'vmb.php',
       campaign_call_status: 'vmb.php',
-      campaign_pause: 'vmb.php',
-      campaign_resume: 'vmb.php',
-      campaign_cancel: 'vmb.php',
+      campaign: 'vmb.php',
       account_message_balance: 'vmb.php',
       download_audio_file: 'vmb.dla.php',
       list_audio_files: 'vmb.aflist.php'
@@ -47,86 +45,66 @@ module Slybroadcast
 
     def verify(**options)
       params = set_credentials(options.merge(c_option: :user_verify))
-      res = Net::HTTP.post_form(
-        endpoint_url,
-        set_credentials(options.merge(c_option: :user_verify))
-      )
+      res = make_post(endpoint_url, params)
       raise Exceptions::InvalidCredentials, 'Invalid `c_uid` or `c_password`' unless res.body.eql?("OK")
       true
     end
 
     def campaign_call_status(**options)
       params = set_credentials(options)
+      res = make_post(endpoint_url, params)
+      parse_response(:CampaignStatusResponse, res)
+    end
 
-      res = Net::HTTP.post_form(
-        endpoint_url,
-        params
-      )
-      result = Parsers::CampaignStatusResponse.new(res.body)
-      result.success? ? result : handle_error(result.error)
+    def campaign(**options)
+      params = set_credentials(options)
+      res = make_post(endpoint_url, params)
+      parse_response(:CampaignActionsResponse, res)
     end
 
     def campaign_pause(**options)
-      params = set_credentials(options.merge(c_option: 'pause'))
-      res = Net::HTTP.post_form(
-        endpoint_url,
-        params
-      )
-      result = Parsers::CampaignActionsResponse.new(res.body)
-      result.success? ? result : handle_error(result.error)
+      campaign(options.merge(c_option: :pause))
     end
 
     def campaign_resume(**options)
-      params = set_credentials(options.merge(c_option: 'run'))
-      res = Net::HTTP.post_form(
-        endpoint_url,
-        params
-      )
-      result = Parsers::CampaignActionsResponse.new(res.body)
-      result.success? ? result : handle_error(result.error)
+      campaign(options.merge(c_option: :run))
     end
 
     def campaign_cancel(**options)
-      params = set_credentials(options.merge(c_option: 'stop'))
-      res = Net::HTTP.post_form(
-        endpoint_url,
-        params
-      )
-      result = Parsers::CampaignActionsResponse.new(res.body)
-      result.success? ? result : handle_error(result.error)
+      campaign(options.merge(c_option: :stop))
     end
 
     def account_message_balance
       params = set_credentials(remain_message: '1')
-      res = Net::HTTP.post_form(
-        endpoint_url,
-        params
-      )
-      result = Parsers::RemainingMessagesResponse.new(res.body)
-      result.success? ? result : handle_error(result.error)
+      res = make_post(endpoint_url, params)
+      parse_response(:RemainingMessagesResponse, res)
     end
 
     def download_audio_file(**options)
       params = set_credentials(options)
-      res = Net::HTTP.post_form(
-        endpoint_url,
-        params
-      )
-      result = Parsers::RemainingMessagesResponse.new(res.body)
-      result.success? ? result : handle_error(result.error)
+      res = make_post(endpoint_url, params)
+      parse_response(:RemainingMessagesResponse, res)
     end
 
     def list_audio_files
       params = set_credentials(c_method: 'get_audio_list')
-      res = Net::HTTP.post_form(
-        endpoint_url,
+      res = make_post(endpoint_url, params)
+      parse_response(:AudioFileListResponse, res)
+    end
+
+    private
+
+    def make_post(url, params)
+      Net::HTTP.post_form(
+        url,
         params
       )
-      result = Parsers::AudioFileListResponse.new(res.body)
-      result.success? ? result : handle_error(result.error)
     end
 
-    private
+    def parse_response(parser, response)
+      result = Parsers.const_get(parser).new(response.body)
+      result.success? ? result : handle_error(result.error)
+    end
 
     def endpoint_url
       method = caller_locations(1,1).first.label.to_sym

data/lib/slybroadcast/parsers/audio_file_list_response.rb

@@ -4,8 +4,6 @@ module Parsers
     attr_accessor :error
     attr_accessor :list
 
-    FIELDS = [:system_file_name, :audio_file_name, :created].freeze
-
     def initialize(body)
       @list = []
       response_parse(body)
@@ -27,12 +25,12 @@ module Parsers
       @error = response[1].strip unless success
 
       @list = response.map do |line|
-        myh = Hash.new
-        fields = line.delete('\\"').split("|")
-        fields.map.with_index do |v, i|
-          myh[FIELDS[i]||:no_defined] = v
-        end
-        myh
+        system_file_name, audio_file_name, created = line.delete('\\"').split("|",3)
+        {
+          system_file_name: system_file_name,
+          audio_file_name: audio_file_name,
+          created: created
+        }
       end
     end
 

data/lib/slybroadcast/utilities.rb

@@ -0,0 +1,31 @@
+module Slybroadcast
+  module Utilities
+    extend self
+
+    #
+    # Usage
+    #
+    #   Slybroadcast::Utilities.callback_parser(body) do |session_id, phone_number, status, failure_reason, delivery_time, carrier|
+    #       {
+    #         session_id: session_id,
+    #         phone_number: phone_number,
+    #         status: status,
+    #         failure_reason: failure_reason,
+    #         delivery_time: delivery_time,
+    #         carrier: carrier
+    #       }
+    #   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
+    end
+
+  end
+end

data/lib/slybroadcast/version.rb

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

metadata

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