short_message 1.1.2 → 2.0.0

data/app/models/short_message/message.rb

@@ -1,38 +1,38 @@
+require "net/http"
+require "uri"
+require "openssl"
+require "json"
+
 module ShortMessage
-  class Message < ActiveRecord::Base
+  class Message < ApplicationRecord
     def deliver
-      deliver_method = Rails.version.to_f > 4.2 ? "deliver_now" : "deliver"
-
       self.sender = ShortMessage.config.default_sms_sender if self.sender.blank?
-      unless self.recipient.blank? and self.text.blank?
-        http = Net::HTTP.new(ShortMessage.config.gateway_server, ShortMessage.config.gateway_port)
-        if ShortMessage.config.gateway_port == Net::HTTP.https_default_port()
-          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)
-        result_set = response.body.gsub("(","").gsub(")","").split(" ")
-        response_code = result_set[0].to_i
+      normalize_addresses!
+      return false if errors.any?
+      return false if self.recipient.blank? || self.text.blank?
+      return false if ShortMessage.config.api_key.to_s.strip.empty?
 
-        if response_code == 200 or response_code == 402
-          if response_code == 402 and not ShortMessage.config.reload_notification_email.blank?
-            eval "ShortMessage::Mailer.payment_required_notification().#{deliver_method}"
-          end
+      response = send_v2_request
+      parsed = parse_delivery_response(response)
+      assign_delivery_metadata(response, parsed)
 
-          self.message_key = result_set[2] unless result_set[2].blank?
-          ActiveSupport::Notifications.instrument('short_message.delivered', options: { key: (result_set[2] unless result_set[2].blank?) })
-          return self.save
-        else
-          eval "ShortMessage::Mailer.error_notification(self, response).#{deliver_method}" unless ShortMessage.config.admin_notification_email.blank?
-        end
+      if delivery_successful?(response, parsed)
+        self.message_key = parsed[:message_key] if parsed[:message_key].present?
+        ActiveSupport::Notifications.instrument("short_message.delivered", key: self.message_key)
+        return self.save
       else
+        if response.code.to_i == 402 && ShortMessage.config.reload_notification_email.present?
+          ShortMessage::Mailer.payment_required_notification.deliver_now
+        end
+
+        Rails.logger.error("ShortMessage delivery failed: HTTP #{response.code}, body=#{response.body}")
+        send_error_notification(response)
         return false
       end
-    end
-
-    def recharge
-      raise "NOT YET IMPLEMENTED"
+    rescue StandardError => e
+      Rails.logger.error("ShortMessage delivery raised #{e.class}: #{e.message}")
+      send_error_notification(e)
+      false
     end
 
     def status_text
@@ -40,23 +40,133 @@ module ShortMessage
     end
 
     private
-    def build_deliver_params_string
-      params = []
-      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
-      raise "NOT YET IMPLEMENTED"
-      # params = []
-      # params << "user=#{ShortMessage.config.user}"
-      # params << "password=#{ShortMessage.config.password}"
-      # params << "amount=#{amount}"
-      # params.join("&")
+
+    def send_v2_request
+      format = ShortMessage.config.response_format.to_s.strip
+      format = "plain" if format.empty?
+      url = "#{ShortMessage.config.api_base_url}/smsc/sendsms/#{ShortMessage.config.api_key}/#{format}"
+
+      uri = URI.parse(url)
+      request = Net::HTTP::Post.new(uri)
+      request["Content-Type"] = "application/x-www-form-urlencoded"
+      request["Accept"] = accept_header_for(format)
+      request.body = URI.encode_www_form(build_deliver_params_hash)
+
+      perform_http_request(uri, request)
+    end
+
+    def perform_http_request(uri, request)
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = uri.scheme == "https"
+      http.verify_mode = OpenSSL::SSL::VERIFY_PEER if http.use_ssl?
+      http.open_timeout = (ShortMessage.config.open_timeout || 5).to_i
+      http.read_timeout = (ShortMessage.config.read_timeout || 30).to_i
+      http.request(request)
+    end
+
+    def accept_header_for(format)
+      return "application/json" if format == "json"
+      "application/x-www-form-urlencoded"
+    end
+
+    def build_deliver_params_hash
+      params = {
+        from: self.sender,
+        to: self.recipient,
+        text: self.text
+      }
+
+      params["dlr-mask"] = ShortMessage.config.dlr_mask if ShortMessage.config.dlr_mask.present?
+      params["dlr-url"] = ShortMessage.config.dlr_url if ShortMessage.config.dlr_url.present?
+      params
+    end
+
+    def parse_delivery_response(response)
+      body = response.body.to_s.strip
+
+      if json_response?(body)
+        payload = JSON.parse(body)
+        return {
+          response_code: payload["code"].to_i,
+          message_status: payload["status"] || payload["message-status"],
+          message_key: payload["message-id"] || payload["message_id"] || payload["messageId"] || payload["id"],
+          raw_payload: payload
+        }
+      end
+
+      normalized = body.gsub("(", "").gsub(")", "")
+      tokens = normalized.include?(",") ? normalized.split(",").map(&:strip) : normalized.split(" ").map(&:strip)
+      {
+        response_code: response.code.to_i,
+        message_status: tokens[0],
+        message_key: tokens[1],
+        message_count: tokens[2].to_i,
+        raw_payload: body
+      }
+    rescue JSON::ParserError
+      {
+        response_code: 0,
+        message_status: nil,
+        message_key: nil,
+        raw_payload: body
+      }
+    end
+
+    def delivery_successful?(response, parsed)
+      response.code.to_i == 200 && parsed[:message_key].present?
+    end
+
+    def send_error_notification(response_or_error)
+      return if ShortMessage.config.admin_notification_email.blank?
+
+      ShortMessage::Mailer.error_notification(self, response_or_error).deliver_now
+    end
+
+    def json_response?(body)
+      body.start_with?("{")
+    end
+
+    def assign_delivery_metadata(response, parsed)
+      self.provider_http_status = response.code.to_i if has_attribute?(:provider_http_status)
+      self.provider_status = parsed[:message_status] if has_attribute?(:provider_status)
+      if has_attribute?(:provider_response_body)
+        self.provider_response_body = parsed[:raw_payload].is_a?(String) ? parsed[:raw_payload] : parsed[:raw_payload].to_json
+      end
+    end
+
+    def normalize_addresses!
+      normalized_recipient = normalize_recipient(self.recipient)
+      if normalized_recipient.nil?
+        errors.add(:recipient, "must be in international format, e.g. +41791234567")
+      else
+        self.recipient = normalized_recipient
+      end
+
+      self.sender = normalize_sender(self.sender)
+    end
+
+    def normalize_recipient(value)
+      normalized = sanitize_phone_number(value)
+      return nil if normalized.blank?
+
+      normalized = "+#{normalized[2..]}" if normalized.start_with?("00")
+      return normalized if normalized.match?(/\A\+[1-9]\d{6,14}\z/)
+
+      nil
+    end
+
+    def normalize_sender(value)
+      return value if value.blank?
+
+      normalized = sanitize_phone_number(value)
+      normalized = "+#{normalized[2..]}" if normalized.start_with?("00")
+      return normalized if normalized.match?(/\A\+[1-9]\d{6,14}\z/)
+
+      value.to_s.strip
+    end
+
+    def sanitize_phone_number(value)
+      value.to_s.strip.gsub(/[\s\-\(\)]/, "")
     end
   end
 end

data/config/routes.rb

@@ -1,6 +1,5 @@
 Rails.application.routes.draw do
   namespace :short_message do
-    get 'messages/status' => "messages#status"
-    post 'messages/status' => "messages#status"
+    match "messages/status", to: "messages#status", via: [:get, :post]
   end
 end

data/db/migrate/20130308133457_create_short_message_messages.rb

@@ -1,4 +1,4 @@
-class CreateShortMessageMessages < ActiveRecord::Migration[4.2]
+class CreateShortMessageMessages < ActiveRecord::Migration[6.1]
   def change
     create_table :short_message_messages do |t|
       t.string :message_key

data/db/migrate/20260608090000_add_delivery_metadata_to_short_message_messages.rb

@@ -0,0 +1,14 @@
+class AddDeliveryMetadataToShortMessageMessages < ActiveRecord::Migration[6.1]
+  def change
+    add_column :short_message_messages, :provider_http_status, :integer, after: :text
+    add_column :short_message_messages, :provider_status, :string, after: :provider_http_status
+    add_column :short_message_messages, :provider_response_body, :text, after: :provider_status
+    add_column :short_message_messages, :error_code, :string, after: :provider_response_body
+    add_column :short_message_messages, :error_message, :string, after: :error_code
+    add_column :short_message_messages, :submitted_at, :datetime, after: :error_message
+    add_column :short_message_messages, :delivered_at, :datetime, after: :submitted_at
+
+    add_index :short_message_messages, :message_key, unique: true
+    add_index :short_message_messages, :status_code
+  end
+end

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

@@ -1,22 +1,23 @@
 ShortMessage.configure do |config|
-  # Configuration example www.gtx-messaging.com
-  config.gateway_server = "http.gtx-messaging.net"
-  config.gateway_port = 443
+  # GTX REST API v2
+  config.api_base_url = "https://rest.gtx-messaging.net"
+  config.api_key = ENV.fetch("GTX_API_KEY", "")
+  config.response_format = "json" # allowed: json, xml, plain
 
-  config.send_file_path = "/smsc.php"
-  # config.account_functions_path = ""
+  # Optional: delivery report callbacks — GTX fetches this URL via GET/POST
+  # config.dlr_url = "https://example.com/short_message/messages/status?token=SECRET"
+  config.dlr_mask = 3
 
-  # enter your details received from provider here
-  config.user = ""
-  config.password = ""
+  # Optional: validate incoming DLR callbacks with a secret token
+  # config.callback_token = ENV["SHORT_MESSAGE_CALLBACK_TOKEN"]
 
-  # config.default_reload_amount = 1000
+  config.open_timeout = 5
+  config.read_timeout = 30
 
-  config.default_mail_sender = "webmaster@your-domain.com"
-  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
+  # Default sender used when message.sender is blank
+  # config.default_sms_sender = "MyApp"
 
-  # set a default sms sender (used if no sender is present)
-  # config.default_sms_sender = ""
+  config.default_mail_sender = "webmaster@your-domain.com"
+  config.reload_notification_email = "webmaster@your-domain.com"
+  config.admin_notification_email = "webmaster@your-domain.com"
 end

data/lib/short_message/config.rb

@@ -1,7 +1,5 @@
-require 'active_support/configurable'
-
 module ShortMessage
-  def self.configure(&block)
+  def self.configure
     yield @config ||= ShortMessage::Configuration.new
   end
 
@@ -9,30 +7,18 @@ module ShortMessage
     @config
   end
 
-  class Configuration #:nodoc:
-    include ActiveSupport::Configurable
-    config_accessor :gateway_server
-    config_accessor :gateway_port
-    config_accessor :send_file_path
-    config_accessor :account_functions_path
-
-    config_accessor :user
-    config_accessor :password
-
-    config_accessor :default_sms_sender
-    config_accessor :default_reload_amount
-    config_accessor :reload_notification_email
-    config_accessor :admin_notification_email
-    config_accessor :voucher_notification_email
-    config_accessor :default_mail_sender
-
-    def param_name
-      config.param_name.respond_to?(:call) ? config.param_name.call : config.param_name
-    end
-
-    # 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
+  class Configuration
+    attr_accessor :api_base_url,
+                  :api_key,
+                  :response_format,
+                  :default_sms_sender,
+                  :reload_notification_email,
+                  :admin_notification_email,
+                  :default_mail_sender,
+                  :dlr_url,
+                  :dlr_mask,
+                  :callback_token,
+                  :open_timeout,
+                  :read_timeout
   end
 end

data/lib/short_message/engine.rb

@@ -2,10 +2,6 @@ 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 false
       g.assets false

data/lib/short_message/version.rb

@@ -1,3 +1,3 @@
 module ShortMessage
-  VERSION = "1.1.2"
+  VERSION = "2.0.0"
 end

metadata

@@ -1,31 +1,51 @@
 --- !ruby/object:Gem::Specification
 name: short_message
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 2.0.0
 platform: ruby
 authors:
 - Andi Saurer
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-07-24 00:00:00.000000000 Z
+date: 2026-06-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.1'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 3.2.0
+        version: '9.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 3.2.0
+        version: '1.6'
 - !ruby/object:Gem::Dependency
-  name: mysql2
+  name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -38,13 +58,15 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Send short messages to a specific SMS Gateway
+description: Rails engine for sending SMS via GTX REST API v2, with delivery status
+  callbacks and metadata persistence
 email:
 - andreas.saurer@econ.uzh.ch
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
 - MIT-LICENSE
 - README.md
 - Rakefile
@@ -52,10 +74,13 @@ files:
 - app/controllers/short_message/messages_controller.rb
 - app/helpers/short_message/application_helper.rb
 - app/mailers/application_mailer.rb
+- app/mailers/short_message/application_mailer.rb
 - app/mailers/short_message/mailer.rb
+- app/models/short_message/application_record.rb
 - app/models/short_message/message.rb
 - config/routes.rb
 - db/migrate/20130308133457_create_short_message_messages.rb
+- db/migrate/20260608090000_add_delivery_metadata_to_short_message_messages.rb
 - lib/generators/short_message/install_generator.rb
 - lib/generators/short_message/templates/config/initializers/short_message.rb
 - lib/generators/short_message/templates/config/locales/short_message.de.yml
@@ -65,48 +90,14 @@ files:
 - lib/short_message/engine.rb
 - lib/short_message/version.rb
 - lib/tasks/short_message_tasks.rake
-- test/dummy/README.rdoc
-- test/dummy/Rakefile
-- test/dummy/app/assets/javascripts/application.js
-- test/dummy/app/assets/stylesheets/application.css
-- test/dummy/app/controllers/application_controller.rb
-- test/dummy/app/helpers/application_helper.rb
-- test/dummy/app/views/layouts/application.html.erb
-- test/dummy/bin/bundle
-- test/dummy/bin/rails
-- test/dummy/bin/rake
-- test/dummy/bin/setup
-- test/dummy/config.ru
-- test/dummy/config/application.rb
-- test/dummy/config/boot.rb
-- test/dummy/config/database.yml
-- test/dummy/config/environment.rb
-- test/dummy/config/environments/development.rb
-- test/dummy/config/environments/production.rb
-- test/dummy/config/environments/test.rb
-- test/dummy/config/initializers/assets.rb
-- test/dummy/config/initializers/backtrace_silencers.rb
-- test/dummy/config/initializers/cookies_serializer.rb
-- test/dummy/config/initializers/filter_parameter_logging.rb
-- test/dummy/config/initializers/inflections.rb
-- test/dummy/config/initializers/mime_types.rb
-- test/dummy/config/initializers/session_store.rb
-- test/dummy/config/initializers/wrap_parameters.rb
-- test/dummy/config/locales/en.yml
-- test/dummy/config/routes.rb
-- test/dummy/config/secrets.yml
-- test/dummy/public/404.html
-- test/dummy/public/422.html
-- test/dummy/public/500.html
-- test/dummy/public/favicon.ico
-- test/integration/navigation_test.rb
-- test/short_message_test.rb
-- test/test_helper.rb
 homepage: https://github.com/asaurer/short_message
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  homepage_uri: https://github.com/asaurer/short_message
+  source_code_uri: https://github.com/asaurer/short_message
+  changelog_uri: https://github.com/asaurer/short_message/blob/master/CHANGELOG.md
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -114,53 +105,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 3.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.9
-signing_key: 
+rubygems_version: 3.5.18
+signing_key:
 specification_version: 4
-summary: Send short messages to a specific SMS Gateway
-test_files:
-- test/dummy/app/controllers/application_controller.rb
-- test/dummy/app/views/layouts/application.html.erb
-- test/dummy/app/assets/javascripts/application.js
-- test/dummy/app/assets/stylesheets/application.css
-- test/dummy/app/helpers/application_helper.rb
-- test/dummy/bin/rake
-- test/dummy/bin/setup
-- test/dummy/bin/bundle
-- test/dummy/bin/rails
-- test/dummy/config/secrets.yml
-- test/dummy/config/routes.rb
-- test/dummy/config/locales/en.yml
-- test/dummy/config/environments/production.rb
-- test/dummy/config/environments/development.rb
-- test/dummy/config/environments/test.rb
-- test/dummy/config/environment.rb
-- test/dummy/config/application.rb
-- test/dummy/config/database.yml
-- test/dummy/config/boot.rb
-- test/dummy/config/initializers/backtrace_silencers.rb
-- test/dummy/config/initializers/mime_types.rb
-- test/dummy/config/initializers/filter_parameter_logging.rb
-- test/dummy/config/initializers/session_store.rb
-- test/dummy/config/initializers/wrap_parameters.rb
-- test/dummy/config/initializers/assets.rb
-- test/dummy/config/initializers/cookies_serializer.rb
-- test/dummy/config/initializers/inflections.rb
-- test/dummy/config.ru
-- test/dummy/Rakefile
-- test/dummy/public/favicon.ico
-- test/dummy/public/422.html
-- test/dummy/public/500.html
-- test/dummy/public/404.html
-- test/dummy/README.rdoc
-- test/short_message_test.rb
-- test/integration/navigation_test.rb
-- test/test_helper.rb
+summary: Send SMS through the GTX REST API v2 from a Rails app
+test_files: []

data/test/dummy/README.rdoc

@@ -1,28 +0,0 @@
-== 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/test/dummy/Rakefile

@@ -1,6 +0,0 @@
-# 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__)
-
-Rails.application.load_tasks

data/test/dummy/app/assets/javascripts/application.js

@@ -1,13 +0,0 @@
-// 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 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
-// compiled file.
-//
-// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
-// about supported directives.
-//
-//= require_tree .

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

@@ -1,15 +0,0 @@
-/*
- * 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

@@ -1,5 +0,0 @@
-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/test/dummy/app/helpers/application_helper.rb

@@ -1,2 +0,0 @@
-module ApplicationHelper
-end

data/test/dummy/app/views/layouts/application.html.erb

@@ -1,13 +0,0 @@
-<!DOCTYPE html>
-<html>
-<head>
-  <title>Dummy</title>
-  <%= stylesheet_link_tag    'application', media: 'all' %>
-  <%= csrf_meta_tags %>
-</head>
-<body>
-
-<%= yield %>
-
-</body>
-</html>

data/test/dummy/bin/bundle

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

data/test/dummy/bin/rails

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