hey-you 0.1.6

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e3e825c0d1b7cdb82618796909f87f4244ef66c2
+  data.tar.gz: 9c564df97362eb0ff7999feebe9764ffb1450049
+SHA512:
+  metadata.gz: 94d4347cc837e84e3185dafb4f046b7be65e826e44bfc0af444cafcfcf413c79b85b2ebb4d7f89861db8f93a98fd00b569f977f7c389f42869d93094a1c1cfec
+  data.tar.gz: 38a3a8952ecc0c962f1820f46eb3a395c2cbc5b8bf21f11405edd151b6e85d75582d8b0c1b324d121a2155fbce934e0f1ebbcc88b51ed0ade836f42f9e483abe

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.env
+
+# rspec failure tracking
+.rspec_status
+
+.byebug_history
+*.gem

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,10 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.3
+  - 2.4.2
+  - 2.5.3
+before_install: gem install bundler
+scripts:
+  - bundle exec rspec
+

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at qnesterr@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,8 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+gemspec
+
+gem 'byebug'
+gem 'bundler'

data/Gemfile.lock

@@ -0,0 +1,67 @@
+PATH
+  remote: .
+  specs:
+    hey-you (0.1.6)
+      fcm (~> 0.0.2)
+      i18n (~> 1.0)
+      mail (~> 2.7)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
+    byebug (10.0.2)
+    concurrent-ruby (1.0.5)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.3)
+    fcm (0.0.2)
+      httparty
+      json
+    ffaker (2.9.0)
+    hashdiff (0.3.7)
+    httparty (0.16.2)
+      multi_xml (>= 0.5.2)
+    i18n (1.0.1)
+      concurrent-ruby (~> 1.0)
+    json (2.1.0)
+    mail (2.7.0)
+      mini_mime (>= 0.1.1)
+    mini_mime (1.0.0)
+    multi_xml (0.6.0)
+    public_suffix (3.0.2)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+    safe_yaml (1.0.4)
+    webmock (3.4.1)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  byebug
+  ffaker (~> 2.9)
+  hey-you!
+  rake (~> 10.5)
+  rspec (~> 3.7)
+  webmock (~> 3.4)
+
+BUNDLED WITH
+   1.16.1

data/README.md

@@ -0,0 +1,373 @@
+# HeyYou [Alpha]
+[![Build Status](https://travis-ci.com/QNester/hey-you.svg?branch=master)](https://travis-ci.com/QNester/hey-you#)
+
+Send multichannel notifications with one command. 
+Сonvenient storage of notifications texts. Create your 
+own channels. Registrate receiver and send notifications for 
+him easy.
+
+* [Requirements](#requirements)
+* [Installation](#installation)
+* [How to use](#how-to-use)
+    * [Configure](#configure)
+    * [Registrate receiver](#registrate-receiver)
+    * [Build your notification](#build-your-notification)
+    * [Send notification](#send-notification)
+    * [Sender options](#sender-options)
+    * [Create your own channels](#create-your-own-channels)    
+
+
+## Requirements
+ * Ruby 2.3.0 min (rspec works with ruby 2.3.3, 2.4.2, 2.5.3)
+ * FCM - Gem send push notification using [fcm gem](https://github.com/spacialdb/fcm).
+ You need *fcm server key* to successful configure push notifications.
+
+## Installation
+
+```ruby
+gem 'hey-you'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install hey-you    
+
+## How to use
+
+### Configure
+First, you must configure HeyYou. Example:
+```ruby
+  HeyYou::Config.configure do
+    config.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.
+##### 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.
+##### Email
+* __config.email.from__ - Email address for send email notifications.
+
+#### 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
+applications. Default: `[:push, :email]`
+* __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:
+
+```ruby
+# config/initializers/hey-you.rb
+HeyYou::Config.configure do
+  ...
+  config.collection_files = I18n.available_locales.map { |locale| "config/notifications/#{locale}.yml" }
+  ...
+end 
+```
+
+```yaml
+# config/notifications/en.yml
+en:
+  any_key:
+    any_nested_key:
+      push:
+        title: Test hey you
+        body: Hey you, %{name}
+      email:
+        subject: Test hello
+        body: Hey you, %{name}  
+```
+
+```yaml
+# config/notifications/ru.yml
+ru:
+  any_key:
+    any_nested_key:
+      push:
+        title: Эй, ты!
+        body: Эй, ты, %{name}
+      email:
+        subject: Привет
+        body: Эй, ты, %{name}  
+```
+
+```ruby
+# From your code:
+I18n.locale = :ru
+user.send_notification('any_key.any_nested_key', name: 'QNester') #=> send notification with body `Эй, ты, QNester`
+I18n.locale = :en
+user.send_notification('any_key.any_nested_key', name: 'QNester') #=> send notification with body `Hey you, QNester`
+user.send_notification('any_key.any_nested_key', name: 'QNester', locale: :ru) #=> send notification with body `Эй, ты, QNester`
+
+```
+
+##### Push
+* __config.push.priority__ - priority level for your pushes.
+Default: high
+* __config.push.ttl__ - default time_to_live option for fcm.
+Default 60
+* __config.push.fcm_timeout__ - default timeout for fcm.
+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.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.
+If you use ActionMailer you can set this option like `delivery_now` or `delivery_later`.
+
+By default all letters will send as simple text.
+
+### Registrate receiver
+You can registrate your application classes like receivers.
+You can easy send notification for receiver with method
+`#send_notification`. For example:
+```ruby
+class User < Model
+  extend HeyYou::Receiver
+  
+  receive(
+    push: -> { push_token.value }, 
+    email: -> { email }
+  )
+end
+```
+
+Class method `#receive` will registrate your class User
+as receiver. In arguments we must pass Hash instance where
+keys - channels names as symbols, and values - procs for 
+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:
+
+```ruby
+class User < Model
+  extend HeyYou::Receiver
+  
+  receive(
+    push: -> { push_token.value }, 
+    email: { subject: -> { email }, options: { mailer_class: UserMailer, mailer_method: :notify! } }
+  )
+end
+``` 
+
+If you pass correct procs in `#receive` you can send notification
+for your user like:
+
+```ruby
+user = User.find(1)
+user.send_notification('for_users.hello')
+```
+
+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.
+
+### Build your notification
+HeyYou Notification Builder - good system for store your notifications in one place.
+You need create yml file with follow format:
+```yaml
+# config/notifications/collection.yml
+any_key:
+  any_nested_key:
+    push:
+      title: Test hey you
+      body: Hey you, %{name}
+    email:
+      subject: Test hello
+      body: Hey you, %{name}  
+``` 
+
+You should pass file path to `config.collection_file` to load your notification texts.
+Now you can send notification:
+
+```ruby
+...
+user.send_notification('any_key.any_nested_key', name: 'HeyYou')
+```
+This command with fetch notifications templates from your collection file 
+for each channel and will try interpolate it. If you will not pass required 
+interpolation keys then error will be raised. After successful interpolation
+notification will send for all available channels for receiver: 
+1) Send push via fcm
+2) Send email
+
+### 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
+like:
+
+```ruby
+HeyYou::Sender.send!(
+  'any_key.any_nested_key', 
+  to: {
+    push: 'fcm_registration_token', 
+    email: 'example_mail@example.com'  
+  },
+  name: 'HeyYou'
+)
+
+```
+This command will process texts and send push and email to `to` credentials.
+
+### Sender options
+#### Only option
+You can user some options for sender. You can send notification exclude
+not required channels with option `:only` like:
+
+```ruby
+user.send_notification('any_key.any_nested_key', name: 'HeyYou', only: [:push])
+```
+
+It will send notification only with push channel. Email will be skipped.
+
+#### Channels options
+Channels options should pass to send method with associated channel names like:
+```ruby
+user.send_notification(
+  'any_key.any_nested_key', 
+  name: 'HeyYou', 
+  email: { layout: 'layout' }
+)
+```
+
+In this example we pass option for email channel. We decide
+specific layout for 'any_key.any_nested_key' notification.
+
+### Create your own channels
+To create your custom channel you should create two classes:
+1. HeyYou::Builders::<YOUR_CHANNEL_NAME>
+2. HeyYou::Channels::<YOUR_CHANNEL_NAME>
+
+You must extend your builder class from `HeyYou::Builder::Base` and realize
+class method `#build`. In this method you should fetch notification data for 
+Your channel. For example: 
+
+```ruby
+class HeyYou::Builder::CustomNotifier < HeyYou::Builder::Base
+  class << self
+    attr_reader :header, :body, :icon
+  
+    def build
+      @header = interpolate(ch_data['header'], options)
+      @body = interpolate(ch_data['body'], options)
+      @icon = options[:icon] || interpolate(ch_data['icon'], options)
+    end
+  end
+end
+```
+
+Your notifications collection YAML file will contain next:
+
+```yaml
+any_key:
+  any_nested_key:
+    push:
+      # ...
+    custom_notifier:
+      header: Hello
+      body: Hello, %{name}
+      icon: 'icons.klass'
+```
+
+To check your builder you can call 
+```ruby
+notifier_data = HeyYou::Builder.new('any_key.any_nested_key', name: 'HeyYou').custom_notifier
+notifier_data # => Instance of HeyYou::Builder::CustomNotifier
+notifier_data.header # => Hello
+notifier_data.body # => Hello, HeyYou
+notifier_data.icon # => 'icons.klass'
+```
+
+You must extend your channel class from `HeyYou::Channels::Base` and
+realize class method `#send!`. This method pass two arguments: builder instance and to option.
+Finally, you channel should look like:
+
+```ruby
+class HeyYou::Channels::CustomNotifier < HeyYou::Channels::Base
+  class << self
+    def send!(builder, to:)
+      custom_notifier_client.send_message(
+        text: builder.custom_notifier.text,
+        token: to 
+      )
+    end
+  end
+end
+
+```
+
+If your channel require some configurations you should create class
+`HeyYou::Config::<YOUR_CHANNEL_NAME>`, extend it with Configurable module and add
+accessors for it. Example:
+
+```ruby
+class HeyYou::Config::CustomNotifier
+  extend HeyYou::Config::Configurable
+
+  attr_accessor :secret_key
+  
+  def client
+    YourProviderClass::Client.new(secret_key)
+  end
+end
+```
+
+If your attr is required you can add checking it
+in your channel:
+
+```ruby
+class HeyYou::Channels::CustomNotifier < HeyYou::Channels::Base
+  class << self
+    def send!(builder, to:)
+      return false unless credentials_present?
+    
+      HeyYou::Config.instance.custom_notifier.client.send_message(
+        text: builder.custom_notifier.text,
+        token: to 
+      )
+    end
+    
+    def required_credentials
+      [:secret_key]
+    end
+  end
+end
+
+```
+
+`#credentials_present?` method check exists required_credentials
+in your channel config.
+
+Now, when you will send notification, it will be send with your channel too.
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/hey_you. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## Code of Conduct
+
+Everyone interacting in the HeyYou project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/hey_you/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "hey-you"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/hey_you.gemspec

@@ -0,0 +1,33 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "hey_you/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "hey-you"
+  spec.version       = HeyYou::VERSION
+  spec.authors       = ["Sergey Nesterov"]
+  spec.email         = ["qnesterr@gmail.com"]
+
+  spec.summary       = 'Send multichannel notification with one command.'
+  spec.description   = 'Send multichannel notifications with one command. ' \
+    'Сonvenient storage of notifications texts. Create your own channels.' \
+    'Registrate receiver send notifications easy.'
+  spec.homepage      = "https://github.com/QNester/hey-you"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "fcm", '~> 0.0.2'
+  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 "rspec", '~> 3.7'
+  spec.add_development_dependency "webmock", '~> 3.4'
+  spec.add_development_dependency "ffaker", '~> 2.9'
+end

data/lib/hey-you.rb

@@ -0,0 +1,8 @@
+require "hey_you/version"
+require "hey_you/config"
+require "hey_you/builder"
+require "hey_you/sender"
+require "hey_you/receiver"
+
+module HeyYou
+end

data/lib/hey_you/builder/_base.rb

@@ -0,0 +1,40 @@
+module HeyYou
+  class Builder
+    class Base
+      attr_reader :data, :key, :options
+
+      def initialize(data, key, **options)
+        @data = data
+        @key = key
+        @options = options
+        build
+      end
+
+      private
+
+      def interpolate(notification_string, options)
+        notification_string % options
+      rescue KeyError => err
+        raise InterpolationError, "Failed build notification string `#{notification_string}`: #{err.message}"
+      end
+
+      def ch_data
+        data.fetch(current_builder_name)
+      end
+
+      alias channel_data ch_data
+
+      def ch_options
+        options.fetch(current_builder_name, {})
+      end
+
+      alias channel_options ch_options
+
+      def current_builder_name
+        self.class.name.split('::').last.downcase
+      end
+
+      class InterpolationError < StandardError; end
+    end
+  end
+end