hutch-schedule 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 90c31b8f2f324f07f2e2bc3c8dcd071ce129e2bf
+  data.tar.gz: 784b5b1690b8beccbbf76a4cec009c8539f4b15b
+SHA512:
+  metadata.gz: 8feccd2adb36ca1864132c5be689162a88ab5a1072d758c4661183f29e103336be13d4001167b6dfbc2002db87eccdd2d3d2d6b8ee6fb86ee5038086b3cb4439
+  data.tar.gz: 03bc493d5ebed1b273e34cc59ab758a91e8fd5a6d88ef9b9b7689e6162442c4f140d9825f114d5dcd9aabebd84123d13f7e701b4488e05a35a7a523c2e84783f

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.idea
+
+# rspec failure tracking
+.rspec_status
+

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,5 @@
+AllCops:
+  TargetRubyVersion: 2.3
+
+Metrics:
+  LineLength: 120

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.1
+before_install: gem install bundler -v 1.14.6

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 wppurking@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,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in hutch-schedule.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 wyatt
+
+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/README.md

@@ -0,0 +1,51 @@
+# Hutch::Schedule
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/hutch/schedule`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'hutch-schedule'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install hutch-schedule
+
+## Usage
+
+为了能够初始化这个项目, 需要在合适的地方设置 Hutch 的 setup_proc 用于初始化 Hutch::Schedule
+
+```ruby
+Hutch::Config.setup_procs  << -> {
+	Hutch::Schedule.connect(Hutch.broker)
+}
+```
+
+提供了如下的功能支持:
+1. 在 RabbitMQ 中自动创建了一个 <hutch>.schedule 的 topic exchange 用于专门转发需要延迟的 Message
+2. 在 RabbitMQ 中自动创建了一个 <hutch>_schedule_queue 的 queue 带有:
+   - dlx 到 <hutch> 的 topic exchange
+   - 以及避免任务一直挤压的 30 天的 ttl
+
+## 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]/hutch-schedule. 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.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

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

data/hutch-schedule.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'hutch/schedule/version'
+
+Gem::Specification.new do |spec|
+  spec.name    = "hutch-schedule"
+  spec.version = Hutch::Schedule::VERSION
+  spec.authors = ["wyatt pan"]
+  spec.email   = ["wppurking@gmail.com"]
+
+  spec.summary     = %q{Add Schedule and Error Retry To Hutch.}
+  spec.description = %q{Add Schedule and Error Retry To Hutch.}
+  spec.homepage    = "https://github.com/wppurking/hutch-schedule"
+  spec.license     = "MIT"
+
+  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 'hutch', '~> 0.24'
+
+  spec.add_development_dependency "activejob"
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "timecop", "~> 0.8"
+end

data/lib/active_job/queue_adapters/hutch_adapter.rb

@@ -0,0 +1,59 @@
+require "hutch/schedule"
+
+module ActiveJob
+  module QueueAdapters
+    # == Hutch adapter for Active Job
+    #
+    # 简单高效的消息服务方案, Hutch 以多线程的方式处理 RabbitMQ 中的不同 Queue 的 Message.
+    #
+    # Read more about Hutch {here}[https://github.com/gocardless/hutch].
+    #
+    #   Rails.application.config.active_job.queue_adapter = :hutch
+    class HutchAdapter
+      # 需要将 activejob 使用的队列全部 routing 到一个 rabbitmq 的 queue 中
+      AJ_ROUTING_KEY = "active_job"
+
+      def initialize
+        @monitor = Monitor.new
+      end
+
+      # 不适用 Consumer 的 enqueue, 无需每次重复计算
+      def enqueue(job) #:nodoc:
+        @monitor.synchronize do
+          # 将整个 job 的 data 变为 hash 发布出去
+          Hutch.publish(routing_key(job), job.serialize)
+        end
+      end
+
+      def enqueue_at(job, timestamp) #:nodoc:
+        interval = [(timestamp - Time.now.utc.to_i), 1.second].max
+        enqueue_in(interval, job.serialize, routing_key(job))
+      end
+
+      # 不适用 Consumer 的 enqueue, 无需每次重复计算
+      def enqueue_in(interval, message, routing_key)
+        @monitor.synchronize do
+          # 必须是 integer
+          props = { expiration: interval.in_milliseconds.to_i }
+          Hutch::Schedule.publish(routing_key, message, props)
+        end
+      end
+
+      # 计算 routing_key
+      def routing_key(job)
+        "#{AJ_ROUTING_KEY}.#{job.queue_name}"
+      end
+
+      class JobWrapper #:nodoc:
+        include Hutch::Consumer
+        # 给 ActiveJob 使用的一个大队列
+        consume "#{HutchAdapter::AJ_ROUTING_KEY}.#"
+
+        def process(job_data)
+          # 执行 ActiveJob 的 Base, 将整个 job 的 data 传过去, 让其进行反序列化, 组织成参数等等
+          Base.execute job_data
+        end
+      end
+    end
+  end
+end

data/lib/hutch/enqueue.rb

@@ -0,0 +1,40 @@
+require 'active_support/concern'
+require 'active_support/core_ext/numeric/time'
+require 'hutch/schedule'
+
+module Hutch
+  # 如果需要增加让 Consumer Enqueue 的动作, 那么则 include 这个 Module
+  module Enqueue
+    extend ActiveSupport::Concern
+
+    # Add Consumer methods
+    class_methods do
+      # 正常的发布 consumer 对应 routing key 的消息
+      def enqueue(message)
+        Hutch.publish(enqueue_routing_key, message)
+      end
+
+      # publish message at a delay times
+      # interval: 推迟的时间
+      # message: 具体的消息
+      def enqueue_in(interval, message)
+        props = { expiration: interval.in_milliseconds.to_i }
+        Hutch::Schedule.publish(enqueue_routing_key, message, props)
+      end
+
+      # 延期在某一个时间点执行
+      def enqueue_at(time, message)
+        # 如果 time 比当前时间还早, 那么就延迟 1s 钟执行
+        interval = [(time.utc - Time.now.utc), 1.second].max
+        enqueue_in(interval, message)
+      end
+
+      # routing_key: 目的为将 Message 发送给 RabbitMQ 那么使用其监听的任何一个 routing_key 都可以发送
+      def enqueue_routing_key
+        raise "Routing Keys is not set!" if routing_keys.size < 1
+        routing_keys.to_a.last
+      end
+    end
+  end
+end
+

data/lib/hutch/schedule/core.rb

@@ -0,0 +1,72 @@
+require 'active_support/dependencies/autoload'
+require 'active_support/core_ext/object/blank'
+require 'active_support/core_ext/numeric'
+require 'active_support/core_ext/module/delegation'
+
+# 共享 Hutch::Broker 实例的所有东西
+module Hutch
+  module Schedule
+    class Core
+
+      attr_reader :broker, :exchange
+
+      delegate :channel, :connection, :logger, to: :broker
+
+      # 初始化 schedule
+      def initialize(broker)
+        raise "Broker can`t be nil" if broker.blank?
+        @broker = broker
+      end
+
+      # 获取 Hutch 上的 Config
+      def config
+        broker.instance_variable_get(:@config)
+      end
+
+      # Core 的连接, 注意连接是有顺序的, 必须先将 exchange 初始化好
+      def connect!
+        declare_exchange!
+        declare_publisher!
+        setup_queue!
+      end
+
+      def declare_publisher!
+        @publisher = Hutch::Publisher.new(connection, channel, exchange, config)
+      end
+
+      # 申明 schedule 使用的 ex
+      def declare_exchange!
+        @exchange = declare_exchange
+      end
+
+      def declare_exchange(ch = channel)
+        exchange_name    = "#{config[:mq_exchange]}.schedule"
+        # TODO: 检查 mq_exchange_options 中的信息, 确保不会覆盖 x-dead-letter-exchange 的参数
+        exchange_options = {
+          durable:                  true,
+          'x-dead-letter-exchange': config[:mq_exchange] }.merge(config[:mq_exchange_options])
+        logger.info "using topic exchange(schedule) '#{exchange_name}'"
+
+        broker.send(:with_bunny_precondition_handler, 'schedule exchange') do
+          ch.topic(exchange_name, exchange_options)
+        end
+      end
+
+      # 申明 schedule 使用的 queue
+      def setup_queue!
+        props = { 'x-message-ttl': 30.days.in_milliseconds, 'x-dead-letter-exchange': config[:mq_exchange] }
+        queue = broker.queue("#{config[:mq_exchange]}_schedule_queue", props)
+
+        # TODO: 可以考虑将这个抽取成为参数
+        # routing all to this queue
+        queue.unbind(exchange, routing_key: '#')
+        queue.bind(exchange, routing_key: '#')
+      end
+
+      # Schedule broker 自己的 publish 方法
+      def publish(*args)
+        @publisher.publish(*args)
+      end
+    end
+  end
+end

data/lib/hutch/schedule/version.rb

@@ -0,0 +1,5 @@
+module Hutch
+  module Schedule
+    VERSION = "0.1.0"
+  end
+end

data/lib/hutch/schedule.rb

@@ -0,0 +1,31 @@
+require 'active_support/core_ext/module/delegation'
+require 'active_support/core_ext/object/blank'
+require 'hutch'
+require 'hutch/enqueue'
+require 'hutch/schedule/core'
+
+# 引入了 active_job 则引入 adapter
+if defined?(ActiveJob)
+  require 'active_job/queue_adapters/hutch_adapter'
+end
+
+# gem 的核心入口文件
+module Hutch
+  # 在 Hutch 下的独立的 Schedule module, 负责与 schedule 相关的 publish
+  module Schedule
+
+    def self.connect(broker)
+      return if core.present?
+      @core = Hutch::Schedule::Core.new(broker)
+      @core.connect!
+    end
+
+    def self.core
+      @core
+    end
+
+    def self.publish(*args)
+      core.publish(*args)
+    end
+  end
+end

data/lib/hutch-schedule.rb

@@ -0,0 +1,2 @@
+# requrie entry point
+require 'hutch/schedule'

metadata

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification
+name: hutch-schedule
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- wyatt pan
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-05-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: hutch
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.24'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.24'
+- !ruby/object:Gem::Dependency
+  name: activejob
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+description: Add Schedule and Error Retry To Hutch.
+email:
+- wppurking@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- hutch-schedule.gemspec
+- lib/active_job/queue_adapters/hutch_adapter.rb
+- lib/hutch-schedule.rb
+- lib/hutch/enqueue.rb
+- lib/hutch/schedule.rb
+- lib/hutch/schedule/core.rb
+- lib/hutch/schedule/version.rb
+homepage: https://github.com/wppurking/hutch-schedule
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: Add Schedule and Error Retry To Hutch.
+test_files: []