timberline-rails 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bd1b6647a272ed349fa5841ea5c034cc5d08113c
+  data.tar.gz: 91c83bda9ed02f63524e2f3dcc5c89f205e7d220
+SHA512:
+  metadata.gz: d760c7a1f26209a068f3c7f378b531ed3e81a3f4f3e1c8f983e6450c28865c7e364fd363fd3804b2b5fbb8f50366ccf350b784695e0d71b75c0538960420ba76
+  data.tar.gz: 0d952ff2409dbf5d29f42eb24e27ebaf8357d45dde94fbdb5fdeb317089b1341d55d0286abb8378ded345746022d6e98aa1531d5b9f6e84e46dd7f823dd61cee

data/.rspec

@@ -0,0 +1 @@
+--color

data/.ruby-gemset

@@ -0,0 +1 @@
+timberline-rails

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - jruby-19mode
+  - jruby-head
+  - 2.0.0
+  - 2.1.0
+  - ruby-head
+services: 
+  - redis-server

data/CHANGELOG

@@ -0,0 +1,3 @@
+0.1.0
+  - First public release of Timberline-Rails
+  - Add Rails-specific configuration logic for loading config/timberline.yml

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Gem dependencies specified in timberline-rails.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,52 @@
+PATH
+  remote: .
+  specs:
+    timberline-rails (0.1.0)
+      timberline (~> 0.6.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    coderay (1.1.0)
+    daemons (1.1.9)
+    diff-lcs (1.2.5)
+    method_source (0.8.2)
+    pry (0.9.12.6)
+      coderay (~> 1.0)
+      method_source (~> 0.8)
+      slop (~> 3.4)
+    rake (10.3.2)
+    redis (3.0.7)
+    redis-expiring-set (0.1.2)
+      redis
+    redis-namespace (1.4.1)
+      redis (~> 3.0.4)
+    rspec (3.0.0)
+      rspec-core (~> 3.0.0)
+      rspec-expectations (~> 3.0.0)
+      rspec-mocks (~> 3.0.0)
+    rspec-core (3.0.0)
+      rspec-support (~> 3.0.0)
+    rspec-expectations (3.0.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.0.0)
+    rspec-mocks (3.0.0)
+      rspec-support (~> 3.0.0)
+    rspec-support (3.0.0)
+    slop (3.5.0)
+    timberline (0.6.0)
+      daemons
+      redis
+      redis-expiring-set
+      redis-namespace
+      trollop
+    trollop (2.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  pry
+  rake
+  rspec (~> 3.0.0)
+  timberline-rails!

data/README.markdown

@@ -0,0 +1,53 @@
+# Timberline-Rails
+
+## Purpose
+
+Timberline-Rails adds some extra functionality to
+[Timberline](https://github.com/treehouse/timberline) to make it easier to use
+in the context of a Rails application.
+
+## What's New
+
+### Configuration
+
+In base Timberline, you have a few options for configuration, from defining a
+`TIMBERLINE\_YAML` constant that points to a yaml config file to defining the
+configuration in code using `Timberline.configure`. Timberline-Rails adds in
+automatic detection for a config file at `config/timberline.yml` in your Rails
+app, complete with environment support (just like database.yml).
+
+## Usage
+
+Timberline-Rails works exactly like Timberline; just make sure that you have
+`timberline-rails` listed in your Gemfile and you're good to go.
+
+## TODO
+
+Still to be done:
+
+- **Rails Workers** - implement workers that expect to operate on ActiveRecord objects
+  so you can quickly and easily background tasks in Rails.
+
+## Contributions
+
+If Timberline-Rails interests you and you think you might want to contribute,
+hit me up over Github. You can also just fork it and make some changes, but
+there's a better chance that your work won't be duplicated or rendered obsolete
+if you check in on the current development status first.
+
+## Development notes
+
+You need Redis installed to do development on Timberline-Rails, and currently the test
+suites assume that you're using the default configurations for Redis. That
+should probably change, but it probably won't until someone needs it to.
+
+Gem requirements/etc. should be handled by Bundler.
+
+## License
+Copyright (C) 2014 by Tommy Morgan
+
+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/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/timberline/rails/version.rb

@@ -0,0 +1,5 @@
+class Timberline
+  class Rails
+    VERSION = "0.1.0"
+  end
+end

data/lib/timberline-rails.rb

@@ -0,0 +1,24 @@
+require 'timberline'
+require 'timberline/rails/version'
+
+class Timberline
+  class Config
+    def rails_initialize
+      if defined? ::Rails
+        config_file = File.join(::Rails.root, 'config', 'timberline.yml')
+        if File.exists?(config_file)
+          configs = YAML.load_file(config_file)
+          config = configs[::Rails.env]
+          load_from_yaml(config)
+        else
+          non_rails_initialize
+        end
+      else
+        non_rails_initialize
+      end
+    end
+
+    alias_method :non_rails_initialize, :initialize
+    alias_method :initialize, :rails_initialize
+  end
+end

data/spec/fake_rails/config/timberline.yml

@@ -0,0 +1,7 @@
+development:
+  host: localhost
+  port: 12345
+  timeout: 10
+  password: foo
+  database: 3
+  namespace: treecurve

data/spec/lib/config_spec.rb

@@ -0,0 +1,53 @@
+require 'spec_helper'
+
+describe Timberline::Config do
+  context "When there is a valid config file" do
+    before { SpecSupport::FakeRails.create_fake_env }
+    after  { SpecSupport::FakeRails.destroy_fake_env }
+
+    it "does not delegate to the original Timberline constructor" do
+      config = Timberline::Config.new
+      expect(config).not_to receive(:non_rails_initialize)
+      config.rails_initialize
+    end
+
+    context "loading data from the config file:" do
+      subject { Timberline::Config.new }
+
+      it "host" do
+        expect(subject.host).to eq("localhost")
+      end
+
+      it "port" do
+        expect(subject.port).to eq(12345)
+      end
+
+      it "timeout" do
+        expect(subject.timeout).to eq(10)
+      end
+
+      it "password" do
+        expect(subject.password).to eq("foo")
+      end
+
+      it "database" do
+        expect(subject.database).to eq(3)
+      end
+
+      it "namespace" do
+        expect(subject.namespace).to eq("treecurve")
+      end
+    end
+  end  
+
+  context "When there is not a valid config file" do
+    before { SpecSupport::FakeRails.create_fake_env_without_config }
+    after  { SpecSupport::FakeRails.destroy_fake_env }
+
+    it "delegates to the original Timberline constructor" do
+      config = Timberline::Config.new
+      expect(config).to receive(:non_rails_initialize)
+      config.rails_initialize
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,19 @@
+require 'rspec'
+require 'pry'
+
+require File.expand_path("../../lib/timberline-rails", __FILE__)
+
+Dir[File.expand_path("../support/**/*.rb", __FILE__)].each { |f| require f }
+
+RSpec.configure do |config|
+  config.mock_with :rspec
+  config.expect_with :rspec do |c|
+    c.syntax = [:expect]
+  end
+
+  config.order = "random"
+
+  config.after(:each) do
+    SpecSupport::TimberlineReset.clear_config
+  end
+end

data/spec/support/fake_rails.rb

@@ -0,0 +1,17 @@
+module SpecSupport
+  module FakeRails
+    def self.create_fake_env
+      fake_rails = OpenStruct.new(root: File.join(File.dirname(File.path(__FILE__)), "..", "fake_rails"), env: "development") 
+      Object.send(:const_set, :Rails, fake_rails)
+    end
+
+    def self.create_fake_env_without_config
+      fake_rails = OpenStruct.new(root: File.join(File.dirname(File.path(__FILE__)), "..", "gibberish"), env: "development") 
+      Object.send(:const_set, :Rails, fake_rails)
+    end
+
+    def self.destroy_fake_env
+      Object.send(:remove_const, :Rails)
+    end
+  end
+end

data/spec/support/timberline_reset.rb

@@ -0,0 +1,20 @@
+module SpecSupport
+  module TimberlineReset
+    def self.clear_config
+      Timberline.redis = nil
+      Timberline.instance_variable_set("@config", nil)
+      clear_test_db
+      Timberline.redis = nil
+    end
+
+    # Use database 15 for testing, so we don't risk overwriting any data that's
+    # actually useful
+    def self.clear_test_db
+      Timberline.config do |c|
+        c.database = 15
+      end
+      Timberline.redis.flushdb
+    end
+
+  end
+end

data/timberline-rails.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "timberline/rails/version"
+
+Gem::Specification.new do |s|
+  s.name        = "timberline-rails"
+  s.version     = Timberline::Rails::VERSION
+  s.authors     = ["Tommy Morgan"]
+  s.email       = ["tommy.morgan@gmail.com"]
+  s.homepage    = "http://github.com/treehouse/timberline-rails"
+  s.summary     = %q{Rails logic and niceties for the Timberline queueing system.}
+  s.description = %q{Timberline is a simple and extensible queuing system built in Ruby and backed by Redis. It makes as few assumptions as possible about how you want to interact with your queues while also allowing for some functionality that should be universally useful, like allowing for automatic retries of jobs and queue statistics.}
+
+  s.rubyforge_project = "timberline-rails"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_runtime_dependency "timberline", "~> 0.6.0"
+
+  s.add_development_dependency "rake"
+  s.add_development_dependency "rspec", '~> 3.0.0'
+  s.add_development_dependency "pry"
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: timberline-rails
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tommy Morgan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: timberline
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: pry
+  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'
+description: Timberline is a simple and extensible queuing system built in Ruby and
+  backed by Redis. It makes as few assumptions as possible about how you want to interact
+  with your queues while also allowing for some functionality that should be universally
+  useful, like allowing for automatic retries of jobs and queue statistics.
+email:
+- tommy.morgan@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .rspec
+- .ruby-gemset
+- .travis.yml
+- CHANGELOG
+- Gemfile
+- Gemfile.lock
+- README.markdown
+- Rakefile
+- lib/timberline-rails.rb
+- lib/timberline/rails/version.rb
+- spec/fake_rails/config/timberline.yml
+- spec/lib/config_spec.rb
+- spec/spec_helper.rb
+- spec/support/fake_rails.rb
+- spec/support/timberline_reset.rb
+- timberline-rails.gemspec
+homepage: http://github.com/treehouse/timberline-rails
+licenses: []
+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: timberline-rails
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Rails logic and niceties for the Timberline queueing system.
+test_files: []