rtpush 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4267cd81aa803556d8324b3a4fc0f0fd56144cce
-  data.tar.gz: aba5e08665d997eac4c724777a61cb812a0091be
+  metadata.gz: 527594e7040fdbf77900607cc5fdedf846a802aa
+  data.tar.gz: 3872d494fffe02eea561a6292c1e20a6e0e21dff
 SHA512:
-  metadata.gz: c45ee83f549c1d33664d43669d6d27b443f29360e9bd64c301d017d7ca1a696ce528e48c38d5e7316262b1e492460a0f4e6ccc83b1387f6a75c4088f76c9ca96
-  data.tar.gz: 0d53d99ae1f705d7d18ebb0e612e2a13432fe4b8c8d93bcb94eda08a029cc8f878920d1bc89529103c84b38a96e586526a2834599699638476d99cdba32dd7b4
+  metadata.gz: 55b6580d7e19d59c246b4f69bd7ab22264bdec49f5a1a75ebcd207512eeb8ba50e799d6bda59a5cb0d5cda065f501cc4c78cb669ba0264de4848a9a1808c52cc
+  data.tar.gz: de85e0f7851ad3a9f4b36ea3fadb5e0c403d1a80074bfa0033f289f787617cddbbd7dd89c325178e0e15a6ee936094663aa7b39e289a9b7d06a64eeb80d61348

data/README.md

@@ -1,12 +1,28 @@
-# rtpush [![Gem Version](https://badge.fury.io/rb/rtpush.svg)](https://badge.fury.io/rb/rtpush) [![Maintainability](https://api.codeclimate.com/v1/badges/687aec30cf02fad5b6eb/maintainability)](https://codeclimate.com/github/satnami/rtpush/maintainability)
+[![Gem Version](https://badge.fury.io/rb/rtpush.svg)](https://badge.fury.io/rb/rtpush) [![Maintainability](https://api.codeclimate.com/v1/badges/687aec30cf02fad5b6eb/maintainability)](https://codeclimate.com/github/satnami/rtpush/maintainability)
 
+# RTPush. The terminal push notification service for Ruby.
+
+## Supported Services
+  * [**FCM Push Notification Service**](https://firebase.google.com/docs/cloud-messaging/)
+  * [**Instapush Notification Service**](https://instapush.im/)
+  * [**Slack Notification Service**](https://api.slack.com/incoming-webhooks)
+  * [**Twilio Messaging Service**](https://www.twilio.com/docs/api/messaging/)
+  
 ## Installation
 ```
 $ gem install rtpush
 ```
 
-## Prerequisites
-make sure you have export variables those in your env
+## Configuring
+You can use [dotenv](https://github.com/bkeepers/dotenv), which is included in the Gemfile,
+to fill in any values that you can't or won't supply through the environment.
+
+In order of precedence RTPush uses:
+1. Environment variables (for example MY_VALUE=abc)
+2. Values provided in a .env file
+3. Default values from .env.default
+
+## Configuration Parameters
 ```
 NOTIFICATION_TITLE=XX
 
@@ -48,4 +64,4 @@ rspec spec
 ## Improvement
 ```
 TBD
-```
+```

data/lib/rtpush.rb

@@ -1,8 +1,11 @@
-Dir[File.join(__dir__, '/initializers/*.rb')].each { |file| require file }
-Dir[File.join(__dir__, '/services/*.rb')].each { |file| require file }
+Dir[File.join(__dir__, '/rtpush/*.rb')].each { |file| require file }
+Dir[File.join(__dir__, '/rtpush/initializers/*.rb')].each { |file| require file }
+Dir[File.join(__dir__, '/rtpush/adapters/*.rb')].each { |file| require file }
 
 module RTPush
   def self.initialize(options, message)
+    raise ArgumentError, 'Missing Message param' if message.to_s.empty?
+    raise ArgumentError, 'Missing Arguments params' if options.empty?
     push(strategies(options), message)
   end
 
@@ -19,15 +22,15 @@ module RTPush
     options.each do |option|
       case option
       when 'sms'
-        strategies << RTPush::TwilioService
+        strategies << RTPush::TwilioAdapter
       when 'mobile'
-        strategies << RTPush::FcmService
+        strategies << RTPush::FcmAdapter
       when 'insta'
-        strategies << RTPush::InstapushService
+        strategies << RTPush::InstapushAdapter
       when 'slack'
-        strategies << RTPush::SlackService
+        strategies << RTPush::SlackAdapter
       else
-        #
+        raise Errors::NotImplementedStrategyError, "Unknown strategy #{option}"
       end
     end
     strategies

data/lib/rtpush/adapters/base_adapter.rb

@@ -0,0 +1,60 @@
+module RTPush
+  class BaseAdapter
+    attr_accessor :errors
+    @@_validators = []
+
+    def initialize
+      @errors = []
+    end
+
+    def self.validates_presence_of(attribute)
+      @@_validators << PresenceValidator.new(attribute)
+    end
+
+    def self.validates_existence_of(attribute)
+      @@_validators << PresenceValidator.new(attribute)
+    end
+
+    def valid?
+      @@_validators.each do |v|
+        v.validate(self)
+      end
+      @errors.empty?
+    end
+
+    def exist?
+      @@_validators.each do |v|
+        v.exist(self)
+      end
+      @errors.empty?
+    end
+  end
+
+  class PresenceValidator
+    attr_reader :attributes
+
+    def initialize(*attributes)
+      @attributes = attributes
+    end
+
+    def validate(record)
+      begin
+        @attributes.each do |attribute|
+          data = record.send(attribute)
+          if data.nil? || data.empty?
+            record.errors << ["#{attribute} can't be blank"]
+          end
+        end
+      end
+    end
+
+    def exist(record)
+      @attributes.each do |attribute|
+        data = ENV[attribute.to_s]
+        if data.nil? || data.empty?
+          record.errors << ["#{attribute} can't be empty"]
+        end
+      end
+    end
+  end
+end

data/lib/{services/fcm_service.rb → rtpush/adapters/fcm_adapter.rb}

@@ -1,5 +1,5 @@
 module RTPush
-  class FcmService
+  class FcmAdapter < RTPush::BaseAdapter
     class << self
       def push(message)
         registration_ids = [ENV['GCM_ANDROID_DEVICE_TOKEN']]
@@ -16,8 +16,8 @@ module RTPush
           }.reject { |_k, v| v.nil? || v.empty? }
         }.reject { |_k, v| v.nil? || v.empty? }
         client.send(registration_ids, options)
-      rescue StandardError => _
-        nil
+      rescue StandardError => e
+        raise Errors::AdapterError, e.message
       end
 
       private

data/lib/{services/instapush_service.rb → rtpush/adapters/instapush_adapter.rb}

@@ -1,12 +1,12 @@
 module RTPush
-  class InstapushService
+  class InstapushAdapter < RTPush::BaseAdapter
     class << self
       def push(message)
         event = Instapush::Event.new ENV['INSTAPUSH_APP_EVENT']
         event.tracker = { message: message, version: '0.9.0' }
         client.push event
-      rescue StandardError => _
-        nil
+      rescue StandardError => e
+        raise Errors::AdapterError, e.message
       end
 
       private

data/lib/{services/rpush_service.rb → rtpush/adapters/rpush_adapter.rb}

@@ -1,11 +1,11 @@
 module RTPush
-  class RpushService
+  class RpushAdapter < RTPush::BaseAdapter
     class << self
       def push(message)
         gcm_push(message)
         apn_push(message)
-      rescue StandardError => _
-        nil
+      rescue StandardError => e
+        raise Errors::AdapterError, e.message
       end
 
       private

data/lib/{services/slack_service.rb → rtpush/adapters/slack_adapter.rb}

@@ -1,11 +1,11 @@
 module RTPush
-  class SlackService
+  class SlackAdapter < RTPush::BaseAdapter
     class << self
       def push(message)
         data = %(*#{ENV['NOTIFICATION_TITLE']}*\n`#{message}`)
         client.ping(data)
-      rescue StandardError => _
-        nil
+      rescue StandardError => e
+        raise Errors::AdapterError, e.message
       end
 
       private

data/lib/{services/twilio_service.rb → rtpush/adapters/twilio_adapter.rb}

@@ -1,5 +1,5 @@
 module RTPush
-  class TwilioService
+  class TwilioAdapter < RTPush::BaseAdapter
     class << self
       def push(message)
         client.messages.create(
@@ -7,8 +7,8 @@ module RTPush
           to: ENV['TWILIO_TO_NUMBER'],
           body: message
         )
-      rescue StandardError => _
-        nil
+      rescue StandardError => e
+        raise Errors::AdapterError, e.message
       end
 
       private

data/lib/rtpush/errors.rb

@@ -0,0 +1,24 @@
+module Errors
+  class Error < StandardError
+    def initialize(msg = nil)
+      @message = msg
+    end
+
+    def message
+      @message
+    end
+  end
+
+  class NotImplementedStrategyError < Error
+    def message
+      super
+    end
+  end
+
+  class AdapterError < Error
+    def message
+      super
+    end
+  end
+
+end

data/lib/rtpush/version.rb

@@ -0,0 +1,7 @@
+module RTPush
+  module VERSION
+    def self.to_s
+      '0.0.6'
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rtpush
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Mhd Sami AlMouhtaseb
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-08 00:00:00.000000000 Z
+date: 2018-03-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dotenv
@@ -184,7 +184,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
-description: terminal push notification service for ruby.
+description: The terminal push notification service for Ruby.
 email: mssatnami@gmail.com
 executables:
 - rtpush
@@ -194,19 +194,22 @@ files:
 - LICENSE
 - README.md
 - bin/rtpush
-- lib/initializers/dotenv.rb
-- lib/initializers/fcm.rb
-- lib/initializers/instapush.rb
-- lib/initializers/redis.rb
-- lib/initializers/rpush.rb
-- lib/initializers/slack.rb
-- lib/initializers/twilio.rb
 - lib/rtpush.rb
-- lib/services/fcm_service.rb
-- lib/services/instapush_service.rb
-- lib/services/rpush_service.rb
-- lib/services/slack_service.rb
-- lib/services/twilio_service.rb
+- lib/rtpush/adapters/base_adapter.rb
+- lib/rtpush/adapters/fcm_adapter.rb
+- lib/rtpush/adapters/instapush_adapter.rb
+- lib/rtpush/adapters/rpush_adapter.rb
+- lib/rtpush/adapters/slack_adapter.rb
+- lib/rtpush/adapters/twilio_adapter.rb
+- lib/rtpush/errors.rb
+- lib/rtpush/initializers/dotenv.rb
+- lib/rtpush/initializers/fcm.rb
+- lib/rtpush/initializers/instapush.rb
+- lib/rtpush/initializers/redis.rb
+- lib/rtpush/initializers/rpush.rb
+- lib/rtpush/initializers/slack.rb
+- lib/rtpush/initializers/twilio.rb
+- lib/rtpush/version.rb
 homepage: https://github.com/satnami/rtpush
 licenses:
 - MIT
@@ -228,7 +231,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.5.2.1
 signing_key: 
 specification_version: 4
 summary: Ruby terminal push notification service.