hertz-twilio 1.0.3 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0948a5633393fc8cee816b06c33e8fe69922f9fcec29acba789a27928db36a8f'
-  data.tar.gz: '0876362cf706cf713acfb03ea9e0392761e47298c3714c3e09cb2741a60ad6de'
+  metadata.gz: 4a440feb7decf0ab34fa2bdfd97788e3361d05102e4b2d4448d73cc6733aa516
+  data.tar.gz: 45afcdc2bcbf6e20bfe8f5d261f5ed6fe58c08e6f36761e5e3a7d17f7a989e18
 SHA512:
-  metadata.gz: 0717d2965a2be52a45770ec1600a5ed2b6a1c7348cafe16b5b9bf2b3197f9eb46339b441dc32a78a61ac47f23e7216bb7fb6cf2b0e3e8290957a5fb410d43313
-  data.tar.gz: 054b9b206c936a9d72b296195a9b6b74011b7215ed47d1bbdcdf2408436a4ac93c30328232ea1e5ea3281ddb0695d962ee7284666a0efdbb495030fb5386b1c9
+  metadata.gz: 73faa0c4783d912105a483102abc1adf94c86545bfaec80572e25e2f0a40fb5adda4f3299f658afce00be5e9f21301bc08067767880e834e8ca4377a910a0fe5
+  data.tar.gz: 0bea9290bd484a5861d56bf4bb5130805a4a04424785cfb645e9ec7ab76e69267cb799b5234a294f7181af15cd575c27726068370ddba4250473883fd467cdfb

data/README.md

@@ -1,12 +1,11 @@
-# Hertz::Courier::Twilio
+# Hertz::Twilio
 
 [![Build Status](https://travis-ci.org/aldesantis/hertz-twilio.svg?branch=master)](https://travis-ci.org/aldesantis/hertz-twilio)
-[![Dependency Status](https://gemnasium.com/badges/github.com/aldesantis/hertz-twilio.svg)](https://gemnasium.com/github.com/aldesantis/hertz-twilio)
 [![Coverage Status](https://coveralls.io/repos/github/aldesantis/hertz-twilio/badge.svg?branch=master)](https://coveralls.io/github/aldesantis/hertz-twilio?branch=master)
-[![Maintainability](https://api.codeclimate.com/v1/badges/e51e8d7489eb72ab97ba/maintainability)](https://codeclimate.com/github/aldesantis/hertz-twilio/maintainability)
+[![Maintainability](https://api.codeclimate.com/v1/badges/204eed3c916b560ef788/maintainability)](https://codeclimate.com/github/aldesantis/hertz-twilio/maintainability)
 
-This is a [Hertz](https://github.com/alessandro1997/hertz) courier for sending notifications to your users via SMS by
-leveraging the [Twilio](https://www.twilio.com) API.
+This is a [Hertz](https://github.com/aldesantis/hertz) courier for sending notifications to your 
+users via SMS by leveraging the [Twilio](https://www.twilio.com) API.
 
 ## Installation
 
@@ -34,9 +33,9 @@ Then, run the installer generator:
 $ rails g hertz:courier:twilio:install
 ```
 
-The courier will use ActiveJob to asynchronously deliver the text messages, so make sure that you're executing 
-background jobs with some adapter (`inline` will work, even though it's not recommended). Jobs are pushed to the
-`default` queue.
+The courier will use ActiveJob to asynchronously deliver the text messages, so make sure that you're 
+executing background jobs with some adapter (`inline` will work, even though it's not recommended). 
+Jobs are pushed to the `default` queue.
 
 Finally, you will have to expose a `#hertz_phone_number` method in your receiver class:
 
@@ -50,9 +49,9 @@ class User
 end
 ```
 
-If `#hertz_phone_number` returns an empty value (i.e. `false`, `nil` or an empty string) at the time the job is
-executed, the notification will not be delivered. This allows you to programmatically enable/disable SMS notifications 
-for a user:
+If `#hertz_phone_number` returns an empty value (i.e. `false`, `nil` or an empty string) at the time 
+the job is executed, the notification will not be delivered. This allows you to programmatically 
+enable/disable SMS notifications for a user:
 
 ```ruby
 class User
@@ -66,8 +65,8 @@ end
 
 ## Usage
 
-All you need to do in order to start delivering notifications by SMS is add `twilio` to the notification's `#deliver_by`
-statement and provide an SMS body:
+All you need to do in order to start delivering notifications by SMS is add `twilio` to the 
+notification's `#deliver_by` statement and provide an SMS body:
 
 ```ruby
 class CommentNotification < Hertz::Notification

data/Rakefile

@@ -1,6 +1,8 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec

data/app/jobs/hertz/twilio/notification_delivery_job.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Hertz
+  module Twilio
+    class NotificationDeliveryJob < ActiveJob::Base
+      queue_as :default
+
+      def perform(notification)
+        return unless notification.receiver.hertz_phone_number.present?
+        return if notification.delivered_with?(:twilio)
+
+        twilio_client.messages.create(
+          to: notification.receiver.hertz_phone_number,
+          from: Hertz::Twilio.sender_id || Hertz::Twilio.phone_number,
+          body: notification.sms_body
+        )
+
+        notification.mark_delivered_with(:twilio)
+      end
+
+      private
+
+      def twilio_client
+        @twilio_client ||= ::Twilio::REST::Client.new(
+          Hertz::Twilio.account_sid,
+          Hertz::Twilio.auth_token
+        )
+      end
+    end
+  end
+end

data/lib/generators/hertz/twilio/install_generator.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Hertz
+  module Twilio
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path('templates', __dir__)
+
+      def copy_initializer_file
+        copy_file 'initializer.rb', 'config/initializers/hertz_twilio.rb'
+      end
+    end
+  end
+end

data/lib/generators/hertz/{courier/twilio → twilio}/templates/initializer.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-Hertz::Courier::Twilio.configure do |config|
+Hertz::Twilio.configure do |config|
   # Your Twilio phone number.
   config.phone_number = '+390123456789'
 
@@ -9,4 +9,8 @@ Hertz::Courier::Twilio.configure do |config|
 
   # Your Twilio authentication token
   config.auth_token = 'YourTwilioAuthToken'
+
+  # Optional: An alphanumeric sender ID that will appear instead of your phone number. Not setting
+  # this will just use `config.phone_number`.
+  config.sender_id = nil
 end

data/lib/hertz/twilio/engine.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Hertz
+  module Twilio
+    class Engine < ::Rails::Engine
+      isolate_namespace Hertz::Twilio
+    end
+  end
+end

data/lib/hertz/twilio/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Hertz
+  module Twilio
+    VERSION = '2.0.0'
+  end
+end

data/lib/hertz/twilio.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'twilio-ruby'
+require 'hertz'
+
+require 'hertz/twilio/engine'
+require 'hertz/twilio/version'
+
+module Hertz
+  module Twilio
+    mattr_accessor :phone_number, :account_sid, :auth_token, :sender_id
+
+    class << self
+      def configure
+        yield(self)
+      end
+
+      def deliver_notification(notification)
+        Hertz::Twilio::NotificationDeliveryJob.perform_later(notification)
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hertz-twilio
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 2.0.0
 platform: ruby
 authors:
 - Alessandro Desantis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-14 00:00:00.000000000 Z
+date: 2018-10-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hertz
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
@@ -208,12 +208,12 @@ files:
 - MIT-LICENSE
 - README.md
 - Rakefile
-- app/jobs/hertz/courier/twilio/notification_delivery_job.rb
-- lib/generators/hertz/courier/twilio/install_generator.rb
-- lib/generators/hertz/courier/twilio/templates/initializer.rb
-- lib/hertz/courier/twilio.rb
-- lib/hertz/courier/twilio/engine.rb
-- lib/hertz/courier/twilio/version.rb
+- app/jobs/hertz/twilio/notification_delivery_job.rb
+- lib/generators/hertz/twilio/install_generator.rb
+- lib/generators/hertz/twilio/templates/initializer.rb
+- lib/hertz/twilio.rb
+- lib/hertz/twilio/engine.rb
+- lib/hertz/twilio/version.rb
 homepage: https://github.com/alessandro1997/hertz-twilio
 licenses:
 - MIT
@@ -234,7 +234,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.5
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: A Twilio courier for Hertz.

data/app/jobs/hertz/courier/twilio/notification_delivery_job.rb

@@ -1,33 +0,0 @@
-# frozen_string_literal: true
-
-module Hertz
-  module Courier
-    module Twilio
-      class NotificationDeliveryJob < ActiveJob::Base
-        queue_as :default
-
-        def perform(notification)
-          return unless notification.receiver.hertz_phone_number.present?
-          return if notification.delivered_with?(:twilio)
-
-          twilio_client.messages.create(
-            to: notification.receiver.hertz_phone_number,
-            from: Hertz::Courier::Twilio.phone_number,
-            body: notification.sms_body
-          )
-
-          notification.mark_delivered_with(:twilio)
-        end
-
-        private
-
-        def twilio_client
-          @twilio_client ||= ::Twilio::REST::Client.new(
-            Hertz::Courier::Twilio.account_sid,
-            Hertz::Courier::Twilio.auth_token
-          )
-        end
-      end
-    end
-  end
-end

data/lib/generators/hertz/courier/twilio/install_generator.rb

@@ -1,15 +0,0 @@
-# frozen_string_literal: true
-
-module Hertz
-  module Courier
-    module Twilio
-      class InstallGenerator < Rails::Generators::Base
-        source_root File.expand_path('../templates', __FILE__)
-
-        def copy_initializer_file
-          copy_file 'initializer.rb', 'config/initializers/hertz_twilio.rb'
-        end
-      end
-    end
-  end
-end

data/lib/hertz/courier/twilio/engine.rb

@@ -1,11 +0,0 @@
-# frozen_string_literal: true
-
-module Hertz
-  module Courier
-    module Twilio
-      class Engine < ::Rails::Engine
-        isolate_namespace Hertz::Courier::Twilio
-      end
-    end
-  end
-end

data/lib/hertz/courier/twilio/version.rb

@@ -1,9 +0,0 @@
-# frozen_string_literal: true
-
-module Hertz
-  module Courier
-    module Twilio
-      VERSION = '1.0.3'
-    end
-  end
-end

data/lib/hertz/courier/twilio.rb

@@ -1,26 +0,0 @@
-# frozen_string_literal: true
-
-require 'twilio-ruby'
-require 'hertz'
-
-require 'hertz/courier/twilio/engine'
-require 'hertz/courier/twilio/version'
-
-module Hertz
-  module Courier
-    module Twilio
-      mattr_accessor :phone_number, :account_sid, :auth_token
-
-      class << self
-        def configure
-          yield(self)
-        end
-
-        def deliver_notification(notification)
-          Hertz::Courier::Twilio::NotificationDeliveryJob
-            .perform_later(notification)
-        end
-      end
-    end
-  end
-end