send_otp_dev 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 58f06bad2d310f7b65416bfccaa5701a20e5eb2a5107cbe15a49586f892bc151
+  data.tar.gz: eea04c97fc2cda966ab4f0f4de8fb447aa62bbbd464d11fb98b16b909b186bda
+SHA512:
+  metadata.gz: 45f6009c183621878a136a1f275ce4cccaad53f4580d31c8f6403aa7f80f6933432cc4023511a1ade1b9daf0d834c31da58fa91b32092cb859c979fb3a549910
+  data.tar.gz: d9b7e5c9f95b9bc5b37b05f5c3a9d3ae9ffd76a771d8b13da0dee30b86b03c8e73acfa37fecbccffebeb1a98c7b50c3a206341a9c487305306ae7471f4d8fde5

data/README.md

@@ -0,0 +1,52 @@
+# SendOtpDev
+
+Welcome to SendOtpDev! This gem allows you to easily send and confirm One-Time Passwords (OTP) for email, SMS, or voice authentication.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'send_otp_dev'
+```
+
+And then execute:
+
+```bash
+bundle install
+```
+
+Or install it yourself as:
+
+```bash
+gem install send_otp_dev
+```
+
+## Usage / Configuration
+
+To use the SendOtpDev gem, you'll need to configure it using your API key with an initializer in your Rails application:
+
+```ruby
+# config/initializers/send_otp_dev.rb
+
+SendOtpDev.configure do |config|
+config.api_key = 'your_sendotp.dev_api_key'
+end
+```
+
+Then, you can send an OTP like so:
+
+```ruby
+SendOtpDev::Client.send_otp(email: 'user@example.com', phone_number: '1234567890', app_name: 'YourAppName')
+```
+
+
+You can also confirm an OTP like so:
+
+```ruby
+SendOtpDev::Client.confirm_otp(token:1234, email: 'user@example.com', phone_number: '1234567890', app_name: 'YourAppName')
+```
+
+
+
+

data/lib/send_otp_dev/client.rb

@@ -0,0 +1,65 @@
+require 'net/http'
+require 'uri'
+require 'json'
+
+module SendOtpDev
+  class Client
+
+    BASE_URL = 'https://api.sendotp.dev/v1'
+
+    def self.send_otp(phone_number: nil, email: nil, app_name:, delivery_method: 'sms')
+      uri = URI("#{BASE_URL}/send_otp")
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = (uri.scheme == 'https')
+
+      form_data = {
+        'app_name' => app_name,
+        'delivery_method' => delivery_method # Can be 'sms' or 'email'
+      }
+      form_data['phone_number'] = phone_number if phone_number
+      form_data['email'] = email if email
+
+      request = Net::HTTP::Post.new(uri)
+      request.set_form_data(form_data)
+
+      request['Authorization'] = "Bearer #{SendOtpDev.configuration.api_key}"
+      request['Content-Type'] = 'application/x-www-form-urlencoded'
+
+      response = http.request(request)
+
+      # Correctly handling the response based on your instructions
+      response.code == '204' || response.body == '1'
+    rescue JSON::ParserError => e
+      puts "Error parsing response: #{e.message}"
+      false
+    end
+
+    def self.confirm_otp(phone_number: nil, email: nil, otp_token:, app_name:)
+      uri = URI("#{BASE_URL}/confirm_otp")
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = (uri.scheme == 'https')
+
+      form_data = {
+        'app_name' => app_name,
+        'token' => otp_token
+      }
+      form_data['phone_number'] = phone_number if phone_number
+      form_data['email'] = email if email
+
+      request = Net::HTTP::Post.new(uri)
+      request.set_form_data(form_data)
+
+      request['Authorization'] = "Bearer #{SendOtpDev.configuration.api_key}"
+      request['Content-Type'] = 'application/x-www-form-urlencoded'
+
+      response = http.request(request)
+
+      response_body = JSON.parse(response.body)
+      response.code == '200' && response_body['success']
+    rescue JSON::ParserError => e
+      puts "Error parsing response: #{e.message}"
+      false
+    end
+
+  end
+end

data/lib/send_otp_dev/configuration.rb

@@ -0,0 +1,9 @@
+module SendOtpDev
+  class Configuration
+    attr_accessor :api_key
+
+    def initialize
+      @api_key = nil
+    end
+  end
+end

data/lib/send_otp_dev.rb

@@ -0,0 +1,13 @@
+require_relative "send_otp_dev/configuration"
+require_relative "send_otp_dev/client"
+
+module SendOtpDev
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield(configuration)
+  end
+end

metadata

@@ -0,0 +1,60 @@
+--- !ruby/object:Gem::Specification
+name: send_otp_dev
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Formulate Labs
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-02-27 00:00:00.000000000 Z
+dependencies:
+- !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: Easily Send and Confirm Email/SMS/Voice OTP Authentication
+email:
+- hello@formulatelabs.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/send_otp_dev.rb
+- lib/send_otp_dev/client.rb
+- lib/send_otp_dev/configuration.rb
+homepage: http://sendotp.dev
+licenses: []
+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: []
+rubygems_version: 3.0.9
+signing_key:
+specification_version: 4
+summary: Easily Send and Confirm Email/SMS/Voice OTP Authentication
+test_files: []