qst_client 0.1

data/lib/qst_client.rb

@@ -0,0 +1,114 @@
+# A QST client implemented in ruby.
+#
+# === Install
+#
+#   gem install qst_client
+#
+# === Example
+#
+# Every method raises a QstClient::Exception with the response if the response code
+# is not between 200 (inclusive) and 400 (exclusive).
+#
+#   client = QstClient.new 'service_url', 'username', 'psasword'
+#   last_id = client.put_messages [{'id' => '2', 'from' => 'sms://1234', 'to' => 'sms://5678', 'text' => 'Hello!', 'properties' => {'foo' => 'bar'}}]
+#   messages = client.get_messages
+#   messages = client.get_messages 'from_id'
+require 'rubygems'
+require 'httparty'
+require 'builder'
+
+class QstClient
+  include HTTParty
+  
+  class Exception < ::Exception
+    attr_reader :response
+    def initialize(response)
+      @response = response
+    end
+  end
+  
+  def initialize(url, username, password)
+    @url = url
+    @auth = {:username => username, :password => password}
+  end
+  
+  # Returns the response of requesting the last id received by the server.
+  def get_last_id
+    response = self.class.head("#{@url}/incoming", :basic_auth => @auth)
+    raise QstClient::Exception.new response unless (200 ... 400).include? response.code
+    response['etag']
+  end
+  
+  # Get messages from the server, optionally saying from which id to start
+  def get_messages(from_id = nil)
+    response = self.class.get "#{@url}/outgoing", :basic_auth => @auth
+    raise QstClient::Exception.new response unless (200 ... 400).include? response.code
+    
+    messages = []
+    
+    elems = ((response || {})['messages'] || {})['message']
+    elems = [elems] if elems.class <= Hash
+    
+    (elems || []).each do |elem|
+      msg = {}
+      msg['from'] = elem['from']
+      msg['to'] = elem['to']
+      msg['text'] = elem['text']
+      msg['id'] = elem['id']
+      msg['when'] = Time.parse(elem['when']) if elem['when'] rescue nil
+      
+      properties = elem['property']
+      if properties
+        msg['properties'] = {}
+        properties = [properties] if properties.class <= Hash      
+        properties.each do |prop|
+          if msg['properties'][prop['name']]
+            if msg['properties'][prop['name']].kind_of? Array
+              msg['properties'][prop['name']] << prop['value']
+            else
+              msg['properties'][prop['name']] = [msg['properties'][prop['name']], prop['value']]
+            end 
+          else
+            msg['properties'][prop['name']] = prop['value']
+          end 
+        end
+      end
+      
+      messages << msg
+    end
+    
+    messages
+  end
+
+  # Put some messages on the server.
+  #   put_messages [{'id' => '2', 'from' => 'sms://1234', 'to' => 'sms://5678', 'text' => 'Hello!', 'properties' => {'foo' => 'bar'}}]
+  def put_messages(messages)
+    xml = Builder::XmlMarkup.new(:indent => 1)
+    xml.instruct!
+    xml.messages do
+      messages.each do |msg|
+        options = {}
+        options[:id] = msg['id'] if msg['id'] 
+        options[:from] = msg['from'] if msg['from']
+        options[:to] = msg['to'] if msg['to']
+        options[:when] = msg['when'].xmlschema if msg['when']
+      
+        xml.message options do
+          xml.text msg['text'] if msg['text']
+          if msg[:properties]
+             msg[:properties].each do |name, values|
+              values = [values] unless values.kind_of? Array
+              values.each do |value|
+                xml.property :name => name, :value => value
+              end
+            end
+          end
+        end
+      end
+    end
+  
+    response = self.class.post "#{@url}/incoming", :basic_auth => @auth, :body => xml.target!, :headers => {'Content-Type' => 'application/xml'}
+    raise QstClient::Exception.new response unless (200 ... 400).include? response.code
+  end
+
+end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification 
+name: qst_client
+version: !ruby/object:Gem::Version 
+  hash: 9
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  version: "0.1"
+platform: ruby
+authors: 
+- InsTEDD
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-06-08 00:00:00 +07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: httparty
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+description: A QST client.
+email: aborenszweig@manas.com.ar
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/qst_client.rb
+has_rdoc: true
+homepage: http://code.google.com/p/qst-client-ruby
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: A QST client
+test_files: []
+