hydroponic_bean 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9be5fc754d60f8829cbbd0ba05227eba6870223f
+  data.tar.gz: 84c0e63df7d54790e15fe9c740a916d6abd09486
+SHA512:
+  metadata.gz: 1fecd8d584eb0d85cf2e0398d5330aeff2fd418dabe8a1c218815b1d894b4d9e56748c1d716022cf61041b0f96e2b5ac4e1940e77cb16a6ccad4ca628c6723a5
+  data.tar.gz: 4a11702f8cfe3255080f2597814693a132b6dc007b1bf93951a5de28b844faf2093f777ff896f4a935af2ab3b3fc8325b17cc3968f1a54b5f77f8d6e9188ea4c

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+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.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at geoffroy@planquart.fr. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in hydroponic_bean.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Geoffroy Planquart
+
+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,47 @@
+# HydroponicBean
+
+This gem aims to provide a mock for the [beaneater](https://github.com/beanstalkd/beaneater) connection,
+used to access a [beanstalkd](https://github.com/kr/beanstalkd)
+instance, either directly or through [backburner](https://github.com/nesquena/backburner).
+
+At the moment, the focus is made only on the producer commands, although it should be
+easy enough (though maybe not as useful) to mock worker commands to, followings the
+[protocol documentation](https://github.com/kr/beanstalkd/blob/master/doc/protocol.txt)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'hydroponic_bean', group: :test
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install hydroponic_bean
+
+## Usage
+
+Simply call `Beaneater.hydroponic!` to make it use this mocked collection.
+
+You can include `HydroponicBean::TestHelper` which provides `assert_job_put(count = 1) do ... end` for you tests.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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]/hydroponic_bean. 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,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "hydroponic_bean"
+
+# 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

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/hydroponic_bean.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'hydroponic_bean/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "hydroponic_bean"
+  spec.version       = HydroponicBean::VERSION
+  spec.authors       = ["Geoffroy Planquart"]
+  spec.email         = ["geoffroy@planquart.fr"]
+
+  spec.summary       = %q{Mocking beaneater's connection}
+  spec.description   = %q{Mocking a TCP connection to a beanstalkd instance}
+  spec.homepage      = "https://github.com/Aethelflaed/hydroponic_bean"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+
+  spec.add_dependency 'beaneater', '~> 1.0'
+end

data/lib/hydroponic_bean.rb

@@ -0,0 +1,25 @@
+require 'beaneater'
+
+require 'hydroponic_bean/version'
+require 'hydroponic_bean/data'
+require 'hydroponic_bean/connection'
+require 'hydroponic_bean/test_helper'
+
+module HydroponicBean
+  def establish_connection
+    # Keep all variables initialized as if normal connection
+    @address = address.first if address.is_a?(Array)
+    match = address.split(':')
+    @host, @port = match[0], Integer(match[1] || DEFAULT_PORT)
+
+    @connection = Connection.new
+  end
+end
+
+class Beaneater
+  def self.hydroponic!
+    Beaneater::Connection.class_eval do
+      prepend HydroponicBean
+    end
+  end
+end

data/lib/hydroponic_bean/commands.rb

@@ -0,0 +1,11 @@
+require 'hydroponic_bean/commands/producer'
+require 'hydroponic_bean/commands/worker'
+require 'hydroponic_bean/commands/other'
+
+module HydroponicBean
+  module Commands
+    include HydroponicBean::Commands::Producer
+    include HydroponicBean::Commands::Worker
+    include HydroponicBean::Commands::Other
+  end
+end

data/lib/hydroponic_bean/commands/other.rb

@@ -0,0 +1,20 @@
+module HydroponicBean
+  module Commands
+    module Other
+      def peek(stream, id)
+        peek_output(HydroponicBean.jobs[id.to_i - 1])
+      end
+
+      protected
+      def peek_output(job)
+        if job
+          output("FOUND #{job[:id]} #{job[:data].length}\r\n")
+          output("#{job[:data]}\r\n")
+        else
+          output(Protocol::NOT_FOUND)
+          return false
+        end
+      end
+    end
+  end
+end

data/lib/hydroponic_bean/commands/producer.rb

@@ -0,0 +1,28 @@
+module HydroponicBean
+  module Commands
+    module Producer
+      def use(stream, tube)
+        @current_tube_name = tube
+        output("USING #{current_tube_name}\r\n")
+      end
+
+      def put(stream, pri, delay, ttr, bytes)
+        bytes = bytes.to_i
+        data = stream.read(bytes)
+
+        if data.length < bytes
+          output(Protocol::BAD_FORMAT)
+          return false
+        end
+
+        if stream.read(2) != "\r\n"
+          output(Protocol::EXPECTED_CRLF)
+          return false
+        end
+
+        id = create_job(pri, delay, ttr, data)
+        output("INSERTED #{id}\r\n")
+      end
+    end
+  end
+end

data/lib/hydroponic_bean/commands/worker.rb

@@ -0,0 +1,6 @@
+module HydroponicBean
+  module Commands
+    module Worker
+    end
+  end
+end

data/lib/hydroponic_bean/connection.rb

@@ -0,0 +1,34 @@
+require 'hydroponic_bean/protocol'
+
+module HydroponicBean
+  class Connection
+    include HydroponicBean::Protocol
+
+    def initialize
+      @_read, @_write = IO.pipe
+    end
+
+    # Necessary interface used by beaneater
+    def write(command)
+      parse(StringIO.new(command))
+    end
+
+    def read(bytes)
+      @_read.read(bytes)
+    end
+
+    def readline
+      @_read.readline
+    end
+
+    def close
+      @_read.close
+      @_write.close
+    end
+
+    protected
+    def output(data)
+      @_write.write(data)
+    end
+  end
+end

data/lib/hydroponic_bean/data.rb

@@ -0,0 +1,40 @@
+module HydroponicBean
+  def self.tubes
+    @tubes ||= Hash.new{|h, k| h[k] = []}
+  end
+
+  def self.jobs
+    @jobs ||= []
+  end
+
+  module Data
+    def current_tube_name
+      @current_tube_name ||= 'default'
+    end
+
+    def current_tube
+      HydroponicBean.tubes[current_tube_name]
+    end
+
+    def next_id
+      HydroponicBean.jobs.length + 1
+    end
+
+    def create_job(pri, delay, ttr, data)
+      job = {
+        id: next_id,
+        tube: current_tube_name,
+        pri: pri.to_i,
+        delay: delay.to_i,
+        ttr: ttr.to_i,
+        data: data,
+      }
+      job[:state] = (job[:delay] == 0) ? :ready : :delayed
+
+      HydroponicBean.jobs.push(job)
+      current_tube.push(job)
+
+      return job[:id]
+    end
+  end
+end

data/lib/hydroponic_bean/protocol.rb

@@ -0,0 +1,31 @@
+require 'hydroponic_bean/commands'
+
+module HydroponicBean
+  module Protocol
+    include HydroponicBean::Data
+    include HydroponicBean::Commands
+
+    OUT_OF_MEMORY   = "OUT_OF_MEMORY\r\n".freeze
+    INTERNAL_ERROR  = "INTERNAL_ERROR\r\n".freeze
+    BAD_FORMAT      = "BAD_FORMAT\r\n".freeze
+    UNKNOWN_COMMAND = "UNKNOWN_COMMAND\r\n".freeze
+    EXPECTED_CRLF   = "EXPECTED_CRLF\r\n".freeze
+    JOB_TOO_BIG     = "JOB_TOO_BIG\r\n".freeze
+    DRAINING        = "DRAINING\r\n".freeze
+    NOT_FOUND       = "NOT_FOUND\r\n".freeze
+
+    def parse(stream)
+      while (line = stream.gets("\r\n")) do
+        if line.slice!(-2..-1) != "\r\n"
+          output(BAD_FORMAT)
+          return
+        end
+
+        command, *args = line.split
+        if !send(command.gsub('-', '_'), *([stream] + args))
+          return
+        end
+      end
+    end
+  end
+end

data/lib/hydroponic_bean/test_helper.rb

@@ -0,0 +1,10 @@
+module HydroponicBean
+  module TestHelper
+    def assert_job_put(count = 1)
+      current_count = HydroponicBean.jobs.count
+      result = yield
+      assert current_count + count == HydroponicBean.jobs.count, "Exepected #{count} job(s) to be put, but found #{HydroponicBean.jobs.count - current_count}"
+      return result
+    end
+  end
+end

data/lib/hydroponic_bean/version.rb

@@ -0,0 +1,3 @@
+module HydroponicBean
+  VERSION = '1.0.0'
+end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: hydroponic_bean
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Geoffroy Planquart
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-07-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: beaneater
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: Mocking a TCP connection to a beanstalkd instance
+email:
+- geoffroy@planquart.fr
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- hydroponic_bean.gemspec
+- lib/hydroponic_bean.rb
+- lib/hydroponic_bean/commands.rb
+- lib/hydroponic_bean/commands/other.rb
+- lib/hydroponic_bean/commands/producer.rb
+- lib/hydroponic_bean/commands/worker.rb
+- lib/hydroponic_bean/connection.rb
+- lib/hydroponic_bean/data.rb
+- lib/hydroponic_bean/protocol.rb
+- lib/hydroponic_bean/test_helper.rb
+- lib/hydroponic_bean/version.rb
+homepage: https://github.com/Aethelflaed/hydroponic_bean
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Mocking beaneater's connection
+test_files: []