iron_mq 1.2.7

data/README.markdown

@@ -0,0 +1,56 @@
+IronMQ Ruby Client
+-------------
+
+Getting Started
+==============
+
+Install the gem:
+
+    gem install ironmq
+
+Create an IronMQ client object:
+
+    @ironmq = IronMQ::Client.new('token'=>'MYTOKEN', 'project_id'=>'MYPROJECTID')
+
+You can get your `token` and `project_id` at http://www.iron.io .
+
+
+The Basics
+=========
+
+**Push** a message on the queue:
+
+    msg = @ironmq.messages.post("hello world!")
+    p msg
+
+**Pop** a message off the queue:
+
+    msg = @ironmq.messages.get()
+    p msg
+
+When you pop/get a message from the queue, it will NOT be deleted. It will eventually go back onto the queue after
+a timeout if you don't delete it (default timeout is 10 minutes).
+
+**Delete** a message from the queue:
+
+    res = msg.delete # or @ironmq.messages.delete(msg["id"])
+    p res
+
+Delete a message from the queue when you're done with it.
+
+Queue Selection
+===============
+
+One of the following:
+
+1. Pass `:queue_name=>'my_queue'` into IronMQ::Client.new
+1. `@client.queue_name = 'my_queue'`
+1. Pass `:queue_name=>'my_queue'` into any post(), get(), or delete()
+
+Queue Information
+=================
+
+    queue = @client.queues.get(:name=>@client.queue_name)
+    puts "size: #{queue.size}"
+
+ 

data/Rakefile

@@ -0,0 +1,38 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler2'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "iron_mq"
+    gem.summary = "Ruby client for IronMQ"
+    gem.description = "Ruby client for IronMQ"
+    gem.email = "travis@iron.io"
+    gem.homepage = "http://www.iron.io"
+    gem.authors = ["Travis Reeder"]
+    gem.add_dependency 'typhoeus'
+    gem.required_ruby_version = '>= 1.9'
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler2"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :test
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'doc'
+  rdoc.title = "iron_mq #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION.yml

@@ -0,0 +1,5 @@
+---
+:major: 1
+:minor: 2
+:patch: 7
+:build: 

data/ironmq.gemspec

@@ -0,0 +1,53 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "ironmq"
+  s.version = "1.2.7"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Travis Reeder"]
+  s.date = "2011-12-08"
+  s.description = "Ruby client for IronMQ"
+  s.email = "travis@iron.io"
+  s.extra_rdoc_files = [
+    "README.markdown"
+  ]
+  s.files = [
+    "README.markdown",
+    "Rakefile",
+    "VERSION.yml",
+    "ironmq.gemspec",
+    "lib/ironmq.rb",
+    "lib/ironmq/client.rb",
+    "lib/ironmq/messages.rb",
+    "lib/ironmq/queues.rb",
+    "test/long_run.rb",
+    "test/quick_run.rb",
+    "test/test_base.rb",
+    "test/test_ironmq.rb"
+  ]
+  s.homepage = "http://www.iron.io"
+  s.require_paths = ["lib"]
+  s.required_ruby_version = Gem::Requirement.new(">= 1.9")
+  s.rubygems_version = "1.8.11"
+  s.summary = "Ruby client for IronMQ"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<typhoeus>, [">= 0"])
+      s.add_runtime_dependency(%q<typhoeus>, [">= 0"])
+    else
+      s.add_dependency(%q<typhoeus>, [">= 0"])
+      s.add_dependency(%q<typhoeus>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<typhoeus>, [">= 0"])
+    s.add_dependency(%q<typhoeus>, [">= 0"])
+  end
+end
+

data/lib/ironmq/client.rb

@@ -0,0 +1,126 @@
+require 'json'
+require 'typhoeus'
+require 'logger'
+
+module IronMQ
+
+  class Client
+
+    attr_accessor :token, :project_id, :queue_name, :logger
+
+    def initialize(options={})
+      @logger = Logger.new(STDOUT)
+      @logger.level=Logger::INFO
+
+      @token = options[:token] || options['token']
+      @project_id = options[:project_id] || options['project_id']
+      @queue_name = options[:queue_name] || options['queue_name'] || "default"
+      @scheme = options[:scheme] || options['scheme'] || "https"
+      @host = options[:host] || options['host'] || "mq-aws-us-east-1.iron.io"
+      @port = options[:port] || options['port'] || 443
+
+      @base_url = "#{@scheme}://#{@host}:#{@port}/1"
+
+    end
+
+    def messages
+      return Messages.new(self)
+    end
+
+    def queues
+      return Queues.new(self)
+    end
+
+    def base_url
+      #"#{scheme}://#{host}:#{port}/1"
+      @base_url
+    end
+
+    def full_url(path)
+      url = "#{base_url}#{path}"
+      url
+    end
+
+    def common_req_hash
+      {
+          :headers=>{"Content-Type" => 'application/json',
+                     "Authorization"=>"OAuth #{@token}",
+                     "User-Agent"=>"IronMQ Ruby Client"}
+      }
+    end
+
+    def post(path, params={})
+      url = full_url(path)
+      @logger.debug 'url=' + url
+      #response = @http_sess.post(path + "?oauth=#{@token}", {'oauth' => @token}.merge(params).to_json, {"Content-Type" => 'application/json'})
+      req_hash = common_req_hash
+      req_hash[:body] = params.to_json
+      response = Typhoeus::Request.post(url, req_hash)
+      @logger.debug 'typhoeus response=' + response.inspect
+      res = check_response(response)
+      #@logger.debug 'response: ' + res.inspect
+      #body = response.body
+      #res = JSON.parse(body)
+      return res, response.code
+    end
+
+    def get(path, params={})
+      url = full_url(path)
+      @logger.debug 'url=' + url
+      req_hash = common_req_hash
+      req_hash[:params] = params
+      @logger.debug 'req_hash=' + req_hash.inspect
+      response = Typhoeus::Request.get(url, req_hash)
+      res = check_response(response)
+      return res, response.code
+    end
+
+    def delete(path, params={})
+      url = "#{base_url}#{path}"
+      @logger.debug 'url=' + url
+      req_hash = common_req_hash
+      req_hash[:params] = params
+      response = Typhoeus::Request.delete(url, req_hash)
+      res = check_response(response)
+      #body = response.body
+      #res = JSON.parse(body)
+      #@logger.debug 'response: ' + res.inspect
+      return res, response.code
+    end
+
+    def check_response(response)
+      # response.code    # http status code
+      #response.time    # time in seconds the request took
+      #response.headers # the http headers
+      #response.headers_hash # http headers put into a hash
+      #response.body    # the response body
+      status = response.code
+      body = response.body
+      # todo: check content-type == application/json before parsing
+      @logger.debug "response code=" + status.to_s
+      @logger.debug "response body=" + body.inspect
+      res = JSON.parse(body)
+      if status < 400
+
+      else
+        raise IronMQ::Error.new(res["msg"], :status=>status)
+      end
+      res
+    end
+
+  end
+
+  class Error < StandardError
+    def initialize(msg, options={})
+      super(msg)
+      @options = options
+    end
+
+    def status
+      @options[:status]
+    end
+  end
+
+
+end
+

data/lib/ironmq/messages.rb

@@ -0,0 +1,78 @@
+module IronMQ
+  class Messages
+
+    attr_accessor :client
+
+    def initialize(client)
+      @client = client
+    end
+
+    def path(options={})
+      path = "/projects/#{@client.project_id}/queues/#{options[:queue_name] || @client.queue_name}/messages"
+    end
+
+    # options:
+    #  :queue_name => can specify an alternative queue name
+    #  :timeout => amount of time before message goes back on the queue
+    def get(options={})
+      begin
+        params = nil
+        if options[:timeout]
+          params = {:timeout => options[:timeout]}
+        end
+        res, status = @client.get(path(options), params)
+        return Message.new(self, res)
+      rescue IronMQ::Error => ex
+        if ex.status == 404
+          return nil
+        end
+        raise ex
+      end
+
+
+    end
+
+    # options:
+    #  :queue_name => can specify an alternative queue name
+    def post(payload, options={})
+      res, status = @client.post(path(options), :body=>payload)
+      return Message.new(self, res)
+    end
+
+    def delete(message_id, options={})
+      path2 = "#{self.path(options)}/#{message_id}"
+      res, status = @client.delete(path2)
+      res
+    end
+
+  end
+
+  class Message
+
+    def initialize(messages, res)
+      @messages = messages
+      @data = res
+    end
+
+    def raw
+      @data
+    end
+
+    def [](key)
+      raw[key]
+    end
+
+    def id
+      raw["id"]
+    end
+
+    def body
+      raw["body"]
+    end
+
+    def delete
+      @messages.delete(self.id)
+    end
+  end
+
+end

data/lib/ironmq/queues.rb

@@ -0,0 +1,72 @@
+module IronMQ
+  class Queues
+
+    attr_accessor :client
+
+    def initialize(client)
+      @client = client
+    end
+
+    def path(options={})
+      path = "/projects/#{@client.project_id}/queues"
+    end
+
+    def list(options={})
+      ret = []
+      res, status = @client.get("#{path(options)}", options)
+      res.each do |q|
+        #p q
+        q = Queue.new(self, q)
+        ret << q
+      end
+      ret
+    end
+
+    # options:
+    #  :name => can specify an alternative queue name
+    def get(options={})
+      res, status = @client.get("#{path(options)}/#{options[:name]}")
+      return Queue.new(self, res)
+    end
+
+
+  end
+
+  class Queue
+
+    def initialize(queues, res)
+      @queues = queues
+      @data = res
+    end
+
+    def raw
+      @data
+    end
+
+    def [](key)
+      raw[key]
+    end
+
+    def id
+      raw["id"]
+    end
+
+    def name
+      raw["name"]
+    end
+
+    def size
+      return raw["size"] if raw["size"]
+      return @size if @size
+      q = @queues.get(:name=>name)
+      @size = q.size
+      return @size
+    end
+
+    # def delete
+    # @messages.delete(self.id)
+    # end
+  end
+
+end
+

data/lib/ironmq.rb

@@ -0,0 +1,3 @@
+require_relative 'ironmq/queues'
+require_relative 'ironmq/messages'
+require_relative 'ironmq/client'

data/test/long_run.rb

@@ -0,0 +1,57 @@
+require 'yaml'
+require 'concur'
+begin
+  require File.join(File.dirname(__FILE__), '..', 'lib', 'ironmq')
+rescue Exception => ex
+  puts "Could NOT load current ironmq: " + ex.message
+  raise ex
+end
+
+@config = YAML::load_file(File.expand_path(File.join("~", "Dropbox", "configs", "ironmq_ruby", "test", "config.yml")))
+@client = IronMQ::Client.new(@config['ironmq'])
+@client.queue_name = 'ironmq-gem-long'
+@num_to_add = @config['count']
+
+start = Time.now
+puts "Queuing #{@num_to_add} items at #{start}..."
+executor = Concur::Executor.new_thread_pool_executor(50)
+@num_to_add.times do |i|
+  task = executor.execute do
+    begin
+      puts "POST #{i}..."
+      res = @client.messages.post("hello world! #{i}")
+    rescue => ex
+      puts "ERROR! #{ex.class.name}: #{ex.message} -- #{ex.backtrace.inspect}"
+      raise ex
+    end
+  end
+end
+
+i = 0
+while executor.queue_size > 0 do
+  i += 1
+  puts "waiting #{i}, queue size=#{executor.queue_size}"
+  sleep 0.5
+end
+
+
+put_time = (Time.now.to_f - start.to_f)
+puts "Finished pushing in #{put_time} seconds"
+
+exit if true
+
+start = Time.now
+puts "Getting and deleting #{@num_to_add} items at #{start}..."
+@num_to_add.times do |i|
+  puts "GET #{i}..."
+  res = @client.messages.get()
+  p res
+  puts "DELETE #{i}..."
+  res = @client.messages.delete(res["id"])
+  p res
+end
+
+puts "Finished pushing #{@num_to_add} items in #{put_time} seconds."
+puts "Finished getting and deleting #{@num_to_add} items in #{(Time.now.to_f - start.to_f)} seconds."
+
+executor.shutdown

data/test/quick_run.rb

@@ -0,0 +1,28 @@
+# Put config.yml file in ~/Dropbox/configs/ironmq_gem/test/config.yml
+require_relative 'test_base'
+
+class QuickRun < TestBase
+ 
+ def setup
+  super
+   @client.queue_name = 'ironmq-gem-quick'
+end
+
+  def test_basics
+    res = @client.messages.post("hello world!")
+    p res
+
+    res = @client.messages.get()
+    p res
+
+    res = @client.messages.delete(res["id"])
+    p res
+
+    res = @client.messages.get()
+    p res
+   
+  end
+
+ 
+end
+

data/test/test_base.rb

@@ -0,0 +1,21 @@
+gem 'test-unit'
+require 'test/unit'
+require 'yaml'
+begin
+  require File.join(File.dirname(__FILE__), '../lib/ironmq')
+rescue Exception => ex
+  puts "Could NOT load current ironmq: " + ex.message
+  raise ex
+end
+
+
+class TestBase < Test::Unit::TestCase
+ def setup
+    puts 'setup'
+    @config = YAML::load_file(File.expand_path(File.join("~", "Dropbox", "configs", "ironmq_ruby", "test", "config.yml")))
+    @client = IronMQ::Client.new(@config['ironmq'])
+    @client.logger.level = Logger::DEBUG
+    @client.queue_name = 'ironmq-ruby-tests'
+
+  end
+end

data/test/test_ironmq.rb

@@ -0,0 +1,111 @@
+# Put config.yml file in ~/Dropbox/configs/ironmq_gem/test/config.yml
+
+gem 'test-unit'
+require 'test/unit'
+require 'yaml'
+require_relative 'test_base'
+
+class IronMQTests < TestBase
+  def setup
+    super
+
+    puts 'clearing queue'
+    while res = @client.messages.get()
+      p res
+      puts res.body.to_s
+      res.delete
+    end
+    puts 'cleared.'
+
+  end
+
+  def test_basics
+
+    res = @client.messages.post("hello world!")
+    p res
+    queue = @client.queues.get(:name=>@client.queue_name)
+    assert queue.size == 1
+
+    res = @client.messages.get()
+    p res
+
+    res = @client.messages.delete(res["id"])
+    p res
+    puts "shouldn't be any more"
+    res = @client.messages.get()
+    p res
+    assert res.nil?
+
+    queue = @client.queues.get(:name=>@client.queue_name)
+    assert queue.size == 0
+
+    res = @client.messages.post("hello world 2!")
+    p res
+
+    msg = @client.messages.get()
+    p msg
+
+    res = msg.delete
+    p res
+
+    puts "shouldn't be any more"
+    res = @client.messages.get()
+    p res
+    assert res.nil?
+  end
+
+  # TODO: pass :timeout in post/get messages and test those
+  def test_timeout
+    res = @client.messages.post("hello world timeout!")
+    p res
+
+    msg = @client.messages.get()
+    p msg
+
+    msg4 = @client.messages.get()
+    p msg4
+    assert msg4.nil?
+
+    puts 'sleeping 45 seconds...'
+    sleep 45
+
+    msg3 = @client.messages.get()
+    p msg3
+    assert msg3.nil?
+
+    puts 'sleeping another 45 seconds...'
+    sleep 45
+
+    msg2 = @client.messages.get()
+    assert msg.id == msg2.id
+
+    msg2.delete
+
+  end
+
+  def test_queues
+    res = @client.queues.list()
+    puts "res.size=" + res.size.to_s
+    res.each do |q|
+      puts "queue_name: " + q.name
+      puts "queue size: " + q.size.to_s
+      assert q.size >= 0
+    end
+    assert res.size > 0
+
+    res = @client.queues.list(:page=>2)
+    puts "res.size=" + res.size.to_s
+    res.each do |q|
+      p q.name
+    end
+    assert res.size == 0
+
+
+  end
+
+  def test_delay
+    # TODO
+  end
+
+end
+

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification
+name: iron_mq
+version: !ruby/object:Gem::Version
+  version: 1.2.7
+  prerelease: 
+platform: ruby
+authors:
+- Travis Reeder
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-12-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  requirement: &12788940 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *12788940
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  requirement: &12788040 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *12788040
+description: Ruby client for IronMQ
+email: travis@iron.io
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.markdown
+files:
+- README.markdown
+- Rakefile
+- VERSION.yml
+- ironmq.gemspec
+- lib/ironmq.rb
+- lib/ironmq/client.rb
+- lib/ironmq/messages.rb
+- lib/ironmq/queues.rb
+- test/long_run.rb
+- test/quick_run.rb
+- test/test_base.rb
+- test/test_ironmq.rb
+homepage: http://www.iron.io
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '1.9'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: Ruby client for IronMQ
+test_files: []