iron_consumer 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6f9af7eb804da99016154d9169c111b92829de2b
+  data.tar.gz: 1ec09872e86d8df74b1612c5e3cd78f121413def
+SHA512:
+  metadata.gz: c615c8dffad3bd7716152de307d3d61ec3c6b5195e0e0717caa00c2776adadd323643604441c2414210289e4f7efef61cf08d56877bae3b3b97f636df14dba73
+  data.tar.gz: b367f3eeda5a1116de2fe208839bceb3fb18f59ef00018a9ddbf78e3bd94016d7fc97e3e68ba6531f4ec3b13488c86b12878057923a2030a9eb643d963afbf85

data/.gitignore

@@ -0,0 +1,3 @@
+*.iml
+.idea/
+iron.json

data/README.md

@@ -0,0 +1,97 @@
+This is a special way to make a worker that runs for a while and pulls off IronMQ.
+
+Benefits:
+
+- no load times so faster and cheaper
+- can run locally and remote in the same way
+- HUD could have easy editor (usersetup and usercode text boxes)
+
+Can use with scheduler or alerts.
+
+## Usage
+
+First thing is to get things running locally.
+
+To do that, make three files, `iron.json`, `usersetup.rb` and
+`usercode.rb`. OR to make this all faster, go git clone this repository and just modify the files:
+https://github.com/iron-io/iron_consumer_starter
+
+### iron.json
+
+This is a normal Iron.io config file and should contain your project id and token (you can download this from
+HUD if you want).
+
+```json
+{
+    "token": "X",
+    "project_id": "Y"
+}
+```
+
+### usersetup.rb
+
+Put all your stuff in here to setup the worker such as making database connections, api clients, etc. Put them
+into the special hash called `connections` (todo: should that have a more generic name?). For example:
+
+```ruby
+require 'mongo'
+require 'twilio-ruby'
+
+db = Mongo::MongoClient.from_uri("mongodb://username:pass@x.mongolab.com:12345/tester")
+# Put this into the special connections map
+IronConsumer.connections['mymongo'] = db.db()
+```
+
+### usercode.rb
+
+This is where you'll write the code that actually does the work. The message will be available with
+`IronConsumer.message` and this will be a normal IronMQ message from the iron_mq gem.
+
+Typically you'll parse the message body and then do your thing. For example:
+
+```ruby
+puts "Got message"
+puts IronConsumer.message.body
+
+# transform body or generate something or do whatever
+username = "Travis" # Would normally get this from database for user
+body = IronConsumer.message.body.gsub("#NAME#", username)
+
+# Now post this new stuff into the database.
+IronConsumer.connections["mongo1"].collection('msgs').insert({'body' => body})
+
+# And/or send email, post to social media, send notifications to mobile phone, etc.
+```
+
+## Running locally
+
+Just create a simple file called `local.rb` and put this in it:
+
+```ruby
+require 'iron_consumer'
+IronConsumer.run('my_queue')
+```
+
+Once you've got it working, just upload it to IronWorker.
+
+## Upload to IronWorker
+
+Run `iron_worker upload consumer` to get your code onto the IronWorker system.
+
+## Now queue up messages from wherever.
+
+```ruby
+require 'iron_mq'
+
+mq = IronMQ::Client.new()
+# Same queue name you are reading from
+qname = "testq"
+queue = mq.queue(qname)
+msg = {
+    "mystring" => "Hello #NAME#!"
+}
+queue.post(msg.to_json)
+```
+
+
+

data/iron_consumer.gemspec

@@ -0,0 +1,26 @@
+require File.expand_path('../lib/iron_consumer/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Travis Reeder"]
+  gem.email         = ["travis@iron.io"]
+  gem.description   = "Ruby client for IronWorker by www.iron.io"
+  gem.summary       = "Ruby client for IronWorker by www.iron.io"
+  gem.homepage      = "https://github.com/iron-io/iron_consumer"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "iron_consumer"
+  gem.require_paths = ["lib"]
+  gem.version       = IronConsumer::VERSION
+
+  gem.required_rubygems_version = ">= 1.3.6"
+  gem.required_ruby_version = Gem::Requirement.new(">= 1.9")
+  gem.add_runtime_dependency "iron_mq", ">= 4.0.0"
+
+  gem.add_development_dependency "test-unit"
+  gem.add_development_dependency "minitest"
+  gem.add_development_dependency "rake"
+
+end
+

data/lib/helpers.rb

@@ -0,0 +1,17 @@
+# hash for user to stuff things to use later.
+module IronConsumer
+  @@connections = {}
+
+  def self.connections
+    return @@connections
+  end
+
+  def self.set_message(m)
+    @@message = m
+  end
+
+  def self.message
+    @@message
+  end
+
+end

data/lib/iron_consumer.rb

@@ -0,0 +1,57 @@
+# hard coding the stuff here that would normally be generate from initial dependency and connections setup.
+
+require 'iron_mq'
+
+require_relative 'helpers'
+
+module IronConsumer
+
+  def self.run(queue_name)
+    qname = queue_name
+
+    # User can have whatever he wants in the usersetup part.
+    # We can put the helpers stuff in a gem that user can optionally use or something.
+
+    begin
+      load "usersetup.rb"
+    rescue LoadError => ex
+      p ex
+      puts ex.message
+      puts "You need a file called usersetup.rb."
+      exit false
+    end
+
+    # mongo1 name is defined by user
+    # Other connections would be made here
+
+    # Iron stuff is setup too:
+    mq = IronMQ::Client.new()
+
+    # qname defined by user too
+    queue = mq.queue(qname)
+    p mq.project_id
+
+    # This worker kicks off whenever a message gets on a queue (only once, needs alerts)
+    while msg = queue.get
+      IronConsumer.set_message(msg)
+      begin
+
+        # USER CODE STUFFED IN HERE
+        begin
+          load "usercode.rb"
+        rescue LoadError => ex
+          p ex
+          puts "You need a file called usercode.rb."
+          exit false
+        end
+        # USER CODE END
+
+        # If finished ok, delete message
+        msg.delete
+
+      rescue Exception => ex
+        puts "Error in user code #{ex} -- #{ex.message}"
+      end
+    end
+  end
+end

data/lib/iron_consumer/version.rb

@@ -0,0 +1,4 @@
+module IronConsumer
+  VERSION = "0.0.1"
+end
+

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: iron_consumer
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Travis Reeder
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: iron_mq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  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: minitest
+  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: 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'
+description: Ruby client for IronWorker by www.iron.io
+email:
+- travis@iron.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- README.md
+- iron_consumer.gemspec
+- lib/helpers.rb
+- lib/iron_consumer.rb
+- lib/iron_consumer/version.rb
+homepage: https://github.com/iron-io/iron_consumer
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '1.9'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: 1.3.6
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Ruby client for IronWorker by www.iron.io
+test_files: []