slybroadcast 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c5d5237a871e54e136af720e5a604309b8d3c45c
+  data.tar.gz: 4704755f03fc6022a4550ad3bbb62c373b9913a6
+SHA512:
+  metadata.gz: cec36c0eb8674270090483e5a19e8ad38dd27e0b19632ea8ff360257db8e808996e278f965013e98c0390de93e31291d1883758ff3736c977cd03d591e9c4881
+  data.tar.gz: a71cc3cf1b98692ca98f5fa2b120a5b77dc4aece6e5d23bb1af87a64f02ef52261b030c0b659588f2d5fe82c36734712cc0c4bc04b915e6d341b68443f6f4639

data/.gitignore

@@ -0,0 +1,50 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Martin Aceto
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,2 @@
+# slybroadcast
+A minimal Slybroadcast Ruby client implementation

data/Rakefile

@@ -0,0 +1,9 @@
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.pattern = 'test/*.rb'
+  t.verbose = true
+end
+
+desc "Run tests"
+task :default => :test

data/lib/slybroadcast.rb

@@ -0,0 +1 @@
+require_relative 'slybroadcast/client'

data/lib/slybroadcast/client.rb

@@ -0,0 +1,155 @@
+require 'singleton'
+require 'uri'
+require 'net/http'
+require_relative 'exceptions'
+require_relative 'parsers/campaign_status_response'
+require_relative 'parsers/campaign_actions_response'
+require_relative 'parsers/remaining_messages_response'
+
+# usage:
+#   Slybroadcast::Client.credentials = {
+#     c_uid: 'user@example.com',
+#     c_password: 'secret'
+#   }
+#   Slybroadcast::Client.verify
+#
+# or
+#
+#   Slybroadcast::Client.verify({
+#     c_uid: 'user@example.com',
+#     c_password: 'secret'
+#   })
+module Slybroadcast
+  class Client
+    include Singleton
+
+    API_URI = 'https://www.mobile-sphere.com/gateway'.freeze
+    ENDPOINTS = {
+      verify: 'vmb.php',
+      campaign_call_status: 'vmb.php',
+      campaign_pause: 'vmb.php',
+      campaign_resume: 'vmb.php',
+      campaign_cancel: 'vmb.php',
+      account_message_balance: 'vmb.php',
+      download_audio_file: 'vmb.dla.php',
+      list_audio_files: 'vmb.aflist.php'
+    }.freeze
+
+    class << self
+      attr_accessor :credentials
+
+      def method_missing(method, *args, &block)
+        instance.send(method, *args, &block)
+      end
+    end
+
+    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))
+      )
+      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 = Net::HTTP.post_form(
+        endpoint_url,
+        params
+      )
+      result = Parsers::CampaignStatusResponse.new(res.body)
+      result.success? ? result : handle_error(result.error)
+    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)
+    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)
+    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)
+    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)
+    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)
+    end
+
+    def list_audio_files
+      params = set_credentials(c_method: 'get_audio_list')
+      res = Net::HTTP.post_form(
+        endpoint_url,
+        params
+      )
+      res.body
+    end
+
+    private
+
+    def endpoint_url
+      method = caller_locations(1,1).first.label.to_sym
+      URI(File.join(API_URI, ENDPOINTS.fetch(method)))
+    end
+
+    def set_credentials(params)
+      (self.class.credentials || {}).merge(params)
+    end
+
+    def handle_error(err)
+      case err
+      when 'c_uid: required'
+        raise Exceptions::InvalidCredentials, err
+      when 'Bad Audio, can\'t download'
+        raise Exceptions::BadAudio, err
+      when 'session_id: required'
+        raise Exceptions::SessionIdRequired, err
+      when 'already finished'
+        raise Exceptions::CampaignAlreadyFinished, err
+      when 'invalid or not found'
+        raise Exceptions::CampaignNotFound, err
+      else
+        raise StandardError, err
+      end
+    end
+
+  end
+end

data/lib/slybroadcast/exceptions.rb

@@ -0,0 +1,20 @@
+module Slybroadcast
+  module Exceptions
+
+    class InvalidCredentials < ::ArgumentError
+    end
+
+    class BadAudio < ::TypeError
+    end
+
+    class CampaignNotFound < ::RuntimeError
+    end
+
+    class CampaignAlreadyFinished < ::RuntimeError
+    end
+
+    class SessionIdRequired < ::ArgumentError
+    end
+
+  end
+end

data/lib/slybroadcast/parsers/campaign_actions_response.rb

@@ -0,0 +1,33 @@
+module Parsers
+  class CampaignActionsResponse
+    attr_accessor :success
+    attr_accessor :error
+    attr_accessor :session_id
+
+    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].gsub(/\d\s?/, '').strip
+      else
+        @session_id = response[1].gsub(/[^0-9]/i, '').strip
+      end
+    end
+
+  end
+end

data/lib/slybroadcast/parsers/campaign_status_response.rb

@@ -0,0 +1,35 @@
+module Parsers
+  class CampaignStatusResponse
+    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/download_audio_file_response.rb

@@ -0,0 +1,27 @@
+module Parsers
+  class DownloadAudioFileResponse
+    attr_accessor :success
+    attr_accessor :error
+
+    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'
+      @error = response[1].strip unless success
+    end
+
+  end
+end

data/lib/slybroadcast/parsers/remaining_messages_response.rb

@@ -0,0 +1,35 @@
+module Parsers
+  class RemainingMessagesResponse
+    attr_accessor :success
+    attr_accessor :error
+    attr_accessor :remaining_messages
+    attr_accessor :pending_messages
+
+    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].include?('remaining')
+
+      unless success
+        @error = response[1].strip
+      else
+        @remaining_messages = response[0].gsub(/[^0-9]/i, '').strip
+        @pending_messages = response[1].gsub(/[^0-9]/i, '').strip
+      end
+    end
+
+  end
+end

data/lib/slybroadcast/version.rb

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

data/slybroadcast.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "slybroadcast/version"
+
+Gem::Specification.new do |s|
+  s.name        = "slybroadcast"
+  s.version     = Slybroadcast::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Martin Aceto"]
+  s.email       = ["martin.aceto@gmail.com"]
+  s.homepage    = "https://github.com/maceto/slybroadcast.git"
+  s.summary     = %q{Slybroadcast Ruby client}
+  s.description = %q{A minimal Slybroadcast Ruby client implementation}
+  s.license       = 'MIT'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.require_paths = ["lib"]
+end

data/test/client.rb

@@ -0,0 +1,186 @@
+require_relative "helper"
+
+describe Slybroadcast::Client do
+  describe 'verify' do
+
+    it 'should be true' do
+
+      mocked_reponse = MiniTest::Mock.new
+      mocked_reponse.expect(:body, "OK")
+
+      Net::HTTP.stub :post_form, mocked_reponse do
+        assert Slybroadcast::Client.verify({})
+      end
+
+    end
+
+    it 'should be false' do
+
+      mocked_reponse = MiniTest::Mock.new
+      mocked_reponse.expect(:body, "ERROR")
+
+      Net::HTTP.stub :post_form, mocked_reponse do
+        assert_raises Slybroadcast::Exceptions::InvalidCredentials do
+          Slybroadcast::Client.verify({})
+        end
+      end
+
+    end
+
+  end
+
+  describe 'campaign_call_status' do
+
+    it 'should return session ID' do
+
+      mocked_reponse = MiniTest::Mock.new
+      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({})
+        assert_equal result.session_id, "123456"
+        assert_equal result.number_of_phone, "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.campaign_call_status({})
+        end
+      end
+
+    end
+
+  end
+
+  describe 'campaign_pause' do
+
+    it 'should return session ID' do
+
+      mocked_reponse = MiniTest::Mock.new
+      mocked_reponse.expect(:body, "OK\nsession ID=123456")
+
+      Net::HTTP.stub :post_form, mocked_reponse do
+        result = Slybroadcast::Client.campaign_pause({})
+        assert_equal result.session_id, "123456"
+      end
+
+    end
+
+    it 'should raise Exceptions::SessionIdRequired' do
+
+      mocked_reponse = MiniTest::Mock.new
+      mocked_reponse.expect(:body, "ERROR\nsession_id: required")
+
+      Net::HTTP.stub :post_form, mocked_reponse do
+        assert_raises Slybroadcast::Exceptions::SessionIdRequired do
+          Slybroadcast::Client.campaign_pause({})
+        end
+      end
+
+    end
+
+  end
+
+
+  describe 'campaign_resume' do
+
+    it 'should return session ID' do
+
+      mocked_reponse = MiniTest::Mock.new
+      mocked_reponse.expect(:body, "OK\nsession ID=123456")
+
+      Net::HTTP.stub :post_form, mocked_reponse do
+        result = Slybroadcast::Client.campaign_resume({})
+        assert_equal result.session_id, "123456"
+      end
+
+    end
+
+    it 'should raise Exceptions::SessionIdRequired' do
+
+      mocked_reponse = MiniTest::Mock.new
+      mocked_reponse.expect(:body, "ERROR\nsession_id: required")
+
+      Net::HTTP.stub :post_form, mocked_reponse do
+        assert_raises Slybroadcast::Exceptions::SessionIdRequired do
+          Slybroadcast::Client.campaign_resume({})
+        end
+      end
+
+    end
+
+  end
+
+  describe 'campaign_cancel' do
+
+    it 'should return session ID' do
+
+      mocked_reponse = MiniTest::Mock.new
+      mocked_reponse.expect(:body, "OK\nsession ID=123456")
+
+      Net::HTTP.stub :post_form, mocked_reponse do
+        result = Slybroadcast::Client.campaign_cancel({})
+        assert_equal result.session_id, "123456"
+      end
+
+    end
+
+    it 'should raise Exceptions::SessionIdRequired' do
+
+      mocked_reponse = MiniTest::Mock.new
+      mocked_reponse.expect(:body, "ERROR\nsession_id: required")
+
+      Net::HTTP.stub :post_form, mocked_reponse do
+        assert_raises Slybroadcast::Exceptions::SessionIdRequired do
+          Slybroadcast::Client.campaign_cancel({})
+        end
+      end
+
+    end
+
+  end
+
+  describe 'account_message_balance' do
+
+    it 'should return remaining messages' do
+
+      mocked_reponse = MiniTest::Mock.new
+      mocked_reponse.expect(:body, "remaining messages=12345\npending messages=123")
+
+      Net::HTTP.stub :post_form, mocked_reponse do
+        result = Slybroadcast::Client.account_message_balance
+        assert_equal result.remaining_messages, "12345"
+        assert_equal result.pending_messages, "123"
+      end
+
+    end
+
+    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.account_message_balance
+        end
+      end
+
+    end
+
+  end
+
+  describe 'download_audio_file' do
+  end
+
+  describe 'list_audio_files' do
+  end
+
+end

data/test/helper.rb

@@ -0,0 +1,4 @@
+require 'minitest/autorun'
+require_relative '../lib/slybroadcast'
+
+ENV['RACK_ENV'] = 'test'

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification
+name: slybroadcast
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Martin Aceto
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-05-05 00:00:00.000000000 Z
+dependencies: []
+description: A minimal Slybroadcast Ruby client implementation
+email:
+- martin.aceto@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- LICENSE
+- README.md
+- Rakefile
+- lib/slybroadcast.rb
+- lib/slybroadcast/client.rb
+- lib/slybroadcast/exceptions.rb
+- lib/slybroadcast/parsers/campaign_actions_response.rb
+- lib/slybroadcast/parsers/campaign_status_response.rb
+- lib/slybroadcast/parsers/download_audio_file_response.rb
+- lib/slybroadcast/parsers/remaining_messages_response.rb
+- lib/slybroadcast/version.rb
+- slybroadcast.gemspec
+- test/client.rb
+- test/helper.rb
+homepage: https://github.com/maceto/slybroadcast.git
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: Slybroadcast Ruby client
+test_files:
+- test/client.rb
+- test/helper.rb