stormmq-client 0.0.4

data/lib/stormmq/secret_keys.rb

@@ -0,0 +1,70 @@
+#--
+# 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 'singleton'
+require 'json'
+require 'base64'
+require 'stormmq/base64_extensions'
+require 'stormmq/errors'
+
+module StormMQ
+
+  SECRET_KEYS_SEARCH_PATH = ['~/.stormmq','/etc']
+  SECRET_KEYS_FILENAME    = 'secret-keys.json'
+
+  class SecretKeys
+    include Singleton
+    attr_writer :key_cache
+
+    # Returns the base64 encoded secret key for the given user name from the secret keys file.
+    def key_for(user)
+      raise Error::UserNotProvidedError, "user cannot be nil."   if user.nil?
+      raise Error::UserNotProvidedError, "user cannot be empty." if user.empty?
+      keys[user] || (raise Error::SecretKeyNotFoundError, "a secret key for user '#{user}' could not be found in the secret key file.", caller)
+    end
+
+    # Returns an <tt>Array</tt> of user names of users who have keys in the secret keys file.
+    def users
+      keys.keys
+    end
+
+    private
+
+    # Return a hash of keys stored in the secret keys file.
+    def keys
+      @secret_keys_cache ||= load_secret_keys
+    end
+
+    # Load the keys from the secret keys file <tt>keyfile</tt>.  Walks the locations specified in
+    # <tt>search_path</tt> in order of preference.
+    def load_secret_keys(search_path=SECRET_KEYS_SEARCH_PATH, keyfile=SECRET_KEYS_FILENAME)
+      full_paths = search_path.map{|p| File.expand_path("#{p}/#{keyfile}")}
+      full_paths.each do |full_path|
+        begin
+          return SecretKeys.secret_keys_hash_from_json(IO.read(full_path))
+        rescue
+        end
+      end
+      raise Error::LoadSecretKeysError,
+          "Could not read the secret keys file from any of [#{full_paths.join ', '}]. Please ensure that a valid keyfile exists in one of these locations and that it is readable.",
+          caller
+    end
+
+    def self.key_for(*args)
+      self.instance.key_for(*args)
+    end
+
+    # Create a hash of the keys contained in json fragment.
+    def self.secret_keys_hash_from_json(json_string)
+      secret_keys_hash = JSON.parse(json_string)
+      secret_keys_hash.inject({}) { |h,(k,v)| h[k] = Base64.urlsafe_decode64(v); h }
+    end
+
+  end
+
+end

data/lib/stormmq/url.rb

@@ -0,0 +1,125 @@
+#--
+# 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 'uri'
+require 'cgi'
+require 'hmac'
+require 'hmac-sha2'
+require 'base64'
+
+require 'stormmq/errors'
+
+module StormMQ
+
+  SCHEMES_DEFAULT_PORTS = {
+    'http'  => 80,
+    'https' => 443
+  }
+
+  class URL
+
+    def initialize(url)
+      if url.is_a?(Hash)
+        @url = URI::Generic.build(url)
+      else
+        @url = URI.parse(url)
+      end
+      raise Error::InvalidURLError, "'#{@url.to_s}' is not a valid URL." unless self.valid?
+    end
+
+    def valid?
+      begin
+        URI.parse(@url.to_s).class != URI::Generic
+      rescue URI::InvalidURIError
+        false
+      end
+    end
+
+    def to_s
+      @url.to_s
+    end
+
+    def add_query_params(params_hash)
+      components = to_h
+      query_hash = StormMQ::URL.querystring_to_hash(components[:query])
+      components[:query] = StormMQ::URL.hash_to_canonical_querystring(
+        query_hash.merge(params_hash)
+      )
+      self.class.new(components)
+    end
+
+    def add_user_and_version_query_params(user, version=0)
+        add_query_params(:user => [user], :version => [version.to_s])
+    end
+
+    def canonicalise(user, version=0)
+      components         = self.add_user_and_version_query_params(user, version).to_h
+      components[:query] = StormMQ::URL.canonicalise_query_string(components[:query]) unless components[:query].nil?
+      canonical          = { :port => StormMQ::URL.default_port_for_scheme(components[:scheme]) }.merge(components)
+      self.class.new(canonical)
+    end
+
+    def sign(secret_key, method='GET')
+      self.add_query_params('signature' => compute_signature(secret_key, method))
+    end
+
+    def compute_signature(secret_key, method='GET')
+      hmac = HMAC::SHA256.new(secret_key)
+      hmac.update("#{method.upcase}#{self.to_s}")
+      Base64.urlsafe_encode64(hmac.digest).chomp
+    end
+
+    def canonicalise_and_sign(user, secret_key, method='GET', verison=0)
+      self.canonicalise(user,verison).sign(secret_key, method)
+    end
+
+    def to_h
+      components = URI.split(@url.to_s)
+      {
+        :scheme   => components[0],
+        :userinfo => components[1],
+        :host     => components[2],
+        :port     => components[3],
+        :registry => components[4],
+        :path     => components[5],
+        :opaque   => components[6],
+        :query    => components[7],
+        :fragment => components[8]
+      }.reject {|k,v| v.nil?}
+    end
+
+    def self.escape(string)
+      return '' if string.nil?
+      URI.escape(string, Regexp.new("[^#{URI::PATTERN::UNRESERVED}]"))
+    end
+
+    def self.default_port_for_scheme(scheme)
+      SCHEMES_DEFAULT_PORTS[scheme.downcase]
+    end
+
+    def self.querystring_to_hash(querystring)
+      return {} if querystring.nil?
+      CGI.parse(querystring)
+    end
+
+    def self.hash_to_canonical_querystring(options)
+      components = []
+      options.each do |key,values|
+        [values].flatten.each {|v| components << "#{StormMQ::URL.escape(key.to_s)}=#{StormMQ::URL.escape(v.to_s)}" }
+      end
+      components.sort.join('&')
+    end
+
+    def self.canonicalise_query_string(querystring)
+      query_hash = StormMQ::URL.querystring_to_hash(querystring)
+      StormMQ::URL.hash_to_canonical_querystring(query_hash)
+    end
+
+  end
+
+end

data/lib/stormmq/utils.rb

@@ -0,0 +1,27 @@
+#--
+# 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 Utils
+    # def self.stormmq_credentials_string(user, password)
+    #   "\0#{user}\0#{password}"
+    # end
+  end
+end
+
+class String
+  def blank?
+    self.gsub(/\s+/,'') == ""
+  end
+end
+
+class NilClass
+  def blank?
+    true
+  end
+end

data/spec/stormmq/amqp_spec.rb

@@ -0,0 +1,21 @@
+#--
+# 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 File.dirname(__FILE__) + '/../../lib/stormmq/amqp'
+
+describe StormMQ::AMQPClient do
+  it "constructs the virtual host string from the StormMQ specific options in the connect option hash" do
+    options = {
+      :company     => 'a_company',
+      :system      => 'a_system',
+      :environment => 'an_environment'
+    }
+    StormMQ::AMQPClient.vhost_from_options(options).should == '/a_company/a_system/an_environment'
+  end
+end
+

data/spec/stormmq/secret_keys_spec.rb

@@ -0,0 +1,25 @@
+#--
+# 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 'base64'
+require File.dirname(__FILE__) + '/../../lib/stormmq/secret_keys'
+require File.dirname(__FILE__) + '/../../lib/stormmq/base64_extensions'
+
+describe StormMQ::SecretKeys do
+
+  describe "secret_keys_hash_from_json" do
+
+    it "should load the secret key for a user from the json format string" do
+      url_safe_base64_key = "BNuWk1agaAUPTZ15sx44kHvNkTnJXsevqTjIo1M1iwFOeNaUqr3qP-_5Dnk=="
+      json = %Q|{"tonybyrne":"#{url_safe_base64_key}"}|
+      StormMQ::SecretKeys.secret_keys_hash_from_json(json).should == { 'tonybyrne' => Base64.urlsafe_decode64(url_safe_base64_key) }
+    end
+
+  end
+
+end

data/spec/stormmq/url_spec.rb

@@ -0,0 +1,129 @@
+#--
+# 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 File.dirname(__FILE__) + '/../../lib/stormmq/url'
+
+describe StormMQ::URL do
+
+  describe "to_s" do
+
+    it "should return the url as a string" do
+      StormMQ::URL.new('https://api.stormmq.com/').to_s.should == 'https://api.stormmq.com/'
+    end
+
+  end
+
+  describe "canonicalise" do
+
+    it "adds explicit port for HTTP" do
+      StormMQ::URL.new('http://api.stormmq.com/').canonicalise('test').to_s.should == 'http://api.stormmq.com:80/?user=test&version=0'
+    end
+
+    it "adds explicit port for HTTPS" do
+      StormMQ::URL.new('https://api.stormmq.com/').canonicalise('test').to_s.should == 'https://api.stormmq.com:443/?user=test&version=0'
+    end
+
+    it "sorts query string params by param name" do
+      StormMQ::URL.new('https://api.stormmq.com/?z=3&x=1&y=2').canonicalise('test').to_s.should == 'https://api.stormmq.com:443/?user=test&version=0&x=1&y=2&z=3'
+    end
+
+    it "sorts query string params with multiple values by value" do
+      StormMQ::URL.new('https://api.stormmq.com/?z=3&x=1&y=2&z=1').canonicalise('test').to_s.should == 'https://api.stormmq.com:443/?user=test&version=0&x=1&y=2&z=1&z=3'
+    end
+
+    it "should canonicalise complex example from http://stormmq.com/rest-apis/for-security-reasons (without user and version params)" do
+      url = 'https://api.stormmq.com/api/2009-01-01/%3D%25?empty=&%20novalue&foo=%2Fvalue'
+      expected = 'https://api.stormmq.com:443/api/2009-01-01/%3D%25?%20novalue=&empty=&foo=%2Fvalue&user=raph&version=0'
+      StormMQ::URL.new(url).canonicalise('raph').to_s.should == expected
+    end
+
+  end
+
+  describe "add_query_params" do
+
+    before(:each) do
+      @url = StormMQ::URL.new('http://api.stormmq.com/')
+    end
+
+    it "should add params to the querystring and canonicalise the querystring" do
+      @url.add_query_params('z' => 3, 'x' => 1, 'y' => 2).to_s.should == 'http://api.stormmq.com/?x=1&y=2&z=3'
+    end
+
+    it "should add params as symbols to the querystring and canonicalise the querystring" do
+      @url.add_query_params(:z => 3, :x => 1, :y => 2).to_s.should == 'http://api.stormmq.com/?x=1&y=2&z=3'
+    end
+
+    it "should add params with multiple values to the querystring and canonicalise the querystring" do
+      @url.add_query_params(:z => [3,1,2]).to_s.should == 'http://api.stormmq.com/?z=1&z=2&z=3'
+    end
+
+    it "should URI escape params and values added to a URL" do
+      @url.add_query_params(' test ' => 'a+value').to_s.should == 'http://api.stormmq.com/?%20test%20=a%2Bvalue'
+    end
+
+  end
+
+  describe "add_user_and_version_query_params" do
+
+    before(:each) do
+      @url = StormMQ::URL.new('http://api.stormmq.com/')
+    end
+
+    it "should add the user and version querystring params to a URL" do
+      @url.add_user_and_version_query_params('tonybyrne',1).to_s.should == 'http://api.stormmq.com/?user=tonybyrne&version=1'
+    end
+
+    it "version should default to '0'" do
+      @url.add_user_and_version_query_params('tonybyrne').to_s.should == 'http://api.stormmq.com/?user=tonybyrne&version=0'
+    end
+
+  end
+
+  describe "query_string_to_hash" do
+
+    it "should convert a simple query string to a hash representation" do
+      StormMQ::URL.querystring_to_hash("param=value").should == { 'param' => ['value'] }
+    end
+
+    it "should uri decode the query string" do
+      StormMQ::URL.querystring_to_hash("%20param=value%20").should == { ' param' => ['value '] }
+    end
+
+  end
+
+  describe "hash_to_canonical_querystring" do
+
+    it "should convert a hash with a single key value pair to a query string" do
+      StormMQ::URL.hash_to_canonical_querystring({'param' => ['value']}).should == "param=value"
+    end
+
+    it "should uri encode components of query string" do
+      StormMQ::URL.hash_to_canonical_querystring(
+        {
+          'param with spaces' => ['value with spaces']
+        }
+      ).should == "param%20with%20spaces=value%20with%20spaces"
+    end
+
+    it "should convert a hash with a single key, but multiple values to a query string, and sort the components" do
+      StormMQ::URL.hash_to_canonical_querystring({'param' => ['Z','X','Y']}).should == "param=X&param=Y&param=Z"
+    end
+
+    it "should convert a hash with a multiple keys, and multiple values to a query string, and sort the components" do
+      StormMQ::URL.hash_to_canonical_querystring(
+        {
+          'paramZ' => ['Z','X','Y'],
+          'paramX' => ['1','3','2'],
+          'paramY' => ['c','a','b']
+        }
+      ).should == "paramX=1&paramX=2&paramX=3&paramY=a&paramY=b&paramY=c&paramZ=X&paramZ=Y&paramZ=Z"
+    end
+
+  end
+
+end

data/spec/stormmq/utils_spec.rb

@@ -0,0 +1,13 @@
+#--
+# 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 File.dirname(__FILE__) + '/../../lib/stormmq/utils'
+
+describe StormMQ::Utils do
+
+end

metadata

@@ -0,0 +1,254 @@
+--- !ruby/object:Gem::Specification 
+name: stormmq-client
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 4
+  version: 0.0.4
+platform: ruby
+authors: 
+- Tony Byrne
+autorequire: 
+bindir: bin
+cert_chain: 
+date: 2010-06-07 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: amqp
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 9
+        segments: 
+        - 0
+        - 6
+        - 7
+        version: 0.6.7
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rest-client
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 1
+        - 4
+        - 2
+        version: 1.4.2
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: ruby-hmac
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 0
+        - 4
+        - 0
+        version: 0.4.0
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: json
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 1
+        - 4
+        - 2
+        version: 1.4.2
+  type: :runtime
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: commandline
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 0
+        - 7
+        - 10
+        version: 0.7.10
+  type: :runtime
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 27
+        segments: 
+        - 1
+        - 3
+        - 0
+        version: 1.3.0
+  type: :development
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 49
+        segments: 
+        - 0
+        - 8
+        - 7
+        version: 0.8.7
+  type: :development
+  version_requirements: *id007
+- !ruby/object:Gem::Dependency 
+  name: rcov
+  prerelease: false
+  requirement: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 25
+        segments: 
+        - 0
+        - 9
+        - 7
+        - 1
+        version: 0.9.7.1
+  type: :development
+  version_requirements: *id008
+- !ruby/object:Gem::Dependency 
+  name: rdoc
+  prerelease: false
+  requirement: &id009 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 11
+        segments: 
+        - 2
+        - 5
+        - 8
+        version: 2.5.8
+  type: :development
+  version_requirements: *id009
+description: A client library for StormMQ's Cloud Messaging service. See http://www.stormmq.com/ for details of the service.
+email: stormmq@byrnehq.com
+executables: 
+- stormmq-amqp-echo-test
+- stormmq-create-system
+- stormmq-delete-system
+- stormmq-describe-company
+- stormmq-describe-system
+- stormmq-get-amqpuser-password
+- stormmq-list-amqpusers
+- stormmq-list-apis
+- stormmq-list-bindings
+- stormmq-list-clusters
+- stormmq-list-companies
+- stormmq-list-exchanges
+- stormmq-list-queues
+- stormmq-list-systems
+- stormmq-url-signer
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/stormmq/amqp.rb
+- lib/stormmq/application.rb
+- lib/stormmq/base64_extensions.rb
+- lib/stormmq/errors.rb
+- lib/stormmq/rest.rb
+- lib/stormmq/secret_keys.rb
+- lib/stormmq/url.rb
+- lib/stormmq/utils.rb
+- bin/stormmq-amqp-echo-test
+- bin/stormmq-create-system
+- bin/stormmq-delete-system
+- bin/stormmq-describe-company
+- bin/stormmq-describe-system
+- bin/stormmq-get-amqpuser-password
+- bin/stormmq-list-amqpusers
+- bin/stormmq-list-apis
+- bin/stormmq-list-bindings
+- bin/stormmq-list-clusters
+- bin/stormmq-list-companies
+- bin/stormmq-list-exchanges
+- bin/stormmq-list-queues
+- bin/stormmq-list-systems
+- bin/stormmq-url-signer
+- spec/stormmq/amqp_spec.rb
+- spec/stormmq/secret_keys_spec.rb
+- spec/stormmq/url_spec.rb
+- spec/stormmq/utils_spec.rb
+- LICENSE
+- Rakefile
+- README
+- TODO
+has_rdoc: true
+homepage: http://github.com/tonybyrne/StormMQ-Ruby-Client
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: A client library for StormMQ's Cloud Messaging service
+test_files: []
+