stormmq-client 0.0.4

data/bin/stormmq-delete-system

@@ -0,0 +1,117 @@
+#!/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/application'
+
+class StormMQ::Application::DeleteSystem < StormMQ::Application
+
+  def initialize
+    synopsis  "--help | <userName> | <userName> <systemName> | <userName> <systemName> <companyName>"
+    options :help
+    expected_args [1,3]
+  end
+
+  def main
+    user    = argv[0]
+    system  = argv[1] || user
+    company = argv[2] || user
+    self.rest_client(user).delete_system(company, system)
+  end
+
+  def man
+    <<-EOM
+NAME
+
+  #{File.basename(__FILE__)}
+
+PURPOSE
+
+ Deletes systems PERMANENTLY, with no chance of recovery. You can
+ recreate the system, of course, if you kept your settings.
+ You will just lose any messages in the meantime.
+
+USAGE
+
+  #{File.basename(__FILE__)} --help
+  #{File.basename(__FILE__)} <userName>
+  #{File.basename(__FILE__)} <userName> <systemName>
+  #{File.basename(__FILE__)} <userName> <systemName> <companyName>
+
+  The second form assumes your companyName and systemName is the same
+  as your userName. This is true for ordinary users who've just
+  signed up.
+
+  The third form assumes your companyName is the same as your
+  userName. This is true for ordinary users.
+
+PARAMETERS
+
+  <userName>
+
+    The user name you log into the site with.
+
+  <systemName>
+
+    If you're not sure if you've already created a system, use:
+
+    stormmq-list-systems <userName>
+
+    A systemName can not contain a '/' or ':'
+
+  <companyName>
+
+    For ordinary users, this is the same as your userName. If you're
+    not sure of your companyName, you can retrieve it with:
+
+    stormmq-list-companies <userName>
+
+  --help, -h
+
+    Displays this help page then quits.
+
+RESULT
+
+  Outputs nothing.
+
+REST API
+
+  Equivalent is DELETE /companies/<companyName>/<systemName>.
+
+NOTES
+
+  To find you companyName, use:
+
+    stormmq-list-companies
+
+  To delete your default system, use:
+
+    stormmq-delete-system <userName>
+
+  To create a new system, use:
+
+    stormmq-create-system <userName> <systemName>
+
+COPYRIGHT
+
+  Copyright (c) 2010, Tony Byrne & StormMQ Ltd.
+  All rights reserved.
+
+SELF TEST
+
+  #{self_test}
+
+    EOM
+  end
+
+end
+
+StormMQ::Application::DeleteSystem.run

data/bin/stormmq-describe-company

@@ -0,0 +1,106 @@
+#!/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/application'
+require 'json'
+
+class StormMQ::Application::DescribeCompany < StormMQ::Application
+
+  def initialize
+    synopsis  "--help | <userName>"
+    options :help
+    expected_args [1,2]
+  end
+
+  def main
+    user    = argv[0]
+    company = argv[1] || user
+    puts JSON.pretty_generate(self.rest_client(user).describe_company(company))
+  end
+
+  def man
+    <<-EOM
+NAME
+
+  #{File.basename(__FILE__)}
+
+PURPOSE
+
+  Describes all the details we have for your company, including every
+  single connection you've made to our Messaging Cloud, how much
+  bandwidth you've used, your current account credits and debits and
+  invoice contact details. Some of the details of this API are in
+  flux. We'd like your feedback in the forums on how to improve it!
+
+USAGE
+
+  #{File.basename(__FILE__)} --help
+  #{File.basename(__FILE__)} <userName>
+  #{File.basename(__FILE__)} <userName> <companyName>
+
+  The second form assumes your companyName is the same as your
+  userName. This is true for ordinary users.
+
+PARAMETERS
+
+  <userName>
+
+    The user name you log into the site with.
+
+  <companyName>
+
+    For ordinary users, this is the same as your userName. If you're
+    not sure of your companyName, you can retrieve it with:
+
+    stormmq-list-companies <userName>
+
+  --help, -h
+
+    Displays this help page then quits.
+
+RESULT
+
+  Outputs a simple JSON list of strings to STDOUT.
+
+REST API
+
+  Equivalent is GET /companies/<companyName>/.
+
+NOTES
+
+  To find you companyName, use:
+
+    stormmq-list-companies
+
+  To delete your default system, use:
+
+    stormmq-delete-system <userName>
+
+  To create a new system, use:
+
+    stormmq-create-system <userName> <systemName>
+
+COPYRIGHT
+
+  Copyright (c) 2010, Tony Byrne & StormMQ Ltd.
+  All rights reserved.
+
+SELF TEST
+
+  #{self_test}
+
+    EOM
+  end
+
+end
+
+StormMQ::Application::DescribeCompany.run

data/bin/stormmq-describe-system

@@ -0,0 +1,135 @@
+#!/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/application'
+require 'json'
+
+class StormMQ::Application::DescribeSystem < StormMQ::Application
+
+  def initialize
+    synopsis  "--help | <userName> | <userName> <systemName> | <userName> <systemName> <companyName>"
+    options :help
+    expected_args [1,3]
+  end
+
+  def main
+    user    = argv[0]
+    system  = argv[1] || user
+    company = argv[2] || user
+    puts JSON.pretty_generate(self.rest_client(user).describe_system(company, system))
+  end
+
+  def man
+    <<-EOM
+NAME
+
+  #{File.basename(__FILE__)}
+
+PURPOSE
+
+ A system is a logical view of resources in our Messaging Cloud.
+ Typically you'd only need one system, eg 'AccountRocks',
+ 'InflationSwapCalculator', 'Jibbit-X', etc. A system has
+ environments.
+
+ A company-system-environment triplet matches an AMQP Virtual Host.
+ E.g., if your company is widgetcorp, your system is accountrock and
+ you want to use an environment of development, your AMQP virtual
+ host name is widgetcorp/accountrock/development.
+
+ If you've just signed up as an ordinary user, then we've already
+ created a system called <userName>for you (see stormmq-list-systems),
+ with an AMQP virtual host called /<userName>/<userName>/development,
+ accessible at amqp.stormmq.com.
+
+ All AMQP virtual hosts are virtually hosted on amqp.stormmq.com.
+
+ To find the passwords to log onto them with AMQP, use:
+
+ stormmq-get-amqpuser-password
+
+USAGE
+
+  #{File.basename(__FILE__)} --help
+  #{File.basename(__FILE__)} <userName>
+  #{File.basename(__FILE__)} <userName> <systemName>
+  #{File.basename(__FILE__)} <userName> <systemName> <companyName>
+
+  The second form assumes your companyName and systemName is the same
+  as your userName. This is true for ordinary users who've just
+  signed up.
+
+  The third form assumes your companyName is the same as your
+  userName. This is true for ordinary users.
+
+PARAMETERS
+
+  <userName>
+
+    The user name you log into the site with.
+
+  <systemName>
+
+    If you're not sure if you've already created a system, use:
+
+    stormmq-list-systems <userName>
+
+    A systemName can not contain a '/' or ':'
+
+  <companyName>
+
+    For ordinary users, this is the same as your userName. If you're
+    not sure of your companyName, you can retrieve it with:
+
+    stormmq-list-companies <userName>
+
+  --help, -h
+
+    Displays this help page then quits.
+
+RESULT
+
+  Outputs a pretty-printed complex JSON list to standard out.
+
+REST API
+
+  Equivalent is GET /companies/<companyName>/<systemName>.
+
+NOTES
+
+  To find you companyName, use:
+
+    stormmq-list-companies
+
+  To delete your default system, use:
+
+    stormmq-delete-system <userName>
+
+  To create a new system, use:
+
+    stormmq-create-system <userName> <systemName>
+
+COPYRIGHT
+
+  Copyright (c) 2010, Tony Byrne & StormMQ Ltd.
+  All rights reserved.
+
+SELF TEST
+
+  #{self_test}
+
+    EOM
+  end
+
+end
+
+StormMQ::Application::DescribeSystem.run

data/bin/stormmq-get-amqpuser-password

@@ -0,0 +1,148 @@
+#!/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/application'
+
+class StormMQ::Application::GetAMQPUserPassword < StormMQ::Application
+
+  def initialize
+    synopsis "--help | <userName> <systemName> <companyName> <environmentName> <amqpUserName>"
+    options :help
+    expected_args :user, :system, :company, :environment, :amqp_user
+  end
+
+  def main
+    puts self.rest_client(@user).amqp_password(@company, @system, @environment, @amqp_user)
+  end
+
+  def man
+    <<-EOM
+NAME
+
+  #{File.basename(__FILE__)}
+
+PURPOSE
+
+  Gets the password for a given AMQP user name. For a recently signed
+  up user, we've created you a default system with a default AMQP
+  user name (amqpUserName) the same as your userName. This is the
+  only tool you'll need initially.
+
+USAGE
+
+  #{File.basename(__FILE__)} --help
+  #{File.basename(__FILE__)} <userName> <systemName> <companyName> <environmentName> <amqpUserName>
+
+  For ordinary users, your companyName is the same as your userName.
+
+  For recently signed up users, the systemName is the same as your
+  userName.
+
+  For recently signed up users, the environmentName is one of:
+
+  * development
+  * testing
+  * production
+
+  For recently signed up users, the amqpUserName is the same as your
+  userName.
+
+PARAMETERS
+
+  <userName>
+
+    The user name you log into the site with.
+
+  <systemName>
+
+    If you're not sure if you've already created a system, use:
+
+    stormmq-list-systems <userName>
+
+    A systemName can not contain a '/' or ':'
+
+  <companyName>
+
+    For ordinary users, this is the same as your userName.
+    If you're not sure of your companyName, you can retrieve it with:
+
+    stormmq-list-companies <userName>
+
+  <environmentName>
+
+    One of:
+
+    * development
+    * testing
+    * production
+
+    For the default system created when you signed up, or for any
+    system created by stormmq-create-system <userName>
+    (except advanced use).
+
+  <amqpUserName>
+
+    This is your userName for the default system we created when you
+    signed up, or for any system created by
+    stormmq-create-system <userName> (except advanced use).
+
+  --help, -h
+
+    Displays this help page then quits.
+
+RESULT
+
+  Outputs a simple JSON object of string keys (user names to use with
+  AMQP) to string values (AMQP passwords, to be used as is without
+  decoding but excluding the quotes).
+
+  If using the default system created when you signed up, then the user
+  name to log on to AMQP ('amqpUserName') will be the same as your
+  userName.
+
+REST API
+
+  Equivalent is GET /companies/<companyName>/<systemName>/<environmentName>/users/.
+
+NOTES
+
+  Pretty prints JSON, so not suitable for use with XHTML, etc, response
+  documents.
+
+  To find you companyName, use:
+
+    stormmq-list-companies
+
+  To delete your default system, use:
+
+    stormmq-delete-system <userName>
+
+  To create a new system, use:
+
+    stormmq-create-system <userName> <systemName>
+
+COPYRIGHT
+
+  Copyright (c) 2010, Tony Byrne & StormMQ Ltd.
+  All rights reserved.
+
+SELF TEST
+
+  #{self_test}
+
+    EOM
+  end
+
+
+end
+
+StormMQ::Application::GetAMQPUserPassword.run