sms_misr 0.1.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: db387fc62afa51a82047c88600c0c9cc19d5293d4bffdfca414d0cccb0a82935
+  data.tar.gz: 97e328333fb1cb4bff664a4fedfbddeb4847ba515df350734473d688704c0aaa
+SHA512:
+  metadata.gz: c5d3886b8c847a3201f1d93e55f1c895d5dce8abeebc17012c2092bc75a2ea7d251446e6dd876503ff5cdcea7b6096a41d6e78778746c474662c2debe087fe71
+  data.tar.gz: 5bb3f00d7f6d94a309670e0e8b14ccd0368ec64e2a916a85b55b67b77b968d1a7650437254f21c6120ae430f38b43cfc1936137fbb141d07a8330dd2c7098205

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.8
+before_install: gem install bundler -v 2.1.4

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in sms_misr.gemspec
+gemspec
+
+gem "rake", ">= 0.8.7"
+gem "rspec", ">= 3.0"

data/Gemfile.lock

@@ -0,0 +1,42 @@
+PATH
+  remote: .
+  specs:
+    sms_misr (0.1.4)
+      httparty
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.4.4)
+    httparty (0.18.1)
+      mime-types (~> 3.0)
+      multi_xml (>= 0.5.2)
+    mime-types (3.3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2020.1104)
+    multi_xml (0.6.0)
+    rake (12.3.3)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.0)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rake (>= 0.8.7)
+  rspec (>= 3.0)
+  sms_misr!
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 mohamedmmahfouz
+
+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,68 @@
+# Sms Misr Gem
+A ruby gem for integration with sms misr services
+PLEASE NOTE THAT this integrates with SMS MISR API ONLY https://smsmisr.com/
+Ruby GEM: https://rubygems.org/gems/sms_misr
+# This GEM is still under testing
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sms_misr'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install sms_misr
+
+## CREDENTIALS SETUP
+
+add the following credentials into your ENV file
+
+````ruby
+SEND_SMS_ENABLED=<must be set to true to allow sending messages, set to false prevent sending any messages>
+SMS_USERNAME=<user name for your sms misr account>
+SMS_PASSWORD=<password for your sms misr account>
+FIXED_OTP_SMS_TOKEN=<Fixed message token for OTP API>
+FIXED_OTP_SMS_SIGNATURE=<Fixed message signature for OTP API>
+````
+## SMS API
+
+to use the sms api: 
+````ruby
+handler = SmsMisr::Handler.new('010XXXXXXXX')
+parsed_response = handler.send_message("message", "SENDER") ## Sender is the sender value of your sms misr account
+## language is English by default, to specify arabic language use the following
+parsed_response = handler.send_message("message", "SENDER", 2)
+````
+
+## OTP API
+to use OTP API make sure FIXED_OTP_SMS_TOKEN & FIXED_OTP_SMS_SIGNATURE are set in your env file
+````ruby
+handler = SmsMisr::Handler.new('010XXXXXXXX')
+parsed_response = handler.send_otp('123456')
+````
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Future work
+- convert sms misr api responses to readable message
+- add backgrounding with sidekiq
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/sms_misr.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "sms_misr"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/sms_misr.rb

@@ -0,0 +1,85 @@
+require "sms_misr/version"
+require 'httparty'
+# This class is responsible for sending the sms for the whole app
+#
+## `send_message` uses sms misr SMS API which takes a longer time to receive the message
+###########
+## `send_otp` uses sms misr OTP API which has a pre-set message identified by `token` and `Msignature` fields
+##  which is found on their website
+###########
+
+class SmsMisr::Handler
+  include HTTParty
+  base_uri 'https://smsmisr.com/api'
+  attr_reader :options
+
+  def initialize(phone_number)
+    @options = {
+      query:
+      {
+        username: username,
+        password: password,
+        mobile: phone_number,
+      },
+    }
+  end
+
+  def send_message(message, sender, language = 1)
+    return unenabled_message unless send_sms_enabled?
+
+    @options[:query].merge!(message_params(message, sender, language))
+    result = self.class.post('/webapi', @options)
+    result.parsed_response
+  end
+
+  def send_otp(otp)
+    return unenabled_message unless send_sms_enabled?
+
+    @options[:query].merge!(otp_params(otp))
+    result = self.class.post('/vSMS', @options)
+    result.parsed_response
+  end
+
+  private
+
+  def message_params(message, sender, language)
+    {
+      language: language,
+      sender: sender,
+      message: message,
+    }
+  end
+
+  def otp_params(otp)
+    {
+      code: otp,
+      token: fixed_message_token,
+      Msignature: fixed_message_signature,
+    }
+  end
+
+  def username
+    ENV.fetch('SMS_USERNAME')
+  end
+
+  def password
+    ENV.fetch('SMS_PASSWORD')
+  end
+
+  def send_sms_enabled?
+    ENV.fetch('SEND_SMS_ENABLED') == 'true'
+  end
+
+  def fixed_message_token
+    ENV.fetch('FIXED_OTP_SMS_TOKEN')
+  end
+
+  def fixed_message_signature
+    ENV.fetch('FIXED_OTP_SMS_SIGNATURE')
+  end
+
+  def unenabled_message
+    { message: 'sending sms is not enabled' }
+  end
+end
+

data/lib/sms_misr/version.rb

@@ -0,0 +1,3 @@
+module SmsMisr
+  VERSION = "0.1.4"
+end

data/sms_misr.gemspec

@@ -0,0 +1,30 @@
+require_relative 'lib/sms_misr/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "sms_misr"
+  spec.version       = SmsMisr::VERSION
+  spec.authors       = ["mohamedmmahfouz"]
+  spec.email         = ["mohamedmmahfouz24@gmail.com"]
+
+  spec.summary       = %q{SMS misr api handler.}
+  spec.description   = %q{SMS misr api handler.}
+  spec.homepage      = "https://github.com/MohamedMMahfouz/sms_misr_gem"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+
+  # spec.metadata["homepage_uri"] = spec.homepage
+  # spec.metadata["source_code_uri"] = "TODO: Put your gem's public repo URL here."
+  # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+
+  # 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(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+  spec.add_runtime_dependency "httparty"
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification
+name: sms_misr
+version: !ruby/object:Gem::Version
+  version: 0.1.4
+platform: ruby
+authors:
+- mohamedmmahfouz
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-12-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: SMS misr api handler.
+email:
+- mohamedmmahfouz24@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/sms_misr.rb
+- lib/sms_misr/version.rb
+- sms_misr-0.1.0.gem
+- sms_misr-0.1.1.gem
+- sms_misr-0.1.2.gem
+- sms_misr-0.1.3.gem
+- sms_misr.gemspec
+homepage: https://github.com/MohamedMMahfouz/sms_misr_gem
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6.2
+signing_key: 
+specification_version: 4
+summary: SMS misr api handler.
+test_files: []