queued-ruby 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 865c893471a8fd7a247099588c38c287536d5e19
+  data.tar.gz: 2abff73f13ff6a6ac44a180fb34273f4b76cfb3f
+SHA512:
+  metadata.gz: f41cc90de1bf6cf45a2900aaf40cedcf3ceca0ec86795b2de8eb53e2c0b8c97f0f5b222f1777d3f8977d94d675dfb0bded03408bc9647c3865dc3c81e8252547
+  data.tar.gz: 091ab0abc75cb0f7c5f6972098f92a0a1d16c6a2aa13f10f90fb2e93ec59b053bea129134d6a7947a97a704bff6191d945834b97fed6db4287aa01f81e33490c

data/Gemfile

@@ -0,0 +1,2 @@
+source 'http://rubygems.org'
+gemspec

data/Gemfile.lock

@@ -0,0 +1,43 @@
+PATH
+  remote: .
+  specs:
+    queue (0.0.1)
+      faraday (>= 0.8, < 0.10)
+      faraday_middleware (>= 0.8, < 0.10)
+      multi_json (~> 1.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    addressable (2.3.5)
+    crack (0.4.1)
+      safe_yaml (~> 0.9.0)
+    diff-lcs (1.2.4)
+    faraday (0.8.8)
+      multipart-post (~> 1.2.0)
+    faraday_middleware (0.9.0)
+      faraday (>= 0.7.4, < 0.9)
+    multi_json (1.8.0)
+    multipart-post (1.2.0)
+    rake (10.1.0)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.5)
+    rspec-expectations (2.14.3)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.3)
+    safe_yaml (0.9.7)
+    webmock (1.13.0)
+      addressable (>= 2.2.7)
+      crack (>= 0.3.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  queue!
+  rake
+  rspec
+  webmock

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 Scott Nelson
+
+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,35 @@
+queued-ruby
+===
+
+[Queued](http://github.com/scttnlsn/queued) client for Ruby
+
+Example
+---
+
+```ruby
+require 'queued-ruby'
+
+client = Queued::Client.new('http://localhost:5353', auth: 'secret')
+queue = client.queue('testing')
+```
+
+Producer:
+
+```ruby
+item = queue.enqueue(foo: 'bar')
+```
+
+Consumer:
+
+```ruby
+item = queue.dequeue(timeout: 10, wait: 30)
+if item
+  p item.value
+  item.complete
+end
+```
+
+Install
+---
+
+    gem install queued-ruby

data/Rakefile

@@ -0,0 +1,7 @@
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+end
+
+task :default => :spec

data/lib/queued/client.rb

@@ -0,0 +1,34 @@
+require 'faraday'
+require 'faraday_middleware'
+
+module Queued
+  class Client
+    def initialize(url, options = {})
+      @url = url
+      @auth = options[:auth]
+
+      @conn = Faraday.new(:url => @url) do |conn|
+        conn.use Middleware::Errors
+
+        conn.request :json
+        conn.response :json, :content_type => /\bjson$/
+        
+        conn.adapter Faraday.default_adapter
+      end
+
+      if @auth
+        @conn.basic_auth('', @auth)
+      end
+    end
+
+    def queue(name)
+      Queue.new(self, name)
+    end
+
+    [:get, :post, :put, :delete].each do |method|
+      define_method method do |*args, &block|
+        @conn.send(method, *args, &block)
+      end
+    end
+  end
+end

data/lib/queued/item.rb

@@ -0,0 +1,17 @@
+module Queued
+  class Item
+    attr_reader :value, :type, :url
+
+    def initialize(client, options = {})
+      @client = client
+      @value = options[:value]
+      @type = options[:type]
+      @url = options[:url]
+    end
+
+    def complete
+      @client.delete @url
+      self
+    end
+  end
+end

data/lib/queued/middleware/errors.rb

@@ -0,0 +1,31 @@
+module Queued
+  class Error < StandardError; end
+  class BadRequest < Error; end
+  class Unauthorized < Error; end
+  class InternalServerError < Error; end
+
+  module Middleware
+    ERROR_MAP = {
+      400 => BadRequest,
+      401 => Unauthorized,
+      500 => InternalServerError
+    }
+
+    class Errors < Faraday::Response::Middleware
+      def on_complete(env)
+        return unless error = ERROR_MAP[env[:status]]
+        raise error, error_message(env[:body])
+      end
+
+      private
+
+      def error_message(body)
+        if body && body.is_a?(Hash)
+          body['error']
+        else
+          body
+        end
+      end
+    end
+  end
+end

data/lib/queued/middleware.rb

@@ -0,0 +1,5 @@
+module Queued
+  module Middleware
+    autoload :Errors, 'queued/middleware/errors'
+  end
+end

data/lib/queued/queue.rb

@@ -0,0 +1,36 @@
+module Queued
+  class Queue
+    def initialize(client, name)
+      @client = client
+      @name = name
+    end
+
+    def enqueue(value, type = 'text/plain')
+      res = @client.post do |req|
+        req.url "/#{@name}"
+        req.headers['Content-Type'] = type
+        req.body = value
+      end
+
+      Item.new(@client,
+        value: value,
+        type: type,
+        url: res.headers['Location'])
+    end
+
+    def dequeue(params = {})
+      res = @client.post do |req|
+        req.url "/#{@name}/dequeue"
+        req.params[:wait] = params[:wait] if params[:wait]
+        req.params[:timeout] = params[:timeout] if params[:timeout]
+      end
+
+      return nil if res.status === 404
+
+      Item.new(@client,
+        value: res.body,
+        type: res.headers['Content-Type'],
+        url: res.headers['Location'])
+    end
+  end
+end

data/lib/queued/version.rb

@@ -0,0 +1,3 @@
+module Queued
+  VERSION = '0.1.0'
+end

data/lib/queued.rb

@@ -0,0 +1,6 @@
+module Queued
+  autoload :Client, 'queued/client'
+  autoload :Item, 'queued/item'
+  autoload :Queue, 'queued/queue'
+  autoload :Middleware, 'queued/middleware'
+end

data/queued-ruby.gemspec

@@ -0,0 +1,24 @@
+$:.push File.expand_path('../lib', __FILE__)
+
+require 'queued/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'queued-ruby'
+  spec.version = Queued::VERSION
+  spec.files = Dir.glob('**/*')
+  spec.require_paths = ['lib']
+  spec.summary = 'Queued client library'
+  spec.description = 'Queued client library for Ruby'
+  spec.authors = ['Scott Nelson']
+  spec.email = 'scott@scttnlsn.com'
+  spec.homepage = 'https://github.com/scttnlsn/queued-rb'
+
+  spec.add_dependency 'faraday', ['>= 0.8', '< 0.10']
+  spec.add_dependency 'faraday_middleware', ['>= 0.8', '< 0.10']
+  spec.add_dependency 'multi_json', ['~> 1.0']
+  spec.add_dependency 'json', ['~> 1.7'] if RUBY_VERSION < '1.9'
+
+  spec.add_development_dependency('rake')
+  spec.add_development_dependency('rspec')
+  spec.add_development_dependency('webmock')
+end

data/spec/client_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+describe Queued::Client do
+  let!(:client) { Queued::Client.new('http://example.com') }
+
+  it 'raises errors' do
+    stub_request(:get, 'http://example.com/foo').to_return(
+      status: 500,
+      headers: { 'Content-Type' => 'application/json' },
+      body: '{"error": "Something went wrong"}')
+
+    expect { client.get '/foo' }.to raise_error(Queued::InternalServerError)
+  end
+
+  it 'sends auth info' do
+    stub_request(:get, 'http://:testing@example.com/foo')
+
+    client = Queued::Client.new('http://example.com', auth: 'testing')
+    client.get '/foo'
+
+    assert_requested :get, 'http://:testing@example.com/foo', times: 1
+  end
+
+  describe '#queue' do
+    it 'should return queue' do
+      expect(client.queue(:foo)).to be_a(Queued::Queue)
+    end
+  end
+end

data/spec/item_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+describe Queued::Item do
+  let!(:client) { Queued::Client.new('http://example.com') }
+  let!(:item) { Queued::Item.new(client, url: 'http://example.com/foo/1') }
+
+  describe '#complete' do
+    before :each do
+      stub_request(:delete, 'http://example.com/foo/1')
+    end
+
+    it 'deletes to complete endpoint' do
+      item.complete()
+      assert_requested :delete, 'http://example.com/foo/1', times: 1
+    end
+  end
+end

data/spec/queue_spec.rb

@@ -0,0 +1,84 @@
+require 'spec_helper'
+
+describe Queued::Queue do
+  let!(:client) { Queued::Client.new('http://example.com') }
+  let!(:queue) { Queued::Queue.new(client, 'foo') }
+
+  describe '#enqueue' do
+    before :each do
+      stub_request(:post, 'http://example.com/foo').
+        to_return(headers: { 'Location' => 'http://example.com/foo/1' })
+    end
+
+    it 'posts to enqueue endpoint' do
+      queue.enqueue('bar')
+
+      assert_requested :post, 'http://example.com/foo',
+        headers: { 'Content-Type' => 'text/plain' },
+        body: 'bar',
+        times: 1
+    end
+
+    it 'returns enqueued item' do
+      item = queue.enqueue('bar')
+
+      expect(item).to be_a(Queued::Item)
+      expect(item.value).to eq 'bar'
+      expect(item.type).to eq 'text/plain'
+      expect(item.url).to eq 'http://example.com/foo/1'
+    end
+
+    it 'encodes JSON values' do
+      queue.enqueue({ bar: 'baz' }, 'application/json')
+
+      assert_requested :post, 'http://example.com/foo',
+        headers: { 'Content-Type' => 'application/json' },
+        body: '{"bar":"baz"}',
+        times: 1
+    end
+  end
+
+  describe '#dequeue' do
+    it 'posts to dequeue endpoint' do
+      stub_request(:post, 'http://example.com/foo/dequeue?timeout=2&wait=1').to_return(
+        headers: { 'Content-Type' => 'text/plain', 'Location' => 'http://example.com/foo/1' },
+        body: 'bar')
+
+      queue.dequeue(wait: 1, timeout: 2)
+      assert_requested :post, 'http://example.com/foo/dequeue?timeout=2&wait=1', times: 1
+    end
+
+    it 'returns dequeued item' do
+      stub_request(:post, 'http://example.com/foo/dequeue').to_return(
+        headers: { 'Content-Type' => 'text/plain', 'Location' => 'http://example.com/foo/1' },
+        body: 'bar')
+
+      item = queue.dequeue()
+
+      expect(item).to be_a(Queued::Item)
+      expect(item.value).to eq 'bar'
+      expect(item.type).to eq 'text/plain'
+      expect(item.url).to eq 'http://example.com/foo/1'
+    end
+
+    it 'returns nil on 404' do
+      stub_request(:post, 'http://example.com/foo/dequeue').to_return(status: 404)
+
+      item = queue.dequeue()
+
+      expect(item).to be_nil
+    end
+
+    it 'parses JSON responses' do
+      stub_request(:post, 'http://example.com/foo/dequeue').to_return(
+        headers: { 'Content-Type' => 'application/json', 'Location' => 'http://example.com/foo/1' },
+        body: '{"bar":"baz"}')
+
+      item = queue.dequeue()
+
+      expect(item).to be_a(Queued::Item)
+      expect(item.type).to eq 'application/json'
+      expect(item.value).to eq 'bar' => 'baz'
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+$:.unshift File.expand_path('../../lib', __FILE__)
+
+require 'queued'
+require 'webmock/rspec'
+
+WebMock.disable_net_connect!

metadata

@@ -0,0 +1,155 @@
+--- !ruby/object:Gem::Specification
+name: queued-ruby
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Scott Nelson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-09-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0.8'
+    - - <
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0.8'
+    - - <
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0.8'
+    - - <
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0.8'
+    - - <
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  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'
+- !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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  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: Queued client library for Ruby
+email: scott@scttnlsn.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- lib/queued/client.rb
+- lib/queued/item.rb
+- lib/queued/middleware/errors.rb
+- lib/queued/middleware.rb
+- lib/queued/queue.rb
+- lib/queued/version.rb
+- lib/queued.rb
+- LICENSE
+- queued-ruby.gemspec
+- Rakefile
+- README.md
+- spec/client_spec.rb
+- spec/item_spec.rb
+- spec/queue_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/scttnlsn/queued-rb
+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: 
+rubygems_version: 2.0.2
+signing_key: 
+specification_version: 4
+summary: Queued client library
+test_files: []