hey-you 0.1.8 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 111d968c94f6f51e803d4232f32e335be19897f91d0ab391ce46a85916a3eae0
-  data.tar.gz: 9915bfd76064d7c977fab321aa655e66dfb32a4b18a9303b7529c8c115bc991c
+  metadata.gz: f5ce0968273a44b7121fd2d9799905b2f2c8ca013f40f3e497ff45f7e83feeb0
+  data.tar.gz: fc8c194e95f2f76314339dbfb64ddf36f38c818cc07296cd9516fb9a44135f56
 SHA512:
-  metadata.gz: c31b6441abb8c789a634857200271d92a2f685bc1f4e85c636c13b616d5ddccb30e876dbf2318dfcb2b484cf715ed57bca6bff137bccb5934d09b263d846333b
-  data.tar.gz: 54138ca7c7d4f13b6c226273d1fa85d31b9fda63426c3f67f9c20071f71cee2990403ae7d5f7257bfe2cc19053494c498333914bdb370a7bc87375eef521445b
+  metadata.gz: c3630186f02e156de3db5cbbe7195d4ba83d2bc31a4f000c3fc5afd7d1b69f193f742e6a4acab1eef1a741727c14e9f296856fe28e79e4df2eb6ff92b7006da6
+  data.tar.gz: 14d5065592601334769ca13f815a6d10665c8718d2ea14317867d40be0d713fd88c9a1e67c8b27f9b7805281e58bc64682c7e77498c4ffcab2b46edaa4c44644

data/README.md

@@ -1,5 +1,6 @@
 # HeyYou [Alpha]
 [![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)
 
 Send multichannel notifications with one command. 
 Сonvenient storage of notifications texts. Create your 
@@ -67,14 +68,18 @@ environment. You can set it like `notifications.#{ENV['APP_ENV]}.yml`
 builder. Default: `.`
 * __config.registered_channels__ - Avialable channels for your
 applications. Default: `[:push, :email]`
+* __config.require_all_channels__ - Boolean. If true, when data for channel will not found in 
+file collection, error will be raised. Default: `false`
 * __config.localization__ - Boolean. If true, hey-you begin support I18n locales for notifications collection. Your
-notifications for build should be nested in `I18n.locale` key. For example:
+notifications for build should be nested in `I18n.locale` key. Default: `false`. For example:
 
 ```ruby
 # config/initializers/hey-you.rb
 HeyYou::Config.configure do
   ...
-  config.collection_files = I18n.available_locales.map { |locale| "config/notifications/#{locale}.yml" }
+  config.collection_files = Rails.application.config.i18n.available_locales.map do |locale|
+    "config/notifications/#{locale}.yml" 
+  end 
   ...
 end 
 ```
@@ -124,7 +129,7 @@ Default 60
 Default 30
 ##### Email
 * __config.email.layout__ - default layout for email letters.
-* __config.email.default_mailing__ - use default mail sending or use custom mailer classes
+* __config.email.use_default_mailing__ - use default mail sending or use custom mailer classes
 * __config.email.default_mailer_class__ - default mailer class for email notifications
 * __config.email.default_mailer_method__ - default mailer_method for mailer_class
 * __config.email.default_delivery_method__ - expects, that mailer_method will build message and delivery_method will send it.
@@ -359,7 +364,7 @@ in your channel config.
 Now, when you will send notification, it will be send with your channel too.
 
 ## Extensions
-* [Slack channel](https://github.com/QNester/hey-you) 
+* [Slack channel](https://github.com/QNester/hey-you-slack) 
 [![Gem Version](https://badge.fury.io/rb/hey-you-slack.svg)](https://badge.fury.io/rb/hey-you-slack)
 
 ## Development

data/lib/hey_you/builder.rb

@@ -1,10 +1,13 @@
 require 'i18n'
-require_relative 'builder/email'
-require_relative 'builder/push'
+require 'hey_you/helper'
+require 'hey_you/builder/email'
+require 'hey_you/builder/push'
 
 module HeyYou
   class Builder
-    attr_reader :data, :options
+    include HeyYou::Helper
+
+    attr_reader :data, :options, :keys
 
     # Load data from collection yaml via key and interpolate variables.
     # Define methods for each registered channel. After initialize you can use
@@ -14,18 +17,32 @@ module HeyYou
       @data = fetch_from_collection_by_key(key, options[:locale])
       @options = options
       config.registered_channels.each do |ch|
-        ch_builder =
-          HeyYou::Builder.const_get("#{ch.downcase.capitalize}").new(data, key, options)
-        instance_variable_set("@#{ch}".to_sym, ch_builder)
-
-        define_ch_method(ch)
+        init_channel_builder(ch, key)
       end
     end
 
     private
 
-    def define_ch_method(ch)
-      method_proc = -> { instance_variable_get("@#{ch}".to_sym) }
+    def init_channel_builder(ch, key)
+      if config.require_all_channels
+        unless data[ch.to_s]
+          raise RequiredChannelNotFound, "For key #{key} and channel #{ch} data not exists in collection."
+        end
+      end
+      unless data[ch.to_s]
+        define_ch_method(ch, true)
+        return
+      end
+
+      ch_builder =
+        HeyYou::Builder.const_get("#{ch.downcase.capitalize}").new(data, key, options)
+      instance_variable_set("@#{ch}".to_sym, ch_builder)
+
+      define_ch_method(ch)
+    end
+
+    def define_ch_method(ch, empty = false)
+      method_proc = empty ? -> { nil } : -> { instance_variable_get("@#{ch}".to_sym) }
       self.class.send(:define_method, ch, method_proc)
     end
 
@@ -37,15 +54,15 @@ module HeyYou
         keys << locale
       end
       keys = keys + key.to_s.split(config.splitter)
-      keys.reduce(config.collection) do |memo, nested_key|
+      data = keys.reduce(config.collection) do |memo, nested_key|
         memo[nested_key.to_s] if memo
       end
-    end
-
-    def config
-      Config.config
+      return data if data
+      raise DataNotFound, "collection data not found for `#{keys.join(config.splitter)}`"
     end
 
     class UnknownLocale < StandardError; end
+    class DataNotFound < StandardError; end
+    class RequiredChannelNotFound < StandardError; end
   end
 end

data/lib/hey_you/channels/_base.rb

@@ -1,6 +1,10 @@
+require 'hey_you/helper'
 module HeyYou
   module Channels
     class Base
+      include HeyYou::Helper
+      extend HeyYou::Helper
+
       class << self
         def send!
           raise NotImplementedError, 'You should define #send! method in your channel.'
@@ -25,10 +29,6 @@ module HeyYou
           []
         end
 
-        def config
-          Config.config
-        end
-
         def ch_name
           self.class.name.split('::').last.downcase
         end

data/lib/hey_you/channels/email.rb

@@ -6,31 +6,31 @@ module HeyYou
     class Email < Base
       class << self
         def send!(builder, to:, **options)
-          raise CredentialsNotExists unless credentials_present?
-
-          method = config.email.default_mailing ? :send_via_mail : :send_via_custom_class
+          method = config.email.use_default_mailing ? :send_via_mail : :send_via_custom_class
           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 = options[:mailer_method] ||
-            builder.email.mailer_method ||
-            config.email.default_mailer_method
-
+          mailer_method = mailer_method_from_builder(mailer, builder, options)
           delivery_method = options[:delivery_method] ||
             builder.email.delivery_method ||
             config.email.default_delivery_method
 
           log("Build mail via #{mailer}##{mailer_method}. Delivery with #{delivery_method}")
           mailer_msg = mailer.public_send(mailer_method, data: builder.email, to: to)
-          mailer_msg.public_send(delivery_method)
+          return mailer_msg.public_send(delivery_method) if mailer_msg.respond_to?(delivery_method)
+          raise(
+            DeliveryMethodNotDefined,
+            "Instance of mailer #{mailer} with method #{mailer_method} not respond to #{delivery_method}"
+          )
         end
 
         # Send email with standard mail (gem 'mail')
         def send_via_mail(builder, to, **_)
+          raise CredentialsNotExists unless credentials_present?
+
           context = self
           mail = Mail.new do
             from HeyYou::Config.instance.email.from
@@ -74,14 +74,29 @@ module HeyYou
 
           mailer
         end
-      end
 
-      class CredentialsNotExists < StandardError;
-      end
-      class ActionMailerClassNotDefined < StandardError;
-      end
-      class MailerClassNotDefined < StandardError;
+        def mailer_method_from_builder(mailer_class, builder, **options)
+          mailer_method = options[:mailer_method] ||
+            builder.email.mailer_method ||
+            config.email.default_mailer_method
+          unless mailer_method
+            raise(
+              MailerMethodNotDefined,
+              'You must set mailer_method in notifications collection or pass :mailer_method option.'
+            )
+          end
+
+          return mailer_method if mailer_class.respond_to?(mailer_method)
+          raise MailerMethodNotDefined, "Method ##{mailer_method} not defined for #{mailer_class}."
+        end
       end
+
+      class CredentialsNotExists < StandardError; end
+      class ActionMailerClassNotDefined < StandardError; end
+      class MailerClassNotDefined < StandardError; end
+      class MailerMethodNotDefined < StandardError; end
+      class DeliveryMethodNotDefined < StandardError; end
+
     end
   end
 end

data/lib/hey_you/config.rb

@@ -1,7 +1,7 @@
 require 'yaml'
-require_relative 'config/conigurable'
-require_relative 'config/push'
-require_relative 'config/email'
+require 'hey_you/config/conigurable'
+require 'hey_you/config/push'
+require 'hey_you/config/email'
 
 #
 # @config REQUIRED collection_file [String] - File path for general notifications file
@@ -17,7 +17,15 @@ module HeyYou
   class Config
     extend Configurable
 
-    DEFAULT_REGISTERED_CHANNELS = %i[email push]
+    DEFAULTS = {
+      registered_channels: %i[email push],
+      splitter: '.',
+      log_tag: 'HeyYou',
+      localization: false,
+      require_all_channels: false
+    }
+
+    DEFAULT_REGISTERED_CHANNELS =
     DEFAULT_SPLITTER = '.'
     DEFAULT_GLOBAL_LOG_TAG = 'HeyYou'
     DEFAULT_LOCALIZATION_FLAG = false
@@ -27,15 +35,17 @@ module HeyYou
     attr_reader   :collection, :env_collection, :configured, :registered_receivers
     attr_accessor(
       :collection_files, :env_collection_file, :splitter,
-      :registered_channels, :localization, :logger, :log_tag
+      :registered_channels, :localization, :logger, :log_tag,
+      :require_all_channels
     )
 
     def initialize
-      @registered_channels ||= DEFAULT_REGISTERED_CHANNELS
-      @splitter ||= DEFAULT_SPLITTER
+      @registered_channels ||= DEFAULTS[:registered_channels]
+      @splitter ||= DEFAULTS[:splitter]
       @registered_receivers = []
-      @log_tag ||= DEFAULT_GLOBAL_LOG_TAG
-      @localization ||= DEFAULT_LOCALIZATION_FLAG
+      @log_tag ||= DEFAULTS[:log_tag]
+      @localization ||= DEFAULTS[:localization]
+      @require_all_channels = DEFAULTS[:require_all_channels]
       define_ch_config_methods
     end
 

data/lib/hey_you/config/conigurable.rb

@@ -11,14 +11,15 @@ module HeyYou
       end
 
       def configure(&block)
-        # TODO: log warn "Already configured" instead nil
-        @configured ? nil : instance_eval(&block)
+        @configured ? raise(AlreadyConfiguredError, 'You already configure HeyYou') : instance_eval(&block)
         @configured = true
       end
 
       def config
         @config ||= self.instance
       end
+
+      class AlreadyConfiguredError < StandardError; end
     end
   end
 end

data/lib/hey_you/config/email.rb

@@ -1,4 +1,4 @@
-require_relative 'conigurable'
+require 'hey_you/config/conigurable'
 require 'mail'
 
 module HeyYou
@@ -13,7 +13,7 @@ module HeyYou
       attr_accessor(
         :from,
         :mail_delivery_method,
-        :default_mailing,
+        :use_default_mailing,
         :default_delivery_method,
         :default_mailer_class,
         :default_mailer_method
@@ -21,7 +21,7 @@ module HeyYou
 
       def initialize
         @mail_delivery_method ||= MAIL_DELIVERY_METHOD
-        @default_mailing ||= !default_mailer_class.nil?
+        @use_default_mailing ||= !default_mailer_class.nil?
         @async ||= true
         @default_mailer_method ||= DEFAULT_ACTION_MAILER_METHOD
         @default_delivery_method ||= DEFAULT_DELIVERY_METHOD

data/lib/hey_you/config/push.rb

@@ -1,4 +1,4 @@
-require_relative 'conigurable'
+require 'hey_you/config/conigurable'
 require 'fcm'
 
 module HeyYou

data/lib/hey_you/helper.rb

@@ -0,0 +1,7 @@
+module HeyYou
+  module Helper
+    def config
+      Config.instance
+    end
+  end
+end

data/lib/hey_you/receiver.rb

@@ -1,7 +1,10 @@
-require_relative 'sender'
+require 'hey_you/sender'
+require 'hey_you/helper'
 
 module HeyYou
   module Receiver
+    include HeyYou::Helper
+
     attr_reader :receiver_channels, :receiver_data
 
     def self.extended klass
@@ -48,7 +51,7 @@ module HeyYou
 
       @receiver_data = receiver_data
       @receiver_channels = receiver_data.keys
-      hey_you_config.registrate_receiver(self)
+      config.registrate_receiver(self)
 
       define_receive_info_methods
     end
@@ -57,10 +60,10 @@ module HeyYou
 
     def check_channels(channels)
       channels.all? do |ch|
-        next if hey_you_config.registered_channels.include?(ch.to_sym)
+        next if config.registered_channels.include?(ch.to_sym)
         raise(
           NotRegisteredChannel,
-          "Channel #{ch} not registered. Registered channels: #{hey_you_config.registered_channels}"
+          "Channel #{ch} not registered. Registered channels: #{config.registered_channels}"
         )
       end
       @received_channels = channels
@@ -79,10 +82,6 @@ module HeyYou
       end
     end
 
-    def hey_you_config
-      Config.config
-    end
-
     class NotRegisteredChannel < StandardError;
     end
   end

data/lib/hey_you/sender.rb

@@ -1,10 +1,13 @@
-require_relative 'builder'
-
-require_relative 'channels/push'
-require_relative 'channels/email'
+require 'hey_you/helper'
+require 'hey_you/builder'
+require 'hey_you/channels/push'
+require 'hey_you/channels/email'
 
 module HeyYou
   class Sender
+    include HeyYou::Helper
+    extend HeyYou::Helper
+
     class << self
       # Send notifications for receiver
       #
@@ -41,9 +44,9 @@ module HeyYou
         builder = Builder.new(notification_key, options)
         response = {}
         config.registered_channels.each do |ch|
-          if channel_allowed?(ch, receive_info, builder, options)
+          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.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, {}) || {}
@@ -60,9 +63,8 @@ module HeyYou
       private
 
       def channel_allowed?(ch, to, builder, **options)
-        unless to[ch].is_a?(Hash) ? to[ch.to_sym][:subject] || to[ch.to_s][:subject] : to[ch.to_sym] || to[ch.to_s]
-          return false
-        end
+        condition = to[ch].is_a?(Hash) ? to[ch.to_sym][:subject] || to[ch.to_s][:subject] : to[ch.to_sym] || to[ch.to_s]
+        return false unless condition
         channel_allowed_by_only?(ch, options[:only]) && !builder.send(ch).nil?
       end
 
@@ -75,10 +77,6 @@ module HeyYou
         return only.map(&:to_sym).include?(ch.to_sym) if only.is_a?(Array)
         only.to_sym == ch.to_sym
       end
-
-      def config
-        Config.config
-      end
     end
 
     class NotRegisteredReceiver < StandardError; end

data/lib/hey_you/version.rb

@@ -1,3 +1,3 @@
 module HeyYou
-  VERSION = "0.1.8"
+  VERSION = "1.0.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hey-you
 version: !ruby/object:Gem::Version
-  version: 0.1.8
+  version: 1.0.0
 platform: ruby
 authors:
 - Sergey Nesterov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-04-28 00:00:00.000000000 Z
+date: 2019-12-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fcm
@@ -139,6 +139,7 @@ files:
 - lib/hey_you/config/conigurable.rb
 - lib/hey_you/config/email.rb
 - lib/hey_you/config/push.rb
+- lib/hey_you/helper.rb
 - lib/hey_you/receiver.rb
 - lib/hey_you/sender.rb
 - lib/hey_you/version.rb
@@ -160,7 +161,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: Send multichannel notification with one command.