idi_sms 0.2.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0b9ac811f9479457ec7a9863cb36ab9b5ef0def7a3342a92a57e0c4f761039d7
+  data.tar.gz: '0953700738f16a2db48266c782bf959afd1a0a212b636e0352a94020a3e8d1e8'
+SHA512:
+  metadata.gz: 6c4be92901ad301b8fbfacddceabc04057cd090635cb872fda01003bc275c48058d04bc231f79d971dd6b77ee32e37e384b989a5bd0219e56c9d0b1c03df172f
+  data.tar.gz: d1b07ee85e568706994b04e34af7ed89a97132fc19bba9ca53bf71172dcceed72b502eef14352404026d6deb79622d98a2b9caaae6ffd1d4fd020918c1c8b07a

data/README.md

@@ -0,0 +1,67 @@
+# idi_sms Gem
+
+## Overview
+
+The `idi_sms` gem is a Ruby library that simplifies the process of sending SMS messages using the 8070 short code SMS-Gateway API. This gem is specifically designed for integration with the PITB Dengue Tracking System, allowing you to send SMS messages efficiently and seamlessly.
+
+## Installation
+
+To use the `idi_sms` gem in your project, follow these steps:
+
+1. Add the gem to your project's Gemfile:
+
+   ```ruby
+   gem 'idi_sms'
+
+Run bundle install to install the gem and its dependencies.
+
+2. Run Command to generate yml file for setting key:
+   
+   ```ruby
+   $ rails generate idi_sms:config
+
+it will create a file on config/idi_sms.yml
+
+3. Set your api_url and secret_key as per your envionrment
+      1. api_url: https://gatewayurl.sms
+      2. secret_key: your_secret_key
+## Usage
+
+```ruby
+Require the gem in your Ruby code:
+require 'idi_sms'
+
+sms_sender = IdiSms::SmsSender.new
+
+
+Customize your SMS details, including the phone number, SMS text, and SMS language:
+
+phone_no = 'xxxxxxxxxx'(allow number only)
+sms_text = 'This gem created by idi'
+sms_language = 'english'
+
+
+Send an SMS using the send_sms method and handle the response:
+
+
+result = sms_sender.send_sms(phone_no, sms_text, sms_language)
+puts result
+
+```
+
+## Contributing
+
+Pull requests are welcome. For major changes, please open an issue first
+to discuss what you would like to change.
+
+Please make sure to update tests as appropriate.
+
+## License
+
+The idi_sms gem is released under the MIT License. See the LICENSE file for details.
+
+Contact
+If you have any questions or encounter issues with the idi_sms gem, feel free to contact idrees.ibrahim009@gmail.com.
+
+
+In the provided text, I added instructions for generating an API key and setting environment variables. Please customize it further with the actual URLs, environment variable names, and any additional details specific to your gem.

data/Rakefile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+task default: %i[]

data/idi_sms.gemspec

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require_relative "lib/idi_sms/version"
+
+Gem::Specification.new do |spec|
+  ## info
+  spec.name = "idi_sms"
+  spec.version = IdiSms::VERSION
+  spec.authors = ["idrees ibrahim"]
+  spec.email = ["idrees.ibrahim@pitv.gov.pk"]
+
+  ## summary
+  spec.summary = "Send Sms by using PITB apis it can be send in urdu and english both"
+  spec.description = "SMS-Gateway API DETAILS For SMS API FOR DENGUE TRACKING SYSTEM NEW. Short Code 8070"
+  spec.homepage = "https://rubygems.org/gems/idi_sms"  
+  spec.required_ruby_version = ">= 2.6.0"
+
+  ## meta information
+  # spec.metadata["allowed_push_host"] = "https://rubygems.org/gems/idi_sms"
+  # spec.metadata["homepage_uri"] = spec.homepage
+  # spec.metadata["source_code_uri"] = "https://github.com/idreesibrahim/idi_sms"
+  # spec.metadata["changelog_uri"] = "https://github.com/idreesibrahim/idi_sms/blob/main/CHANGELOG.md" 
+  
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) ||
+        f.start_with?(*%w[bin/ test/ spec/ features/ .git .circleci appveyor Gemfile])
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+  spec.license       = "Nonstandard"
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/lib/generators/idi_sms/config/config_generator.rb

@@ -0,0 +1,14 @@
+# Create a generator at lib/generators/idi_sms/config/config_generator.rb
+require 'rails/generators'
+
+module IdiSms
+  module Generators
+    class ConfigGenerator < Rails::Generators::Base
+      source_root File.expand_path('templates', __dir__)
+
+      def create_config_file
+        template 'idi_sms.yml', 'config/idi_sms.yml'
+      end
+    end
+  end
+end

data/lib/generators/idi_sms/config/templates/idi_sms.yml

@@ -0,0 +1,7 @@
+development:
+  api_url: 
+  secret_key: your_secret_key
+
+production:
+  api_url: 
+  secret_key: your_secret_key

data/lib/idi_sms/version.rb

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

data/lib/idi_sms.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require 'net/http'
+require 'json'
+require 'yaml'
+
+module IdiSms
+  class SmsSender
+    def initialize(environment = :development)
+      config = load_config(environment)
+      @api_url = config['api_url']
+      @secret_key = config['secret_key']
+    end
+
+    def send_sms(phone_no, sms_text, sms_language)
+      response = send_sms_request(phone_no, sms_text, sms_language)
+      process_response(response)
+    end
+
+    private
+
+    def load_config(environment)
+      config_file = File.expand_path('config/idi_sms.yml')
+      YAML.load_file(config_file)[environment.to_s]
+    end
+
+    def send_sms_request(phone_no, sms_text, sms_language)
+      url = URI.parse(@api_url)
+      http = Net::HTTP.new(url.host, url.port)
+      http.use_ssl = true
+
+      request = Net::HTTP::Post.new(url)
+      request['Content-Type'] = 'application/json'
+      request.body = {
+        sec_key: @secret_key,
+        phone_no: phone_no,
+        sms_text: sms_text,
+        sms_language: sms_language
+      }.to_json
+
+      http.request(request)
+    end
+
+    def process_response(response)
+      if response.code == '200'
+        response_body = JSON.parse(response.body)
+        response_body['status'] == 'success' ? 'SMS sent successfully.' : "Error: #{response_body['message']}"
+      else
+        'Failed to send SMS.'
+      end
+    end
+  end
+end

data/sig/idi_sms.rbs

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

metadata

@@ -0,0 +1,55 @@
+--- !ruby/object:Gem::Specification
+name: idi_sms
+version: !ruby/object:Gem::Version
+  version: 0.2.1
+platform: ruby
+authors:
+- idrees ibrahim
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2023-10-24 00:00:00.000000000 Z
+dependencies: []
+description: SMS-Gateway API DETAILS For SMS API FOR DENGUE TRACKING SYSTEM NEW. Short
+  Code 8070
+email:
+- idrees.ibrahim@pitv.gov.pk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- idi_sms-0.0.1.gem
+- idi_sms-0.1.0.gem
+- idi_sms-0.2.0.gem
+- idi_sms.gemspec
+- lib/generators/idi_sms/config/config_generator.rb
+- lib/generators/idi_sms/config/templates/idi_sms.yml
+- lib/idi_sms.rb
+- lib/idi_sms/version.rb
+- sig/idi_sms.rbs
+homepage: https://rubygems.org/gems/idi_sms
+licenses:
+- Nonstandard
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Send Sms by using PITB apis it can be send in urdu and english both
+test_files: []