hertz-courier-twilio 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 686cfdb462120ccab5c110158373764e03e6168c
+  data.tar.gz: 453aecc745aba06d542e2349325e409f84d6f0b8
+SHA512:
+  metadata.gz: 8f428a12a91a9d1d05a62e74dcec0ca9024211c447d9a97409710341d96e7860f54934ae37b8dcd61e460551a14bd2be27cfbac5e4708acb63c72bf6250ed198
+  data.tar.gz: d1d17d00836ba37ecc6f5c1abb979a32dbebdfb96b6fe93e58373f9ad1930c7c91f7dd460e9c7d077fd45d74fff82fc4397d5cadbf70c0a661ca41c6bab23837

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2016 Alessandro Desantis
+
+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,97 @@
+# Hertz::Courier::Twilio
+
+[![Dependency Status](https://gemnasium.com/badges/github.com/alessandro1997/hertz-courier-twilio.svg)](https://gemnasium.com/github.com/alessandro1997/hertz-courier-twilio)
+[![Code Climate](https://codeclimate.com/github/alessandro1997/hertz-courier-twilio/badges/gpa.svg)](https://codeclimate.com/github/alessandro1997/hertz-courier-twilio)
+
+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.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'hertz-courier-twilio'
+```
+
+And then execute:
+
+```console
+$ bundle
+```
+
+Or install it yourself as:
+
+```console
+$ gem install hertz-courier-twilio
+```
+
+Then, run the installer generator:
+
+```console
+$ 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.
+
+Finally, you will have to expose a `#hertz_phone_number` method in your receiver
+class:
+
+```ruby
+class User
+  include Hertz::Notifiable
+
+  def hertz_phone_number
+    phone_number
+  end
+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:
+
+```ruby
+class User
+  include Hertz::Notifiable
+
+  def hertz_phone_number
+    phone_number if phone_number_verified?
+  end
+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:
+
+```ruby
+class CommentNotification < Hertz::Notification
+  deliver_by :twilio
+
+  def sms_body
+    'You received a new comment!'
+  end
+end
+```
+
+All `CommentNotification`s will now be delivered by SMS! :)
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/alessandro1997/hertz-courier-twilio.
+
+## License
+
+The gem is available as open source under the terms of the
+[MIT License](http://opensource.org/licenses/MIT).
+
+# To do
+
+- [ ] Allow changing the job's queue
+- [ ] Store notification delivery in the DB to avoid resending

data/Rakefile

@@ -0,0 +1,30 @@
+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    = 'Hertz'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+load 'rails/tasks/statistics.rake'
+
+Bundler::GemHelper.install_tasks
+
+Rake::TestTask.new(:spec) do |t|
+  t.libs << 'lib'
+  t.libs << 'spec'
+  t.pattern = 'spec/**/*_spec.rb'
+  t.verbose = false
+end
+
+task default: :spec

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

@@ -0,0 +1,29 @@
+# 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?
+
+          twilio_client.messages.create(
+            to: notification.receiver.hertz_phone_number,
+            from: Hertz::Courier::Twilio.phone_number,
+            body: notification.sms_body
+          )
+        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

@@ -0,0 +1,14 @@
+# 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/generators/hertz/courier/twilio/templates/initializer.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+Hertz::Courier::Twilio.configure do |config|
+  # Your Twilio phone number.
+  config.phone_number = '+390123456789'
+
+  # Your Twilio account's SID.
+  config.account_sid = 'YourTwilioAccountSid'
+
+  # Your Twilio authentication token
+  config.auth_token = 'YourTwilioAuthToken'
+end

data/lib/hertz/courier/twilio.rb

@@ -0,0 +1,25 @@
+# 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

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

@@ -0,0 +1,10 @@
+# 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

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

metadata

@@ -0,0 +1,221 @@
+--- !ruby/object:Gem::Specification
+name: hertz-courier-twilio
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Alessandro Desantis
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-05-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.6
+- !ruby/object:Gem::Dependency
+  name: hertz
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: twilio-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.11.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.11.1
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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: rubocop-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: rspec-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: rspec-activejob
+  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: fuubar
+  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: faker
+  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: database_cleaner
+  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: factory_girl_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: pg
+  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: 
+email:
+- desa.alessandro@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+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
+homepage: https://github.com/alessandro1997/hertz-courier-twilio
+licenses:
+- MIT
+metadata: {}
+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.5.1
+signing_key: 
+specification_version: 4
+summary: A Twilio courier for Hertz.
+test_files: []