sendotp 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e442bd426deaf7aa06e0cd068f71953e96a0ff88
+  data.tar.gz: 464d8b0dcf82f41a627b77ee4b2fce70acd171b3
+SHA512:
+  metadata.gz: 8ed24d2ce81349e725f66ff7ceaf9a5c386fe9b236d5bfe7d788ac9a6494db17422c437e42a953ea8c4faf0e511612fca731af91a1be5322a4715b208e9059a7
+  data.tar.gz: '09a86d4a89ffc30a759a2d86b0515af15933573f19f238aab6dbfec9d7619b7dc7a19c773fd56b3b93f7aeae1f7f212d37c9da02b5ca615ded04de3c4671412f'

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.3
+before_install: gem install bundler -v 1.14.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at utkarsh@walkover.in. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in send_otp.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Utkarsh
+
+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 @@
+# SendOtp
+
+This SDK enables sendOTP and allows you to send OTP
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'send_otp'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install send_otp  
+        
+### Requests  
+```
+sendotp = SendOtp::Otp.new('AuthKey')  
+sendotp.send_otp(contact_number, sender_id, otp); //otp is optional if not sent it'll be generated automatically  
+sendotp.retry(contact_number, retry_voice);  
+sendotp.verify(contact_number, otp);  
+```
+### Usage
+
+To send OTP, without optional parameters 
+```
+sendotp.send_otp("919999999999", "PRIIND")
+```  
+
+To send OTP, with optional parameters  
+```
+sendotp.send_otp("919999999999", "PRIIND", "4635")
+```
+
+To retry OTP
+```
+sendotp.retry("919999999999", false)
+```
+**Note:** Set retry_voice false if you want to retry otp via text, default value is true
+
+To verify OTP
+
+```
+sendotp.verify("919999999999", "4635");
+```
+**Options**:
+
+By default SendOtp uses default message template, but custom message template can also set in constructor like
+```
+sendotp = SendOtp::Otp.new('AuthKey', 'Otp for your order is {{otp}}, please do not share it with anybody')  
+```  
+{{otp}} expression is used to inject generated otp in message.
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/MSG91/sendotp-ruby. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://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 "send_otp"
+
+# 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/send_otp.rb

@@ -0,0 +1,132 @@
+require 'send_otp/version'
+require 'uri'
+require 'net/http'
+module SendOtp
+
+  class Otp
+
+
+    #variable auth_key; //MSG91 auth key
+    #variable message_template = "Your otp is {{otp}}. Please do not share it with anybody" //message template to send, {{otp}} is required to inject generated otp
+
+    # Creates a new SendOtp instance
+    # @param {string} auth_jey Authentication key
+    # @param {string, optional} message_template
+
+    def initialize(auth_key, message_template=nil)
+      @auth_key = auth_key
+      if message_template
+        @message_template = message_template
+      else
+        @message_template = 'Your otp is {{otp}}. Please do not share it with anybody'
+      end
+    end
+
+    # Send Otp to given mobile number
+    # @param {string} contact_number receiver's mobile number along with country code
+    # @param {string} sender_id
+    # @param {string, optional} otp
+    # @param {string, optional} n number of digits of Otp
+
+    def send_otp(contact_number, sender_id, otp = '', n = 4)
+      otp = generate_otp(n) if otp.to_s.empty?
+      @message_template.gsub! '{{otp}}', otp.to_s
+      args = {
+          authkey: @auth_key,
+          mobile: contact_number,
+          sender: sender_id,
+          message: @message_template,
+          otp: otp
+      }
+
+      do_request('sendotp.php', args)
+    end
+
+
+    # Retry Otp to given mobile number
+    # @param {string} contact_number receiver's mobile number along with country code
+    # @param {boolean} retry_voice, false to retry otp via text call, default true
+
+    def retry(contact_number, retry_voice)
+      # if retry voice is false, set `retry_type` as `text` else set it to `voice` call msg91 API to retry otp
+      # return msg91 API response
+      retry_type =  'voice'
+      retry_type = 'text' unless retry_voice
+      args = {
+          authkey: @auth_key,
+          mobile: contact_number,
+          retrytype: retry_type
+      }
+      do_request('retryotp.php', args)
+    end
+
+
+    # Verify Otp to given mobile number
+    # @param {string} contact_number receiver's mobile number along with country code
+    # @param {string} otp otp to verify
+    # Return true if OTP verified successfully
+    # @returns {boolean} true if otp verified successfully else false
+
+    def verify(contact_number, otp)
+      args = {
+          authkey: @auth_key,
+          mobile: contact_number,
+          otp: otp
+      }
+
+      response = do_request('verifyRequestOTP.php', args)
+      body = eval(response.body)
+
+      if body[:type] == 'success'
+        true
+      else
+        false
+      end
+    rescue
+      false
+    end
+
+
+    private
+
+
+    # Returns the base URL for MSG91 api call
+    # @returns {string} Base URL for MSG91 api call
+
+    def get_base_url
+      'https://control.msg91.com/api/'
+    end
+
+    def generate_random_number(upper_limit, lower_limit)
+      Random.rand(upper_limit-lower_limit)+lower_limit
+    end
+
+    # returns a n digit random number
+    def generate_otp(n = 4)
+      smallest_num_of_n_plus1_digits = 10 ** n
+      smallest_num_of_n_digits = 10 ** (n-1)
+      rand_number = generate_random_number(smallest_num_of_n_plus1_digits, smallest_num_of_n_digits)
+      while rand_number > smallest_num_of_n_plus1_digits || rand_number < smallest_num_of_n_digits
+        rand_number = generate_random_number(smallest_num_of_n_plus1_digits, smallest_num_of_n_digits)
+      end
+
+      rand_number
+    end
+
+
+    # Common private method to make HTTP request
+    # call this in above three methods (send, retry, verify)
+    # @param {string} path, MSG91 API's endpoint
+    # @param {json} params, arguments to send in API
+
+    def do_request(url, args)
+      uri = URI.parse(get_base_url + url)
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = true
+      request = Net::HTTP::Post.new(uri.request_uri, initheader = {'Content-Type' => 'application/json'})
+      request.set_form_data(args)
+      http.request(request)
+    end
+  end
+
+end

data/lib/send_otp/version.rb

@@ -0,0 +1,3 @@
+module SendOtp
+  VERSION = "0.1.0"
+end

data/send_otp.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'send_otp/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "sendotp"
+  spec.version       = SendOtp::VERSION
+  spec.authors       = ["Utkarsh"]
+  spec.email         = ["utkarsh@walkover.in"]
+
+  spec.summary       = %q{This gem allows to send otp, verify otp and retry otp}
+  spec.description   = %q{This gem enables sendOTP and allows you to send OTP}
+  spec.homepage      = "https://sendotp.msg91.com/"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |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_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: sendotp
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Utkarsh
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-04-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: This gem enables sendOTP and allows you to send OTP
+email:
+- utkarsh@walkover.in
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/send_otp.rb
+- lib/send_otp/version.rb
+- send_otp.gemspec
+homepage: https://sendotp.msg91.com/
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: This gem allows to send otp, verify otp and retry otp
+test_files: []