kannel_rails 0.0.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2012 YOURNAME
+
+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,67 @@
+## KannelRails
+
+KannelRails is a Rails engine that allows you to easily integrate with Kannel smsbox via HTTP to send and receive SMS
+
+### Installing
+
+Just add KannelRails to your Gemfile:
+
+```ruby
+  gem 'kannel_rails'
+```
+
+KannelRails is tested on Rails 3.2. It might work for Rails 3.0 and up.
+
+### Configuration
+
+In your Rails app, add a configuration file: config/kannel_rails.yml
+
+Sample content:
+
+```yaml
+development:
+  kannel_url: http://kannel_server:13013 # Kannel smsbox sendsms-port
+  username: username # Kannel sendsms-user username
+  password: password # Kannel sendsms-user password
+  api_secret: testing # A secret key you will also configure in Kannel for extra security
+```
+
+In config/routes.rb, add:
+
+```ruby
+mount KannelRails::Engine => '/sms'
+```
+
+In your Kannel config, configure your sms-service like so:
+
+```
+group = sms-service
+omit-empty = true
+get-url = "http://rails_app/sms/receive_message?api_secret=api_secret_you_set_in_kannel_rails_yml&from=%p&text=%a"
+```
+
+You can change the mount point of the rails engine to anything you want but make sure you also change the kannel get-url
+
+### Sending SMS
+
+Sending an SMS is as simple as:
+
+```ruby
+KannelRails.send_message("+639001234567", "Hello World!")
+```
+
+### Receiving SMS
+
+To handle incoming SMS, create handler classes and register them.
+
+Classes have an invoke method which is called when handle? is true
+
+The return value of invoke will be the response to Kannel, which will be sent back to the sender as SMS. omit-empty is set in the sms-service so that empty strings will not be sent back.
+
+Sample handler is in spec/dummy/lib/echo_handler.rb
+
+Register the handler class in config/initializers/sms_handlers.rb (or some other place if you want):
+
+```ruby
+KannelRails::Handlers.register HandlerClass
+```

data/Rakefile

@@ -0,0 +1,27 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'KannelRails'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+Bundler::GemHelper.install_tasks
+

data/app/assets/javascripts/kannel_rails/application.js

@@ -0,0 +1,15 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// the compiled file.
+//
+// WARNING: THE FIRST BLANK LINE MARKS THE END OF WHAT'S TO BE PROCESSED, ANY BLANK LINE SHOULD
+// GO AFTER THE REQUIRES BELOW.
+//
+//= require jquery
+//= require jquery_ujs
+//= require_tree .

data/app/assets/stylesheets/kannel_rails/application.css

@@ -0,0 +1,13 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+ */

data/app/controllers/kannel_rails/application_controller.rb

@@ -0,0 +1,4 @@
+module KannelRails
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/controllers/kannel_rails/sms_controller.rb

@@ -0,0 +1,24 @@
+module KannelRails
+  class SmsController < ApplicationController
+
+    def receive_message
+      if KannelRails.config.api_secret and KannelRails.config.api_secret != params[:api_secret]
+        render :status => :forbidden, :text => "Unauthorized Request"
+      else
+        reply = ""
+
+        KannelRails::Handlers.each do |handler_class|
+          handler = handler_class.new(params[:from], params[:text])
+
+          if handler.handle?
+            reply = handler.invoke
+            break
+          end
+        end
+
+        render :text => reply
+      end
+    end
+
+  end
+end

data/app/helpers/kannel_rails/application_helper.rb

@@ -0,0 +1,4 @@
+module KannelRails
+  module ApplicationHelper
+  end
+end

data/app/views/layouts/kannel_rails/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>KannelRails</title>
+  <%= stylesheet_link_tag    "kannel_rails/application", :media => "all" %>
+  <%= javascript_include_tag "kannel_rails/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/routes.rb

@@ -0,0 +1,5 @@
+KannelRails::Engine.routes.draw do
+
+  match 'receive_message' => 'sms#receive_message'
+
+end

data/lib/kannel_rails.rb

@@ -0,0 +1,35 @@
+require "kannel_rails/engine"
+require "kannel_rails/config"
+require "kannel_rails/handlers"
+require "kannel_rails/handlers/base"
+require "net/http"
+
+module KannelRails
+
+  def self.send_message(recipient, message)
+    request_url = config.kannel_url.chomp('/') + "/cgi-bin/sendsms?" +
+                  "username=#{CGI.escape(config.username.to_s)}&password=#{CGI.escape(config.password.to_s)}" +
+                  "&to=#{CGI.escape(recipient.to_s)}&text=#{CGI.escape(message.to_s)}"
+
+    response = Net::HTTP.get_response(URI.parse(
+      request_url
+    ))
+
+    response.is_a? Net::HTTPSuccess
+  end
+
+  def self.config
+    unless defined?(@config)
+      config_file = YAML.load_file(File.join(Rails.root, 'config/kannel_rails.yml'))
+
+      if config_file[Rails.env]
+        @config = KannelRails::Config.new(config_file[Rails.env])
+      else
+        raise "Missing section #{Rails.env} in config/kannel_rails.yml!"
+      end
+    end
+
+    return @config
+  end
+
+end

data/lib/kannel_rails/config.rb

@@ -0,0 +1,17 @@
+class KannelRails::Config
+
+  attr_accessor :kannel_url
+  attr_accessor :username
+  attr_accessor :password
+  attr_accessor :dlr_url
+  attr_accessor :api_secret
+
+  def initialize(config_hash = {})
+    self.kannel_url = config_hash['kannel_url']
+    self.username = config_hash['username']
+    self.password = config_hash['password']
+    self.dlr_url = config_hash['dlr_url']
+    self.api_secret = config_hash['api_secret']
+  end
+
+end

data/lib/kannel_rails/engine.rb

@@ -0,0 +1,5 @@
+module KannelRails
+  class Engine < ::Rails::Engine
+    isolate_namespace KannelRails
+  end
+end

data/lib/kannel_rails/handlers.rb

@@ -0,0 +1,13 @@
+module KannelRails::Handlers
+
+  @handlers = []
+
+  def self.register(handler_class)
+    @handlers << handler_class
+  end
+
+  def self.each(&block)
+    @handlers.each(&block)
+  end
+
+end

data/lib/kannel_rails/handlers/base.rb

@@ -0,0 +1,18 @@
+class KannelRails::Handlers::Base
+
+  attr_accessor :sender, :message
+
+  def initialize(sender, message)
+    self.sender = sender
+    self.message = message
+  end
+
+  def handle?
+    raise "Please override this method!"
+  end
+
+  def invoke
+    raise "Please override this method!"
+  end
+
+end

data/lib/kannel_rails/version.rb

@@ -0,0 +1,3 @@
+module KannelRails
+  VERSION = "0.0.1"
+end

data/lib/tasks/kannel_rails_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :kannel_rails do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: kannel_rails
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Heinrich Lee Yu
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-09-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: &69194230 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.8
+  type: :runtime
+  prerelease: false
+  version_requirements: *69194230
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: &69193660 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *69193660
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: &69193370 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *69193370
+description: Kannel integration for Rails
+email:
+- hleeyu@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- app/controllers/kannel_rails/application_controller.rb
+- app/controllers/kannel_rails/sms_controller.rb
+- app/helpers/kannel_rails/application_helper.rb
+- app/assets/javascripts/kannel_rails/application.js
+- app/assets/stylesheets/kannel_rails/application.css
+- app/views/layouts/kannel_rails/application.html.erb
+- config/routes.rb
+- lib/tasks/kannel_rails_tasks.rake
+- lib/kannel_rails/handlers/base.rb
+- lib/kannel_rails/engine.rb
+- lib/kannel_rails/handlers.rb
+- lib/kannel_rails/config.rb
+- lib/kannel_rails/version.rb
+- lib/kannel_rails.rb
+- MIT-LICENSE
+- Rakefile
+- README.md
+homepage: 
+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'
+      segments:
+      - 0
+      hash: 567176499
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 567176499
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Kannel integration for Rails
+test_files: []