emergent_ussd_gateway 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d7c4f42f34ceacd928f0690d665a43221cb3a1c5c6cf3f9c11371250701e2518
+  data.tar.gz: 8fed40fe24a3acf80d23ba4cd97758eb74bc104e0c0770745d9ba52c054dd932
+SHA512:
+  metadata.gz: 19ea4f6c0cbec6f319bf922b75447c8039c424487bf8f157c31cc3f867281f0f5300f782c7f2bd0b592923d56ea3f5e7d8654ec9462450485e6b441f208d3185
+  data.tar.gz: 7dafeca8caf184e21f6a29239fca05af6d23aff89ffe1d3fade3141cf90a4642c2c1437b65b01401618e4dd8d5ab79358cdfa085d0bc4f657d66394f51d482a6

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,8 @@
+AllCops:
+  TargetRubyVersion: 3.0
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2025-07-17
+
+- Initial release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Shepherd Yaw Morttey
+
+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,162 @@
+# EmergentUssdGateway
+
+EmergentUssdGateway is a Ruby gem that simplifies handling USSD requests from the [Emergent Technology USSD Gateway](www.emergentafrica.com). Built for Rails developers, it provides a structured way to parse USSD push requests, manage sessions, and send back valid JSON responses.
+
+---
+
+## Features
+
+- Parse and normalize USSD initiation, response, release, and timeout events
+- Provide structured response builders for `Response` and `Release`
+- Easily integrate with any Rails app by subclassing a base controller
+- Mask input routes when expecting confidential entries like PINs
+- Optional local session tracking (in-memory, Redis, etc. - future versions)
+
+---
+
+## Installation
+
+Add this line to your Gemfile:
+
+```ruby
+gem 'emergent_ussd_gateway'
+```
+
+Then run:
+
+```bash
+bundle install
+```
+
+Or install it directly:
+
+```bash
+gem install emergent_ussd_gateway
+```
+
+---
+
+## Usage in Rails
+
+Create a controller that inherits from the gem’s base controller and implement your USSD logic by overriding `handle_ussd`.
+
+```ruby
+# app/controllers/emergent_ussd_controller.rb
+class EmergentUssdController < EmergentUssdGateway::BaseController
+  private
+
+  def handle_ussd(request)
+    case request.type.downcase
+    when "initiation"
+      EmergentUssdGateway::ResponseBuilder.new(
+        type: "Response",
+        message: "Welcome.\n1. Check Balance 2. Change PIN 3. Request Support."
+      )
+    when "response"
+      case request.message.strip
+      when "1"
+        EmergentUssdGateway::ResponseBuilder.new(
+          type: "Release",
+          message: "Your account balance is GHS 53,743"
+        )
+      when "2"
+        EmergentUssdGateway::ResponseBuilder.new(
+          type: "Response",
+          message: "Enter your new PIN",
+          mask_next_route: true
+        )
+      when "3"
+        EmergentUssdGateway::ResponseBuilder.new(
+          type: "Response",
+          message: "Support: Call 1234 or email support@example.com"
+        )
+      else
+        EmergentUssdGateway::ResponseBuilder.new(
+          type: "Response",
+          message: "Invalid option. 1. Check Balance 2. Change PIN 3. Request Support."
+        )
+      end
+    else
+      EmergentUssdGateway::ResponseBuilder.new(
+        type: "Release",
+        message: "Session ended."
+      )
+    end
+  end
+end
+```
+
+Add a route to your `config/routes.rb`:
+
+```ruby
+post "/ussd-app", to: "emergent_ussd#ussd"
+```
+
+---
+
+## Example Payloads
+
+**Incoming POST from Emergent Gateway**
+
+```json
+{
+  "Mobile": "233262183777",
+  "SessionId": "abc123",
+  "ServiceCode": "711",
+  "Type": "initiation",
+  "Message": "*711#",
+  "Operator": "Vodafone"
+}
+```
+
+**Response JSON**
+
+```json
+{
+  "Type": "Response",
+  "Message": "Enter your PIN",
+  "MaskNextRoute": true
+}
+```
+
+---
+
+## Development
+
+```bash
+git clone https://github.com/smorttey/emergent_ussd_gateway.git
+cd emergent_ussd_gateway
+bin/setup       # Install dependencies
+rake spec       # Run tests
+bin/console     # Interactive dev console
+```
+
+To install locally:
+
+```bash
+bundle exec rake install
+```
+
+To release a new version:
+
+1. Update `lib/emergent_ussd_gateway/version.rb`
+2. Run:
+
+   ```bash
+   bundle exec rake release
+   ```
+
+---
+
+## Contributing
+
+Bug reports and pull requests are welcome at:
+https://github.com/smorttey/emergent_ussd_gateway
+
+---
+
+## License
+
+This gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+---

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/emergent_ussd_gateway/base_controller.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require "json"
+require_relative "request_parser"
+require_relative "response_builder"
+
+module EmergentUssdGateway
+  # Base controller for handling Emergent Technology USSD requests in Rails.
+  # Subclass this controller and implement #handle_ussd(request) to provide your logic.
+  # Mount your subclassed controller in your Rails routes.
+  class BaseController < ActionController::API
+    # POST /ussd-app
+    def ussd
+      request_data = EmergentUssdGateway::RequestParser.new(params.to_unsafe_h)
+      response = handle_ussd(request_data)
+      unless response.is_a?(EmergentUssdGateway::ResponseBuilder)
+        raise "handle_ussd must return an EmergentUssdGateway::ResponseBuilder instance"
+      end
+
+      render json: response.to_h
+    rescue ArgumentError => e
+      render json: { error: e.message }, status: :bad_request
+    rescue StandardError => e
+      render json: { error: e.message }, status: :internal_server_error
+    end
+
+    private
+
+    # Subclasses must implement this method.
+    # @param request [EmergentUssdGateway::RequestParser]
+    # @return [EmergentUssdGateway::ResponseBuilder]
+    def handle_ussd(request)
+      raise NotImplementedError, "You must implement handle_ussd(request) in your subclass."
+    end
+  end
+end

data/lib/emergent_ussd_gateway/request_parser.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module EmergentUssdGateway
+  # Parses and validates incoming USSD JSON requests for the Emergent Technology USSD API.
+  # Ensures all required fields are present and exposes request attributes.
+  # Raises ArgumentError if validation fails.
+  class RequestParser
+    REQUIRED_FIELDS = %w[Type Mobile SessionId ServiceCode Message Operator].freeze
+
+    attr_reader :type, :mobile, :session_id, :service_code, :message, :operator
+
+    def initialize(params)
+      @type = params["Type"] || params["type"]
+      @mobile = params["Mobile"] || params["mobile"]
+      @session_id = params["SessionId"] || params["session_id"]
+      @service_code = params["ServiceCode"] || params["service_code"]
+      @message = params["Message"] || params["message"]
+      @operator = params["Operator"] || params["operator"]
+      validate!
+    end
+
+    def self.from_json(json)
+      new(JSON.parse(json))
+    end
+
+    def validate!
+      missing = missing_fields
+      return if missing.empty?
+
+      raise ArgumentError, "Missing required USSD fields: #{missing.join(", ")}"
+    end
+
+    private
+
+    def missing_fields
+      field_map = {
+        "Type" => @type,
+        "Mobile" => @mobile,
+        "SessionId" => @session_id,
+        "ServiceCode" => @service_code,
+        "Message" => @message,
+        "Operator" => @operator
+      }
+      field_map.select { |_k, v| v.nil? }.keys
+    end
+  end
+end

data/lib/emergent_ussd_gateway/response_builder.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module EmergentUssdGateway
+  # Builds USSD API responses for the Emergent Technology USSD API.
+  # Allows setting Type, Message, and optional MaskNextRoute fields.
+  # Provides a to_json method for API-compliant output.
+  class ResponseBuilder
+    attr_accessor :type, :message, :mask_next_route
+
+    def initialize(type:, message:, mask_next_route: nil)
+      @type = type
+      @message = message
+      @mask_next_route = mask_next_route
+    end
+
+    def to_h
+      h = { "Type" => type, "Message" => message }
+      h["MaskNextRoute"] = mask_next_route unless mask_next_route.nil?
+      h
+    end
+
+    def to_json(*_args)
+      to_h.to_json
+    end
+  end
+end

data/lib/emergent_ussd_gateway/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module EmergentUssdGateway
+  VERSION = "0.1.0"
+end

data/lib/emergent_ussd_gateway.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require_relative "emergent_ussd_gateway/version"
+
+module EmergentUssdGateway
+  class Error < StandardError; end
+  # Your code goes here...
+end

data/sig/emergent_ussd_gateway.rbs

@@ -0,0 +1,4 @@
+module EmergentUssdGateway
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: emergent_ussd_gateway
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Shepherd Yaw Morttey
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2025-07-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: This gem simplifies the integration of Emergent Technology's USSD Gateway
+  into Ruby on Rails applications. It provides request parsers, response builders,
+  and a base controller for clean USSD session handling.
+email:
+- shepherd@mfidie.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/emergent_ussd_gateway.rb
+- lib/emergent_ussd_gateway/base_controller.rb
+- lib/emergent_ussd_gateway/request_parser.rb
+- lib/emergent_ussd_gateway/response_builder.rb
+- lib/emergent_ussd_gateway/version.rb
+- sig/emergent_ussd_gateway.rbs
+homepage: https://github.com/smorttey/emergent_ussd_gateway
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/smorttey/emergent_ussd_gateway
+  source_code_uri: https://github.com/smorttey/emergent_ussd_gateway
+  changelog_uri: https://github.com/smorttey/emergent_ussd_gateway/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.22
+signing_key:
+specification_version: 4
+summary: Rails-friendly gem to handle USSD requests from Emergent Technology
+test_files: []