short_message 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8c279adb74034281791d363ed71482435e27abc7
-  data.tar.gz: 3fdecf7b086165361a255c65448bf0bee39d7814
+  metadata.gz: d987538fe6cd5c550bbf3612cae44a45fb4a08e7
+  data.tar.gz: 1335ad39e09979ccaae3097cb02f7f48620d6489
 SHA512:
-  metadata.gz: a28908e48e31fcc3c04681a60a9ef042a475964866f99317478de60bb73070fe5b4f93696dcc2e499b5cf57f05b1abf8074f977f6e82b240cf1b3066e3f38ae7
-  data.tar.gz: 5857e907d60d7d9a213c80ffa1088e8c08c59f49a5cd8e66e35f743506e70b501295e1752128029e240b135b707155fd21e0fea52bbe5302cf741dc4556dfbcb
+  metadata.gz: 6f5d5d95c78f15da9a21db1cc6f07e26d872d426421829840fe289704c6500f8a3fa8df7be917f92b35d3b090711b4edebf26486d106e3a8ae2f3ca4e857aad4
+  data.tar.gz: de7b38d19b85bf706d3010233aa5efccd63ba392e81406996382f909d824b0e079092f5fdd812173bd47e14aaa4a0f0dc04a0fce16f6cc6125c18cbfe26eab1c

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright 2013 YOURNAME
+Copyright 2016 Andi Saurer
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -1,8 +1,8 @@
-# ShortMessage #
+# ShortMessage
 
 [![Gem Version](https://badge.fury.io/rb/short_message.png)](http://badge.fury.io/rb/short_message)
 
-## Installation ##
+## Installation
 
 Add it to your Gemfile:
 
@@ -22,30 +22,38 @@ Run the generator:
 rails generate short_message:install
 ```
 
-And rake the migrations:
+And run the migrations:
+
 ```console
 rake db:migrate
 ```
-## Usage ##
+
+## Usage
 
 Create a message and deliver it:
+
 ```ruby
-@sms = ShortMessage::Message.new(:sender => "0041791234567", :recipient => "0041799876543", :text => "Hello World!")
+@sms = ShortMessage::Message.new(sender: "0041791234567", recipient: "0041799876543", text: "Hello World!")
 @sms.deliver
 ```
-## Customization ##
-### Status Codes ##
+
+## Customization
+
+### Status Codes
+
 If you need to customize the status response codes simply edit the internationalization files in config/locales
 
-### Params ###
-To override the params string add this to an initializer file (or put it into config/initializers/short_message.rb)
+### Params
+
+To override the params string add the code below into `config/initializers/short_message.rb`:
+
 ```ruby
 ShortMessage::Message.module_eval do
   private
   def build_deliver_params_string
     # your code here
   end
-  
+
   def build_recharge_params_string amount
     # your code here
   end

data/Rakefile

@@ -1,16 +1,10 @@
-#!/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
+
+require 'rdoc/task'
 
 RDoc::Task.new(:rdoc) do |rdoc|
   rdoc.rdoc_dir = 'rdoc'
@@ -20,8 +14,24 @@ RDoc::Task.new(:rdoc) do |rdoc|
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
 
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+load 'rails/tasks/statistics.rake'
 
 
 
 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/short_message/application_controller.rb

@@ -1,4 +1,5 @@
 module ShortMessage
   class ApplicationController < ActionController::Base
+    protect_from_forgery with: :exception
   end
 end

data/app/controllers/short_message/messages_controller.rb

@@ -0,0 +1,20 @@
+require_dependency "short_message/application_controller"
+
+module ShortMessage
+  class MessagesController < ApplicationController
+    def status
+      unless params[:id].blank? or params[:status].blank?
+        if message = ShortMessage::Message.find_by(message_key: params[:id])
+          message.status_code = params[:status]
+          message.save!
+
+          render plain: "Message #{params[:id]} has now status #{params[:status]}"
+        else
+          render plain: "Message #{params[:id]} not found!", status: 404
+        end
+      else
+        render plain: "Message ID or status not provided!", status: 400
+      end
+    end
+  end
+end

data/app/mailers/application_mailer.rb

@@ -0,0 +1,3 @@
+class ApplicationMailer < ActionMailer::Base
+  default from: ShortMessage.config.default_mail_sender
+end

data/app/mailers/short_message/mailer.rb

@@ -1,21 +1,11 @@
 module ShortMessage
-  class Mailer < ActionMailer::Base
-    default from: ShortMessage.config.default_mail_sender
-
-    def recharge_notification amount
-      mail to: ShortMessage.config.reload_notification_email, :subject => "SMS credit recharged", :body => "Your SMS Account has automatically been recharged with #{amount} sms."
-    end
-
-    def voucher_notification amount
-      mail :to => ShortMessage.config.voucher_notification_email, :subject => "SMS credit recharged, please create a voucher", :body => "Please add a voucher:\r\nCustomer: #{ShortMessage.config.user_id}\r\nAmount: #{amount} sms\r\n\r\nThank you!"
-    end
-
-    def recharge_failed_notification amount, message
-      mail :to => ShortMessage.config.reload_notification_email, :subject => "SMS credit recharge failed", :body =>"SMS account could not be recharged with #{amount} sms. Error: #{body}"
+  class Mailer < ApplicationMailer
+    def error_notification message, response
+      mail to: ShortMessage.config.admin_notification_email, subject: "Error delivering SMS to #{message.recipient}", body: "SMS from #{message.sender} to #{message.recipient} could not be sent!\r\n\r\nResponse: #{response.to_yaml}"
     end
 
-    def error_notification message, response
-      mail :to => ShortMessage.config.reload_notification_email, :subject => "Error delivering SMS to #{message.recipient}", :body =>"SMS from #{message.sender} to #{message.recipient} could not be sent!\r\n\r\nResponse: #{response.to_yaml}"
+    def payment_required_notification
+      mail to: ShortMessage.config.reload_notification_email, subject: "SMS Gateway requires payment", body: "Your SMS Gateway API #{ShortMessage.config.gateway_server} requires payment!"
     end
   end
 end

data/app/models/short_message/message.rb

@@ -1,13 +1,5 @@
-require "net/http"
-
 module ShortMessage
   class Message < ActiveRecord::Base
-    attr_accessible :message_key, :recipient, :sender, :status_code, :text
-
-    def status_text
-      I18n.t("short_message.status.code_#{self.status_code}")
-    end
-
     def deliver
       self.sender = ShortMessage.config.default_sms_sender if self.sender.blank?
 
@@ -17,78 +9,52 @@ module ShortMessage
           http.use_ssl = true
           http.verify_mode = OpenSSL::SSL::VERIFY_NONE
         end
-        response, data = http.post(ShortMessage.config.send_file_path, build_deliver_params_string)
 
-        if response.code == "200"
-          # returns something like 0:200: OK (<mobilenumber>:<msgid>)
-          result_set = response.body.gsub("(","").gsub(")","").split(":")
-          self.status_code = result_set[0].to_i
-          self.message_key = result_set[3] unless result_set[3].blank?
+        response, data = http.post(ShortMessage.config.send_file_path, build_deliver_params_string)
 
-          if self.status_code == 3 and ShortMessage.config.default_reload_amount > 0
-            if self.recharge
-              self.deliver
-            else
-              self.status_code = 99
-              return false
-            end
+        if response.code == "200" or response.code == "402"
+          if response.code == "402" and not ShortMessage.config.reload_notification_email.blank?
+            ShortMessage::Mailer.payment_required_notification(self, response).deliver_now
           end
 
-          self.save
-          true
+          result_set = response.body.gsub("(","").gsub(")","").split(" ")
+          self.message_key = result_set[2] unless result_set[2].blank?
+
+          return self.save
         else
-          Mailer.error_notification(self, response).deliver unless ShortMessage.config.admin_notification_email.blank?
-          false
+          ShortMessage::Mailer.error_notification(self, response).deliver_now unless ShortMessage.config.admin_notification_email.blank?
         end
+      else
+        return false
       end
     end
 
-    def recharge amount = ShortMessage.config.default_reload_amount
-      unless ShortMessage.config.account_functions_path.blank?
-        http = Net::HTTP.new(ShortMessage.config.gateway_server)
-        response, body = http.post(ShortMessage.config.account_functions_path, build_recharge_params_string(amount))
-
-        if response.code == "200"
-          # returns something like 0:Successful
-          result_set = response.body.split(":")
+    def recharge
+      raise "NOT YET IMPLEMENTED"
+    end
 
-          if result_set[0].to_i == 0
-            logger.info "SMS account successfully charged with #{amount} sms."
-            Mailer.recharge_notification(amount).deliver unless ShortMessage.config.reload_notification_email.blank?
-            Mailer.voucher_notification(amount).deliver unless ShortMessage.config.voucher_notification_email.blank?
-            true
-          else
-            logger.warn "SMS account could not be recharged with #{amount} sms. Error: #{body}"
-            Mailer.recharge_failed_notification(amount, body).deliver unless ShortMessage.config.reload_notification_email.blank?
-            false
-          end
-        else
-          "#{response.code} #{response.message}"
-        end
-      end
+    def status_text
+      I18n.t("short_message.status.code_#{self.status_code}")
     end
 
     private
     def build_deliver_params_string
       params = []
-      params << "UserID=#{ShortMessage.config.user_id}"
-      params << "CCUID=#{ShortMessage.config.ccu_id}"
-      params << "ID=#{ShortMessage.config.id_string}"
-      params << "sender=#{CGI.escape(self.sender)}"
-      params << "receipient=#{CGI.escape(self.recipient)}"
-      params << "message=#{CGI.escape(self.text)}"
-      params << "utf-8=1"
+      params << "user=#{ShortMessage.config.user}"
+      params << "pass=#{ShortMessage.config.password}"
+      params << "from=#{CGI.escape(self.sender)}"
+      params << "to=#{CGI.escape(self.recipient)}"
+      params << "text=#{CGI.escape(self.text)}"
       params.join("&")
     end
 
     def build_recharge_params_string amount
-      params = []
-      params << "UserIDFS=#{ShortMessage.config.user_id}"
-      params << "CCUID=#{ShortMessage.config.ccu_id}"
-      params << "pay=1"
-      params << "amount=#{amount}"
-      params << "idstring=#{ShortMessage.config.id_string}"
-      params.join("&")
+      raise "NOT YET IMPLEMENTED"
+      # params = []
+      # params << "user=#{ShortMessage.config.user}"
+      # params << "password=#{ShortMessage.config.password}"
+      # params << "amount=#{amount}"
+      # params.join("&")
     end
   end
 end

data/config/routes.rb

@@ -1,2 +1,6 @@
-ShortMessage::Engine.routes.draw do
+Rails.application.routes.draw do
+  namespace :short_message do
+    get 'messages/status' => "messages#status"
+    post 'messages/status' => "messages#status"
+  end
 end

data/db/migrate/20130308133457_create_short_message_messages.rb

@@ -7,7 +7,7 @@ class CreateShortMessageMessages < ActiveRecord::Migration
       t.integer :status_code
       t.text :text
 
-      t.timestamps
+      t.timestamps null: false
     end
   end
 end

data/lib/generators/short_message/templates/config/initializers/short_message.rb

@@ -1,21 +1,21 @@
 ShortMessage.configure do |config|
-  config.gateway_server = "www1.q-x.ch"
+  # Configuration example www.gtx-messaging.com
+  config.gateway_server = "http.gtx-messaging.net"
   config.gateway_port = 443
 
-  config.send_file_path = "/app/sms/gw1/cust/send.php"
-  config.account_functions_path = "/app/sms/gw1/cust/accfunc.php"
+  config.send_file_path = "/smsc.php"
+  # config.account_functions_path = ""
 
   # enter your details received from provider here
-  config.user_id = ""
-  config.ccu_id = ""
-  config.id_string = ""
+  config.user = ""
+  config.password = ""
 
-  config.default_reload_amount = 1000
+  # config.default_reload_amount = 1000
 
   config.default_mail_sender = "webmaster@your-domain.com"
-  config.reload_notification_email = "webmaster@your-domain.com"
-  config.admin_notification_email = "webmaster@your-domain.com" # set to blank to deactivate error mailing
-  config.voucher_notification_email = "give-me-money@your-domain.com" # set nil to disable voucher mailing
+  config.reload_notification_email = "webmaster@your-domain.com" # send a message if payment is required
+  config.admin_notification_email = "webmaster@your-domain.com" # set nil to deactivate error mailing
+  # config.voucher_notification_email = "give-me-money@your-domain.com" # set nil to disable voucher mailing
 
   # set a default sms sender (used if no sender is present)
   # config.default_sms_sender = ""

data/lib/generators/short_message/templates/config/locales/short_message.de.yml

@@ -1,14 +1,8 @@
 de:
   short_message:
     status:
-      code_1: "Empfänger abwesend"
-      code_3: "anerkannt"
-      code_5: "anruf blockiert"
-      code_6: "MSC Fehler"
-      code_7: "zugestellt"
-      code_18: "abgewiesen"
-      code_20: "nicht verfügbar während Roaming"
-      code_21: "unerwarteter Wert"
-      code_22: "unbekannter Abonnent"
-      code_99: "Aufladen fehlgeschlagen"
-      code_999: "unkategorisierter Status"
+      code_1: "An Telefon zugestellt"
+      code_2: "Nicht an Telefon zugestellt"
+      code_4: "Bei SMSC in Warteschlange"
+      code_8: "Zugestellt an SMSC"
+      code_16: "Nicht zugestellt an SMSC"

data/lib/generators/short_message/templates/config/locales/short_message.en.yml

@@ -1,14 +1,8 @@
 en:
   short_message:
     status:
-      code_1: "absent subscriber"
-      code_3: "accepted"
-      code_5: "call barred"
-      code_6: "controlling MSC failure"
-      code_7: "delivered"
-      code_18: "rejected by gateway"
-      code_20: "unavailable while roaming to"
-      code_21: "unexpected data value"
-      code_22: "unknown subscriber"
-      code_99: "recharge failed"
-      code_999: "uncategorized status"
+      code_1: "Delivered to phone"
+      code_2: "Not delivered to phone"
+      code_4: "Queued on SMSC"
+      code_8: "Delivered to SMSC"
+      code_16: "Not delivered to SMSC"

data/lib/short_message/config.rb

@@ -16,9 +16,8 @@ module ShortMessage
     config_accessor :send_file_path
     config_accessor :account_functions_path
 
-    config_accessor :user_id
-    config_accessor :ccu_id
-    config_accessor :id_string
+    config_accessor :user
+    config_accessor :password
 
     config_accessor :default_sms_sender
     config_accessor :default_reload_amount
@@ -31,7 +30,7 @@ module ShortMessage
       config.param_name.respond_to?(:call) ? config.param_name.call : config.param_name
     end
 
-    # define param_name writer (copied from AS::Configurable)
+    # define param_name writer
     writer, line = 'def param_name=(value); config.param_name = value; end', __LINE__
     singleton_class.class_eval writer, __FILE__, line
     class_eval writer, __FILE__, line

data/lib/short_message/engine.rb

@@ -1,14 +1,13 @@
 module ShortMessage
   class Engine < ::Rails::Engine
     isolate_namespace ShortMessage
-    
+
     initializer "short_message.migrate_database" do |app|
       Rails.application.config.paths['db/migrate'] << paths["db/migrate"].expanded.join
     end
-    
+
     config.generators do |g|
-      g.test_framework      :rspec,        :fixture => false
-      g.fixture_replacement :factory_girl, :dir => 'spec/factories'
+      g.test_framework false
       g.assets false
       g.helper false
     end

data/lib/short_message/version.rb

@@ -1,3 +1,3 @@
 module ShortMessage
-  VERSION = "0.1.0"
+  VERSION = "1.0.0"
 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>.

data/{spec → test}/dummy/Rakefile

@@ -1,7 +1,6 @@
-#!/usr/bin/env rake
 # Add your own tasks in files placed in lib/tasks ending in .rake,
 # for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
 
 require File.expand_path('../config/application', __FILE__)
 
-Dummy::Application.load_tasks
+Rails.application.load_tasks

data/{spec → test}/dummy/app/assets/javascripts/application.js

@@ -2,14 +2,12 @@
 // 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.
+// or any plugin's vendor/assets/javascripts directory 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.
+// 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.
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
 //
-//= require jquery
-//= require jquery_ujs
 //= require_tree .

data/test/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,15 @@
+/*
+ * 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 any plugin's vendor/assets/stylesheets directory 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 bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/test/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,5 @@
+class ApplicationController < ActionController::Base
+  # Prevent CSRF attacks by raising an exception.
+  # For APIs, you may want to use :null_session instead.
+  protect_from_forgery with: :exception
+end

data/{spec → test}/dummy/app/views/layouts/application.html.erb

@@ -2,8 +2,7 @@
 <html>
 <head>
   <title>Dummy</title>
-  <%= stylesheet_link_tag    "application", :media => "all" %>
-  <%= javascript_include_tag "application" %>
+  <%= stylesheet_link_tag    'application', media: 'all' %>
   <%= csrf_meta_tags %>
 </head>
 <body>

data/test/dummy/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+load Gem.bin_path('bundler', 'bundle')

data/test/dummy/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../../config/application', __FILE__)
+require_relative '../config/boot'
+require 'rails/commands'

data/test/dummy/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run

data/test/dummy/bin/setup

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+require 'pathname'
+
+# path to your application root.
+APP_ROOT = Pathname.new File.expand_path('../../',  __FILE__)
+
+Dir.chdir APP_ROOT do
+  # This script is a starting point to setup your application.
+  # Add necessary setup steps to this file:
+
+  puts "== Installing dependencies =="
+  system "gem install bundler --conservative"
+  system "bundle check || bundle install"
+
+  # puts "\n== Copying sample files =="
+  # unless File.exist?("config/database.yml")
+  #   system "cp config/database.yml.sample config/database.yml"
+  # end
+
+  puts "\n== Preparing database =="
+  system "bin/rake db:setup"
+
+  puts "\n== Removing old logs and tempfiles =="
+  system "rm -f log/*"
+  system "rm -rf tmp/cache"
+
+  puts "\n== Restarting application server =="
+  system "touch tmp/restart.txt"
+end

data/test/dummy/config/application.rb

@@ -0,0 +1,26 @@
+require File.expand_path('../boot', __FILE__)
+
+require 'rails/all'
+
+Bundler.require(*Rails.groups)
+require "short_message"
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+
+    # Do not swallow errors in after_commit/after_rollback callbacks.
+    config.active_record.raise_in_transactional_callbacks = true
+  end
+end
+

data/test/dummy/config/boot.rb

@@ -0,0 +1,5 @@
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../../Gemfile', __FILE__)
+
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+$LOAD_PATH.unshift File.expand_path('../../../../lib', __FILE__)