stormmq-client 0.0.6 → 0.0.7

data/CHANGELOG

@@ -1,3 +1,11 @@
+0.0.7
+
+  * Added additional Rspecs to bring test coverage of the API code
+    up to 100%.
+
+  * It's now possible to load the secret keys from a custom location
+    via the API
+
 0.0.6
 
   * Update the gemspec to add dependency for Bunny.

data/bin/stormmq-amqp-echo-test

@@ -93,7 +93,7 @@ class StormMQ::Application::AMQPEchoTest < StormMQ::Application
       msg = queue.pop[:payload]
 
       if msg == test_message
-        puts "\nSUCESS: received test message '#{msg}'"
+        puts "\nSUCCESS: received test message '#{msg}'"
         retval = 0
       else
         puts "\nFAILURE: expected test message, but got '#{msg}' instead"
@@ -190,10 +190,7 @@ NOTES
 
   For a default system, you'll just need your userName.
 
-COPYRIGHT
-
-  Copyright (c) 2010, Tony Byrne & StormMQ Ltd.
-  All rights reserved.
+#{_man_copyright}
 
     EOM
   end

data/bin/stormmq-create-system

@@ -194,10 +194,7 @@ NOTES
 
     stormmq-delete-system <userName>
 
-COPYRIGHT
-
-  Copyright (c) 2010, Tony Byrne & StormMQ Ltd.
-  All rights reserved.
+#{_man_copyright}
 
 SELF TEST
 

data/bin/stormmq-delete-system

@@ -100,10 +100,7 @@ NOTES
 
     stormmq-create-system <userName> <systemName>
 
-COPYRIGHT
-
-  Copyright (c) 2010, Tony Byrne & StormMQ Ltd.
-  All rights reserved.
+#{_man_copyright}
 
 SELF TEST
 

data/bin/stormmq-describe-company

@@ -89,10 +89,7 @@ NOTES
 
     stormmq-create-system <userName> <systemName>
 
-COPYRIGHT
-
-  Copyright (c) 2010, Tony Byrne & StormMQ Ltd.
-  All rights reserved.
+#{_man_copyright}
 
 SELF TEST
 

data/bin/stormmq-describe-system

@@ -118,10 +118,7 @@ NOTES
 
     stormmq-create-system <userName> <systemName>
 
-COPYRIGHT
-
-  Copyright (c) 2010, Tony Byrne & StormMQ Ltd.
-  All rights reserved.
+#{_man_copyright}
 
 SELF TEST
 

data/bin/stormmq-get-amqpuser-password

@@ -130,10 +130,7 @@ NOTES
 
     stormmq-create-system <userName> <systemName>
 
-COPYRIGHT
-
-  Copyright (c) 2010, Tony Byrne & StormMQ Ltd.
-  All rights reserved.
+#{_man_copyright}
 
 SELF TEST
 

data/bin/stormmq-list-amqpusers

@@ -124,10 +124,7 @@ NOTES
 
     stormmq-create-system <userName> <systemName>
 
-COPYRIGHT
-
-  Copyright (c) 2010, Tony Byrne & StormMQ Ltd.
-  All rights reserved.
+#{_man_copyright}
 
 SELF TEST
 

data/bin/stormmq-list-apis

@@ -68,10 +68,7 @@ NOTES
   Pretty prints JSON, so not suitable for use with XHTML etc.,
   response documents.
 
-COPYRIGHT
-
-  Copyright (c) 2010, Tony Byrne & StormMQ Ltd.
-  All rights reserved.
+#{_man_copyright}
 
 SELF TEST
 

data/bin/stormmq-list-bindings

@@ -112,10 +112,7 @@ NOTES
 
     stormmq-create-system <userName> <systemName>
 
-COPYRIGHT
-
-  Copyright (c) 2010, Tony Byrne & StormMQ Ltd.
-  All rights reserved.
+#{_man_copyright}
 
 SELF TEST
 

data/bin/stormmq-list-clusters

@@ -84,10 +84,7 @@ NOTES
 
     stormmq-list-companies
 
-COPYRIGHT
-
-  Copyright (c) 2010, Tony Byrne & StormMQ Ltd.
-  All rights reserved.
+#{_man_copyright}
 
 SELF TEST
 

data/bin/stormmq-list-companies

@@ -72,10 +72,7 @@ NOTES
   Security prevents you from obtaining information about which other
   users belong to which companies.
 
-COPYRIGHT
-
-  Copyright (c) 2010, Tony Byrne & StormMQ Ltd.
-  All rights reserved.
+#{_man_copyright}
 
 SELF TEST
 

data/bin/stormmq-list-exchanges

@@ -113,10 +113,7 @@ NOTES
 
     stormmq-create-system <userName> <systemName>
 
-COPYRIGHT
-
-  Copyright (c) 2010, Tony Byrne & StormMQ Ltd.
-  All rights reserved.
+#{_man_copyright}
 
 SELF TEST
 

data/bin/stormmq-list-queues

@@ -113,10 +113,7 @@ NOTES
 
     stormmq-create-system <userName> <systemName>
 
-COPYRIGHT
-
-  Copyright (c) 2010, Tony Byrne & StormMQ Ltd.
-  All rights reserved.
+#{_man_copyright}
 
 SELF TEST
 

data/bin/stormmq-list-systems

@@ -93,10 +93,7 @@ NOTES
 
     stormmq-create-system <userName> <systemName>
 
-COPYRIGHT
-
-  Copyright (c) 2010, Tony Byrne & StormMQ Ltd.
-  All rights reserved.
+#{_man_copyright}
 
 SELF TEST
 

data/bin/stormmq-url-signer

@@ -91,10 +91,7 @@ NOTES
 
   Advanced use only - commandline subject to change.
 
-COPYRIGHT
-
-  Copyright (c) 2010, Tony Byrne & StormMQ Ltd.
-  All rights reserved.
+#{_man_copyright}
 
     EOM
   end

data/lib/stormmq/application.rb

@@ -32,5 +32,15 @@ module StormMQ
       'Self test ouput goes here'
     end
 
+    def _man_copyright
+      <<-EOS
+COPYRIGHT
+
+  Copyright (c) 2010, Tony Byrne & StormMQ Ltd.
+  All rights reserved.
+      EOS
+    end
+
+
   end
 end

data/lib/stormmq/secret_keys.rb

@@ -11,20 +11,23 @@ require 'json'
 require 'base64'
 require 'stormmq/base64_extensions'
 require 'stormmq/errors'
+require 'stormmq/utils'
 
 module StormMQ
 
-  SECRET_KEYS_SEARCH_PATH = ['~/.stormmq','/etc']
+  SECRET_KEYS_SEARCH_PATH = [
+    File.join(ENV['HOME'], '.stormmq'),
+    File.join('/', 'etc', 'stormmq')
+  ]
+
   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.
+    # Returns the 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?
+      raise Error::UserNotProvidedError, "user cannot be blank." if user.blank?
       keys[user] || (raise Error::SecretKeyNotFoundError, "a secret key for user '#{user}' could not be found in the secret key file.", caller)
     end
 
@@ -33,21 +36,16 @@ module StormMQ
       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 = search_path.map{|p| File.expand_path(File.join(p,keyfile))}
       full_paths.each do |full_path|
         begin
-          return SecretKeys.secret_keys_hash_from_json(IO.read(full_path))
+          return @secret_keys_cache = SecretKeys.secret_keys_hash_from_json(IO.read(full_path))
         rescue
+          # A dummy statement so that this branch is picked up by rcov
+          dummy = true
         end
       end
       raise Error::LoadSecretKeysError,
@@ -55,6 +53,18 @@ module StormMQ
           caller
     end
 
+    def forget_keys
+      @secret_keys_cache = nil
+    end
+
+    private
+
+    # Return a hash of keys stored in the secret keys file.
+    def keys
+      @secret_keys_cache ||= load_secret_keys
+    end
+
+
     def self.key_for(*args)
       self.instance.key_for(*args)
     end

data/lib/stormmq/url.rb

@@ -11,7 +11,7 @@ require 'cgi'
 require 'hmac'
 require 'hmac-sha2'
 require 'base64'
-
+require 'stormmq/base64_extensions'
 require 'stormmq/errors'
 
 module StormMQ
@@ -80,7 +80,7 @@ module StormMQ
 
     def to_h
       components = URI.split(@url.to_s)
-      {
+      component_hash = {
         :scheme   => components[0],
         :userinfo => components[1],
         :host     => components[2],
@@ -91,6 +91,7 @@ module StormMQ
         :query    => components[7],
         :fragment => components[8]
       }.reject {|k,v| v.nil?}
+      component_hash
     end
 
     def self.escape(string)

data/lib/stormmq/version.rb

@@ -1,3 +1,3 @@
 module StormMQ
-  VERSION = '0.0.6'
+  VERSION = '0.0.7'
 end

data/spec/secret-keys.json

@@ -0,0 +1 @@
+{"test":"qQC5BNDK5rMOxLC0G2hkOoW5Z7P-c4aO2pok5r0V0Ac"}

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+$:.unshift File.join(File.expand_path(File.dirname(__FILE__)), "..", "lib")
+require 'spec'

data/spec/stormmq/amqp_spec.rb

@@ -6,9 +6,25 @@
 # for terms of use and redistribution.
 #++
 
-require File.dirname(__FILE__) + '/../../lib/stormmq/amqp'
+require File.join(File.dirname(__FILE__), '..', 'spec_helper')
+require 'stormmq/amqp'
 
 describe StormMQ::AMQPClient do
+
+  it "adds default StormMQ client options to an option hash" do
+    options = {
+      :company     => 'a_company',
+      :system      => 'a_system',
+      :environment => 'an_environment'
+    }
+    new_options = StormMQ::AMQPClient.add_stormmq_options(options)
+    
+    new_options[:host].should  == 'amqp.stormmq.com'
+    new_options[:port].should  == 443
+    new_options[:vhost].should == '/a_company/a_system/an_environment'
+    new_options[:ssl].should be_true
+  end
+
   it "constructs the virtual host string from the StormMQ specific options in the connect option hash" do
     options = {
       :company     => 'a_company',
@@ -17,5 +33,17 @@ describe StormMQ::AMQPClient do
     }
     StormMQ::AMQPClient.vhost_from_options(options).should == '/a_company/a_system/an_environment'
   end
+  
+  it "returns an instance of the Bunny AMQP client" do
+    StormMQ::AMQPClient.instance.should be_instance_of(Bunny::Client)
+  end
+
+  it "run block in scope of Bunny AMQP client instance" do
+    block = Proc.new { }
+    options = StormMQ::AMQPClient.add_stormmq_options({})
+    Bunny.should_receive(:run).with(options, &block)
+    StormMQ::AMQPClient.run({}, &block)
+  end
+  
 end
 

data/spec/stormmq/base64_extensions_spec.rb

@@ -0,0 +1,28 @@
+#--
+# 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.join(File.dirname(__FILE__), '..', 'spec_helper')
+require 'base64'
+require 'stormmq/base64_extensions'
+
+describe Base64 do
+  
+  before(:each) do
+    @unsafe_encoded = "jv7N7mnDnl4FWgayyxzN695zYJ4SC/OTnXel9SPIP/2XV6d7+3vTyV4v0zQWAfvNwZm/bB/h6P+X+FUUdcvJig=="
+    @safe_encoded   = "jv7N7mnDnl4FWgayyxzN695zYJ4SC_OTnXel9SPIP_2XV6d7-3vTyV4v0zQWAfvNwZm_bB_h6P-X-FUUdcvJig=="
+  end
+  
+  it "implements a URL safe base64 decode" do
+    Base64.encode64(Base64.urlsafe_decode64(@safe_encoded)).gsub(/\n/,'').should == @unsafe_encoded
+  end
+
+  it "implements a URL safe base64 encode" do
+    Base64.urlsafe_encode64(Base64.decode64(@unsafe_encoded)).gsub(/\n/,'').should == @safe_encoded
+  end
+
+end

data/spec/stormmq/secret_keys_spec.rb

@@ -6,9 +6,11 @@
 # for terms of use and redistribution.
 #++
 
+require File.join(File.dirname(__FILE__), '..', 'spec_helper')
 require 'base64'
-require File.dirname(__FILE__) + '/../../lib/stormmq/secret_keys'
-require File.dirname(__FILE__) + '/../../lib/stormmq/base64_extensions'
+require 'stormmq/secret_keys'
+require 'stormmq/base64_extensions'
+require 'stormmq/errors'
 
 describe StormMQ::SecretKeys do
 
@@ -22,4 +24,51 @@ describe StormMQ::SecretKeys do
 
   end
 
+  describe "loading of keys from keyfile" do
+    
+    it "should throw an error when keyfile does not exist" do
+      keystore = StormMQ::SecretKeys.instance
+      lambda { keystore.load_secret_keys('/non-existing-path') }.should raise_error(StormMQ::Error::LoadSecretKeysError)
+    end
+    
+    it "should load keys from a file" do
+      keystore = StormMQ::SecretKeys.instance
+      lambda { keystore.load_secret_keys(File.join('spec')) }.should_not raise_error(StormMQ::Error::LoadSecretKeysError)
+    end
+    
+    it "should handle an error while reading the keyfile" do
+      IO.should_receive(:read).and_raise "bang! The universe has ended."
+      keystore = StormMQ::SecretKeys.instance
+      lambda { keystore.load_secret_keys(File.join('spec')) }.should raise_error(StormMQ::Error::LoadSecretKeysError)
+    end
+    
+  end
+
+  describe "key and user retrieval" do
+    
+    before(:each) do
+      @keystore = StormMQ::SecretKeys.instance
+      @keystore.forget_keys
+      @keystore.load_secret_keys(File.join('spec'))
+    end
+    
+    it "should return a list of users found in the key file" do
+      @keystore.users.should == ['test']
+      StormMQ::SecretKeys.key_for('test').should_not be_nil
+    end
+
+    it "should retrieve the key for a named user" do
+      @keystore.key_for('test').should_not be_nil
+    end
+    
+    it "should retrieve the key for a named user when using the class method" do
+      StormMQ::SecretKeys.key_for('test').should_not be_nil
+    end
+    
+    it "should raise an error when a key for a named user is not present in the keyfile" do
+      lambda { @keystore.key_for('wibble') }.should raise_error(StormMQ::Error::SecretKeyNotFoundError)
+    end
+    
+  end
+
 end

data/spec/stormmq/url_spec.rb

@@ -6,7 +6,8 @@
 # for terms of use and redistribution.
 #++
 
-require File.dirname(__FILE__) + '/../../lib/stormmq/url'
+require File.join(File.dirname(__FILE__), '..', 'spec_helper')
+require 'stormmq/url'
 
 describe StormMQ::URL do
 
@@ -126,4 +127,72 @@ describe StormMQ::URL do
 
   end
 
+  describe "valid?" do
+    
+    it "a valid URL" do
+      StormMQ::URL.new("http://www.byrnehq.com").valid?.should be_true
+    end
+
+    it "an invalid URL" do
+      lambda { StormMQ::URL.new("random://www") }.should raise_error(StormMQ::Error::InvalidURLError)
+    end
+    
+    it "an invalid URI as detected by URI.parse" do
+      URI.should_receive(:parse).and_raise URI::InvalidURIError
+      lambda { StormMQ::URL.new({:host => 'www.byrnehq.com'}) }.should raise_error(StormMQ::Error::InvalidURLError)
+    end
+    
+  end
+
+  describe "to_h" do
+    
+    before(:each) do
+      @hash = StormMQ::URL.new('http://www.stormmq.com:81/path?query=1').to_h
+    end
+    
+    it "should extract the scheme" do
+      @hash[:scheme].should == 'http'
+    end
+
+    it "should extract the host" do
+      @hash[:host].should == 'www.stormmq.com'
+    end
+
+    it "should extract the port" do
+      @hash[:port].should == '81'
+    end
+
+    it "should extract the path" do
+      @hash[:path].should == '/path'
+    end
+
+    it "should extract the query" do
+      @hash[:query].should == 'query=1'
+    end
+
+    it "should not contain a fragment" do
+      @hash[:fragment].should be_nil
+    end
+
+    it "should not contain an opaque" do
+      @hash[:opaque].should be_nil
+    end
+
+    it "should not contain a registry" do
+      @hash[:registry].should be_nil
+    end
+    
+  end
+
+  describe "canonicalise and sign" do
+    
+    it "should canonicalise and sign a URL (in one step)" do
+      base64key = "d60bfe079c88f2c78310131d9bb419214ec3badb0bdfccb20a1c568f380426c5"
+      key = Base64::decode64(base64key)
+      StormMQ::URL.new('http://api.stormmq.com/').canonicalise_and_sign('test', base64key).to_s.should  ==
+        'http://api.stormmq.com:80/?signature=qQC5BNDK5rMOxLC0G2hkOoW5Z7P-c4aO2pok5r0V0Ac%3D&user=test&version=0'      
+    end
+    
+  end
+
 end

data/spec/stormmq/utils_spec.rb

@@ -6,8 +6,33 @@
 # for terms of use and redistribution.
 #++
 
-require File.dirname(__FILE__) + '/../../lib/stormmq/utils'
+require File.join(File.dirname(__FILE__), '..', 'spec_helper')
+require 'stormmq/utils'
 
 describe StormMQ::Utils do
 
+  describe NilClass, 'blank?' do
+  
+    it "should extend NilClass to add a 'blank?' method" do
+      nil.blank?.should be_true
+    end
+
+  end
+  
+  describe String, 'blank?' do
+  
+    it "a string with non space characters is not blank" do
+      'not blank'.blank?.should be_false
+    end
+
+    it "an empty string is blank" do
+      ''.blank?.should be_true
+    end
+
+    it "a string containing only space is blank" do
+      '    '.blank?.should be_true
+    end
+
+  end
+
 end

metadata

@@ -1,20 +1,20 @@
 --- !ruby/object:Gem::Specification 
 name: stormmq-client
 version: !ruby/object:Gem::Version 
-  hash: 19
+  hash: 17
   prerelease: false
   segments: 
   - 0
   - 0
-  - 6
-  version: 0.0.6
+  - 7
+  version: 0.0.7
 platform: ruby
 authors: 
 - Tony Byrne
 autorequire: 
 bindir: bin
 cert_chain: 
-date: 2010-06-08 00:00:00 +01:00
+date: 2010-06-18 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -209,7 +209,10 @@ files:
 - bin/stormmq-list-queues
 - bin/stormmq-list-systems
 - bin/stormmq-url-signer
+- spec/secret-keys.json
+- spec/spec_helper.rb
 - spec/stormmq/amqp_spec.rb
+- spec/stormmq/base64_extensions_spec.rb
 - spec/stormmq/secret_keys_spec.rb
 - spec/stormmq/url_spec.rb
 - spec/stormmq/utils_spec.rb