smspromote 0.0.1

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2010 Vincent Landgraf
+
+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.rdoc

@@ -0,0 +1,24 @@
+= SMS Promote Ruby Bindings
+
+This is a ruby gem that helps you sending sms using the http://smspromote.de
+service. To start follow the instructions:
+
+Save your api key in a keystore:
+
+  echo "SECRETKEYJHKSJH123123LKJ" > ~/.smspromote.key
+  
+Create a new ruby source file with the following script
+
+  require "rubygems"
+  require "smspromote"
+  
+  API_KEY = SmsPromote::Gateway.read_api_key_from_file
+  GATEWAY = SmsPromote::Gateway.new(API_KEY, :secure => true,
+                                    :originator => "MY SERVICE OR NUMBER")
+  
+  msg = SmsPromote::Message.new('001231231231', 'Hello World')
+  
+  GATEWAY.send_messsage(msg)
+  
+  p msg.delivered?
+  p msg.cost

data/lib/smspromote.rb

@@ -0,0 +1,13 @@
+module SmsPromote
+  VERSION = "0.0.1"
+end
+
+begin
+  require 'rest_client'
+rescue LoadError
+  require 'rubygems'
+  require 'rest_client'
+end
+
+require 'smspromote/message'
+require 'smspromote/gateway'

data/lib/smspromote/gateway.rb

@@ -0,0 +1,76 @@
+module SmsPromote
+  class Gateway
+    SECURE = "https://gateway.smspromote.de/"
+    INSECURE = "http://gateway.smspromote.de/"
+    
+    # returns the api key as string. The api key will be read 
+    # from the ".smspromote.key" file from the home directroy of
+    # the current user
+    def self.read_api_key_from_file
+      File.read("#{ENV['HOME']}/.smspromote.key").chomp
+    end
+    
+    # create a new gateway using the passed api_key and options
+    # api_key:: [String] yourt api key (e.g. "KAJSHkjhlskfl32jh24")
+    # options:: a hash of options
+    #   :secure (true/false) # use ssl or not
+    #   :originator (string) # sender address
+    #   :debug (true/false)  # use the dummy service
+    def initialize(api_key, options = {})
+      @api_key = api_key
+      @options = {
+        :secure => false
+      }.merge(options)
+    end
+    
+    # send message using the gateway defaults
+    def send_message(message)
+      options = {
+        :key => @api_key, 
+        :to => message.recipient,
+        :message => message.body, 
+        :route => route,
+        :concat => message.multipart? ? 1 : 0,
+        :debug => debug? ? 1 : 0,
+        :message_id => 1,
+        :cost => 1,
+        :count => 1
+      }
+      
+      # use oroginator if gold route was used
+      if route == :gold
+        options[:from] = @options[:originator]
+      end
+      
+      data = parse_response(RestClient.post(service_url, options).body)
+      message.after_send(data[:code], data[:message_id], data[:cost], data[:count])
+      message
+    end
+    
+    # returns the response message hash based on the body data
+    def parse_response(body)
+      lines = body.split(/\n/)
+      {
+        :code => lines[0].to_i,
+        :message_id => lines[1],
+        :cost => (lines[2] || "0").to_f,
+        :count => (lines[3] || "0").to_i
+      }
+    end
+
+    # returns true if the message sending is a dummy operation
+    def debug?
+      !!@options[:debug]
+    end
+
+    # returns either basic or gold
+    def route
+      @options[:originator] ? :gold : :basic
+    end
+  
+    # returns the service url based on the security options
+    def service_url
+      @options[:secure] ? SECURE : INSECURE
+    end
+  end
+end

data/lib/smspromote/message.rb

@@ -0,0 +1,49 @@
+module SmsPromote
+  class Message
+    attr_reader :type, :reference, :recipient, :body,
+                :code, :message_id, :cost, :count, :send_time
+    
+    # creates a new message object with an recipient and a message body
+    # recipient:: [String] the number to send this message
+    # body:: [String] the body of the message
+    def initialize(recipient, body)
+      @recipient = recipient
+      @body = body
+      @type = :default
+    end
+    
+    # returns true if the message is valid, false otherwise
+    def valid?
+      !@body.nil? && !@recipient.nil?
+    end
+    
+    # returns true if the sms has to be send in multiple parts
+    def multipart?
+      @body.length > 160
+    end
+    
+    # returns true if the message was send
+    def send?
+      @send
+    end
+    
+    # returns true if the message was delivered, false otherwise
+    def delivered?
+      @code == 100
+    end
+    
+    # sets the message information after the message has been send
+    # code:: [Fixnum] the message code (e.g. 100)
+    # message_id:: [String] the message id string 
+    # cost:: [Float] the cost for sending the message
+    # count:: [Fixnum] the count of smsparts that have been sended
+    def after_send(code, message_id, cost, count)
+      @send_time = Time.now
+      @send = true
+      @code = code
+      @message_id = message_id
+      @cost = cost
+      @count = count
+    end
+  end
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification 
+name: smspromote
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Vincent Landgraf
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-07-11 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rest-client
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.6.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: rake
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: ""
+email: 
+- vilandgr@googlemail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/smspromote/gateway.rb
+- lib/smspromote/message.rb
+- lib/smspromote.rb
+- LICENSE
+- README.rdoc
+has_rdoc: true
+homepage: http://github.com/threez/smspromote
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: 1.3.5
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: this gem helps sending sms using the smspromote.de sms gateway
+test_files: []
+