truesenses 0.1.1 → 0.2.0

data/README.rdoc

@@ -1,9 +1,40 @@
 = truesenses
 
-Description goes here.
+A implementation of the truesenses HTTP/HTTPS API for sending SMS.
+Register at truesenses.com and buy some credits.
+
+== Install
+ gem install truesenses
+
+== Notes
+Not all API methods are implemented (i.e. delivery reports)
+Multiple recipients are not supported (to allow for better error reports)
+
+== How to use
+
+ require 'rubygems'
+ require 'truesenses'
+
+ include Truesenses
+ # you need a config which specifies at least username/password
+ config = Config.new(:username => 'ABCDE', :password => 'defgh', :prototcol => :http, :deliver => false)
+ # or
+ config = Config.load(File.join(RAILS_ROOT, 'config', 'truesenses.yml'), RAILS_ENV)
+
+ # then you can create the gateway object
+ gateway = SMSGateway.new(config)
+
+ # you can query the remaining credits
+ gateway.credits_left
+
+ # or send text messages (of course...)
+ # all response codes but 01 will trigger an exception
+ id = gateway.send_text_message('Your message', '+41987654321', :origin => 'ABCD')
+
+
 
 == Note on Patches/Pull Requests
- 
+
 * Fork the project.
 * Make your feature addition or bug fix.
 * Add tests for it. This is important so I don't break it in a
@@ -14,4 +45,4 @@ Description goes here.
 
 == Copyright
 
-Copyright (c) 2010 pascalbetz. See LICENSE for details.
+Copyright (c) 2010 simplificator. See LICENSE for details.

data/Rakefile

@@ -5,7 +5,7 @@ begin
   require 'jeweler'
   Jeweler::Tasks.new do |gem|
     gem.name = "truesenses"
-    gem.summary = %Q{implementation of the http api for truesenses.com SMS gateway}
+    gem.summary = %Q{implementation of the api for truesenses.com SMS gateway}
     gem.description = %Q{implementation of the http/https api for truesenses.com SMS gateway}
     gem.email = "info@simplificator.com"
     gem.homepage = "http://github.com/simplificator/truesenses"

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.2.0

data/lib/truesenses/config.rb

@@ -1,6 +1,12 @@
 module Truesenses
   class Config
     attr_reader :password, :username, :protocol, :origin, :deliver
+    
+    # :username
+    # :password
+    # :protocol :http or :https, defaults to :http
+    # :origin default origin ID of text message
+    # :deliver true|false, false turns on the TEST mode of truesenses API
     def initialize(options)
       options = options.stringify_keys
       @password = options['password']
@@ -10,7 +16,10 @@ module Truesenses
       @deliver = options.has_key?('deliver') ? options['deliver'] : true
       verify!
     end
-
+    
+    # Load config from a YAML file
+    # if root is specified, then this root key is used (useful when you store different configurations
+    # in one YAML file: Config.load('somefile.yml', RAILS_ENV))
     def self.load(filename, root = nil)
       data = YAML.load_file(filename)
       Config.new(root ? data[root] : data)

data/lib/truesenses/sms_gateway.rb

@@ -7,29 +7,37 @@ module Truesenses
     include HTTParty
 
     attr_reader :config
+
+
+
     def initialize(config)
       @config = config
     end
 
+    #
     def credits_left
-      post_request('CHECKCREDITS')
+      post_request('CHECKCREDITS').to_i
     end
 
+    # Send a text message
+    #
+    # Available options are:
     # :origin: if nil, do not transmit origin even if specified in config
     # :flash: true|false (defaults to false)
     # :test: true|false (defaults to false)
+    #
+    # returns the ID of the message in the YYMMDDHHMMSS format (strange, i know...)
     def send_text_message(message, receipient, options = {})
       params = {'NUMBER' => receipient, 'MESSAGE' => message}
-      if !(options.has_key?(:origin) && options[:origin].nil?) && options[:origin] || self.config.origin
+      if options.has_key?(:origin) && options[:origin].nil?
+        # ignore origin, even if it's in config
+      elsif options[:origin] || self.config.origin
+        # set origin override config is specified in options
         params['ORIGIN'] = options[:origin] || self.config.origin
       end
       params['FLASH'] = 'ON' if options[:flash]
-      params['TEST'] = 'ON' if options[:test]
-      if self.config.deliver
-        post_request('SENDMESSAGE', params)
-      else
-        puts "Fake Delivery: #{message} to #{receipient}"
-      end
+      params['TEST'] = 'ON' if options[:test] || (self.config.deliver == false)
+      post_request('SENDMESSAGE', params)
     end
 
 

data/sample.yml

@@ -0,0 +1,12 @@
+production:
+  username: ABCDE
+  password: something
+  protocol: :https
+  origin: XYZ
+  deliver: true
+test:
+  username: ABCDE
+  password: something
+  protocol: :https
+  origin: XYZ
+  deliver: false

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: truesenses
 version: !ruby/object:Gem::Version 
-  hash: 25
+  hash: 23
   prerelease: false
   segments: 
   - 0
-  - 1
-  - 1
-  version: 0.1.1
+  - 2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - pascalbetz
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-09-06 00:00:00 +02:00
+date: 2010-09-07 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -55,6 +55,7 @@ files:
 - lib/truesenses/hash.rb
 - lib/truesenses/sms_gateway.rb
 - lib/truesenses/sms_gateway_error.rb
+- sample.yml
 - test/helper.rb
 - test/test_truesenses.rb
 has_rdoc: true
@@ -90,7 +91,7 @@ rubyforge_project:
 rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
-summary: implementation of the http api for truesenses.com SMS gateway
+summary: implementation of the api for truesenses.com SMS gateway
 test_files: 
 - test/helper.rb
 - test/test_truesenses.rb