irfsdash 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 James Harrison
+
+MIT License
+
+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,57 @@
+# IRFSDash
+
+IRFSDash is a handy little Ruby library that lets you, a noble application developer, easily push content to the IRFS office dashboard. It does simple checking to make sure your stuff complies with the API requirements.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'irfsdash'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install irfsdash
+
+## Usage
+
+Add to your gemfile:
+
+    gem 'irfsdash'
+
+In an initializer:
+
+    IRFSDash.setup(source: 'My Application')
+    # you can add color: and icon: to add default colors/icons to your stuff
+
+Publish to the activity feed:
+
+    IRFSDash.activity(content: 'Hello, world!', type: 'string')
+    IRFSDash.activity(content: 4, label: 'clips in the last hour', type: 'number')
+
+Publish a project update:
+
+    IRFSDash.project(project: 'Snippets', happy: false)
+    IRFSDash.project(project: 'Snippets', happy: false, label: 'Build failing')
+
+Publish to the tickers:
+
+    IRFSDash.ticker(content: 'This will scroll across the screen', ticker_type: 'main')
+    IRFSDash.ticker(content: 'This will scroll across the screen below that', ticker_type: 'small')
+
+Publish a widget:
+
+    IRFSDash.widget(content: '<strong>Hello</strong> world')
+    IRFSDash.widget(url: 'http://some-url')
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/irfsdash.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'irfsdash/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "irfsdash"
+  gem.version       = IRFSDash::VERSION
+  gem.authors       = ["James Harrison"]
+  gem.email         = ["james.harrison2@bbc.co.uk"]
+  gem.description   = %q{Interface gem for the BBC Research and Development IRFS Dashboard}
+  gem.summary       = %q{This gem lets you easily push messages to be displayed on the IRFS Dashboard system}
+  gem.homepage      = "http://gitlab.prototype0.net/irfsdash"
+
+  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.require_paths = ["lib"]
+  gem.add_dependency('amqp', '>= 0.9.8')
+  gem.add_dependency('json', '>= 1.7.5')
+end

data/lib/irfsdash/version.rb

@@ -0,0 +1,3 @@
+module IRFSDash
+  VERSION = "0.0.1"
+end

data/lib/irfsdash.rb

@@ -0,0 +1,55 @@
+require "irfsdash/version"
+
+module IRFSDash
+  # Returns an AMQP channel
+  def self.amqp_channel
+    @amqp_connection ||= AMQP.connect(:host => '127.0.0.1')
+    @amqp_channel    ||= AMQP::Channel.new(@amqp_connection)
+    return @amqp_channel
+  end
+  def self.amqp_exchange(name, opts={})
+    @amqp_exchanges ||= {}
+    @amqp_exchanges[name] ||= AMQP::Exchange.new(name, opts)
+    return @amqp_exchanges[name] 
+  end
+  # Setup the library's defaults
+  def self.setup(opts={})
+    @defaults = opts
+  end
+  # Publish to the activity stream
+  # Minimum: :source, :content
+  def self.activity(opts={})
+    msg = opts.merge!(@defaults)
+    raise ArgumentError, "No source specified" unless msg[:source]
+    raise ArgumentError, "No content specified" unless msg[:content]
+    raise ArgumentError, "No type specified" unless msg[:type]
+    self.amqp_channel.fanout("irfs-dashboard.activity").publish(JSON.dump(msg))
+  end
+  # Publish a project update
+  # Minimum: :source, :project, :happy
+  def self.project(opts={})
+    msg = opts.merge!(@defaults)
+    raise ArgumentError, "No source specified" unless msg[:source]
+    raise ArgumentError, "No project specified" unless msg[:project]
+    raise ArgumentError, "No happy specified" unless msg[:happy]
+    self.amqp_channel.fanout("irfs-dashboard.projects").publish(JSON.dump(msg))
+  end
+  # Publish to the ticker
+  # Minimum: :source, :content, :ticker_type
+  def self.ticker(opts={})
+    msg = opts.merge!(@defaults)
+    raise ArgumentError, "No source specified" unless msg[:source]
+    raise ArgumentError, "No content specified" unless msg[:content]
+    raise ArgumentError, "No ticker type specified" unless msg[:ticker_type]
+    self.amqp_channel.fanout("irfs-dashboard.tickers").publish(JSON.dump(msg))
+  end
+  # Publish a widget
+  # Minimum: :source, (:content OR :url)
+  def self.project(opts={})
+    msg = opts.merge!(@defaults)
+    raise ArgumentError, "No source specified" unless msg[:source]
+    raise ArgumentError, "No content or URL specified" unless msg[:url] or msg[:content]
+    self.amqp_channel.fanout("irfs-dashboard.widgets").publish(JSON.dump(msg))
+  end
+
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: irfsdash
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- James Harrison
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: amqp
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.8
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.7.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.7.5
+description: Interface gem for the BBC Research and Development IRFS Dashboard
+email:
+- james.harrison2@bbc.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- irfsdash.gemspec
+- lib/irfsdash.rb
+- lib/irfsdash/version.rb
+homepage: http://gitlab.prototype0.net/irfsdash
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: This gem lets you easily push messages to be displayed on the IRFS Dashboard
+  system
+test_files: []
+has_rdoc: