smster 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 715e7236f095993ddfa89768a85a791ae4c0efd8
+  data.tar.gz: dd512320a0ffc07130b56771512cab7f9d86d410
+SHA512:
+  metadata.gz: 733d1fc0f88b29bb49fc5ae099142bb03c9cf07a03a23eaaabcbd8be8b8f807d98cb96906dfd3dea633849fb54be15e34783fc78043439d28871faf2c2a686fd
+  data.tar.gz: f46599540651ddb19bfdf1fe08ea7fd875b4791cbb743271f0dfe5d11020ae0a27cd8d38d5796c0b17d70d103773555e4115e131479c62b531bf23c4b65c3d49

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2015 doniv
+
+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,32 @@
+= Smster
+SMS sending service through different providers with maximum convenience.
+
+===== Supported
+* {Nexmo}[https://www.nexmo.com/]
+* {Clickatell}[https://www.clickatell.com/] 
+
+== Setup
+Add gem:
+  gem 'smster', git: 'git@github.com:IlyaDonskikh/smster.git'
+  
+Install:
+  rails g smster:install
+
+== Sending message
+Add config of your provider into config/initializers/smster.rb.
+
+And let's start!
+  Sms::Nexmo.create(text: 'sms text', to: phone_number)
+  Sms::Clickatell.create(text: 'sms text', to: phone_number)
+  
+== Callbacks
+Add to routes, setup proveder callbacks and get sms statuses:
+  post 'smster/$provider_name/callback'
+  
+== Feedback
+Please use the {issue tracker}[https://github.com/IlyaDonskikh/smster/issues].
+
+== Thanks
+1. Mickhail Zelenin for the idea for this gem.
+2. Egor Kiselev for help in creation of this manual.
+3. Alexey Bandar for the recommendation of the first provider.

data/Rakefile

@@ -0,0 +1,34 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Smster'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/app/controllers/smster/clickatell_controller.rb

@@ -0,0 +1,22 @@
+class Smster::ClickatellController < ApplicationController
+  skip_before_filter :verify_authenticity_token
+
+  def callback
+    code = clickatell_params[:apiMessageId]
+    description = clickatell_params[:description]
+    sms = Sms::Clickatell.find_by!(code: code)
+
+    sms.status_message = description
+    sms.save
+
+    sms.accept! if description == 'Received by recipient'
+    result = { sms.id => sms.status }
+
+    render json: result.as_json, status: 200
+  end
+
+  private
+    def clickatell_params
+      params.require(:data)
+    end
+end

data/app/controllers/smster/nexmo_controller.rb

@@ -0,0 +1,17 @@
+class Smster::NexmoController < ApplicationController
+  skip_before_filter :verify_authenticity_token
+
+  def callback
+    code = params['messageId']
+    status = params['status']
+    sms = Sms::Nexmo.find_by!(code: code)
+
+    sms.status_message = status
+    sms.save
+
+    sms.accept! if status == 'delivered'
+    result = { sms.id => sms.status }
+
+    render json: result.as_json, status: 200
+  end
+end

data/lib/generators/smster/install/templates/create_smsters.rb

@@ -0,0 +1,20 @@
+class CreateSmsters< ActiveRecord::Migration
+  def up
+    create_table :smsters do |t|
+      t.string :text
+      t.string :name
+      t.string :from
+      t.string :to
+      t.string :code
+      t.string :type
+      t.integer :status
+      t.string :status_message
+
+      t.timestamps
+    end
+  end
+
+  def down
+    drop_table :smsters
+  end
+end

data/lib/generators/smster/install/templates/smster.rb

@@ -0,0 +1,8 @@
+Smster.configure do |config|
+  ## Nexmo
+  config.nexmo_key = ""
+  config.nexmo_sekret = ""
+
+  ## Clickatell
+  config.clickatell_authorization_code = ""
+end

data/lib/generators/smster/install_generator.rb

@@ -0,0 +1,38 @@
+require 'rails/generators'
+module Smster
+  class InstallGenerator < Rails::Generators::Base
+    desc "Add migration"
+    include Rails::Generators::Migration
+    source_root File.expand_path('../install/templates', __FILE__)
+
+    def copy_migrations
+      copy_migration "create_smsters"
+    end
+
+    def self.next_migration_number(path)
+      unless @prev_migration_nr
+        @prev_migration_nr = Time.now.utc.strftime("%Y%m%d%H%M%S").to_i
+      else
+        @prev_migration_nr += 1
+      end
+      @prev_migration_nr.to_s
+    end
+
+    desc 'Add initializer'
+    source_root File.expand_path('../install/templates', __FILE__)
+
+    def copy_initializer
+      filename = 'smster'
+      copy_file "#{filename}.rb", "config/initializers/#{filename}.rb"
+    end
+
+    protected
+      def copy_migration(filename)
+        if self.class.migration_exists?("db/migrate", "#{filename}")
+          say_status("skipped", "Migration #{filename}.rb already exists")
+        else
+          migration_template "#{filename}.rb", "db/migrate/#{filename}.rb"
+        end
+      end
+  end
+end

data/lib/smster.rb

@@ -0,0 +1,21 @@
+require 'rest_client'
+require "smster/configuration"
+require 'smster/sms'
+require 'smster/sms/clickatell'
+require 'smster/sms/nexmo'
+
+module Smster
+  class Engine < Rails::Engine; end
+  
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+end

data/lib/smster/configuration.rb

@@ -0,0 +1,11 @@
+module Smster
+  class Configuration
+    attr_accessor :nexmo_key, :nexmo_sekret, :clickatell_authorization_code
+
+    def initialize
+      @nexmo_key = ""
+      @nexmo_sekret = ""
+      @clickatell_authorization_code = ""
+    end
+  end
+end

data/lib/smster/sms.rb

@@ -0,0 +1,32 @@
+class Sms < ActiveRecord::Base
+  self.table_name = "smsters"
+  attr_accessor :mode
+
+  ## Codes
+  STATUS_CODES = { created: 0, sent: 1, delivered: 2, failed: 3 }
+
+  ## Callbacks
+  after_create :send_sms
+
+  ## Validations
+  validates :type, :to, :text, presence: true
+
+  ## Etc.
+  def initialize(attributes = {})
+    attr_with_defaults = {
+      status: STATUS_CODES[:created]
+    }.merge(attributes)
+    super(attr_with_defaults)
+  end
+
+  def mode
+    @mode ||= case Rails.env
+    when 'test' then 'test'
+    else 'production'
+    end
+  end
+
+  def accept!
+    self.update(status: STATUS_CODES[:delivered])
+  end
+end

data/lib/smster/sms/clickatell.rb

@@ -0,0 +1,34 @@
+class Sms::Clickatell < Sms
+  def send_sms
+    config = Smster.configuration
+    authorization_code = config.clickatell_authorization_code
+
+    text = self.text.tr(" ", "+")
+    phone = to.gsub(/\D/, '') 
+
+    api_message_id = if self.mode == 'test'
+      logger.debug("Mode: #{mode}. To: #{phone}, text: #{text}")
+      self.id
+    else
+      response = RestClient.post('https://api.clickatell.com/rest/message',
+        { "text" => text, "to" => [phone.to_s] }.to_json, 
+        :content_type => :json, 
+        :accept => :json, 
+        'X-Version' => 1, 
+        'Authorization' => "bearer #{authorization_code}")
+      response = JSON.parse(response)
+      response['data']['message'][0]['apiMessageId']
+    end
+
+    if api_message_id.present?
+      self.code = api_message_id
+      self.status = STATUS_CODES[:sent]
+      self.save
+    end
+  rescue => e
+    logger.debug("Error #{e}")
+    self.status = STATUS_CODES[:failed]
+    self.status_message = e.to_s
+    self.save
+  end
+end

data/lib/smster/sms/nexmo.rb

@@ -0,0 +1,45 @@
+class Sms::Nexmo < Sms
+  def send_sms
+    config = Smster.configuration
+    api_key = config.nexmo_key
+    api_secret = config.nexmo_sekret
+
+    text = self.text.tr(" ", "+")
+    phone = to.gsub(/\D/, '') 
+    current_status = STATUS_CODES[:sent]
+
+    api_message_id = if self.mode == 'test'
+      logger.debug("Mode: #{mode}. To: #{phone}, text: #{text}")
+      self.id
+    else
+      response = RestClient.post('https://rest.nexmo.com/sms/json', 
+        "text" => text, 
+        "to" => phone.to_s, 
+        :content_type => :json,
+        :from => 'OnlinePay',
+        :api_key => api_key,
+        :api_secret => api_secret)
+
+      json_response = JSON.parse(response)
+      error_text = json_response['messages'][0]['error-text']
+      json_response['messages'][0]['message-id']
+    end
+
+    if api_message_id.present?
+      self.code = api_message_id
+      self.status = STATUS_CODES[:sent]
+    end
+
+    if error_text.present?
+      self.status = STATUS_CODES[:failed]
+      self.status_message = error_text
+    end
+
+    self.save
+  rescue => e
+    logger.debug("Error #{e}")
+    self.status = STATUS_CODES[:failed]
+    self.status_message = e.to_s
+    self.save
+  end
+end

data/lib/smster/version.rb

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

data/lib/tasks/smster_tasks.rake

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

data/test/controller/smster/clickatell_controller_test.rb

@@ -0,0 +1,27 @@
+require 'test_helper'
+
+class Smster::ClickatellControllerTest < ActionController::TestCase
+  def setup
+    @text = "simple text"
+    @number = (0...7).map { (1..9).to_a.sample }.join  
+    @provider = Sms::Clickatell
+  end
+
+  test 'callback' do
+    delivered_code = Sms::STATUS_CODES[:delivered]
+    sms = @provider.create(text: @text, to: @number)
+
+    post :callback, { 
+      "data" =>  {
+        "charge" => 1.5,
+        "messageStatus" => 003,
+        "description" => "Received by recipient",
+        "apiMessageId" => sms.code
+      }
+    }
+
+    response = JSON.parse(@response.body)
+    result = { sms.id => delivered_code }
+    assert_equal result.as_json, response
+  end
+end

data/test/controller/smster/nexmo_controller_test.rb

@@ -0,0 +1,19 @@
+require 'test_helper'
+
+class Smster::NexmoControllerTest < ActionController::TestCase
+  def setup
+    @text = "simple text"
+    @number = (0...7).map { (1..9).to_a.sample }.join  
+    @provider = Sms::Nexmo
+  end
+
+  test 'callback' do
+    delivered_code = Sms::STATUS_CODES[:delivered]
+    sms = @provider.create(text: @text, to: @number)
+
+    post :callback, { "messageId" => sms.code, "status" => 'delivered' }
+    response = JSON.parse(@response.body)
+    result = { sms.id => delivered_code }
+    assert_equal result.as_json, response
+  end
+end

data/test/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.