ifree-sms 0.1.0

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2010-2011 Aimbulance.
+
+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,57 @@
+= IfreeSms
+
+The IfreeSms gem for i-free sms provider
+
+== Install
+  
+  gem 'ifree-sms'
+
+  rails generate ifree_sms:install
+  
+== Usage
+
+Use middleware with options:
+
+  config.app_middleware.use IfreeSms::Manager do |c|
+    c.routes = "/ifree/sms"
+  end
+
+Initialize IfreeSms and set its configurations.
+  
+  # config/initializers/ifree_sms.rb
+  if Object.const_defined?("IfreeSms")
+      
+    IfreeSms.setup do |config|
+      config.secret_key = ""
+      config.project_name = ""
+      config.service_number = ""
+      config.debug = true
+    end
+    
+    IfreeSms::Manager.incoming_message do |env, message|  
+      # set it if you want to send answer for user
+      message.answer_text = "put here sms answer for user"
+    end
+  end
+  
+Send sms answer to user (asynchronous)
+  
+ * phone format => 380971606179
+ * text length => 160 Latin or 70 Unicode
+ * sms_id - unique sms id
+  
+  IfreeSms.send_sms(phone, text, sms_id)
+  
+or
+
+  IfreeSms::Message.first.send_answer("some text")
+  
+If you want to send sms to custom user, don't put sms_id (Paid action)
+  
+  IfreeSms.send_sms(phone, text)
+  
+== Dependences
+
+* {curb}[https://github.com/taf2/curb]
+  
+  sudo apt-get install libcurl3 libcurl3-gnutls libcurl4-openssl-dev

data/Rakefile

@@ -0,0 +1,44 @@
+# encoding: utf-8
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+require File.join(File.dirname(__FILE__), 'lib', 'ifree_sms', 'version')
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the ifree_sms 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 ifree_sms plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'IfreeSms'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |s|
+    s.name = "ifree-sms"
+    s.version = IfreeSms::VERSION.dup
+    s.summary = "The IfreeSms gem for i-free sms provider"
+    s.description = "The IfreeSms gem for i-free sms provider"
+    s.email = "superp1987@gmail.com"
+    s.homepage = "https://github.com/superp/ifree-sms"
+    s.authors = ["Igor Galeta", "Pavlo Galeta"]
+    s.files =  FileList["[A-Z]*", "{app,lib}/**/*"] - ["Gemfile"]
+    #s.extra_rdoc_files = FileList["[A-Z]*"]
+  end
+  
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler not available. Install it with: gem install jeweler"
+end

data/app/models/ifree_sms/message.rb

@@ -0,0 +1,5 @@
+module IfreeSms
+  class Message < ::ActiveRecord::Base
+    include IfreeSms::Smsing
+  end
+end

data/lib/generators/ifree_sms/USAGE

@@ -0,0 +1,7 @@
+Usage:
+  rails generate ifree_sms:install
+
+Options:
+                 
+Example:
+  rails g ifree_sms:install

data/lib/generators/ifree_sms/install_generator.rb

@@ -0,0 +1,36 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+
+module IfreeSms
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
+      
+      desc "Create ifree_sms migration"
+      source_root File.expand_path(File.join(File.dirname(__FILE__), 'templates'))      
+      
+      # copy migration files
+      def create_migrations
+        migration_template "migrate/create_messages.rb", File.join('db/migrate', "ifree_sms_create_messages.rb")
+      end
+      
+      # copy configurations
+      def copy_configurations
+        copy_file('config/ifree_sms.rb', 'config/initializers/ifree_sms.rb')
+      end
+      
+      def self.next_migration_number(dirname)
+        if ActiveRecord::Base.timestamped_migrations
+          current_time.utc.strftime("%Y%m%d%H%M%S")
+        else
+          "%.3d" % (current_migration_number(dirname) + 1)
+        end
+      end
+      
+      def self.current_time
+        @current_time ||= Time.now
+        @current_time += 1.minute
+      end
+    end
+  end
+end

data/lib/generators/ifree_sms/templates/config/ifree_sms.rb

@@ -0,0 +1,15 @@
+# config/initializers/ifree_sms.rb
+if Object.const_defined?("IfreeSms")
+
+  IfreeSms.setup do |config|
+    config.secret_key = ""
+    config.project_name = ""
+    config.service_number = ""
+    config.debug = true
+  end
+
+  IfreeSms::Manager.incoming_message do |env, message|  
+    # set it if you want to send answer for user
+    message.answer_text = "put here sms answer for user"
+  end
+end

data/lib/generators/ifree_sms/templates/migrate/create_messages.rb

@@ -0,0 +1,30 @@
+class IfreeSmsCreateMessages < ActiveRecord::Migration
+  def self.up
+    create_table :ifree_sms_messages do |t|
+      # Messageable
+      t.string  :messageable_type, :limit => 40
+      t.integer :messageable_id
+      
+      # Sms info
+      t.integer  :sms_id
+      t.integer  :phone, :limit => 8
+      t.integer  :service_number
+      t.string   :sms_text
+      t.datetime :now
+      
+      t.integer :status_id, :limit => 1, :default => 1
+		  
+      t.timestamps
+    end
+
+    add_index :ifree_sms_messages, [:messageable_type, :messageable_id]
+    add_index :ifree_sms_messages, :sms_id
+    add_index :ifree_sms_messages, :phone
+    add_index :ifree_sms_messages, :service_number
+    add_index :ifree_sms_messages, :status_id
+  end
+
+  def self.down
+    drop_table :ifree_sms_messages
+  end
+end

data/lib/ifree-sms.rb

@@ -0,0 +1 @@
+require 'ifree_sms'

data/lib/ifree_sms/callbacks.rb

@@ -0,0 +1,33 @@
+# encoding: utf-8
+module IfreeSms
+  module Callbacks
+    # Hook to _run_callbacks asserting for conditions.
+    def _run_callbacks(kind, *args) #:nodoc:
+      options = args.last # Last callback arg MUST be a Hash
+
+      send("_#{kind}").each do |callback, conditions|
+        invalid = conditions.find do |key, value|
+          value.is_a?(Array) ? !value.include?(options[key]) : (value != options[key])
+        end
+
+        callback.call(*args) unless invalid
+      end
+    end
+    
+    # A callback that runs after message created
+    # Example:
+    #   IfreeSms::Manager.incoming_message do |env, opts|
+    #   end
+    #
+    def incoming_message(options = {}, method = :push, &block)
+      raise BlockNotGiven unless block_given?
+      _incoming_message.send(method, [block, options])
+    end
+    
+    # Provides access to the callback array for incoming_message
+    # :api: private
+    def _incoming_message
+      @_incoming_message ||= []
+    end
+  end
+end

data/lib/ifree_sms/config.rb

@@ -0,0 +1,43 @@
+# encoding: utf-8
+module IfreeSms
+  class Config < Hash
+    # Creates an accessor that simply sets and reads a key in the hash:
+    #
+    # class Config < Hash
+    #   hash_accessor :routes, :secret_key, :service_number, :project_name
+    # end
+    #
+    # config = Config.new
+    # config.routes = '/posts/message'
+    # config[:routes] #=> '/posts/message'
+    #
+    def self.hash_accessor(*names) #:nodoc:
+      names.each do |name|
+        class_eval <<-METHOD, __FILE__, __LINE__ + 1
+          def #{name}
+            self[:#{name}]
+          end
+
+          def #{name}=(value)
+            self[:#{name}] = value
+          end
+        METHOD
+      end
+    end
+    
+    hash_accessor :routes, :secret_key, :service_number, :project_name, :debug
+    
+    def initialize(other={})
+      merge!(other)
+      self[:routes] ||= "/ifree/sms"
+      self[:secret_key] ||= "some_very_secret_key_given_ifree"
+      self[:service_number] ||= "some_service_number"
+      self[:project_name] ||= "project_name"
+      self[:debug] ||= false
+    end
+    
+    def url
+      "http://srv1.com.ua/#{self[:project_name]}/second.php"
+    end
+  end
+end

data/lib/ifree_sms/engine.rb

@@ -0,0 +1,9 @@
+# encoding: utf-8
+require 'rails'
+require 'ifree_sms'
+
+module IfreeSms
+  class Engine < ::Rails::Engine
+    
+  end
+end

data/lib/ifree_sms/manager.rb

@@ -0,0 +1,54 @@
+# encoding: utf-8
+module IfreeSms
+  class Manager
+    extend IfreeSms::Callbacks
+    
+    attr_accessor :config
+    
+    # Initialize the middleware. If a block is given, a IfreeSms::Config is yielded so you can properly
+    # configure the IfreeSms::Manager.
+    def initialize(app, options={})
+      options.symbolize_keys!
+
+      @app, @config = app, IfreeSms::Config.new(options)
+      yield @config if block_given?
+      self
+    end
+    
+    def call(env) # :nodoc:      
+      if smsing_path?(env['PATH_INFO'])
+        create(env)
+      else
+        @app.call(env)
+      end
+    end
+    
+    # :api: private
+    def _run_callbacks(*args) #:nodoc:
+      self.class._run_callbacks(*args)
+    end
+    
+    protected
+      
+      def create(env, body = '', status = 500)
+        request = Rack::Request.new(env)
+        message = IfreeSms::Message.new(:request => request)
+        
+        unless message.test?          
+          _run_callbacks(:incoming_message, env, message) if message.save
+          
+          body, status = message.response_to_ifree
+        else
+          body, status = [message.test_to_ifree, 200]
+        end
+        
+        [status, {'Content-Type' => 'application/xml', 'Content-Length' => body.size.to_s}, body]
+      end
+      
+      def smsing_path?(request_path)
+        return false if @config.routes.nil?
+
+        @config.routes == request_path
+      end
+  end
+end

data/lib/ifree_sms/smsing.rb

@@ -0,0 +1,109 @@
+# encoding: utf-8
+require "base64"
+
+module IfreeSms
+  module Smsing
+    def self.included(base)
+      base.send :include, InstanceMethods
+      base.send :extend,  ClassMethods
+    end
+    
+    module ClassMethods
+      def self.extended(base)
+        base.class_eval do
+          # Associations
+          belongs_to :messageable, :polymorphic => true
+          
+          # Validations
+          validates :sms_id, :phone, :service_number, :sms_text, :now, :presence => true
+          validate :check_secret_key
+
+          attr_accessible :request
+          attr_accessor :md5key, :test, :answer_text
+          
+          scope :with_messageable, lambda { |record| where(["messageable_id = ? AND messageable_type = ?", record.id, record.class.name]) }
+        end
+      end
+    end
+    
+    module InstanceMethods
+      
+      def request
+        @request
+      end
+      
+      def request=(req)
+        self.sms_id = req.params["smsId"].to_i
+        self.phone = req.params["phone"].to_i
+        self.service_number = req.params["serviceNumber"].to_i
+        self.encoded_sms_text = req.params["smsText"]
+        self.now = parse_date(req.params["now"])
+        self.md5key = req.params["md5key"]
+        self.test = req.params["test"]
+        
+        @request = req
+      end
+      
+      def encoded_sms_text
+        @encoded_sms_text
+      end
+      
+      def encoded_sms_text=(value)
+        self.sms_text = Base64.decode64(value) unless value.blank? 
+        @encoded_sms_text = value
+      end
+      
+      def to_ifree    
+        if self.answer_text.blank?
+          "<Response noresponse='true'/>"
+        else
+          "<Response><SmsText>#{self.answer_text}</SmsText></Response>"
+        end   
+      end
+      
+      def test_to_ifree
+        "<Response><SmsText>#{self.test}</SmsText></Response>"
+      end
+      
+      def response_to_ifree
+        unless self.new_record?
+          [self.to_ifree, 200]
+        else  
+          [self.errors.to_xml, 422]
+        end
+      end
+      
+      def test?
+        !self.test.blank?
+      end
+      
+      def send_answer(text)
+        IfreeSms.send_sms(self.phone, text, self.sms_id)
+      end 
+      
+      protected
+        
+        def check_secret_key
+          errors.add(:md5key, :invalid) unless valid_secret?
+        end
+        
+        def valid_secret?          
+          return false if now.nil?
+          
+          digest = IfreeSms.calc_digest(service_number, encoded_sms_text, now.utc.strftime("%Y%m%d%H%M%S"))
+          
+          IfreeSms.log("md5key: #{md5key}, calc_digest: #{digest}")
+          
+          self.md5key == digest
+        end
+        
+        def parse_date(value)
+          begin
+            DateTime.strptime(value, "%Y%m%d%H%M%S")
+          rescue Exception => e
+            nil
+          end
+        end
+    end
+  end
+end

data/lib/ifree_sms/version.rb

@@ -0,0 +1,4 @@
+# encoding: utf-8
+module IfreeSms
+  VERSION = "0.1.0".freeze
+end

data/lib/ifree_sms.rb

@@ -0,0 +1,68 @@
+# encoding: utf-8
+require "curb"
+require "base64"
+require 'digest/md5'
+
+module IfreeSms
+  autoload :Smsing,    'ifree_sms/smsing'
+  autoload :Manager,   'ifree_sms/manager'
+  autoload :Config,    'ifree_sms/config'
+  autoload :Callbacks, 'ifree_sms/callbacks'
+  
+  mattr_accessor :config
+  @@config = Config.new
+  
+  def self.setup(&block)
+    yield config
+  end
+  
+  def self.log(message)
+    if IfreeSms.config.debug
+      Rails.logger.info("[IfreeSms] #{message}")
+    end
+  end
+  
+  def self.table_name_prefix
+    'ifree_sms_'
+  end
+ 
+  # Send sms message
+  # Sample request:
+  # http://srv1.com.ua/mcdonalds/second.php?smsId=noID&phone=380971606179&serviceNumber=3533&smsText=test-message&md5key=f920c72547012ece62861938b7731415&now=20110527160613
+  #
+  def self.send_sms(phone, text, sms_id='noID')
+    now = Time.now.utc.strftime("%Y%m%d%H%M%S")
+    
+    params = {}
+    params[:smsId] = sms_id
+    params[:phone] = phone
+    params[:serviceNumber] = config.service_number
+    params[:smsText] = Base64.encode64(text)
+    params[:now] = now
+    params[:md5key] = calc_digest(config.service_number, params[:smsText], now)
+    
+    get(params)
+  end
+  
+  def self.get(params)
+    query = Rack::Utils.build_query(params)
+    url = [config.url, query].join('?')
+    
+    log("request: #{url}")
+    
+    http = Curl::Easy.new(url)
+    http.perform
+    
+    log("response: #{http.body_str}")
+    
+    http.body_str
+  end
+  
+  def self.calc_digest(number, text, now)
+    log("service_number: #{number}, sms_text: #{text}, now: #{now}, secret: #{config.secret_key}")
+    
+    Digest::MD5.hexdigest([number, text, config.secret_key, now].map(&:to_s).join)
+  end
+end
+
+require 'ifree_sms/engine' if defined?(Rails)

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification 
+name: ifree-sms
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Igor Galeta
+- Pavlo Galeta
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-06-08 00:00:00 +03:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 29
+        segments: 
+        - 0
+        - 7
+        - 15
+        version: 0.7.15
+  name: curb
+  version_requirements: *id001
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 1
+        - 4
+        - 4
+        version: 1.4.4
+  name: nokogiri
+  version_requirements: *id002
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: activemodel
+  version_requirements: *id003
+  prerelease: false
+description: The IfreeSms gem for i-free sms provider
+email: superp1987@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- LICENSE
+- README.rdoc
+- Rakefile
+- app/models/ifree_sms/message.rb
+- lib/generators/ifree_sms/USAGE
+- lib/generators/ifree_sms/install_generator.rb
+- lib/generators/ifree_sms/templates/config/ifree_sms.rb
+- lib/generators/ifree_sms/templates/migrate/create_messages.rb
+- lib/ifree-sms.rb
+- lib/ifree_sms.rb
+- lib/ifree_sms/callbacks.rb
+- lib/ifree_sms/config.rb
+- lib/ifree_sms/engine.rb
+- lib/ifree_sms/manager.rb
+- lib/ifree_sms/smsing.rb
+- lib/ifree_sms/version.rb
+has_rdoc: true
+homepage: https://github.com/superp/ifree-sms
+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.6.2
+signing_key: 
+specification_version: 3
+summary: The IfreeSms gem for i-free sms provider
+test_files: []
+