hey-you 1.0.1 → 1.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aa6f17fe4c0da43b871befcc3b590393cc49ffd96fdd4191ac330a39a3663d1f
-  data.tar.gz: 25e6a567dc7dcfbef8d1f90ad3fd2d6c5aa7e0e837ce674dc4319e6cef18df03
+  metadata.gz: 6fc4f5a3d663c2e8496f01efec20e020f02b03088d4a83c182cf1a673deb2886
+  data.tar.gz: d442018540664c329f346ebaabd4c558d4da11b39763a703b990dd09d6e8a1dd
 SHA512:
-  metadata.gz: 9107c177d8ca761a216db6ea8b667fd29ec7f75829cca42b5610ba8c7e567a53f495c4b2c9fc9e708958a7036e1fed3931ca18a6e41d511094f41df4190e60c2
-  data.tar.gz: 5c980f03a8528570b355ba4e7e425d27259768bc36ab679aeff93bb2a95e31e56975e0b8bf3b0c78cbfc24dfb63e96a293af505bcc0ba37dfcce5b8a65383e04
+  metadata.gz: 7cfad0eac54d8256b0347bffeff673e938e265c16ca4adf724390588e77046449bc62cab904171fb8baf114d47e5255cef60fa0d19b6a79f5d7fbcdf6085c113
+  data.tar.gz: 64b3e74fb8269048f2fc3dccd3fd49824c4d905ba0dec1376d1c8a7ab659d4af91805a7699c9d4f05e398e6e4aba212fb6bae774d38c30abc4e679b8b47b7f25

data/.travis.yml

@@ -1,10 +1,9 @@
 sudo: false
 language: ruby
 rvm:
-  - 2.3.3
-  - 2.4.2
-  - 2.5.3
-  - 2.6.1
+  - 2.5.0
+  - 2.6.0
+  - 2.7.0
 before_install: gem install bundler
 scripts:
   - bundle exec rspec

data/CHANGELOG.md

@@ -0,0 +1,19 @@
+# Changelog for hey-you gem
+## 1.3.0
+- Feature: `body_part` in email builder.
+
+### 1.2.3
+- Improvement: fix ruby 2.7 warnings
+- Fix: fix `NoMethodError` in `sender.rb` when channel must be ignored by `if` 
+
+### 1.2.2
+- Improvement: `if` condition for receiver (if condition `false` - sending will be skipped).
+- Improvement: `force` option - send message independent on `if` condition.
+
+
+### 1.2.1
+- Improvement: Builder will not make channel builder if it skipped by only option
+
+### 1.2.0
+- Feature: data source extensions (check readme for more information). 
+__Attention__: You should rewrite your configuration for use yaml data source! 

data/README.md

@@ -1,4 +1,4 @@
-# HeyYou [Alpha]
+# HeyYou
 [![Build Status](https://travis-ci.com/QNester/hey-you.svg?branch=master)](https://travis-ci.com/QNester/hey-you#)
 [![Gem Version](https://badge.fury.io/rb/hey-you.svg)](https://badge.fury.io/rb/hey-you)
 
@@ -20,7 +20,7 @@ him easy.
 
 
 ## Requirements
- * Ruby 2.3.0 min (rspec works with ruby 2.3.3, 2.4.2, 2.5.3)
+ * Ruby 2.5.0 min (rspec works with ruby 2.5.0, 2.6.0, 2.7.0)
  * FCM - Gem send push notification using [fcm gem](https://github.com/spacialdb/fcm).
  You need *fcm server key* to successful configure push notifications.
 
@@ -44,15 +44,20 @@ Or install it yourself as:
 First, you must configure HeyYou. Example:
 ```ruby
   HeyYou::Config.configure do
-    config.collection_files = ['config/notifications.yml']
+    config.data_source.options = { collection_files: ['config/notifications.yml'] }
     config.email.from = 'noreply@example-mail.com'
     config.push.fcm_token = 'fcm_server_key'
   end
 ```
 #### Required settings
 Options for gem base work.
-##### Base
-* __config.collection_files__ - File or files contained all your notifications texts.
+##### Data Source
+* __config.data_source.source_class__ - Class implemented instance method `load_collections` returning hash (by default `HeyYou::DataSource::Yaml`)
+* __config.data_source.options__ - Arguments for source_class. This options will be passed to init `source_class`
+OR
+* __config.data_source.source_instance__ - Instance of source class implemented `load_collections`
+
+Read more about data source in [data source](#data-source-1).d
 ##### Push
 * __config.push.fcm_token__ - Required setting for push channel. You can not send
 push messages if setting was not set. You should set it to equal your fcm server key.
@@ -62,8 +67,6 @@ push messages if setting was not set. You should set it to equal your fcm server
 #### Optional settings
 Additional options for configure your notifications.
 #### Base
-* __config.env_collection_file__ - File contained all your notifications texts for
-environment. You can set it like `notifications.#{ENV['APP_ENV]}.yml`
 * __config.splitter__ - Chars for split notification keys for 
 builder. Default: `.`
 * __config.registered_channels__ - Avialable channels for your
@@ -77,9 +80,10 @@ notifications for build should be nested in `I18n.locale` key. Default: `false`.
 # config/initializers/hey-you.rb
 HeyYou::Config.configure do
   ...
-  config.collection_files = Rails.application.config.i18n.available_locales.map do |locale|
+  i18n_files = Rails.application.config.i18n.available_locales.map do |locale|
     "config/notifications/#{locale}.yml" 
   end 
+  config.data_source.options = { collection_files: i18n_files }
   ...
 end 
 ```
@@ -159,8 +163,8 @@ fetching values required to send notification. For push channel
 expected that proc will return receiver's fcm registration id. For
 email expected that proc will return receiver's email address.
 
-You can pass options for receiver channels. You must pass proc with receive_data to `:subject` key and options 
-pass to `:options` key:
+You can pass options and sending condition for receiver channels. You must pass proc with receive_data to `:subject` key and options 
+pass to `:options` key. `if` key should be passed for sending condition:
 
 ```ruby
 class User < Model
@@ -168,7 +172,11 @@ class User < Model
   
   receive(
     push: -> { push_token.value }, 
-    email: { subject: -> { email }, options: { mailer_class: UserMailer, mailer_method: :notify! } }
+    email: { 
+      subject: -> { email }, 
+      if: -> { email_notifications? },
+      options: { mailer_class: UserMailer, mailer_method: :notify! } 
+    }
   )
 end
 ``` 
@@ -185,9 +193,18 @@ Last command will fetch notifications credentials for user instance
 and will try to send SMS, Push and Email for it. What argument we pass
 for method? This is string key for builder. Read next to understand it.
 
+Sometimes you need send notification independent on user's notification settings. For this case you can use
+`force` option in `#send_notification`:
+```ruby
+user = User.find(1)
+user.settings.update!(email_notifications: false)
+user.send_notification('for_users.hello') #=> will not send notification
+user.send_notification('for_users.hello', force: true) #=> will send notification
+```
+
 ### Build your notification
 HeyYou Notification Builder - good system for store your notifications in one place.
-You need create yml file with follow format:
+By default you need create yml file with follow format:
 ```yaml
 # config/notifications/collection.yml
 any_key:
@@ -214,6 +231,46 @@ notification will send for all available channels for receiver:
 1) Send push via fcm
 2) Send email
 
+#### Data Source
+Often we need store our notification text in another data source, not int yml files. HeyYou has flexible
+system for data source. All what you need - make your own provider source and pass it to config. For example:
+
+```ruby
+class NotificationText < ApplicationRecord
+  def self.load_collections
+    # load colelctions from database to hash
+    # THIS METHOD MUST returns hash! 
+  end
+end
+```
+
+```ruby
+HeyYou::Config.configure do
+  # NotificationText is a rails model
+  config.data_source.source_instance = NotificationText
+end
+```
+
+HeyYou will pull texts from database to memory with initialize your application after this configuration. Builder
+will build your texts successfully.
+
+HeyYou by default contains only two data sources:
+1. `HeyYou::DataSource::Yaml` - for store notifications collections in data. For example: 
+```ruby
+  HeyYou::Config.configure do
+    config.data_source.source_class = HeyYou::DataSource::Yaml
+    config.data_source.options = { collection_files: ['config/notifications.yml'] }
+  end
+```
+2. `HeyYou::DataSource::Hash` - store notification everywhere you want and pass to HeyYou only hash
+```ruby
+  config.data_source.source_class = HeyYou::DataSource::Yaml
+  config.data_source.options = { data: { welcome: { email: { ... }, push: { ... } } } }
+```
+
+__Pay attention__: for difference source we should pass difference options.
+
+
 ### Send notification
 Receiver not only one way to send notification. You can send it using `HeyYou::Sender`.
 Just use method `#send` for HeyYou::Sender and pass notification key and `to` options

data/hey_you.gemspec

@@ -26,7 +26,7 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency "mail", '~> 2.7'
   spec.add_runtime_dependency "i18n", '~> 1.0'
 
-  spec.add_development_dependency "rake", '~> 10.5'
+  spec.add_development_dependency "rake", '~> 13.0'
   spec.add_development_dependency "rspec", '~> 3.7'
   spec.add_development_dependency "webmock", '~> 3.4'
   spec.add_development_dependency "ffaker", '~> 2.9'

data/lib/hey_you/builder.rb

@@ -13,11 +13,14 @@ module HeyYou
     # Define methods for each registered channel. After initialize you can use
     #   `instance.<ch_name>`. It will be return instance of HeyYou::Builder::<YOUR_CHANNEL_NAME>
     #
+    # Skip builder for excluded channels (not included in `only` option)
+    #
+    # @param [String] key - notification key for fetching notification data from collection
     def initialize(key, **options)
       @data = fetch_from_collection_by_key(key, options[:locale])
       @options = options
       config.registered_channels.each do |ch|
-        init_channel_builder(ch, key)
+        init_channel_builder(ch, key) if channel_allowed_by_only?(ch, options[:only])
       end
     end
 
@@ -35,7 +38,7 @@ module HeyYou
       end
 
       ch_builder =
-        HeyYou::Builder.const_get("#{ch.downcase.capitalize}").new(data, key, options)
+        HeyYou::Builder.const_get("#{ch.downcase.capitalize}").new(data[ch.to_s], key, **options)
       instance_variable_set("@#{ch}".to_sym, ch_builder)
 
       define_ch_method(ch)
@@ -61,6 +64,12 @@ module HeyYou
       raise DataNotFound, "collection data not found for `#{keys.join(config.splitter)}`"
     end
 
+    def channel_allowed_by_only?(ch, only)
+      return true unless only
+      return only.map(&:to_sym).include?(ch.to_sym) if only.is_a?(Array)
+      only.to_sym == ch.to_sym
+    end
+
     class UnknownLocale < StandardError; end
     class DataNotFound < StandardError; end
     class RequiredChannelNotFound < StandardError; end

data/lib/hey_you/builder/_base.rb

@@ -23,10 +23,8 @@ module HeyYou
         raise InterpolationError, "Failed build notification string `#{notification_string}`: #{err.message}"
       end
 
-      def ch_data
-        data.fetch(current_builder_name)
-      end
 
+      alias ch_data data
       alias channel_data ch_data
 
       def ch_options

data/lib/hey_you/builder/email.rb

@@ -3,19 +3,36 @@ require_relative '_base'
 module HeyYou
   class Builder
     class Email < Base
-      attr_reader :subject, :body, :layout, :mailer_class, :mailer_method, :delivery_method
+      attr_reader :subject, :body, :layout, :mailer_class, :mailer_method, :delivery_method, :body_parts
 
       def build
         @mailer_class = ch_data.fetch('mailer_class', nil)
         @mailer_method = ch_data.fetch('mailer_method', nil)
         @delivery_method = ch_data.fetch('delivery_method', nil)
-        @body = interpolate(ch_data.fetch('body'), options)
+        @body = interpolate(ch_data['body'], options) if ch_data['body']
+        @body_parts = interpolate_each(ch_data.fetch('body_parts', nil), options)
         @subject = interpolate(ch_data.fetch('subject'), options)
       end
 
       def to_hash
-        { body: body, subject: subject }
+        { body: body, subject: subject, body_parts: body_parts }
+      end
+
+      private
+
+      def interpolate_each(notification_hash, options)
+        return notification_hash unless notification_hash.is_a?(Hash)
+
+        notification_hash.each do |k, v|
+          next interpolate_each(v, options) if v.is_a?(Hash)
+
+          begin
+            notification_hash[k] = v % options
+          rescue KeyError
+            raise InterpolationError, "Failed build notification string `#{v}`: #{err.message}"
+          end
+        end
       end
     end
   end
-end
+end

data/lib/hey_you/channels/email.rb

@@ -7,13 +7,13 @@ module HeyYou
       class << self
         def send!(builder, to:, **options)
           method = config.email.use_default_mailing ? :send_via_mail : :send_via_custom_class
-          public_send(method, builder, to, options)
+          public_send(method, builder, to, **options)
         end
 
         # Send email via custom class instance.
         def send_via_custom_class(builder, to, **options)
-          mailer = mailer_class_from_builder(builder, options)
-          mailer_method = mailer_method_from_builder(mailer, builder, options)
+          mailer = mailer_class_from_builder(builder, **options)
+          mailer_method = mailer_method_from_builder(mailer, builder, **options)
           delivery_method = options[:delivery_method] ||
             builder.email.delivery_method ||
             config.email.default_delivery_method

data/lib/hey_you/config.rb

@@ -2,6 +2,7 @@ require 'yaml'
 require 'hey_you/config/conigurable'
 require 'hey_you/config/push'
 require 'hey_you/config/email'
+require 'hey_you/config/data_source'
 
 #
 # @config REQUIRED collection_file [String] - File path for general notifications file
@@ -34,9 +35,8 @@ module HeyYou
 
     attr_reader   :collection, :env_collection, :configured, :registered_receivers
     attr_accessor(
-      :collection_files, :env_collection_file, :splitter,
-      :registered_channels, :localization, :logger, :log_tag,
-      :require_all_channels
+      :splitter, :registered_channels, :localization, :logger, :log_tag,
+      :require_all_channels, :data_source
     )
 
     def initialize
@@ -49,13 +49,6 @@ module HeyYou
       define_ch_config_methods
     end
 
-    def collection_file
-      @collection_files || raise(
-        CollectionFileNotDefined,
-        'You must define HeyYou::Config.collection_files'
-      )
-    end
-
     def collection
       @collection ||= load_collection
     end
@@ -84,6 +77,10 @@ module HeyYou
       logger&.info("[#{log_tag}] #{msg} ")
     end
 
+    def data_source
+      DataSource.instance
+    end
+
     private
 
     def define_ch_config_methods
@@ -101,21 +98,8 @@ module HeyYou
       self.class.send(:define_method, ch, method_proc)
     end
 
-    # Load yaml from collection_file and merge it with yaml from env_collection_file
     def load_collection
-      @collection_files = [collection_files] if collection_files.is_a?(String)
-      notification_collection = {}
-      collection_files.each do |file|
-        notification_collection.merge!(YAML.load_file(file))
-      end
-      notification_collection.merge!(env_collection)
-    end
-
-    def load_env_collection
-      if env_collection_file
-        return YAML.load_file(env_collection_file) rescue { }
-      end
-      {}
+      data_source.load_data
     end
   end
 end

data/lib/hey_you/config/data_source.rb

@@ -0,0 +1,38 @@
+require 'hey_you/config/conigurable'
+require 'hey_you/data_source/yaml'
+require 'hey_you/data_source/hash'
+
+module HeyYou
+  class Config
+    class DataSource
+      extend Configurable
+
+      attr_accessor :source_class, :options, :source_instance
+
+      def initialize
+        @type = DEFAULTS[:type]
+        @options = DEFAULTS[:options]
+        @source_class = HeyYou::DataSource::Yaml
+      end
+
+      def load_data
+        return source_instance.load_collections if source_instance
+
+        if source_class.nil?
+          raise InvalidDataSourceError, 'You must pass `config.data_source.source_class` in configuration.'
+        end
+
+        source_class.new(**options).load_collections
+      rescue ArgumentError => err
+        problem_fields =
+          err.message.gsub(/missing keyword(.?):\s/, '').split(', ').map { |f| "`#{f}`" }.join(', ')
+        field_word = problem_fields.split(', ').size > 1 ? 'fields' : 'field'
+        msg = "You must pass #{field_word} #{problem_fields} for `config.data_source.options` in configuration"
+
+        raise InvalidOptionsError, msg
+      end
+
+      class InvalidOptionsError < StandardError; end
+    end
+  end
+end

data/lib/hey_you/data_source/_base.rb

@@ -0,0 +1,9 @@
+module HeyYou
+  module DataSource
+    class Base
+      def load_notifications
+        raise NotImplementedError
+      end
+    end
+  end
+end

data/lib/hey_you/data_source/hash.rb

@@ -0,0 +1,17 @@
+require 'hey_you/data_source/_base'
+
+module HeyYou
+  module DataSource
+    class Hash < Base
+      attr_reader :data
+
+      def initialize(data:)
+        @data = data
+      end
+
+      def load_collections
+        data
+      end
+    end
+  end
+end

data/lib/hey_you/data_source/yaml.rb

@@ -0,0 +1,37 @@
+require 'hey_you/data_source/_base'
+
+module HeyYou
+  module DataSource
+    class Yaml < Base
+      attr_reader :collection_files, :env_collection_file
+
+      def initialize(collection_files:, env_collection_file: nil)
+        @collection_files = collection_files
+        @collection_files = [collection_files] if collection_files.is_a?(String)
+        @env_collection_file = env_collection_file
+      end
+
+      # Load yaml from collection_file and merge it with yaml from env_collection_file
+      def load_collections
+        notification_collection = {}
+        collection_files.each do |file|
+          notification_collection.merge!(YAML.load_file(file))
+        end
+        notification_collection.merge!(env_collection)
+      end
+
+      def env_collection
+        @env_collection ||= load_env_collection
+      end
+
+      private
+
+      def load_env_collection
+        if env_collection_file
+          return YAML.load_file(env_collection_file) rescue { }
+        end
+        {}
+      end
+    end
+  end
+end

data/lib/hey_you/receiver.rb

@@ -74,9 +74,11 @@ module HeyYou
         if receiver_data[ch].is_a?(Hash)
           me = self
           self.send(:define_method, "#{ch}_ch_receive_info", receiver_data[ch].fetch(:subject))
+          self.send(:define_method, "#{ch}_ch_receive_condition", receiver_data[ch].fetch(:if, -> { true }))
           self.send(:define_method, "#{ch}_ch_receive_options", -> { me.receiver_data[ch].fetch(:options, {}) })
         else
           self.send(:define_method, "#{ch}_ch_receive_info", receiver_data[ch])
+          self.send(:define_method, "#{ch}_ch_receive_condition", -> { true })
           self.send(:define_method, "#{ch}_ch_receive_options", -> { {} })
         end
       end

data/lib/hey_you/sender.rb

@@ -15,6 +15,7 @@ module HeyYou
       # @input notification_key [String] - key for notification builder
       # @input options [Hash]
       #   @option only [String/Array[String]] - whitelist for using channels
+      #   @option force [Boolean] - ignore `if` for receiver
       #
       def send_to(receiver, notification_key, **options)
         unless receiver_valid?(receiver)
@@ -29,6 +30,10 @@ module HeyYou
       def send!(notification_key, receiver, **options)
         to_hash = {}
         receiver.class.receiver_channels.each do |ch|
+          if !options[:force] && !receiver.public_send("#{ch}_ch_receive_condition")
+            next
+          end
+
           to_hash[ch] = {
             # Fetch receiver's info for sending: phone_number, email, etc
             subject: receiver.public_send("#{ch}_ch_receive_info"),
@@ -37,16 +42,16 @@ module HeyYou
           }
         end
 
-        send_to_receive_info(notification_key, to_hash, options)
+        send_to_receive_info(notification_key, to_hash, **options)
       end
 
       def send_to_receive_info(notification_key, receive_info, **options)
-        builder = Builder.new(notification_key, options)
+        builder = Builder.new(notification_key, **options)
         response = {}
         config.registered_channels.each do |ch|
-          if channel_allowed?(ch, receive_info, builder, options) && builder.respond_to?(ch) && builder.public_send(ch)
+          if channel_allowed?(ch, receive_info, builder, **options) && builder.respond_to?(ch) && builder.public_send(ch)
             config.log(
-              "Send #{ch}-message to #{receive_info[ch][:subject]} with data: #{builder.public_send(ch).data}" \
+              "Send #{ch}-message to `#{receive_info[ch][:subject]}` with data: #{builder.public_send(ch).data}" \
               " and options: #{receive_info[ch][:options]}"
             )
             receive_options = receive_info[ch].fetch(:options, {}) || {}
@@ -54,7 +59,7 @@ module HeyYou
               builder, to: receive_info[ch][:subject], **receive_options
             )
           else
-            config.log("Channel #{ch} not allowed.")
+            config.log("Channel #{ch} not allowed or sending condition doesn't return truthy result.")
           end
         end
         response
@@ -63,7 +68,10 @@ module HeyYou
       private
 
       def channel_allowed?(ch, to, builder, **options)
-        condition = to[ch].is_a?(Hash) ? to[ch.to_sym][:subject] || to[ch.to_s][:subject] : to[ch.to_sym] || to[ch.to_s]
+        data_in_subject = to[ch.to_sym]&.fetch(:subject, nil) || to[ch.to_s]&.fetch(:subject, nil)
+        data_in_core = to[ch.to_sym] || to[ch.to_s]
+
+        condition = to[ch].is_a?(Hash) ? data_in_subject : data_in_core
         return false unless condition
         channel_allowed_by_only?(ch, options[:only]) && !builder.send(ch).nil?
       end

data/lib/hey_you/version.rb

@@ -1,3 +1,3 @@
 module HeyYou
-  VERSION = "1.0.1"
+  VERSION = "1.3.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hey-you
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.3.2
 platform: ruby
 authors:
 - Sergey Nesterov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-12-19 00:00:00.000000000 Z
+date: 2020-10-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fcm
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.5'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.5'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -121,6 +121,7 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - README.md
 - Rakefile
@@ -137,8 +138,12 @@ files:
 - lib/hey_you/channels/push.rb
 - lib/hey_you/config.rb
 - lib/hey_you/config/conigurable.rb
+- lib/hey_you/config/data_source.rb
 - lib/hey_you/config/email.rb
 - lib/hey_you/config/push.rb
+- lib/hey_you/data_source/_base.rb
+- lib/hey_you/data_source/hash.rb
+- lib/hey_you/data_source/yaml.rb
 - lib/hey_you/helper.rb
 - lib/hey_you/receiver.rb
 - lib/hey_you/sender.rb
@@ -161,7 +166,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Send multichannel notification with one command.