hey-you 1.2.1 → 1.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a7b3080ba368db5d653caccc37a984f7700292a54ba90204c086bdd7b95b4b6d
-  data.tar.gz: c2f589b517e59fdda778d6b9f99074a7c2fc932bbf97052a395f1b3491260d74
+  metadata.gz: 755f8775f2918592a3faf297f7dbed8f5b7253d137ac47ffedae9a9106a5d44f
+  data.tar.gz: 17c927968d8fe27c6a5e8b2ace86af1bb30683f3cc968099aca19401c94cbcd7
 SHA512:
-  metadata.gz: 3799695ed32d46f2aa0005346aa37d3b2288a373391900dedb575f90e5d71db4272d1d73edf3b5d5754066600bff886bc5e845271329bfead1dcc4f0208b3523
-  data.tar.gz: 29421836627cf3ba25e6731bca4e84830bef3f450ab5d400c85f7b80ef5a63b28c0492621e1edecb69ab2ae3506b1d178a88203ac34dec9a85a47d5171f0083a
+  metadata.gz: 592e4f17b2e26f26f04477150118a91d2cf68696bc17f3021617e554a14bddb19fd3fec5e2c8d2dc37342d045e6ca2c2c679969de645aa9269edf6cc139ea596
+  data.tar.gz: 83aa1a371cffa0efce33fb69e410abbe6d0eda85e019ab117f1e1ccb93cfee8d7ce92fb4b23d83a4b19d08615ccc0616c378ebd030801bc10b0773edb71e1596

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog for hey-you gem
 
+## 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
 

data/README.md

@@ -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/lib/hey_you/builder.rb

@@ -38,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)

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/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"),
@@ -46,7 +51,7 @@ module HeyYou
         config.registered_channels.each do |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

data/lib/hey_you/version.rb

@@ -1,3 +1,3 @@
 module HeyYou
-  VERSION = "1.2.1"
+  VERSION = "1.2.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hey-you
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.2.2
 platform: ruby
 authors:
 - Sergey Nesterov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-07-01 00:00:00.000000000 Z
+date: 2020-07-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fcm
@@ -166,7 +166,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.8
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Send multichannel notification with one command.