rails_otp 1.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f3e47045b4b6d34525bad4ac2031ffd777c6d822
+  data.tar.gz: a6082001f9ee2b796ad7e9310a0f9363d30d23a4
+SHA512:
+  metadata.gz: b5670c341d5cc9ca591f9e7e4ffee82a57adc6b5102dfb31b903561e0cd270f390d3e811eafd937059dc34e530ac7beb0662787b9b7e647e8b45355de915dd0f
+  data.tar.gz: c3b6635dabf82cb3c1cfeb555de6ba0186b58f072f4976a50e364775cc75e37ac433c7de6b35ec62aa863723c4bc195b21d39b782083b5c8dc75f6143fb7f22d

data/.gitignore

@@ -0,0 +1,3 @@
+.DS_Store
+/pkg/*
+.gem

data/.gitlab-ci.yml

@@ -0,0 +1,8 @@
+image: ruby:2.3
+
+before_script:
+  - gem install bundler
+  - bundle install
+
+rspec:
+   script: "rake spec"

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+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.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at nitesh.sharma@cybrilla.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,41 @@
+PATH
+  remote: .
+  specs:
+    rails_otp (1.1.0)
+      httparty (~> 0.9.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.2.5)
+    httparty (0.9.0)
+      multi_json (~> 1.0)
+      multi_xml
+    multi_json (1.12.1)
+    multi_xml (0.5.5)
+    rake (10.5.0)
+    rspec (3.4.0)
+      rspec-core (~> 3.4.0)
+      rspec-expectations (~> 3.4.0)
+      rspec-mocks (~> 3.4.0)
+    rspec-core (3.4.4)
+      rspec-support (~> 3.4.0)
+    rspec-expectations (3.4.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-mocks (3.4.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-support (3.4.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.12)
+  rails_otp!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.12.5

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 sinscary
+
+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,75 @@
+# Rails Otp
+This gem is for adding two-factor-authentication. It generates OTP and Verifies it. And sends otp. For sending it uses Exotel, Smsgupshup etc. service providers' api
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rails_otp'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rails_otp
+
+## Usage
+
+* **Migrations**
+
+ To generate migration run 
+
+`$ rails g opal:migration table_name`
+
+Run `rake  db:migrate` to run the migration.
+
+```
+== 20160711094521 OtpAddToUsers: migrating ====================================
+-- change_table(:users)
+   -> 0.0013s
+== 20160711094521 OtpAddToUsers: migrated (0.0014s) ===========================
+```
+
+Once done with this step, include module `RailsOtp` to your model.
+
+* **Configurations**
+
+Setup your configuraion as follows
+
+```
+RailsOtp.configure do |config|
+      config.sid = 'exotel_sid'
+      config.token = 'exotel_token'
+      config.otp_expiry_time = 'set expiry time for otp'
+end
+```
+
+Now For e.g. you have instance of `user`. then use `user.generate_otp!` to generate_otp for user.
+
+To regenerate otp run `user.regenerate_otp!`
+
+To verify otp use `user.verify_otp('otp')`.
+
+To send otp using exotel api use following method
+
+```
+Opal::Exotel.send(:to => phone_munber, :body => 'Your message here')
+```
+
+
+
+## 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).
+
+
+## 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 "rails_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

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/generators/rails_otp/migration_generator.rb

@@ -0,0 +1,12 @@
+require 'rails/generators/active_record'
+
+
+module RailsOtp
+  class MigrationGenerator < ActiveRecord::Generators::Base
+    source_root File.expand_path("../../templates", __FILE__)
+
+    def copy_otp_migration
+      migration_template "migration.rb", "db/migrate/otp_add_to_#{table_name}.rb"
+    end
+  end
+end

data/lib/generators/templates/migration.rb

@@ -0,0 +1,10 @@
+class OtpAddTo<%= table_name.camelize %> < ActiveRecord::Migration
+  def self.up
+    change_table :<%= table_name %> do |t|
+      t.string :otp_code
+      t.boolean :verified_status
+      
+      t.datetime :otp_expiry_time
+    end
+  end
+end

data/lib/rails_otp.rb

@@ -0,0 +1,22 @@
+require "rails_otp/version"
+require "rails_otp/otp"
+require "rails_otp/exotel"
+require "rails_otp/configuration"
+
+module RailsOtp
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.reset
+    @configuration = Configuration.new
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+end

data/lib/rails_otp/configuration.rb

@@ -0,0 +1,11 @@
+module RailsOtp
+  class Configuration
+    attr_accessor :sid, :token, :otp_expiry_time
+
+    def initialize
+      @sid = 'exotel_sid'
+      @token = 'exotel_token'
+      @otp_expiry_time = Time.now + 5.minutes
+    end
+  end
+end

data/lib/rails_otp/exotel.rb

@@ -0,0 +1,28 @@
+require 'httparty'
+
+module RailsOtp
+  class Exotel
+    include HTTParty
+    base_uri "https://twilix.exotel.in/v1/Accounts"
+
+    def self.send(params={})
+      self.new.send(params)
+    end
+
+    def send(params={})
+      params = transform_params(params)
+      response = self.class.post("/#{RailsOtp::configuration.sid}/Sms/send",  {:body => params, :basic_auth => auth })
+      response.response.code
+    end
+
+    protected
+
+    def transform_params(params)
+      params.inject({}){ |h, (key, value)| h[key.to_s.capitalize.to_sym] = value; h }
+    end
+
+    def auth
+      {:username => RailsOtp::configuration.sid, :password => RailsOtp::configuration.token}
+    end
+  end
+end

data/lib/rails_otp/otp.rb

@@ -0,0 +1,59 @@
+require 'securerandom'
+
+module RailsOtp
+  def generate_otp
+    self.verified_status = false
+    #TODO: add expiry time to config
+    self.otp_expiry_time = RailsOtp::configuration.otp_expiry_time #code is valid only for 5 minutes
+    self.otp_code = SecureRandom.hex(4)
+  end
+
+  def generate_otp!
+    generate_otp
+    save
+  end
+
+  def verify_otp(otp)
+    otp_code_valid?(otp) && code_not_expired
+  end
+
+  def regenerate_otp
+    generate_otp
+  end
+
+  def regenerate_otp!
+    regenerate_otp
+    save
+  end
+
+  private
+
+    #check whether both generated and entered otp match or not
+    def matches?(otp)
+      otp == self.otp_code 
+    end
+
+    #function to check whether otp is expired or not
+    def expired?
+      self.otp_expiry_time < Time.now
+    end
+
+    # custom messages for invalid code and code expiry time.
+    def otp_code_valid?(otp)
+      if matches?(otp)
+        true
+      else
+        errors.add(:base, "you have entered a invalid code")
+        false
+      end
+    end
+
+    def code_not_expired
+      if !expired?
+        true
+      else
+        errors.add(:base, "this otp code has been expired")
+        false
+      end
+    end
+end

data/lib/rails_otp/version.rb

@@ -0,0 +1,3 @@
+module RailsOtp
+  VERSION = "1.1.0"
+end

data/rails_otp.gemspec

@@ -0,0 +1,35 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rails_otp/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rails_otp"
+  spec.version       = RailsOtp::VERSION
+  spec.authors       = ["Nitesh Sharma"]
+  spec.email         = ["nbsharma@outlook.com"]
+
+  spec.summary       = %q{A ruby gem for two-factor-authentication}
+  spec.description   = %q{This gem generates and verifies otp and sets api configuration based on service provider.}
+  spec.homepage      = "https://github.com/sinscary/rails_otp"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  # end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+
+  spec.add_dependency "httparty", "~>0.9.0"
+end

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: rails_otp
+version: !ruby/object:Gem::Version
+  version: 1.1.0
+platform: ruby
+authors:
+- Nitesh Sharma
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-07-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+description: This gem generates and verifies otp and sets api configuration based
+  on service provider.
+email:
+- nbsharma@outlook.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .gitlab-ci.yml
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/generators/rails_otp/migration_generator.rb
+- lib/generators/templates/migration.rb
+- lib/rails_otp.rb
+- lib/rails_otp/configuration.rb
+- lib/rails_otp/exotel.rb
+- lib/rails_otp/otp.rb
+- lib/rails_otp/version.rb
+- rails_otp.gemspec
+homepage: https://github.com/sinscary/rails_otp
+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.6.6
+signing_key: 
+specification_version: 4
+summary: A ruby gem for two-factor-authentication
+test_files: []