wavecell_otp_and_sms 1.0.8

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fc051602c92a6230ca74923d5711247481c1636070ccd98a6a5af07d247e30ea
+  data.tar.gz: c4b3ede95d204f1ef7fae8c9855bb091dd7d383e0dd90e670d3b8c82f15275e9
+SHA512:
+  metadata.gz: 8978cf78a63bdab762e6a6b8420c092f1ab6b155e440638ba3758576b1f5b045bf40ad2025dd66d9af20917965e9c3a12f8b5557011c5f6a40e7726f5d86786b
+  data.tar.gz: 99a2c1b59b97294220506350a43c29f9addda897d6e9c24f54ddbb39a02fb28a52fadd8f187cc0b12aff838bea639fc68d893c3d689b9c72e81db20507c48562

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.env

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 alejandrogacumadeguzman@gmail.com. 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 wavecell_sms.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,43 @@
+PATH
+  remote: .
+  specs:
+    wavecell_otp_and_sms (1.0.8)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    httparty (0.18.0)
+      mime-types (~> 3.0)
+      multi_xml (>= 0.5.2)
+    mime-types (3.3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2019.1009)
+    multi_xml (0.6.0)
+    rake (13.0.1)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.1)
+      rspec-support (~> 3.9.1)
+    rspec-expectations (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  httparty
+  rake (~> 13.0)
+  rspec (~> 3.2)
+  wavecell_otp_and_sms!
+
+BUNDLED WITH
+   2.1.3

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Alejandro De Guzman
+
+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,74 @@
+# Wavecell
+
+Ruby gem wrapper for sending sms, generate OTP, verify OTP using wavecell.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'wavecell_otp_and_sms'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install wavecell_otp_and_sms
+
+## Example
+
+  ```ruby
+    initializer.rb
+    # Initiate Wavecell SMS configuration by putting sub account and api key
+    WavecellOtpAndSms.configure do |config|
+      config.api_key = 'api_key'
+      config.sub_account = 'sub_account'
+    end
+
+    # Compose your message to be sent to users
+    @sms_config = WavecellOtpAndSms::SendSms.new(
+      source: 'Name of Source e.g ACME Inc.',
+      destination: 'Mobile Number',
+      text: 'Lorem Ipsum is simply dummy text',
+      encoding: 'AUTO'
+    )
+
+    # Generate OTP
+    @send_otp_config = WavecellOtpAndSms::SendOtp.new(
+      destination: 'Mobile Number',
+      country_code: 'PH',
+      product_name: 'Lorem Ipsum'
+    )
+
+    # Verify using UID and verification
+    @verify_otp_config = WavecellOtpAndSms::VerifyOtp.new(
+      uid: '92849238423',
+      code: '4454'
+    )
+
+    # Call .send to send the SMS
+    @sms_config.send
+
+  ```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/deguzman20/wavecell_otp_and_sms. 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](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the WavecellSms project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/deguzman20/wavecell_otp_with_sms/blob/master/CODE_OF_CONDUCT.md).
+# wavecell_otp_and_sms

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "wavecell_otp_and_sms"
+
+# 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/wavecell_otp_and_sms/configuration.rb

@@ -0,0 +1,10 @@
+module WavecellOtpAndSms
+  class Configuration
+    attr_accessor :api_key, :sub_account
+
+    def initialize
+      @api_key
+      @sub_account
+    end
+  end
+end

data/lib/wavecell_otp_and_sms/send_otp.rb

@@ -0,0 +1,42 @@
+require 'httparty'
+
+module WavecellOtpAndSms
+  class SendOtp
+    include HTTParty
+    attr_accessor :destination, :country_code, :product_name
+
+    # Initialize OTP parameters
+    def initialize(options = {})
+      @destination = options[:destination]
+      @country_code = options[:country_code]
+      @product_name = options[:product_name]
+    end
+
+    # Call this to generate url for the api calls
+    def send
+      generate_url
+    end
+
+    private
+      # Construct API using the parameters and initial configuration
+      def generate_url
+        api_key = WavecellOtpAndSms.configuration.api_key
+        sub_account = WavecellOtpAndSms.configuration.sub_account
+        details = [destination, country_code, product_name]
+        parameters = {
+          destination: destination,
+          country_code: country_code,
+          product_name: product_name
+        }
+        query_string = parameters.to_a.map { |x| "#{x[0]}=#{x[1]}" }.join("&")
+        url = "https://api.wavecell.com/otp/v1/#{sub_account}" + "?#{query_string}"
+        HTTParty.post(url.to_str,
+        :body => parameters.to_json,
+        :headers => {
+          "Content-Type" => "application/json",
+          "Authorization" => "Bearer #{api_key}"
+        })
+      end
+
+  end
+end

data/lib/wavecell_otp_and_sms/send_sms.rb

@@ -0,0 +1,44 @@
+require 'httparty'
+
+module WavecellOtpAndSms
+  class SendSms
+    include HTTParty
+    attr_accessor :source, :destination, :text, :encoding
+
+    # Initialize SMS parameters to send message to api
+    def initialize(options = {})
+      @source = options[:source]
+      @destination = options[:destination]
+      @text = options[:text]
+      @encoding = options[:encoding]
+    end
+
+    # Call this to generate url for the api calls
+    def send
+      generate_url
+    end
+
+    private
+      # Construct API using the parameters and initial configuration
+      def generate_url
+        api_key = WavecellOtpAndSms.configuration.api_key
+        sub_account = WavecellOtpAndSms.configuration.sub_account
+        details = [source, destination, text, encoding]
+        parameters = {
+          source: source,
+          destination: destination,
+          text: text,
+          encoding: encoding
+        }
+        query_string = parameters.to_a.map { |x| "#{x[0]}=#{x[1]}" }.join("&")
+        url = "https://api.wavecell.com/sms/v1/#{sub_account}/single" + "?#{query_string}"
+        HTTParty.post(url.to_str,
+        :body => parameters.to_json,
+        :headers => {
+          "Content-Type" => "application/json",
+          "Authorization" => "Bearer #{api_key}"
+        })
+      end
+
+  end
+end

data/lib/wavecell_otp_and_sms/verify_otp.rb

@@ -0,0 +1,40 @@
+require 'httparty'
+
+module WavecellOtpAndSms
+  class VerifyOtp
+    include HTTParty
+    attr_accessor :uid, :code
+
+    # Initialize OTP parameters
+    def initialize(options = {})
+      @uid = options[:uid]
+      @code = options[:code]
+    end
+
+    # Call this to generate url for the api calls
+    def send
+      generate_url
+    end
+
+    private
+      # Construct API using the parameters and initial configuration
+      def generate_url
+        api_key = WavecellOtpAndSms.configuration.api_key
+        sub_account = WavecellOtpAndSms.configuration.sub_account
+        details = [uid, code]
+        parameters = {
+          uid: uid,
+          code: code
+        }
+        query_string = parameters.to_a.map { |x| "#{x[0]}=#{x[1]}" }.join("&")
+        url = "https://api.wavecell.com/otp/v1/#{sub_account}/#{uid}?code=#{code}"
+        HTTParty.get(url.to_str,
+        :body => parameters.to_json,
+        :headers => {
+          "Content-Type" => "application/json",
+          "Authorization" => "Bearer #{api_key}"
+        })
+      end
+
+  end
+end

data/lib/wavecell_otp_and_sms/version.rb

@@ -0,0 +1,3 @@
+module WavecellOtpAndSms
+  VERSION = "1.0.8"
+end

data/lib/wavecell_otp_and_sms.rb

@@ -0,0 +1,22 @@
+require "wavecell_otp_and_sms/version"
+require "wavecell_otp_and_sms/configuration"
+require "wavecell_otp_and_sms/send_sms"
+require "wavecell_otp_and_sms/send_otp"
+require "wavecell_otp_and_sms/verify_otp"
+
+
+module WavecellOtpAndSms
+  class Error < StandardError; end
+
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configure
+    yield configuration
+  end
+end

data/wavecell_otp_and_sms.gemspec

@@ -0,0 +1,32 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "wavecell_otp_and_sms/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "wavecell_otp_and_sms"
+  spec.version       = WavecellOtpAndSms::VERSION
+  spec.authors       = ["Alejandro De Guzman"]
+  spec.email         = ["alejandrogacumadeguzman@gmail.com"]
+
+  spec.summary       = "API integration for processing bulk SMS with wavecell."
+  spec.description   = "Process your SMS notifications using Wavecell API"
+  spec.homepage      = "https://github.com/deguzman20/wavecell_otp_and_sms"
+  spec.license       = "MIT"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+
+  # 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_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "rspec", "~> 3.2"
+  spec.add_development_dependency "httparty"
+  # spec.add_development_dependency "pry", "~> 1.0"
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: wavecell_otp_and_sms
+version: !ruby/object:Gem::Version
+  version: 1.0.8
+platform: ruby
+authors:
+- Alejandro De Guzman
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-03-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Process your SMS notifications using Wavecell API
+email:
+- alejandrogacumadeguzman@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec_status"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/wavecell_otp_and_sms.rb
+- lib/wavecell_otp_and_sms/configuration.rb
+- lib/wavecell_otp_and_sms/send_otp.rb
+- lib/wavecell_otp_and_sms/send_sms.rb
+- lib/wavecell_otp_and_sms/verify_otp.rb
+- lib/wavecell_otp_and_sms/version.rb
+- wavecell_otp_and_sms.gemspec
+homepage: https://github.com/deguzman20/wavecell_otp_and_sms
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/deguzman20/wavecell_otp_and_sms
+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.1.2
+signing_key: 
+specification_version: 4
+summary: API integration for processing bulk SMS with wavecell.
+test_files: []