stormmq-client 0.0.4

data/bin/stormmq-url-signer

@@ -0,0 +1,111 @@
+#!/usr/bin/env ruby
+# encoding: utf-8
+#--
+# Copyright (c) 2010, Tony Byrne & StormMQ Ltd.
+# All rights reserved.
+#
+# Please refer to the LICENSE file that accompanies this source
+# for terms of use and redistribution.
+#++
+
+$:.unshift File.join(File.expand_path(File.dirname(__FILE__)), "..", "lib")
+
+require 'stormmq/secret_keys'
+require 'stormmq/application'
+
+class StormMQ::Application::URLSigner < StormMQ::Application
+
+  def initialize
+    synopsis  "--help | --user <userName> --method <HttpMethod> --url <URL>"
+    options :help
+
+    option :names           => %w(--user -u),
+           :opt_description => "a valid user name, i.e. the user name that you log into the site with",
+           :arity           => [1,1],
+           :opt_found       => get_args
+
+    option  :names           => %w(--method -m),
+            :opt_description => "the HTTP method to use - defaults to 'GET'",
+            :arity           => [1,1],
+            :opt_found       => get_args,
+            :opt_not_found   => 'GET'
+
+    option  :names           => %w(--url -a),
+            :opt_description => "the URL to be signed",
+            :arity           => [1,1],
+            :opt_found       => get_args,
+            :opt_not_found   => CommandLine::OptionParser::OPT_NOT_FOUND_BUT_REQUIRED
+  end
+
+  def main
+    puts self.url.canonicalise_and_sign(opt.user, self.secret_key(opt.user), opt['--method'])
+  end
+
+  def man
+    <<-EOM
+NAME
+
+  #{File.basename(__FILE__)}
+
+PURPOSE
+
+  Use this to experiment with the how signing URLs works if you need
+  a reference implementation.
+
+USAGE
+
+  #{File.basename(__FILE__)} --help
+  #{File.basename(__FILE__)} --user <userName> --method <HttpMethod> --url <URL>
+
+PARAMETERS
+
+  --user
+
+    The user name you log in to this site with.
+
+  --method
+
+    One of:
+
+    * GET
+    * HEAD
+    * OPTIONS
+    * PUT
+    * DELETE
+
+    POST is not yet supported.
+
+  --url
+
+    The unsigned URL to be signed.
+
+  --help, -h
+
+    Displays this help page then quits.
+
+RESULT
+
+  Outputs a signed URL to STDOUT.
+
+NOTES
+
+  Advanced use only - commandline subject to change.
+
+COPYRIGHT
+
+  Copyright (c) 2010, Tony Byrne & StormMQ Ltd.
+  All rights reserved.
+
+    EOM
+  end
+
+  def url
+    StormMQ::URL.new(opt.url)
+  end
+
+  def secret_key(user) # :nodoc:
+    StormMQ::SecretKeys.key_for(user)
+  end
+end
+
+StormMQ::Application::URLSigner.run

data/lib/stormmq/amqp.rb

@@ -0,0 +1,92 @@
+#--
+# Copyright (c) 2010, Tony Byrne & StormMQ Ltd.
+# All rights reserved.
+#
+# Please refer to the LICENSE file that accompanies this source
+# for terms of use and redistribution.
+#++
+
+require 'mq'
+require 'pp'
+
+module StormMQ
+
+  module AMQPClientImplementation
+
+    VERSION = '0.0.4'
+
+    def process_frame frame
+      if mq = channels[frame.channel]
+        mq.process_frame(frame)
+        return
+      end
+
+      case frame
+      when Frame::Method
+        case method = frame.payload
+        when Protocol::Connection::Start
+          send Protocol::Connection::StartOk.new(
+            {
+              :platform    => 'Ruby/EventMachine',
+              :product     => 'StormMQ AMQP',
+              :information => 'http://github.com/tonybyrne/StormMQ-Ruby-Client/',
+              :version     => VERSION
+            },
+            'AMQPLAIN',
+            {
+              :LOGIN => @settings[:user],
+              :PASSWORD => @settings[:password]
+            },
+            'en_US'
+          )
+
+        when Protocol::Connection::Tune
+          send Protocol::Connection::TuneOk.new(
+            :channel_max => 0,
+            :frame_max   => 131072,
+            :heartbeat   => 0
+          )
+
+          send Protocol::Connection::Open.new(
+            :virtual_host => @settings[:vhost],
+            :capabilities => '',
+            :insist       => @settings[:insist]
+          )
+
+        when Protocol::Connection::OpenOk
+          succeed(self)
+
+        when Protocol::Connection::Close
+          STDERR.puts "#{method.reply_text} in #{Protocol.classes[method.class_id].methods[method.method_id]}"
+
+        when Protocol::Connection::CloseOk
+          @on_disconnect.call if @on_disconnect
+        end
+      end
+    end
+  end
+
+  module AMQPClient
+
+    def self.connect(options={})
+      AMQP.client = AMQPClientImplementation
+      AMQP.connect(
+        {
+          :vhost   => self.vhost_from_options(options),
+          :host    => 'amqp.stormmq.com',
+          :port    => 443,
+          :ssl     => true
+        }.merge(options)
+      )
+    end
+
+    def self.vhost_from_options(options)
+      vhost = "/#{options[:company]}/#{options[:system]}/#{options[:environment]}"
+      [:company, :system, :environment].each {|option| options.delete(option)}
+      vhost
+    end
+
+  end
+
+end
+

data/lib/stormmq/application.rb

@@ -0,0 +1,36 @@
+#--
+# Copyright (c) 2010, Tony Byrne & StormMQ Ltd.
+# All rights reserved.
+#
+# Please refer to the LICENSE file that accompanies this source
+# for terms of use and redistribution.
+#++
+
+require 'stormmq/errors'
+require 'stormmq/rest'
+require 'commandline'
+require 'commandline/optionparser'
+
+module StormMQ
+  class Application < CommandLine::Application_wo_AutoRun
+
+    def initialize(*args)
+      author    "Tony Byrne"
+      copyright "2010, Tony Byrne & StormMQ. All rights reserved."
+      super(*args)
+    end
+
+    def rest_client(user)
+      begin
+        Rest.new(:user => user)
+      rescue Error::SecretKeyNotProvidedError
+        raise "Could not find the secret key for user '#{user}' - please ensure it is present in the secret key file"
+      end
+    end
+
+    def self_test
+      'Self test ouput goes here'
+    end
+
+  end
+end

data/lib/stormmq/base64_extensions.rb

@@ -0,0 +1,19 @@
+#--
+# Copyright (c) 2010, Tony Byrne & StormMQ Ltd.
+# All rights reserved.
+#
+# Please refer to the LICENSE file that accompanies this source
+# for terms of use and redistribution.
+#++
+
+module Base64
+
+  def urlsafe_decode64(str)
+    decode64(str.tr("-_", "+/"))
+  end
+
+  def urlsafe_encode64(bin)
+    encode64(bin).tr("+/", "-_")
+  end
+
+end

data/lib/stormmq/errors.rb

@@ -0,0 +1,33 @@
+#--
+# Copyright (c) 2010, Tony Byrne & StormMQ Ltd.
+# All rights reserved.
+#
+# Please refer to the LICENSE file that accompanies this source
+# for terms of use and redistribution.
+#++
+
+module StormMQ
+
+  module Error
+
+    class Base < StandardError
+    end
+
+    class LoadSecretKeysError < StormMQ::Error::Base
+    end
+
+    class SecretKeyNotFoundError < StormMQ::Error::Base
+    end
+
+    class SecretKeyNotProvidedError < StormMQ::Error::Base
+    end
+
+    class UserNotProvidedError < StormMQ::Error::Base
+    end
+
+    class InvalidURLError < StormMQ::Error::Base
+    end
+
+  end
+
+end

data/lib/stormmq/rest.rb

@@ -0,0 +1,160 @@
+#--
+# Copyright (c) 2010, Tony Byrne & StormMQ Ltd.
+# All rights reserved.
+#
+# Please refer to the LICENSE file that accompanies this source
+# for terms of use and redistribution.
+#++
+
+require 'stormmq/url'
+require 'stormmq/errors'
+require 'stormmq/secret_keys'
+require 'json'
+require 'rest_client'
+
+module StormMQ
+
+  API_HOST       = ENV['STORMMQ_HOST']        || "api.stormmq.com"
+  API            = ENV['STORMMQ_API']         || "api"
+  API_VERSION    = ENV['STORMMQ_API_VERSION'] || "2009-01-01"
+
+  COMPANIES_PATH = '/companies/'
+  CLUSTERS_PATH  = '/clusters'
+  APIS_PATH      = '/'
+
+  # The Rest class implements the client for StormMQ's RESTful API.  The API allows clients to access
+  # company, system and environment information.
+
+  class Rest
+
+    RestClient.proxy = ENV['http_proxy'] unless ENV['http_proxy'].nil?
+
+    def initialize(options={})
+      unless @user = options.delete(:user)
+        raise Error::UserNotProvidedError,
+          "could not determine the user name - either provide it via the :user param",
+            caller
+      end
+
+      unless @secret_key = options.delete(:secret_key) || self.class.secret_key_from_key_store(@user)
+        raise Error::SecretKeyNotProvidedError, "could not determine the secret key for user '#{@user}' - either provide it via the :secret_key param or ensure it is available in the secret key file",
+          caller
+      end
+
+      @host        = options.delete(:host)    || API_HOST
+      @api         = options.delete(:api)     || API
+      @version     = options.delete(:version) || API_VERSION
+
+      @url_options = options
+    end
+
+    # Returns an Array of company indentifiers associated with the user.
+    def companies
+      signed_get(COMPANIES_PATH)
+    end
+
+    # Takes a String containing a valid company identifier and returns a
+    # Hash representation of the detailed information stored on the StormMQ
+    # system about the company.
+    def describe_company(company)
+      signed_get(COMPANIES_PATH, escape(company))
+    end
+
+    def systems(company)
+      signed_get(COMPANIES_PATH, escape(company), '/')
+    end
+
+    def create_system(company, system, json)
+      signed_put(json, COMPANIES_PATH, escape(company), escape(system))
+    end
+
+    def describe_system(company, system)
+      signed_get(COMPANIES_PATH, escape(company), escape(system))
+    end
+
+    def delete_system(company, system)
+      signed_delete(COMPANIES_PATH, escape(company), escape(system))
+    end
+
+    def clusters(company)
+      signed_get(CLUSTERS_PATH, escape(company))
+    end
+
+    def queues(company, system, environment)
+      signed_get(COMPANIES_PATH, escape(company), escape(system), escape(environment), 'queues/')
+    end
+
+    def bindings(company, system, environment)
+      signed_get(COMPANIES_PATH, escape(company), escape(system), escape(environment), 'bindings/')
+    end
+
+    def exchanges(company, system, environment)
+      signed_get(COMPANIES_PATH, escape(company), escape(system), escape(environment), 'exchanges/')
+    end
+
+    def apis
+      signed_get(APIS_PATH)
+    end
+
+    def amqp_password(company, system, environment, amqp_user)
+      signed_get(COMPANIES_PATH, escape(company), escape(system), escape(environment), 'users', escape(amqp_user))
+    end
+
+    def amqp_users(company, system, environment)
+      signed_get(COMPANIES_PATH, escape(company), escape(system), escape(environment), 'users/')
+    end
+
+    private
+
+    def signed_get(*path_args)
+      get(build_signed_resource_url(make_normalised_path(*path_args)))
+    end
+
+    def signed_delete(*path_args)
+      delete(build_signed_resource_url(make_normalised_path(*path_args), 'DELETE'))
+    end
+
+    def signed_put(payload, *path_args)
+      put(build_signed_resource_url(make_normalised_path(*path_args), 'PUT'), payload)
+    end
+
+    def escape(string) # :nodoc:
+      StormMQ::URL.escape(string)
+    end
+
+    def get(signed_url) # :nodoc:
+      JSON.parse(RestClient.get(signed_url.to_s, {:accept => '*/*'}).to_s)
+    end
+
+    def delete(signed_url) # :nodoc:
+      JSON.parse(RestClient.delete(signed_url.to_s).to_s)
+    end
+
+    def put(signed_url, payload) # :nodoc:
+      JSON.parse(RestClient.put(signed_url.to_s, payload, {:accept => '*/*', :content_type => 'application/json'}).to_s)
+    end
+
+    def build_signed_resource_url(resource_path='/', method='GET') # :nodoc:
+      StormMQ::URL.new(
+        {
+          :host   => @host,
+          :scheme => 'https',
+          :path   => make_normalised_path(@api, @version, resource_path)
+        }.merge(@url_options)
+      ).canonicalise_and_sign(@user, @secret_key, method)
+    end
+
+    def make_normalised_path(*args) # :nodoc:
+      ('/' + args.join('/')).gsub(/\/+/,'/')
+    end
+
+    def self.secret_key_from_key_store(user) # :nodoc:
+      begin
+        SecretKeys.key_for(user)
+      rescue
+      end
+    end
+
+  end
+
+end