hey-you 1.0.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aa6f17fe4c0da43b871befcc3b590393cc49ffd96fdd4191ac330a39a3663d1f
-  data.tar.gz: 25e6a567dc7dcfbef8d1f90ad3fd2d6c5aa7e0e837ce674dc4319e6cef18df03
+  metadata.gz: 4d00b4135e266174d5c8a8a1090a34acedac8b2fbdc6c82c0dd19d9e30072ef3
+  data.tar.gz: ae481c0244a148df0620a2507b6eacb94dfdaa72f4cbc6ddeccd909ce2c6d914
 SHA512:
-  metadata.gz: 9107c177d8ca761a216db6ea8b667fd29ec7f75829cca42b5610ba8c7e567a53f495c4b2c9fc9e708958a7036e1fed3931ca18a6e41d511094f41df4190e60c2
-  data.tar.gz: 5c980f03a8528570b355ba4e7e425d27259768bc36ab679aeff93bb2a95e31e56975e0b8bf3b0c78cbfc24dfb63e96a293af505bcc0ba37dfcce5b8a65383e04
+  metadata.gz: 40ce68c45090a678097d965c98603eeec09fbf87f2946f7f3602137c92a46636320e89a88c329b17a146b4eb0543be6e716d7ccbac2e4036dba0fe7ef476f6ea
+  data.tar.gz: 538ceba1fd584b76ef57bad07583474d8ad17f52375f0521a467fd30208f5996ee76d9442f7927ae5ca8893ca41ec52e82c981df16a999e34e70aeef57c966db

data/.travis.yml

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

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+# Changelog for hey-you gem
+
+### 1.2.0
+- Feature: data source extensions (check readme for more information)

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)
 
@@ -44,15 +44,18 @@ 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`
 ##### 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.
@@ -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 
 ```
@@ -187,7 +191,7 @@ for method? This is string key for builder. Read next to understand it.
 
 ### 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 +218,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/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/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hey-you
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.2.0
 platform: ruby
 authors:
 - Sergey Nesterov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-12-19 00:00:00.000000000 Z
+date: 2020-02-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fcm
@@ -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