action_push 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ff1cc117f681c6bda61285aa5107cf481178e282a8e0feed7fa38b43a75ec3ab
+  data.tar.gz: dc6057e306c7dbcf688aade09d3e23cc60da3b06d4ed6be3c2493c2ef8a480d1
+SHA512:
+  metadata.gz: 948ab35dfc5cc18ed73281b071f4b3ca1d96f57be63e839f5554156e2ffbd4e5981c5ba17f0bba69efa8e53f552cac83e3b5b8a1d7cc17f72fd1257ba6679862
+  data.tar.gz: 7771253022b54cb8bb21c76a7d651fef27fed3bc7ec12536871a1f88074ecfa605dce9fde1071e68c6b06b36edc2150687efd9e0280d2b4f4b66b0cc55ecb4b6

data/.gitignore

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

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,124 @@
+require:
+  - rubocop-performance
+
+AllCops:
+  AutoCorrect: false
+  Exclude:
+    - '*.gemspec'
+    - 'bin/*'
+    - 'spec/**/*'
+    - 'vendor/**/*'
+  TargetRubyVersion: 2.6.5
+
+Bundler/OrderedGems:
+  Enabled: false
+
+# ============================== Documentation ======================
+Style/Documentation:
+  Enabled: false
+
+# ============================== Metrics ============================
+Metrics/ClassLength:
+  Max: 180
+Metrics/BlockLength:
+  Enabled: true
+Metrics/MethodLength:
+  Max: 25
+Metrics/AbcSize:
+  Max: 40
+
+# ============================== Naming =============================
+Naming/PredicateName:
+  ForbiddenPrefixes:
+    - is_
+Naming/FileName:
+  Enabled: true
+  Exclude:
+    - 'Gemfile'
+Naming/MethodParameterName:
+  Enabled: false
+Naming/AccessorMethodName:
+  Enabled: false
+
+# ============================== Layout =============================
+Layout/HashAlignment:
+  EnforcedHashRocketStyle: key
+  EnforcedColonStyle: key
+Layout/ParameterAlignment:
+  EnforcedStyle: with_fixed_indentation
+Layout/CaseIndentation:
+  EnforcedStyle: case
+  IndentOneStep: false
+Layout/MultilineMethodCallIndentation:
+  Enabled: true
+  EnforcedStyle: indented
+Layout/SpaceBeforeBlockBraces:
+  EnforcedStyle: space
+  EnforcedStyleForEmptyBraces: space
+Layout/EmptyLines:
+  Enabled: true
+Layout/EmptyLineAfterMagicComment:
+  Enabled: false
+Layout/EmptyLinesAroundBlockBody:
+  Enabled: true
+Layout/EndAlignment:
+  EnforcedStyleAlignWith: variable
+Layout/FirstHashElementIndentation:
+  EnforcedStyle: consistent
+Layout/HeredocIndentation:
+  Enabled: false
+Layout/RescueEnsureAlignment:
+  Enabled: false
+Layout/LineLength:
+  Max: 140
+# ============================== Style ==============================
+Style/RescueModifier:
+  Enabled: true
+Style/PercentLiteralDelimiters:
+  PreferredDelimiters:
+    default: '[]'
+    '%i':    '[]'
+    '%w':    '[]'
+  Exclude:
+    - 'config/routes.rb'
+Style/StringLiterals:
+  Enabled: true
+Style/AsciiComments:
+  Enabled: false
+Style/Copyright:
+  Enabled: false
+Style/SafeNavigation:
+  Enabled: false
+Style/Lambda:
+  Enabled: false
+Style/Alias:
+  Enabled: true
+  EnforcedStyle: prefer_alias_method
+Style/ClassAndModuleChildren:
+  Enabled: true
+  EnforcedStyle: nested
+Style/TrailingCommaInArrayLiteral:
+  Enabled: true
+  EnforcedStyleForMultiline: no_comma
+Style/RescueStandardError:
+  Enabled: true
+  EnforcedStyle: explicit
+Style/InverseMethods:
+  AutoCorrect: false
+  Enabled: true
+Style/IfUnlessModifier:
+  Enabled: false
+Style/SpecialGlobalVars:
+  Enabled: false
+Style/BlockComments:
+  Enabled: false
+Style/GuardClause:
+  Enabled: false
+Style/TrailingCommaInHashLiteral:
+  Enabled: false
+
+# ============================== Lint ==============================
+Lint/DuplicateMethods:
+  Enabled: false
+Lint/AmbiguousOperator:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+
+rvm:
+  - 2.6.5
+
+before_install:
+  - bundle install
+
+script:
+  - bundle exec rubocop
+  - bundle exec rspec

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in action_push.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,76 @@
+PATH
+  remote: .
+  specs:
+    action_push (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    ast (2.4.0)
+    coderay (1.1.2)
+    concurrent-ruby (1.1.5)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.3)
+    hashdiff (1.0.0)
+    i18n (1.8.2)
+      concurrent-ruby (~> 1.0)
+    jaro_winkler (1.5.4)
+    method_source (0.9.2)
+    parallel (1.19.1)
+    parser (2.7.0.2)
+      ast (~> 2.4.0)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    public_suffix (4.0.3)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.1)
+      rspec-support (~> 3.9.1)
+    rspec-expectations (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.2)
+    rubocop (0.79.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.7.0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.7)
+    rubocop-performance (1.5.2)
+      rubocop (>= 0.71.0)
+    ruby-progressbar (1.10.1)
+    safe_yaml (1.0.5)
+    unicode-display_width (1.6.1)
+    webmock (3.8.0)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  action_push!
+  bundler (~> 1.17)
+  i18n
+  pry
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  rubocop
+  rubocop-performance
+  webmock
+
+BUNDLED WITH
+   1.17.3

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Aliaksandr Shylau
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/Makefile

@@ -0,0 +1,12 @@
+.PHONY: help
+
+help:
+	@echo 'Available targets:'
+	@echo '  make dockerize OR make ARGS="--build" dockerize'
+	@echo '  make release'
+
+dockerize:
+	docker-compose up ${ARGS}
+
+release:
+	bin/release.sh

data/README.md

@@ -0,0 +1,180 @@
+```ruby
+class ApplicationPush < ActionPush::Base
+  default :ios do |ios|
+    ios.thread_id = 'fuck'
+    ios.badge = 10
+  end
+end
+```
+
+```ruby
+class UserPush < ApplicationPush
+  default :ios do |ios|
+    ios.alert do |a|
+      a.launch_image = 'user.png'
+    end
+  end
+
+  def welcome
+    # envelope#title and #body set corresponding
+    # attributes for all registered providers like ios and android 
+    envelope.title = 'hello'
+    envelope.body = 'world'
+    envelope.payload = { user_id: 1 }
+
+    envelope.for(:ios) do |ios|
+      ios.thread_id = 123     
+    end
+    
+    # push method sets #scheduled = true to the message,
+    # so this pushes will be delivered when you call a 
+    # class method: `UserPush.welcome`
+    push :ios, token: 'foo'
+    push :android, token: 'bar'
+  end
+
+
+  def buy
+    push :ios, token: 'foo' do |ios|
+      # translations are available under the key:
+      # en.user_push.buy.title
+      #
+      # You can set I18n scope by redefining i18n_scope method:
+      #
+      # def i18n_scope
+      #   "self.class.to_s.underscore}.#{action_name}"
+      # end
+      ios.title = t('.title')
+      
+      # you can redefine scheduling in a block
+      ios.scheduled = false
+    end
+    
+    push :android do |android|
+      android.token = 'foo' 
+      android.title = t('.title')
+    end
+  end
+end
+```
+
+## Using with Sidekiq
+
+```ruby
+# enable delay extension at `config/initializers/sidekiq.rb`
+Sidekiq::Extensions.enable_delay!
+
+@user = User.last
+UserPush.delay_for(4.seconds).welcome(@user.id)
+```
+
+## Configuration
+
+```ruby
+gorush = ActionPush::Delivery::Gorush.new(
+  url: 'http://localhost:8088/api/push', 
+  topic: 'com.app.id',
+  logger: STDOUT
+)
+
+ActionPush::Base.register_delivery_method :ios, ->(push) do 
+   gorush.send_to_apple(push)
+end
+```
+
+## Testing
+
+```ruby
+# spec/support/action_push.rb
+
+ActionPush::Base.register_delivery_method :ios, ActionPush::Delivery::Memory
+
+RSpec.configure do |config|
+  config.before(:each) do
+    ActionPush::Delivery::Memory.clear
+  end
+end
+```
+
+```ruby
+# app/models/user.rb
+ 
+class User < ApplicationRecord
+  def confirm
+    update!(confirmed_at: Time.current)
+    UserPush.welcome(id)
+  end
+end
+````
+
+```ruby
+# app/pushes/user_push.rb
+ 
+class UserPush < ApplicationPush
+  def welcome(id)
+    user = User.find(id)
+    
+    envelope.title = 'Welcome push'
+    envelope.body = 'Glad to see you'
+    
+    push :ios, token: user.ios_push_token
+  end
+end
+```
+
+```ruby
+# spec/models/user_spec.rb
+ 
+RSpec.describe User do
+  let(:user) do
+    create :user 
+  end
+
+  it 'sends a push' do
+    expect { user.confirm }.to change { ActionPush::Delivery::Memory.size }.by(1)
+    expect(ActionPush::Delivery::Memory.last).to have_attributes(title: 'Welcome push', body: 'Glad to see you', token: user.ios_push_token) 
+  end
+end 
+```
+
+## Реализация провайдера
+
+Можно легко реализовать функционал нового провайдера для, скажем, отправки
+уведомлений в браузер пользователя через WebSocket.
+
+В этом примере провайдером будет выступать [nchan](https://github.com/slact/nchan)
+
+```ruby
+class WebsocketMessage < ActionPush::Provider::Base
+  attr_accessor :chanel, :payload
+end
+```
+
+```ruby
+class ApplicationPush < ActionPush::Base
+  register_default :socket, WebsocketMessage.new
+end
+```
+
+```ruby
+class FollowRequestPush < ApplicationPush
+  def notify(user_id)
+    user = User.find(user_id)
+    push :socket, chanel: "pub/#{user.id}", payload: { title: t('.title') }
+  end
+end
+```
+
+```ruby
+# config/initializers/action_push
+
+ApplicationPush.register_delivery_method :socket, ->(push) do 
+  `curl http://nchan:8080/#{push.chanel} -X POST --data='#{push.payload.to_json}'`
+end
+```
+
+Теперь вы можете слать уведомления прямо в браузер пользователя:
+
+```ruby
+FollowRequestPush.notify(1)
+```