tsig_api 1.0.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5502843ccb8a98114e81d8b945e1dc074bbb504b
+  data.tar.gz: d88a64b06000bbe3dc81df4ee65509cd6351aaa2
+SHA512:
+  metadata.gz: e5af2390f1f4a2bfd636798e7b01d72180f3aab1155dd46f646f6b4511e8bd580cb3f14270a090f887f121377913c1d03e624efa11b2e484f9c5e6b33f50e0e8
+  data.tar.gz: 1b307ea2d86adb3b441d2206d633a3b4e9e286f69e59e6b611361edb443eeae5bbaafd85991afa0fe1d4635bd757c73d7c6ce95ccea3a4e8ab27c1fd4036eaac

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 [name of plugin creator]
+
+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,4 @@
+tsig_api
+========
+
+TxtSignal Api Client

data/Rakefile

@@ -0,0 +1,23 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the tsig_api plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the tsig_api plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'TSIG API'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/init.rb

@@ -0,0 +1,4 @@
+# Include hook code here
+$:.unshift(File.dirname(__FILE__) + '/lib')
+
+require 'tsig_api'

data/install.rb

@@ -0,0 +1 @@
+# Install hook code here

data/lib/tsig_api.rb

@@ -0,0 +1,30 @@
+
+def build_global_element(elem)
+  txtsig_api_config = YAML::load_file(File.join(Rails.root, "config/tsig_api.yml"))
+  rails_env = Rails.env.to_s || "development"
+  return txtsig_api_config[rails_env.to_sym][elem]
+end
+
+module TsigApi
+
+  # extracts just the text from a tsig flash message
+  #
+  def self.text_from_flash(str)
+    matches = /\<li\>(.+)\<\/li\>/im.match(str)
+    messages = []
+    if matches
+      messages = matches[1].split(/\<\/li\>\s*\<li\>/)
+    end
+    return messages
+  end
+
+end
+
+require 'rexml/document'
+require 'tsig_api/authorize'
+require 'tsig_api/base'
+require 'tsig_api/carrier'
+require 'tsig_api/contact'
+require 'tsig_api/group'
+require 'tsig_api/message'
+require 'tsig_api/team'

data/lib/tsig_api/authorize.rb

@@ -0,0 +1,15 @@
+require 'tsig_api/base'
+
+module TsigApi
+
+  class Authorize < TsigApi::Base
+
+    self.remote_type = :authorize
+
+    def query
+      TsigApi::RemoteActions::Request.new(:body => request_xml(:authorize, nil), :url => '/api/authorize')
+    end
+
+  end
+
+end

data/lib/tsig_api/base.rb

@@ -0,0 +1,108 @@
+require 'tsig_api/remote_actions'
+
+module TsigApi
+
+  class Base
+    
+    class << self
+      attr_accessor :remote_type
+
+      def establish_connection(clientid, username, password)
+        @TXTSIG_CLIENT_ID = clientid
+        @TXTSIG_API_USERNAME = username
+        @TXTSIG_API_PASSWORD = password
+
+        TsigApi.send(:const_set, "TXTSIG_HOST", build_global_element(:host)) unless TsigApi.const_defined?(:TXTSIG_HOST)
+        TsigApi.send(:const_set, "TXTSIG_PORT", build_global_element(:port)) unless TsigApi.const_defined?(:TXTSIG_PORT)
+      end
+
+    end
+    
+    attr_accessor :group_id
+    
+    def initialize(group_id=nil)
+      self.group_id = group_id
+    end
+
+    def list
+      raise 'Abstract, subclass'
+    end
+
+    def create
+      raise "Abstract, subclass"
+    end
+    
+    def query
+      raise "Abstract, subclass"
+    end
+    
+    def update
+      raise "Abstract, subclass"
+    end
+    
+    def destroy
+      raise "Abstract, subclass"
+    end
+    
+    def parse_response(response)
+      begin
+        doc = REXML::Document.new(response.body)
+      rescue
+        return nil
+      end
+      content_type = doc.root.elements[1].attributes["type"]
+      response_hash = {}
+      doc.root.elements[1].elements[1].elements.each do |e|
+        if e.attributes["name"] == self.class.remote_type.to_s.pluralize
+          response_hash[e.attributes["name"]] = e.elements.collect do |ne| 
+            if ne.cdatas.empty?
+              ne.get_text.to_s.gsub(/^\s+/, "").gsub(/\s+$/, "") 
+            else
+              ne.cdatas[0].to_s.gsub(/^\s+/, "").gsub(/\s+$/, "")
+            end 
+          end
+        else
+          if e.cdatas.empty?
+            response_hash[e.attributes["name"]] = e.get_text.to_s.gsub(/^\s+/, "").gsub(/\s+$/, "")
+          else
+            response_hash[e.attributes["name"]] = e.cdatas[0].to_s.gsub(/^\s+/, "").gsub(/\s+$/, "")
+          end
+        end
+      end
+      return [content_type, response_hash]
+    end
+    
+    protected
+        
+    def credentials_xml
+      xml = <<-EOS
+        <credentials>
+            <api_username><![CDATA[#{TsigApi::Base.instance_variable_get('@TXTSIG_API_USERNAME')}]]></api_username>
+    	      <api_password><![CDATA[#{TsigApi::Base.instance_variable_get('@TXTSIG_API_PASSWORD')}]]></api_password>
+    		    <client_id><![CDATA[#{TsigApi::Base.instance_variable_get('@TXTSIG_CLIENT_ID')}]]></client_id>
+        </credentials>      
+      EOS
+    end
+    
+    def group_id_node
+      param_node('group', group_id)
+    end
+
+    def param_node(name, value)
+      %Q{<param name="#{name}"><![CDATA[#{value}]]></param>}
+    end
+
+    def request_xml(action, body)
+      xml = <<-EOS
+      <?xml version='1.0'?>
+      <txtsig_request version='1.0'>
+          #{credentials_xml}
+          <action type="#{action.to_s.downcase}_#{self.class.remote_type}">
+          #{body}
+          </action>
+      </txtsig_request>
+      EOS
+    end
+
+  end
+end

data/lib/tsig_api/carrier.rb

@@ -0,0 +1,16 @@
+require 'rexml/document'
+require 'tsig_api/base'
+
+module TsigApi
+
+  class Carrier < TsigApi::Base
+
+    self.remote_type = :carriers
+    
+    def query
+      TsigApi::RemoteActions::Request.new(:body => request_xml(:list, "<param name='group'>#{group_id}</param>"))
+    end
+    
+  end
+
+end

data/lib/tsig_api/contact.rb

@@ -0,0 +1,79 @@
+require 'tsig_api/base'
+
+module TsigApi
+  class Contact < TsigApi::Base
+    self.remote_type = :contact
+
+    def create(options={:first_name => nil, :last_name => nil, :cell_carrier => nil, :cell_number => nil, :receive_messages => nil, :add_teams => nil})
+      team_xml = ""
+      if options[:add_teams]
+      	team_xml += "<param name='add_teams'>"
+        options[:add_teams].each do |at|
+          team_xml += "<team>#{at}</team>"
+        end
+        team_xml += "</param>"
+      end
+      remsg = 0
+      remsg = 1 if options[:receive_messages]
+      xml = "
+      <param name='group'>#{group_id}</param>
+    	<param name='first_name'>#{options[:first_name]}</param>
+    	<param name='last_name'>#{options[:last_name]}</param>
+    	<param name='cell_number'>#{options[:cell_number]}</param>
+    	<param name='cell_carrier'>#{options[:cell_carrier]}</param>
+    	<param name='receive_messages'>#{remsg}</param>
+    	#{team_xml}
+      "
+      TsigApi::RemoteActions::Request.new(:body => request_xml(:create, xml))
+    end
+    
+    def query(options={:first_name => nil, :last_name => nil, :cell_carrier => nil, :cell_number => nil, :contact_id => nil})
+      xml = "<param name='group'>#{group_id}</param>"
+      if options[:contact_id]
+        xml += "<param name='contact_id'>#{options[:contact_id]}</param>"
+      else
+        use_options = options.reject { |o, k| o == :contact_id }
+        use_options.each do |arg, val|
+          xml += "<param name='#{arg.to_s}'>#{val}</param>" if val
+        end
+      end
+      TsigApi::RemoteActions::Request.new(:body => request_xml(:query, xml))
+    end
+    
+    def update(contact_id, options = {:first_name => nil, :last_name => nil, :cell_carrier => nil, :cell_number => nil, :receive_messages => nil, :add_teams => nil, :del_teams => nil})
+      xml = "<param name='group'>#{group_id}</param>"
+      xml += "<param name='contact_id'>#{contact_id}</param>"
+      use_options = options.reject { |o, v| [:add_teams, :del_teams].include?(o) }
+      use_options.each do |arg, val|
+        xml += "<param name='#{arg.to_s}'>#{val}</param>" if val
+      end
+      if options[:add_teams]
+        add_team_xml = "<param name='add_teams'>"
+        options[:add_teams].each do |at|
+          add_team_xml += "<team>#{at}</team>"
+        end
+        add_team_xml += "</param>"
+        xml += add_team_xml
+      end
+      if options[:del_teams]
+        del_team_xml = "<param name='del_teams'>"
+        options[:del_teams].each do |at|
+          del_team_xml += "<team>#{at}</team>"
+        end
+        del_team_xml += "</param>"
+        xml += del_team_xml
+      end
+      TsigApi::RemoteActions::Request.new(:body => request_xml(:update, xml))
+    end
+    
+    def delete(contact_id)
+      xml = <<-EOS
+      <param name='group'>#{group_id}</param>
+      <param name='contact_id'>#{contact_id}</param>
+      EOS
+      
+      TsigApi::RemoteActions::Request.new(:body => request_xml(:delete, xml))
+    end
+    
+  end
+end

data/lib/tsig_api/group.rb

@@ -0,0 +1,15 @@
+require 'tsig_api/base'
+
+module TsigApi
+
+  class Group < TsigApi::Base
+
+    self.remote_type = :groups
+    
+    def query
+      TsigApi::RemoteActions::Request.new(:body => request_xml(:list, nil))
+    end
+    
+  end
+
+end

data/lib/tsig_api/message.rb

@@ -0,0 +1,116 @@
+require 'tsig_api/base'
+
+module TsigApi
+
+  class Message < TsigApi::Base
+    self.remote_type = :message
+    
+    def create(options={:broadcast_type => nil, :date_sent => nil, :send_now => nil, :message => nil, :has_contacts => nil, :has_teams => nil})
+      date_sent = (options[:date_sent] || options[:send_at])
+      date_sent = parse_date(date_sent) if date_sent
+      sndnow = %w(1 true).include?(options[:send_now].to_s)
+      
+      xml = <<-EOS
+      <param name='group'><![CDATA[#{group_id}]]></param>
+    	<param name='broadcast_type'>#{options[:broadcast_type]}</param>
+    	<param name='send_at'>#{date_sent}</param>
+    	<param name='send_now'>#{sndnow}</param>
+    	<param name='message'><![CDATA[#{options[:message]}]]></param>
+      EOS
+      
+      if options[:has_contacts]
+        has_contact_xml = "<param name='has_contacts'>"
+        options[:has_contacts].each do |at|
+          has_contact_xml += "<contact>#{at}</contact>"
+        end
+        has_contact_xml += "</param>"
+        xml += has_contact_xml
+      end
+      if options[:has_teams]
+        has_team_xml = "<param name='has_teams'>"
+        options[:has_teams].each do |at|
+          has_team_xml += "<team><![CDATA[#{at}]]></team>"
+        end
+        has_team_xml += "</param>"
+        xml += has_team_xml
+      end
+      TsigApi::RemoteActions::Request.new(:body => request_xml(:create, xml))
+    end
+    
+    def query(options={:broadcast_type => nil, :date_sent => nil, :send_now => nil, :message => nil, :sent_before => nil, :sent_after => nil, :message_id => nil, :message_by_team => nil })
+      xml = "<param name='group'>#{group_id}</param>"
+      if options[:message_id]
+        xml += "<param name='message_id'>#{options[:message_id]}</param>"
+      else
+        if options[:send_now]
+          sndnow = 0
+          sndnow = 1 if options[:send_now]
+        end
+        options[:send_now] = sndnow
+        options[:date_sent] = parse_date(options[:date_sent]) if options[:date_sent]
+        options[:sent_after] = parse_date(options[:sent_after]) if options[:sent_after]
+        options[:sent_before] = parse_date(options[:sent_before]) if options[:sent_before]
+        use_options = options.reject { |o, k| o == :message }
+        use_options.each do |arg, val|
+          xml += "<param name='#{arg.to_s}'>#{val}</param>" if val
+        end
+        if options[:message]
+          xml += "<param name='message'><![CDATA[#{option[:message]}]]></param>"
+        end
+      end
+      TsigApi::RemoteActions::Request.new(:body => request_xml(:query, xml))
+    end
+    
+    def update(message_id, options={:broadcast_type => nil, :date_sent => nil, :send_now => nil, :message => nil,  :has_contacts => nil, :has_teams => nil})
+      xml = "<param name='group'>#{group_id}</param>"
+      xml += "<param name='message_id'>#{message_id}</param>"
+      sndnow = 0
+      sndnow = 1 if options[:send_now]
+      options[:send_now] = sndnow
+      options[:date_sent] = parse_date(options[:date_sent]) if options[:date_sent]
+      [:broadcast_type, :date_sent, :send_now].each do |arg|
+        xml += "<param name='#{arg}'>#{options[arg]}</param>" if options[arg]
+      end
+      xml += "<param name='message'><![CDATA[#{options[:message]}]]></param>" if options[:message]
+      if options[:has_contacts]
+        has_contact_xml = "<param name='has_contacts'>"
+        options[:has_contacts].each do |at|
+          has_contact_xml += "<contact>#{at}</contact>"
+        end
+        has_contact_xml += "</param>"
+        xml += has_contact_xml
+      end
+      if options[:has_teams]
+        has_team_xml = "<param name='has_teams'>"
+        options[:has_teams].each do |at|
+          has_team_xml += "<team>#{at}</team>"
+        end
+        has_team_xml += "</param>"
+        xml += has_team_xml
+      end
+      TsigApi::RemoteActions::Request.new(:body => request_xml(:update, xml))
+    end
+    
+    def delete(message_id)
+      xml = "
+      <param name='group'>#{group_id}</param>
+      <param name='message_id'>#{message_id}</param>
+      "
+      TsigApi::RemoteActions::Request.new(:body => request_xml(:delete, xml))
+    end
+
+    private
+    
+    def parse_date(d)
+      if not d.is_a?(String)
+        begin
+          d = d.strftime("%m/%d/%Y %H:%M %p")
+        rescue
+          raise "Date for message to be sent must be a string in MM-DD-YYYY HH:MM [am/pm] or a DateTime object"
+        end
+      end
+      d
+    end
+    
+  end
+end