hey-you-nexmo 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ac3f5da9666d7dfce8e57f80e5a9d12e38369b839b5b8c7f6e8b67a594047001
+  data.tar.gz: 80f2f94e1ea2227147c0816580e933ed4cead2326da76e6f4e72e5eb59621dcb
+SHA512:
+  metadata.gz: c64da584bcbf15cb9c1d1736c506d16445ba4b4edd6aca778275bd3dcc488db54697036876074d4b0eabf4cbe8b6a8a6292be1e11040dfafc712d3ce23458636
+  data.tar.gz: f5fb3c2a24fcc613040acf9fc08c8078ba0cee84aa9096d4bc0559b1a0852a8a7e474f50f66db392ccfadd036a4804ee698c2174aead870ee29016d38bb996fa

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+
+.rspec_status
+.byebug_history

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,12 @@
+---
+sudo: false
+language: ruby
+rvm:
+  - 2.5.3
+  - 2.6.1
+  - 2.7.1
+before_install: gem install bundler
+scripts:
+  - bundle exec rspec
+
+

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 qnesterr@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 [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in hey-you-nexmo.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"

data/Gemfile.lock

@@ -0,0 +1,72 @@
+PATH
+  remote: .
+  specs:
+    hey-you-nexmo (0.1.0)
+      hey-you (~> 1.2)
+      nexmo (~> 7.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    concurrent-ruby (1.1.6)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.4.3)
+    faraday (0.15.4)
+      multipart-post (>= 1.2, < 3)
+    fcm (0.0.7)
+      faraday (= 0.15.4)
+    ffaker (2.15.0)
+    hashdiff (1.0.1)
+    hey-you (1.2.0)
+      fcm (~> 0.0.2)
+      i18n (~> 1.0)
+      mail (~> 2.7)
+    i18n (1.8.3)
+      concurrent-ruby (~> 1.0)
+    jwt (2.2.1)
+    mail (2.7.1)
+      mini_mime (>= 0.1.1)
+    mini_mime (1.0.2)
+    multipart-post (2.1.1)
+    nexmo (7.1.2)
+      jwt (~> 2)
+      sorbet-runtime (~> 0.5)
+      zeitwerk (~> 2, >= 2.2)
+    public_suffix (4.0.4)
+    rake (12.3.3)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      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.3)
+    safe_yaml (1.0.5)
+    sorbet-runtime (0.5.5794)
+    webmock (3.8.3)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+    zeitwerk (2.3.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  ffaker (~> 2.15)
+  hey-you-nexmo!
+  rake (~> 12.0)
+  rspec (~> 3.0)
+  webmock (~> 3.4)
+
+BUNDLED WITH
+   2.1.4

data/README.md

@@ -0,0 +1,69 @@
+# Hey, You, Nexmo!
+[![Build Status](https://travis-ci.com/QNester/hey-you-nexmo.svg?branch=master)](https://travis-ci.com/QNester/hey-you-nexmo#)
+[![Gem Version](https://badge.fury.io/rb/hey-you-nexmo.svg)](https://badge.fury.io/rb/hey-you-nexmo)
+
+Send Nexmo sms via [hey-you gem](https://github.com/QNester/hey-you). This gem depended on [nexmo-ruby](https://github.com/Nexmo/nexmo-ruby).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'hey-you-nexmo'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install hey-you-nexmo
+
+## Usage
+
+After load gem you can send Nexmo SMS via [hey-you](https://github.com/QNester/hey-you).
+
+For example:
+```yaml
+# config/notifications.yml
+events:
+  verified_code:
+    # ...
+    nexmo:
+      text: 'Your verification code: %{code}'
+      from: 'bestNumber'
+      is_unicode: false # has priority above this setting in config
+```
+
+```ruby
+# config/initalizers/hey-you.rb
+HeyYou::Config.configure do 
+  # [String] required - your sender number 
+  config.nexmo.from = 'myNumber'
+
+  # [Nexmo::Client] required - Instance of Nexmo client (check https://github.com/Nexmo/nexmo-ruby for more info)
+  config.nexmo.client = Nexmo::Client.new(...)
+  
+  # [Boolean] optional - If you will send unicode texts
+  config.nexmo.is_unicode = true
+  
+  # Check https://developer.nexmo.com/api/sms#delivery-receipt for more info about settings below
+  config.nexmo.ttl = 90000
+  config.nexmo.status_report_req = true
+  config.nexmo.callback = 'http://my_callback.url/'
+end
+```
+
+```ruby
+# // somewhere in your app 
+builder = Builder.new('events.verified_code', code: verified_code) 
+HeyYou::Channels::Nexmo.send!(builder, to: receiver_phone_number) #=> { success: true }
+```
+
+## 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`. 

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 "hey/you/nexmo"
+
+# 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/hey-you-nexmo.gemspec

@@ -0,0 +1,34 @@
+require_relative 'lib/hey_you_nexmo/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "hey-you-nexmo"
+  spec.version       = HeyYouNexmo::VERSION
+  spec.authors       = ["Sergey Nesterov"]
+  spec.email         = ["qnesterr@gmail.com"]
+
+  spec.summary       = %q{Nexmo SMS sender via `hey-you`}
+  spec.description   = %q{This gem extend core gem `hey-you` for send Nexmo SMS.}
+  spec.homepage      = "https://github.com/QNester/hey-you-nexmo"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.5.0")
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org/"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/QNester/hey-you-nexmo"
+  spec.metadata["changelog_uri"] = "https://github.com/QNester/hey-you-nexmo/blob/master/CHANGELOG.md"
+
+  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 "hey-you", '~> 1.2'
+  spec.add_runtime_dependency "nexmo", '~> 7.1'
+
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "webmock", '~> 3.4'
+  spec.add_development_dependency "ffaker", '~> 2.15'
+end

data/lib/hey-you-nexmo.rb

@@ -0,0 +1,11 @@
+require 'hey-you'
+require 'hey_you_nexmo/version'
+require_relative 'hey_you/config/nexmo'
+require_relative 'hey_you/builder/nexmo'
+require_relative 'hey_you/channels/nexmo'
+
+module HeyYouNexmo
+  CHANNEL_NAME = 'nexmo'.freeze
+
+  HeyYou::Config.instance.registrate_channel(CHANNEL_NAME)
+end

data/lib/hey_you/builder/nexmo.rb

@@ -0,0 +1,17 @@
+module HeyYou
+  class Builder
+    class Nexmo < Base
+      attr_reader :text, :from, :is_unicode
+
+      def build
+        @text = ch_data.fetch('text')
+        @from = ch_data.fetch('from', nil)
+        @is_unicode = ch_data.fetch('is_unicode', false)
+      rescue KeyError => e
+        fail MissingRequiredParameter, e
+      end
+
+      class MissingRequiredParameter < StandardError; end
+    end
+  end
+end

data/lib/hey_you/channels/nexmo.rb

@@ -0,0 +1,61 @@
+require 'nexmo'
+
+module HeyYou
+  module Channels
+    class Nexmo < Base
+      class ResponseError < StandardError; end
+      class CredentialsNotExists < StandardError; end
+
+      ERROR_MESSAGES = {
+        from_required: 'You must pass `from` globally (to configure) or in your notifications',
+        config_required: 'You must pass `{%{options}}` to `configure``',
+        to_required: 'You must pass `to` as option. Can not send sms to nowhere.',
+        callback_required: 'You must pass `callback` to `configure` if `status_report_req` is true'
+      }.freeze
+
+      class << self
+        # @param [HeyYou::Builder] builder - builder with notifications texts and settings=
+        # @option [String/Symbol] to - msisdn receiver
+        def send!(builder, **options)
+          raise CredentialsNotExists, ERROR_MESSAGES[:config_required] % { options: required_credentials } unless credentials_present?
+          raise CredentialsNotExists, ERROR_MESSAGES[:to_required] unless options[:to]
+
+          params = build_params(builder, **options)
+
+          config.nexmo.client.sms.send(params)
+        rescue ::Nexmo::Error => e
+          fail ResponseError, e
+        end
+
+        private
+
+        def build_params(builder, **options)
+          from = builder.nexmo.from || config.nexmo.from
+
+          raise CredentialsNotExists, ERROR_MESSAGES[:from_required] unless from
+
+          if config.nexmo.status_report_req && !config.nexmo.callback
+            raise CredentialsNotExists, ERROR_MESSAGES[:callback_required]
+          end
+
+          params = {
+            from: from,
+            to: options[:to],
+            text: builder.nexmo.text,
+            status_report_req: config.nexmo.status_report_req,
+            ttl: config.nexmo.ttl
+          }
+
+          params.merge!(type: 'unicode') if builder.nexmo.is_unicode || config.nexmo.is_unicode
+          params.merge!(callback: config.nexmo.callback) if params[:status_report_req]
+
+          params
+        end
+
+        def required_credentials
+          %i[client]
+        end
+      end
+    end
+  end
+end

data/lib/hey_you/config/nexmo.rb

@@ -0,0 +1,22 @@
+require 'json'
+
+module HeyYou
+  class Config
+    class Nexmo
+      extend Configurable
+      DEFAULTS = {
+        is_unicode: false,
+        status_report_req: false,
+        ttl: 259200000 # 72 hours
+      }.freeze
+
+      attr_accessor :client, :from, :is_unicode, :ttl, :status_report_req, :callback
+
+      def initialize
+        @is_unicode = DEFAULTS[:is_unicode]
+        @status_report_req = DEFAULTS[:status_report_req]
+        @ttl = DEFAULTS[:ttl]
+      end
+    end
+  end
+end

data/lib/hey_you_nexmo/version.rb

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

metadata

@@ -0,0 +1,147 @@
+--- !ruby/object:Gem::Specification
+name: hey-you-nexmo
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sergey Nesterov
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-07-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: hey-you
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: nexmo
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.1'
+- !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.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: ffaker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.15'
+description: This gem extend core gem `hey-you` for send Nexmo SMS.
+email:
+- qnesterr@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- hey-you-nexmo.gemspec
+- lib/hey-you-nexmo.rb
+- lib/hey_you/builder/nexmo.rb
+- lib/hey_you/channels/nexmo.rb
+- lib/hey_you/config/nexmo.rb
+- lib/hey_you_nexmo/version.rb
+homepage: https://github.com/QNester/hey-you-nexmo
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org/
+  homepage_uri: https://github.com/QNester/hey-you-nexmo
+  source_code_uri: https://github.com/QNester/hey-you-nexmo
+  changelog_uri: https://github.com/QNester/hey-you-nexmo/blob/master/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.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: Nexmo SMS sender via `hey-you`
+test_files: []