nexmo_rails 0.3.1 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 42b972b8b6b429ac78f330b225042443a6ae3ae3cec31cebb32620fc5bbc0392
-  data.tar.gz: 0ff3462241fe40883f7f8bc9f82596176746be7025365bc096b833a305158d00
+  metadata.gz: d34cdf077d1ddbc165e0c8e1885195f7a696af8122f45051c485b21ead088cc5
+  data.tar.gz: 530deeff982fc3c73d9aeb6224ccfafdbb7b2b9e29ca3e5065cc53bdf1f57e45
 SHA512:
-  metadata.gz: eb39f0e1b88c4624c4665c96ee28dc70d1b241cf8336ea563da775f5cceacf1788264413494a5f62f35d9880d9fe376999a04d5f55cc7e1f76731361050b8d09
-  data.tar.gz: b7cb08bd45c7e5fe5e3b1caccfd236c4efe3e6cf8d96dc08d0ee2bd143aac81abb98d68035046664edb0030836ad804a376bb5efdfee31ebd7e694a3feb3bee8
+  metadata.gz: ee22b9998fe67c8a4cc3ea49a4387b5c197840d3a9b8f746cfb753d2606233eb2257d65ecb18930ffe31a93156d2050dcf8fb47f5535717a1110083109ed2040
+  data.tar.gz: 0f8c71c2fb376727a08af72ec579ea5f691326f5154c1cd331d2c30a41084aa0b2ee930aa3772773deb9f373d8be6314577168c86f08ba29c107a9a25c3ddd68

data/README.md

@@ -16,27 +16,27 @@ 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:
+To install the Nexmo Rails gem add it 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:
+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, you must supply it with your Nexmo API credentials. You can do so either as environemnt variables or as part of your Rails credentials.
+
+### With Environment Variables 
+
+To add your Nexmo API credentials as environment variables, 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:
 
 ```
 
@@ -55,11 +55,37 @@ NEXMO_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 Nexmo 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 Nexmo credentials with the following namespacing:
+
+```yaml
+
+nexmo:
+    api_key:
+    api_secret:
+
+```
+
+You may add any of the Nexmo API credentials your application needs nested within the `nexmo:` namespace.
+
+### Running the Initializer
+
 To initialize your global Nexmo client in your application, run the following from your terminal:
 
 ```console
 
-rails generate nexmo_initializer
+$ rails generate nexmo_initializer
 
 ```
 

data/Rakefile

@@ -6,6 +6,8 @@ end
 
 require 'rdoc/task'
 
+require 'rails/dummy/tasks'
+
 RDoc::Task.new(:rdoc) do |rdoc|
   rdoc.rdoc_dir = 'rdoc'
   rdoc.title    = 'NexmoRails'

data/lib/generators/nexmo_initializer/nexmo_initializer_generator.rb

@@ -1,4 +1,4 @@
-require 'rails/generators'
+require 'rails/all'
 
 class NexmoInitializerGenerator < Rails::Generators::Base
     source_root File.expand_path('../templates', __FILE__)
@@ -6,6 +6,29 @@ class NexmoInitializerGenerator < Rails::Generators::Base
     desc "This generator creates a Nexmo initializer file at config/initializers and makes a configured Nexmo client globally available"
 
     def create_nexmo_initializer
+      if Rails.application.credentials.nexmo
+        return credentials_initializer
+      end
+
+      env_initializer
+    end
+
+    private
+
+    def credentials_initializer
+      initializer "nexmo.rb" do <<~HEREDOC
+        Nexmo.setup do |config|
+          config.api_key = Rails.application.credentials.nexmo[:api_key],
+          config.api_secret = Rails.application.credentials.nexmo[:api_secret],
+          config.signature_secret = Rails.application.credentials.nexmo[:api_signature],
+          config.application_id = Rails.application.credentials.nexmo[:application_id],
+          config.private_key = Rails.application.credentials.nexmo[:private_key]
+        end
+        HEREDOC
+      end
+    end
+
+    def env_initializer
       initializer "nexmo.rb" do <<~HEREDOC
         Nexmo.setup do |config|
           config.api_key = ENV['NEXMO_API_KEY']

data/lib/nexmo_rails/version.rb

@@ -1,3 +1,3 @@
 module NexmoRails
-  VERSION = '0.3.1'
+  VERSION = '0.4.1'
 end

data/lib/nexmo_rails.rb

@@ -7,10 +7,11 @@ module Nexmo
 
     attr_accessor :client
 
-    def_delegators :@client, :account, :alerts, :applications, :calls,
-                   :conversations, :conversions, :files, :messages, 
-                   :numbers, :number_insight, :pricing, :redact, 
-                   :secrets, :sms, :signature, :tfa, :verify
+    def_delegators :@client, :account, :alerts, :applications, 
+                   :applications_v2, :calls, :conversations,
+                   :conversions, :files, :messages, :numbers,
+                   :number_insight, :pricing, :redact, :secrets,
+                   :sms, :signature, :tfa, :verify
                    
     def setup(&block)
       config = OpenStruct.new 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nexmo_rails
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.1
 platform: ruby
 authors:
 - Nexmo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-06-13 00:00:00.000000000 Z
+date: 2019-06-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jwt
@@ -80,6 +80,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails-dummy
+  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