slybroadcast 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c5d5237a871e54e136af720e5a604309b8d3c45c
-  data.tar.gz: 4704755f03fc6022a4550ad3bbb62c373b9913a6
+  metadata.gz: a3c77a059de695a7af878b28e80f5060c6d7fff7
+  data.tar.gz: d73febfd602e36ecfd3501453e76aafa12c41c8e
 SHA512:
-  metadata.gz: cec36c0eb8674270090483e5a19e8ad38dd27e0b19632ea8ff360257db8e808996e278f965013e98c0390de93e31291d1883758ff3736c977cd03d591e9c4881
-  data.tar.gz: a71cc3cf1b98692ca98f5fa2b120a5b77dc4aece6e5d23bb1af87a64f02ef52261b030c0b659588f2d5fe82c36734712cc0c4bc04b915e6d341b68443f6f4639
+  metadata.gz: af3a8ad55c236b749d858baa6fb5f4f75164c7f62164711904820b09b658cca9b0705b266757c4b9a9204c9d3fa1310f32a4bcc3f2a6f9976875a9257c2a8492
+  data.tar.gz: 41e33725cfacceebe8f69cdc1a841f09a38fd26a8ee2146571b49ed7a733c9d2b024878cbdd33179eb7795a39b1cce0d2f57caa0626d0796fbfb2dcfe5490cfd

data/README.md

@@ -1,2 +1,210 @@
-# slybroadcast
+slybroadcast
+=========
+
 A minimal Slybroadcast Ruby client implementation
+
+Usage
+-----------
+
+``` ruby
+
+require './lib/slybroadcast'
+Slybroadcast::Client.credentials = { c_uid: 'example@email.com',  c_password: 'xxx'  }
+
+```
+
+### Verify Username and Password
+
+To verify your slybroadcast Username and Password.
+
+``` ruby
+
+Slybroadcast::Client.credentials = { c_uid: 'example@email.com',  c_password: 'xxx'  }
+result = Slybroadcast::Client.verify
+
+result.success?
+true
+
+result.failed?
+false
+
+```
+
+### Send a Campaign
+
+Campaign submission with audio file previously uploaded.
+
+``` ruby
+
+result = Slybroadcast::Client.campaign_call_status(
+  c_phone: "+16173999981, +16173999982, +16173999983",
+  c_record_audio: "Meetup1",
+  c_callerID: "+16173999980",
+  c_date: "now",
+  mobile_only: "1"
+)
+
+result.success?
+true
+
+result.session_id
+1234567788
+
+
+
+result.failed?
+false
+
+result.error
+"Bad Audio, can't download"
+
+```
+
+Campaign submission using a client's audio file.
+
+``` ruby
+
+result = Slybroadcast::Client.campaign_call_status(
+  c_phone: "+16173999981, +16173999982, +16173999983",
+  c_url: "https://user_audio_url",
+  c_callerID: "+16173999980",
+  c_date: "now",
+  mobile_only: "1",
+  c_audio: "mp3"
+)
+
+result.success?
+true
+
+result.session_id
+1234567788
+
+
+
+result.failed?
+false
+
+result.error
+"Bad Audio, can't download"
+
+```
+
+### Pause Campaign
+
+To temporarily pause a campaign or session, but not cancel it.
+
+``` ruby
+
+result = Slybroadcast::Client.campaign_pause(session_id: "6045428032")
+
+result.success?
+true
+
+result.session_id
+1234567788
+
+
+
+result.failed?
+false
+
+result.error
+"already finished"
+
+```
+
+### Resume Campaign
+
+To resume a campaign.
+
+``` ruby
+
+result = Slybroadcast::Client.campaign_resume(session_id: "6045428032")
+
+result.success?
+true
+
+result.session_id
+1234567788
+
+
+
+result.failed?
+false
+
+result.error
+"already finished"
+
+```
+
+### Cancel Campaign
+
+To cancel a campaign.
+
+``` ruby
+
+result = Slybroadcast::Client.campaign_cancel(session_id: "6045428032")
+
+result.success?
+true
+
+result.session_id
+1234567788
+
+
+
+result.failed?
+false
+
+result.error
+"already finished"
+
+```
+
+### Request Account Message Balance
+
+To request the number of remaining messages in your account.
+
+``` ruby
+
+result = Slybroadcast::Client.account_message_balance
+
+result.success?
+true
+
+result.remaining_messages
+"12345"
+
+result.pending_messages
+"123"
+
+
+
+result.failed?
+false
+
+```
+
+### Retrieve a List of all Audio Files
+
+To view a full list of your audio files.
+
+``` ruby
+
+result = Slybroadcast::Client.list_audio_files
+
+result.success?
+true
+
+result.list
+[
+  {:system_file_name=>"170425242023265.wav", :audio_file_name=>"123456", :created=>"2017-04-25 22:42:25"},
+  {:system_file_name=>"294b755.wav", :audio_file_name=>"recording20160425-31049-1mq2hk7", :created=>"2017-05-03 20:39:11"},
+  {:system_file_name=>"15213094.wav", :audio_file_name=>"Test01", :created=>"2017-05-03 20:38:16"}
+]
+
+
+result.failed?
+false
+
+```

data/lib/slybroadcast/client.rb

@@ -5,6 +5,8 @@ require_relative 'exceptions'
 require_relative 'parsers/campaign_status_response'
 require_relative 'parsers/campaign_actions_response'
 require_relative 'parsers/remaining_messages_response'
+require_relative 'parsers/download_audio_file_response'
+require_relative 'parsers/audio_file_list_response'
 
 # usage:
 #   Slybroadcast::Client.credentials = {
@@ -120,7 +122,8 @@ module Slybroadcast
         endpoint_url,
         params
       )
-      res.body
+      result = Parsers::AudioFileListResponse.new(res.body)
+      result.success? ? result : handle_error(result.error)
     end
 
     private

data/lib/slybroadcast/parsers/audio_file_list_response.rb

@@ -0,0 +1,40 @@
+module Parsers
+  class AudioFileListResponse
+    attr_accessor :success
+    attr_accessor :error
+    attr_accessor :list
+
+    FIELDS = [:system_file_name, :audio_file_name, :created].freeze
+
+    def initialize(body)
+      @list = []
+      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 != 'ERROR'
+      @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
+      end
+    end
+
+  end
+end

data/lib/slybroadcast/version.rb

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

data/test/client.rb

@@ -178,9 +178,50 @@ describe Slybroadcast::Client do
   end
 
   describe 'download_audio_file' do
+
+    it 'should raise StandardError' do
+
+      mocked_reponse = MiniTest::Mock.new
+      mocked_reponse.expect(:body, "ERROR")
+
+      Net::HTTP.stub :post_form, mocked_reponse do
+        assert_raises StandardError do
+          Slybroadcast::Client.download_audio_file
+        end
+      end
+
+    end
+
   end
 
   describe 'list_audio_files' do
+
+    it 'should return a list' do
+
+      mocked_reponse = MiniTest::Mock.new
+      mocked_reponse.expect(:body, "\"r15294b17042522420232165.wav\"|\"123456\"|\"2017-04-25 22:42:25\"\n\"b15294b187575.wav\"|\"recording20160425-31049-1mq2hk7\"|\"2017-05-03 20:39:11\"")
+
+      Net::HTTP.stub :post_form, mocked_reponse do
+        result = Slybroadcast::Client.list_audio_files
+        assert_equal result.success?, true
+        assert_equal result.list.count, 2
+      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.list_audio_files
+        end
+      end
+
+    end
+
   end
 
 end

data/test/parsers.rb

@@ -0,0 +1,116 @@
+require_relative "helper"
+
+describe Parsers do
+
+  describe 'CampaignActionsResponse' do
+
+    it 'should return session ID' do
+
+      response = "OK\nSession ID=123456"
+      result = Parsers::CampaignActionsResponse.new(response)
+      assert result.success?
+      assert_equal result.session_id, "123456"
+
+    end
+
+    it 'should return error description' do
+
+      response = "ERROR\nc_uid: required"
+      result = Parsers::CampaignActionsResponse.new(response)
+      assert result.failed?
+      assert_equal result.error, "c_uid: required"
+
+    end
+
+  end
+
+  describe 'CampaignStatusResponse' do
+
+    it 'should return session ID' do
+
+      response = "OK\nSession ID=123456\nNumber of Phone=123"
+      result = Parsers::CampaignStatusResponse.new(response)
+      assert result.success?
+      assert_equal result.session_id, "123456"
+      assert_equal result.number_of_phone, "123"
+
+    end
+
+    it 'should return error description' do
+
+      response = "ERROR\nc_uid: required"
+      result = Parsers::CampaignStatusResponse.new(response)
+      assert result.failed?
+      assert_equal result.error, "c_uid: required"
+
+    end
+
+  end
+
+  describe 'RemainingMessagesResponse' do
+
+    it 'should return session ID' do
+
+      response = "remaining messages=123456\npending messages=123"
+      result = Parsers::RemainingMessagesResponse.new(response)
+      assert result.success?
+      assert_equal result.remaining_messages, "123456"
+      assert_equal result.pending_messages, "123"
+
+    end
+
+    it 'should return error description' do
+
+      response = "ERROR\nc_uid: required"
+      result = Parsers::RemainingMessagesResponse.new(response)
+      assert result.failed?
+      assert_equal result.error, "c_uid: required"
+
+    end
+
+  end
+
+  describe 'DownloadAudioFileResponse' do
+
+    it 'should return true' do
+
+      response = "OK"
+      result = Parsers::DownloadAudioFileResponse.new(response)
+      assert result.success?
+
+    end
+
+    it 'should return error description' do
+
+      response = "ERROR\nc_uid: required"
+      result = Parsers::DownloadAudioFileResponse.new(response)
+      assert result.failed?
+      assert_equal result.error, "c_uid: required"
+
+    end
+
+  end
+
+  describe 'AudioFileListResponse' do
+
+    it 'should return true' do
+
+      response = "\"r15294b17042522420232165.wav\"|\"123456\"|\"2017-04-25 22:42:25\"\n\"b15294b187575.wav\"|\"recording20160425-31049-1mq2hk7\"|\"2017-05-03 20:39:11\""
+      result = Parsers::AudioFileListResponse.new(response)
+      assert result.success?
+      assert_equal 2, result.list.count
+
+    end
+
+    it 'should return error description' do
+
+      response = "ERROR\nc_uid: required"
+      result = Parsers::AudioFileListResponse.new(response)
+      assert result.failed?
+      assert_equal result.error, "c_uid: required"
+
+    end
+
+  end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: slybroadcast
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Martin Aceto
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-05 00:00:00.000000000 Z
+date: 2017-05-06 00:00:00.000000000 Z
 dependencies: []
 description: A minimal Slybroadcast Ruby client implementation
 email:
@@ -24,6 +24,7 @@ files:
 - lib/slybroadcast.rb
 - lib/slybroadcast/client.rb
 - lib/slybroadcast/exceptions.rb
+- lib/slybroadcast/parsers/audio_file_list_response.rb
 - lib/slybroadcast/parsers/campaign_actions_response.rb
 - lib/slybroadcast/parsers/campaign_status_response.rb
 - lib/slybroadcast/parsers/download_audio_file_response.rb
@@ -32,6 +33,7 @@ files:
 - slybroadcast.gemspec
 - test/client.rb
 - test/helper.rb
+- test/parsers.rb
 homepage: https://github.com/maceto/slybroadcast.git
 licenses:
 - MIT
@@ -59,3 +61,4 @@ summary: Slybroadcast Ruby client
 test_files:
 - test/client.rb
 - test/helper.rb
+- test/parsers.rb