sms_sender 0.0.3

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 [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

@@ -0,0 +1,80 @@
+SmsSender
+=========
+
+This plugin aims to provide very easy way to send an sms from your Rails app.
+The service used for sending sms messages is Polish http://smsapi.pl. In order
+to use the plugin you have to sign up at http://smsapi.pl. They give you a few
+free smses, so you can test how the plugin works for you without paying.
+
+Installation
+=============
+
+To install the plugin, just add it in your gemfile:
+
+gem "sms_sender"
+
+Configuration
+==============
+
+All you need to do is add following lines in your config/application.rb:
+
+config.sms_sender_login="your login at smsapi.pl"
+config.sms_sender_password="your password at smsapi.pl"
+config.sms_sender_eco=1
+
+Alternatively, if you don't want to send eco smses, you comment the last line and add:
+
+#config.sms_sender_eco=1
+config.sms_sender_from="5555"
+
+You may also wish to send test requests to smsapi while you develop your app. I always use
+it development mode. Just add in config/development.rb:
+
+config.sms_sender_test=1
+
+With this the plugin will send requests to smsapi, but you will not be charged and people
+will not get any messages.
+
+Usage
+=====
+
+The plugin adds a method:
+
+send_sms(telephone, text)
+
+This method is available in all your controllers. When sth goes wrong it will raise SmsApiError,
+so it's wise to write:
+
+begin
+  send_sms("666", "hello world")
+rescue SmsApiError => e
+  logger.error "Sms api failed with error #{e.error_code}"
+  .... other error handling code
+end
+
+Testing
+=======
+
+When you run your tests the plugin does not send any requests to smsapi. Instead it uses
+a fake implementation of sender and gives you two extra assertions. In your tests you may write:
+
+assert_sms_sent "6666", "hello world"
+
+This will be passed if somewhere in your code there was a call
+
+send_sms "6666", "hellow world"
+
+Be careful though, assert_sms_sent will be passed once only. If you call it twice without
+a proper call to send_sms, it will fail.
+
+On the other hand you may want to check:
+
+assert_no_sms_sent
+
+That will be passed iff there was no calls to send_sms.
+
+Both assertions are added to Test::Unit::Assertions. They work in test/unit tests, as well as
+in RSpec and Cucumber.
+
+======
+Copyright (c) 2011 RocketMind Software, released under the MIT license.

data/Rakefile

@@ -0,0 +1,52 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+require 'rake/gempackagetask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the sms_sender 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 sms_sender plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'SmsSender'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+PKG_FILES = FileList[
+  '[a-zA-Z]*',
+  'generators/**/*',
+  'lib/**/*',
+  'rails/**/*',
+  'tasks/**/*',
+  'test/**/*'
+]
+
+spec = Gem::Specification.new do |s|
+  s.name = "sms_sender"
+  s.version = "0.0.3"
+  s.author = "Maciej Zubala - RocketMind Software"
+  s.email = "maciej.zubala@rocketmind.pl"
+  s.platform = Gem::Platform::RUBY
+  s.summary = "Sends sms messages using http://smsapi.pl"
+  s.homepage = "https://github.com/mzubala/sms_sender"
+  s.files = PKG_FILES.to_a
+  s.require_path = "lib"
+  s.has_rdoc = false
+  s.extra_rdoc_files = ["README"]
+end
+
+desc 'Turn this plugin into a gem.'
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+end

data/init.rb

@@ -0,0 +1 @@
+require "sms_sender"

data/install.rb

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

data/lib/action_controller_ext.rb

@@ -0,0 +1,15 @@
+module ActionController
+
+  class Base
+
+    include SmsSender
+
+    def send_sms telephone, text
+      message = Message.new telephone, text
+      sender = create_sms_sender
+      sender.send_sms message
+    end
+
+  end
+
+end

data/lib/message.rb

@@ -0,0 +1,28 @@
+module SmsSender
+
+  class Message
+
+    attr_accessor :text, :telephone
+
+    def initialize telephone, text
+      @text = text
+      @telephone = normalized_telephone telephone
+    end
+
+    def == other
+      ((other.text || "") == self.text) && ((other.telephone || "") == self.telephone)
+    end
+
+    def to_s
+      "#{@telephone} - #{@text}"
+    end
+
+    private
+
+    def normalized_telephone telephone
+      telephone.gsub(/[^\d]/, "")
+    end
+
+  end
+
+end

data/lib/sms_api_sender.rb

@@ -0,0 +1,89 @@
+require 'net/http'
+require 'digest/md5'
+
+module SmsSender
+
+  class SmsApiSender
+
+    SMS_API_URL = "https://ssl.smsapi.pl/send.do"
+
+    attr_writer :from, :test, :eco, :login, :password
+
+    def initialize logger
+      @logger = logger
+    end
+
+    def send_sms message
+      url = URI.parse(SMS_API_URL)
+      req = Net::HTTP::Post.new(url.path)
+      params = basic_params message
+      add_extra_params(params)
+      req.set_form_data(params)
+      @logger.info "Requesting sms api to send message: #{truncated_text(message)}"
+      http = Net::HTTP.new(url.host, url.port)
+      http.use_ssl = true
+      res = http.start { |http| http.request(req) }
+      @logger.info "Sms api request finished processing with response #{res.body}"
+      if sms_not_sent? res
+        raise SmsApiError res.code
+      end
+    end
+
+    private
+
+    def basic_params message
+      {
+        "username" => Rails.configuration.sms_sender_login,
+        "password" => Digest::MD5.hexdigest(Rails.configuration.sms_sender_password),
+        "to" => message.telephone,
+        "message" => truncated_text(message),
+        "encoding" => "utf-8"
+      }
+    end
+
+    def add_extra_params(params)
+      params.merge! "from" => Rails.configuration.sms_sender_from if Rails.configuration.respond_to?(:sms_sender_from)
+      params.merge! "test" => "1" if Rails.configuration.respond_to?(:sms_sender_test)
+      params.merge! "eco" => "1" if Rails.configuration.respond_to?(:sms_sender_eco)
+    end
+
+    def sms_not_sent? response
+      !response.is_a?(Net::HTTPSuccess) || !(response.body =~ /.*OK.*/)
+    end
+
+    def truncated_text message
+      text = message.text
+      length = [text.length, max_len_of_text(text)].min
+      text[0, length]
+    end
+
+    def max_len_of_text text
+      if text.match SPECIAL_CHARS
+        MAX_LEN_SHORT
+      else
+        MAX_LEN_LONG
+      end
+    end
+
+    MAX_LEN_SHORT = 201
+    MAX_LEN_LONG = 457
+
+    SPECIAL_CHARS = /[^@\u00A3\$\u00A5\u00E8\u00E9\u00F9\u00EC\u00F2\u00C7\u00D8\u00F8\u00C5\u00E5_\^\{\}\[~\]\|\u00C6\u00E6\u00DF\u00C9!"#\u00A4%&'\(\)\*\+\,\-\.\/0-9:;<=>\?A-Z\u00C4\u00D6\u00D1\u00DC\u00A7\u00BFa-z\u00E4\u00F6\u00F1\u00FC\u00E0 \r\n]/
+
+  end
+
+  class SmsApiError
+
+    attr_reader :error_code
+
+    def initialize error_code
+      @error_code = error_code
+    end
+
+    def to_s
+      "Sms Api error code: #{@error_code}"
+    end
+
+  end
+
+end

data/lib/sms_sender.rb

@@ -0,0 +1,16 @@
+module SmsSender
+
+  def create_sms_sender
+    if Rails.env == "test"
+      TestSender.new
+    else
+      SmsApiSender.new logger
+    end
+  end
+
+end
+
+require "message"
+require "test_sender"
+require "sms_api_sender"
+require "action_controller_ext"

data/lib/test_sender.rb

@@ -0,0 +1,50 @@
+module SmsSender
+
+  class TestSender
+
+    @@sent_messages = []
+
+    def send_sms message
+      @@sent_messages << message
+    end
+
+    def self.sent? message
+      @@sent_messages.include? message
+    end
+
+    def self.sent_count
+      @@sent_messages.size
+    end
+
+    def self.clear
+      @@sent_messages = []
+    end
+
+  end
+
+end
+
+module Test
+
+  module Unit
+
+    module Assertions
+
+      def assert_sms_sent telephone, text
+        msg = SmsSender::Message.new(telephone, text)
+        sent = SmsSender::TestSender.sent?(msg)
+        SmsSender::TestSender.clear
+        assert(sent, "Message #{msg} should be sent, but it was not sent.")
+      end
+
+      def assert_no_sms_sent
+        c = SmsSender::TestSender.sent_count
+        SmsSender::TestSender.clear
+        assert(c == 0, "No messages should be sent, but #{c} messages was sent")
+      end
+
+    end
+
+  end
+
+end

data/test/sms_sender_test.rb

@@ -0,0 +1,8 @@
+require 'test_helper'
+
+class SmsSenderTest < ActiveSupport::TestCase
+  # Replace this with your real tests.
+  test "the truth" do
+    assert true
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'rubygems'
+require 'test/unit'
+require 'active_support'

data/uninstall.rb

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

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification 
+name: sms_sender
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.3
+platform: ruby
+authors: 
+- Maciej Zubala - RocketMind Software
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-07-18 00:00:00 +02:00
+default_executable: 
+dependencies: []
+
+description: 
+email: maciej.zubala@rocketmind.pl
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+files: 
+- init.rb
+- install.rb
+- MIT-LICENSE
+- Rakefile
+- README
+- uninstall.rb
+- lib/action_controller_ext.rb
+- lib/message.rb
+- lib/sms_api_sender.rb
+- lib/sms_sender.rb
+- lib/test_sender.rb
+- test/sms_sender_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: https://github.com/mzubala/sms_sender
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.5.0
+signing_key: 
+specification_version: 3
+summary: Sends sms messages using http://smsapi.pl
+test_files: []
+