hey-you 1.2.0 → 1.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4d00b4135e266174d5c8a8a1090a34acedac8b2fbdc6c82c0dd19d9e30072ef3
-  data.tar.gz: ae481c0244a148df0620a2507b6eacb94dfdaa72f4cbc6ddeccd909ce2c6d914
+  metadata.gz: 9ad2c28532b80d7b3efb44590b9a9281169cd09240062d99a94a8c26498e9d8e
+  data.tar.gz: 837c96af5d9c6d2a220d8384a6b77c1209f2358247d7a16cc5e33165045eb461
 SHA512:
-  metadata.gz: 40ce68c45090a678097d965c98603eeec09fbf87f2946f7f3602137c92a46636320e89a88c329b17a146b4eb0543be6e716d7ccbac2e4036dba0fe7ef476f6ea
-  data.tar.gz: 538ceba1fd584b76ef57bad07583474d8ad17f52375f0521a467fd30208f5996ee76d9442f7927ae5ca8893ca41ec52e82c981df16a999e34e70aeef57c966db
+  metadata.gz: dbd3ac7e73206eb9e3410fb51acb84f2c25fb8266570d047d2483ec12b11907b7629d10f19407b797abbc1c36cd918a3610b2b5f44c082f2d5d02fe00133b32d
+  data.tar.gz: add12e5c26ddf9a8dcb8f75592d115f095168eb55a6486fdec1c79abe9a10cbabb9f50390afc614a5945856bddca9108c7742fd124e47dc6cc0bce469bd04525

data/.travis.yml

@@ -1,8 +1,6 @@
 sudo: false
 language: ruby
 rvm:
-  - 2.3.0
-  - 2.4.0
   - 2.5.0
   - 2.6.0
   - 2.7.0

data/CHANGELOG.md

@@ -1,4 +1,22 @@
 # Changelog for hey-you gem
+## 1.3.1/1.3.2/1.3.3
+Fixing bugs
+
+## 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)
+- Feature: data source extensions (check readme for more information). 
+__Attention__: You should rewrite your configuration for use yaml data source! 

data/README.md

@@ -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.
 
@@ -52,10 +52,12 @@ First, you must configure HeyYou. Example:
 #### Required settings
 Options for gem base work.
 ##### Data Source
-* __config.data_source.source_class__ - Class implemented instance method `load_collections` returning hash (by default HeyYou::DataSource::Yaml)
+* __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.
@@ -65,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
@@ -163,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
@@ -172,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
 ``` 
@@ -189,6 +193,15 @@ 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.
 By default you need create yml file with follow format:

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/data_source.rb

@@ -22,7 +22,7 @@ module HeyYou
           raise InvalidDataSourceError, 'You must pass `config.data_source.source_class` in configuration.'
         end
 
-        source_class.new(options).load_collections
+        source_class.new(**options).load_collections
       rescue ArgumentError => err
         problem_fields =
           err.message.gsub(/missing keyword(.?):\s/, '').split(', ').map { |f| "`#{f}`" }.join(', ')

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,24 +30,28 @@ 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"),
             # Fetch receiver's options like :mailer_class
-            options: receiver.public_send("#{ch}_ch_receive_options") || {}
+            options: receiver.public_send("#{ch}_ch_receive_options").merge(options) || {}
           }
         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
@@ -81,4 +89,4 @@ module HeyYou
 
     class NotRegisteredReceiver < StandardError; end
   end
-end
+end

data/lib/hey_you/version.rb

@@ -1,3 +1,3 @@
 module HeyYou
-  VERSION = "1.2.0"
+  VERSION = "1.3.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hey-you
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.3
 platform: ruby
 authors:
 - Sergey Nesterov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-02-15 00:00:00.000000000 Z
+date: 2020-10-28 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
@@ -166,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.