vonage_rails 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1e57188ca719587ccc849ea056ba617f3765e4791725f46a2c9a35b678d3aa15
+  data.tar.gz: a93c1f0c1f393db3b848acbaf79411920d8de7afbe18658cc2eaac9f64fbd63f
+SHA512:
+  metadata.gz: 45c47ada2204ab3223290f8f1df0e82cabe701ddccbdde70057ccb0197c9e2d74a421fa625dd2496f0b3453f294b7cf5e217478203f1dfa9d41060aa22319bc1
+  data.tar.gz: 585125e6ddfb45c94bfabc8178ce4c5b44915479f6d48f19f9f9f7e13588cf84e7b45fd4eb7393c2e0ecb354a4ca736ba42eb355bef3d12819c6aeaf3e073563

data/LICENSE

@@ -0,0 +1,24 @@
+The MIT License (MIT)
+
+Copyright 2020 Vonage
+
+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,108 @@
+# Vonage Rails Gem
+
+[![Gem Version](https://badge.fury.io/rb/vonage_rails.svg)](https://badge.fury.io/rb/vonage_rails) [![Coverage Status](https://coveralls.io/repos/github/Nexmo/nexmo-rails/badge.svg?branch=master)](https://coveralls.io/github/Nexmo/nexmo-rails?branch=master) [![Build Status](https://api.travis-ci.org/Nexmo/nexmo-rails.svg?branch=master)](https://travis-ci.org/Nexmo/nexmo-rails)
+
+<img src="https://developer.nexmo.com/assets/images/Vonage_Nexmo.svg" height="48px" alt="Nexmo is now known as Vonage" />
+
+This is the Vonage Rails Gem for Vonage APIs. To use it you'll
+need a Vonage account. Sign up [for free at vonage.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
+
+Vonage Rails requires: 
+
+* Rails 5.2+
+* Ruby 2.5.3+
+* To use the Vonage 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 Vonage Rails gem add it to your project's Gemfile:
+
+```ruby
+
+gem 'vonage_rails'
+
+```
+
+Then, run `bundle install` from the command line.
+
+## Usage
+
+The Vonage Rails gem will initialize a new instance of the Vonage client inside your Rails application and make it globally accessible. To make this happen, you must supply it with your Vonage API credentials. You can do so either as environemnt variables or as part of your Rails credentials.
+
+### With Environment Variables 
+
+To add your Vonage API credentials as environment variables, first add the desired Vonage credentials to your `.env` file. For example, if you are using only the `API_KEY` and `API_SECRET`, then add the following:
+
+```
+
+VONAGE_API_KEY = your_api_key
+VONAGE_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:
+
+```
+
+VONAGE_API_SIGNATURE = your_signature
+VONAGE_PRIVATE_KEY = your_private_key_file_path
+VONAGE_APPLICATION_ID = your_application_id
+
+```
+
+Make sure you have the `dotenv-rails` Gem installed in your application and that your `.env` file is included in `.gitignore` so as not to commit your credentials to version control. 
+
+### With Rails Credentials
+
+To add your Vonage API credentials to your Rails Credentials, go ahead and open your encrypted credentials file with the following command:
+
+```console
+
+$ EDITOR="code --wait" rails credentials:edit
+
+```
+
+You can replace the `EDITOR` variable with your preferred editor. Once the credentials file is open, you are able to add the Vonage credentials with the following namespacing:
+
+```yaml
+
+vonage:
+    api_key:
+    api_secret:
+
+```
+
+You may add any of the Vonage API credentials your application needs nested within the `vonage:` namespace.
+
+### Running the Initializer
+
+To initialize your global Vonage client in your application, run the following from your terminal:
+
+```console
+
+$ rails generate vonage_initializer
+
+```
+
+This will create a `./config/initializers/vonage.rb` file in your application that will make the variable `Vonage` available across your application, which contains your fully credentialed Vonage client.
+
+At this point, you can access any of the Vonage APIs by simply referring to `Vonage` in your code. For example, instead of first initializing a Vonage client with your credentials to send an SMS, all you need to do is add the following to your application:
+
+```ruby
+
+Vonage.sms.send(from: 'YOUR_NUMBER', to: 'NUMBER', text: 'Hello world')
+
+```
+
+More information on the Vonage Ruby Server SDK and how to use it with the Vonage APIs can be found [here](https://github.com/Vonage/vonage-ruby-sdk).
+
+## License
+
+This project is under the [MIT License](LICENSE).

data/Rakefile

@@ -0,0 +1,28 @@
+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    = 'VonageRails'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'bundler/gem_tasks'
+
+require 'rspec/core/rake_task'
+require 'coveralls/rake/task'
+
+RSpec::Core::RakeTask.new(:test)
+
+Coveralls::RakeTask.new
+
+task default: :test
+
+task :test_with_coveralls => [:test, 'coveralls:push']

data/lib/generators/vonage_initializer/vonage_initializer_generator.rb

@@ -0,0 +1,43 @@
+require 'rails/all'
+
+class VonageInitializerGenerator < Rails::Generators::Base
+    source_root File.expand_path('../templates', __FILE__)
+
+    desc "This generator creates a Vonage initializer file at config/initializers and makes a configured Vonage client globally available"
+
+    def create_vonage_initializer
+      if Rails.application.credentials.vonage
+        return credentials_initializer
+      end
+
+      env_initializer
+    end
+
+    private
+
+    def credentials_initializer
+      initializer "vonage.rb" do <<~HEREDOC
+        Vonage.setup do |config|
+          config.api_key = Rails.application.credentials.vonage[:api_key]
+          config.api_secret = Rails.application.credentials.vonage[:api_secret]
+          config.signature_secret = Rails.application.credentials.vonage[:api_signature]
+          config.application_id = Rails.application.credentials.vonage[:application_id]
+          config.private_key = Rails.application.credentials.vonage[:private_key]
+        end
+        HEREDOC
+      end
+    end
+
+    def env_initializer
+      initializer "vonage.rb" do <<~HEREDOC
+        Vonage.setup do |config|
+          config.api_key = ENV['VONAGE_API_KEY']
+          config.api_secret = ENV['VONAGE_API_SECRET']
+          config.signature_secret = ENV['VONAGE_API_SIGNATURE']
+          config.application_id = ENV['VONAGE_APPLICATION_ID']
+          config.private_key = ENV['VONAGE_PRIVATE_KEY']
+        end
+        HEREDOC
+      end
+    end
+end

data/lib/vonage_rails.rb

@@ -0,0 +1,28 @@
+require 'vonage'
+require 'forwardable'
+
+module Vonage
+  class << self
+    extend Forwardable
+
+    attr_accessor :client
+
+    def_delegators :@client, :account, :alerts, :applications, 
+                   :voice, :conversations, :conversions,
+                   :files, :messages, :numbers,
+                   :number_insight, :pricing, :redact, :secrets,
+                   :sms, :signature, :tfa, :verify
+                   
+    def setup(&block)
+      config = OpenStruct.new 
+      config.instance_eval(&block)
+      self.client = ::Vonage::Client.new(
+        api_key: config.api_key,
+        api_secret: config.api_secret,
+        signature_secret: config.signature_secret,
+        application_id: config.application_id,
+        private_key: config.private_key.present? && File.exist?(config.private_key) ? File.read(config.private_key) : config.private_key
+      )
+    end
+  end
+end

data/lib/vonage_rails/version.rb

@@ -0,0 +1,5 @@
+# :nocov:
+module VonageRails
+  VERSION = '1.0.0'
+end
+# :nocov:

metadata

@@ -0,0 +1,166 @@
+--- !ruby/object:Gem::Specification
+name: vonage_rails
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Vonage
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-09-15 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: vonage
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 7.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 7.2.0
+- !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: rails
+  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'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.15
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.15
+description: Rails Initializer for Vonage's Ruby Server SDK
+email:
+- devrel@vonage.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- Rakefile
+- lib/generators/vonage_initializer/vonage_initializer_generator.rb
+- lib/vonage_rails.rb
+- lib/vonage_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: []
+rubygems_version: 3.0.0
+signing_key: 
+specification_version: 4
+summary: This is a Rails initializer for Vonage's Ruby Gem. To use it you'll need
+  a Vonage account. Sign up for free at https://www.vonage.com
+test_files: []