Contents

module TextMagic
  class API

    class Executor

      include HTTParty
      base_uri "https://www.textmagic.com/app"

      # Executes a command by sending a request to the TextMagic's Bulk
      # SMS gateway. This is a low-level generic method used by methods
      # in TextMagic::API class. You should never need to use this method
      # directly.
      #
      # Parameters specified in the +options+ hash will be added to the
      # HTTP POST request"s body together with command, username and
      # password.
      #
      # Returns a hash with values parsed from the server"s response if
      # the command was successfully executed. In case the server replies
      # with error, this method raises a TextMagic::API::Error.
      def self.execute(command, username, password, options = {})
        raise TextMagic::API::Error.new(3, "Command is undefined") unless command
        raise TextMagic::API::Error.new(5, "Invalid username & password combination") unless username && password
        options.merge!(:username => username, :password => password, :cmd => command)
        options.delete_if { |key, value| !key || !value }
        response = self.post("/api", :body => options, :format => :json)
        raise Error.new(response) if response && response["error_code"]
        response
      end
    end
  end
end

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
textmagic-0.6.0	lib/textmagic/executor.rb