nexmo_rails 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a99673a5cde8fd7793f3505a0d0f0d24a55ba251aa32adf6733e982d0582db5a
+  data.tar.gz: 88d0eeb00a51896414a58e7944d8a6ec0233aac78f0e0cb8f8c1f1293522dcf2
+SHA512:
+  metadata.gz: 7ed4cd5750e1341f47d133475f22a9c20d95189c7c48c0f4ecc58ae34dc084ee9cf55ed6ec710e9b6be4ddd8b3026270bc5dea69696bdc7c263681e1e831ae8c
+  data.tar.gz: 77092e3ecbe832ff51fe1598e8ca9d8f068f21b72da847f4dc8a989313d67375503db1cbfb78a28695f9eb5e99a5766fc714bf9bef698c6a838d623b8e1350f8

data/LICENSE

@@ -0,0 +1,24 @@
+The MIT License (MIT)
+
+Copyright (c) 2016-2019 Nexmo Inc
+
+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,78 @@
+# Nexmo Rails Gem
+
+This is the Nexmo Rails Gem for Nexmo's API. To use it you'll
+need a Nexmo account. Sign up [for free at nexmo.com](https://dashboard.nexmo.com/sign-up?utm_source=DEV_REL&utm_medium=github&utm_campaign=nexmo-rails).
+
+* [Requirements](#requirements)
+* [Installation](#installation)
+* [Usage](#usage)
+* [License](#license)
+
+## Requirements
+
+Nexmo Rails requires: 
+
+* Rails 5.2+
+* Ruby 2.5.3+
+* [dotenv](https://github.com/bkeepers/dotenv)
+* To use the Nexmo APIs, you [need an account](https://dashboard.nexmo.com/sign-up?utm_source=DEV_REL&utm_medium=github&utm_campaign=nexmo-rails)
+
+## Installation
+
+To install the Nexmo Rails gem, add it, along with `dotenv-rails`, to your project's Gemfile:
+
+```ruby
+
+gem 'nexmo_rails'
+gem 'dotenv-rails'
+
+```
+
+The `dotenv-rails` gem assists with environment variable management and utilization. 
+
+Then, run `bundle install` from the command line.
+
+## Usage
+
+The Nexmo Rails gem will initialize a new instance of the Nexmo client inside your Rails application and make it globally accessible. To make this happen, first add the desired Nexmo credentials to your `.env` file. For example, if you are using only the `API_KEY` and `API_SECRET`, then add the following:
+
+```
+
+NEXMO_API_KEY = your_api_key
+NEXMO_API_SECRET = your_api_secret
+
+```
+
+If you are also using a `SIGNATURE`, `APPLICATION_ID` and/or a `PRIVATE_KEY`, then add them as appropriate to your `.env` file:
+
+```
+
+NEXMO_API_SIGNATURE = your_signature
+NEXMO_PRIVATE_KEY = your_private_key_file_path
+NEXMO_APPLICATION_ID = your_application_id
+
+```
+
+To initialize your global Nexmo client in your application, run the following from your terminal:
+
+```console
+
+rails generate nexmo_initializer
+
+```
+
+This will create a `./config/initializers/nexmo.rb` file in your application that will make the variable `Nexmo` available across your application, which contains your fully credentialed Nexmo client.
+
+At this point, you can access any of the Nexmo APIs by simply referring to `Nexmo` in your code. For example, instead of first initializing a Nexmo client with your credentials to send an SMS, all you need to do is add the following to your application:
+
+```ruby
+
+Nexmo.sms.send(from: 'YOUR_NUMBER', to: 'NUMBER', text: 'Hello world')
+
+```
+
+More information on the Nexmo Ruby client library and how to use it with the Nexmo APIs can be found [here](https://github.com/Nexmo/nexmo-ruby).
+
+## License
+
+This project is under the [MIT License](LICENSE).

data/Rakefile

@@ -0,0 +1,27 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'NexmoRails'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/lib/generators/nexmo_initializer/nexmo_initializer_generator.rb

@@ -0,0 +1,20 @@
+require 'rails/generators'
+
+class NexmoInitializerGenerator < Rails::Generators::Base
+    source_root File.expand_path('../templates', __FILE__)
+
+    desc "This generator creates a Nexmo initializer file at config/initializers and makes a configured Nexmo client globally available"
+
+    def create_nexmo_initializer
+      initializer "nexmo.rb" do <<~HEREDOC
+        Nexmo.setup do |config|
+          config.api_key = ENV['NEXMO_API_KEY'],
+          config.api_secret = ENV['NEXMO_API_SECRET'],
+          config.api_signature = ENV['NEXMO_API_SIGNATURE'],
+          config.application_id = ENV['NEXMO_APPLICATION_ID'],
+          config.private_key = ENV['NEXMO_PRIVATE_KEY']
+        end
+        HEREDOC
+      end
+    end
+end

data/lib/nexmo_rails.rb

@@ -0,0 +1,20 @@
+require 'nexmo'
+require 'forwardable'
+
+module Nexmo
+  class << self
+    extend Forwardable
+
+    attr_accessor :client
+
+    def_delegators :@client, :sms, :tfa, :calls, :verify,
+                   :number_insight, :applications, :numbers,
+                   :secrets, :redact, :signature
+
+    def setup
+      self.client = ::Nexmo::Client.new do |config|
+        yield config
+      end
+    end
+  end
+end

data/lib/nexmo_rails/version.rb

@@ -0,0 +1,3 @@
+module NexmoRails
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: nexmo_rails
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nexmo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-04-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jwt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: nexmo
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.5'
+- !ruby/object:Gem::Dependency
+  name: dotenv-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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'
+- !ruby/object:Gem::Dependency
+  name: generator_spec
+  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: Rails Initializer for Nexmo's Ruby Client
+email:
+- devrel@nexmo.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- Rakefile
+- lib/generators/nexmo_initializer/nexmo_initializer_generator.rb
+- lib/nexmo_rails.rb
+- lib/nexmo_rails/version.rb
+homepage: https://github.com/Nexmo/nexmo-rails
+licenses:
+- MIT
+metadata:
+  homepage: https://github.com/Nexmo/nexmo-rails
+  source_code_uri: https://github.com/Nexmo/nexmo-rails
+  bug_tracker_uri: https://github.com/Nexmo/nexmo-rails/issues
+  changelog_uri: https://github.com/Nexmo/nexmo-rails/blog/master/CHANGES.md
+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.7.6
+signing_key: 
+specification_version: 4
+summary: This is a Rails initializer for Nexmo's Ruby Gem. To use it you'll need a
+  Nexmo account. Sign up for free at https://www.nexmo.com
+test_files: []