torquebox-backstage 0.1.0

data/lib/resource.rb

@@ -0,0 +1,53 @@
+#
+# Copyright 2011 Red Hat, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+module Backstage
+  module Resource
+
+    def self.included(base)
+      base.extend( ClassMethods )
+      base.send( :attr_accessor, :parent )
+    end
+
+    def association_chain
+      chain = []
+      chain << parent if parent
+      chain << self
+      chain
+    end
+    
+    def to_hash
+      self.class.to_hash_attributes.inject({ }) do |response, attribute|
+        response[attribute] = __send__( attribute )
+        response
+      end
+    end
+
+    def resource
+      self
+    end
+
+    def available_actions
+      []
+    end
+
+    module ClassMethods
+      def to_hash_attributes
+        [:resource]
+      end
+    end
+  end
+end

data/lib/resource_helpers.rb

@@ -0,0 +1,63 @@
+#
+# Copyright 2011 Red Hat, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+module Backstage
+  class Application < Sinatra::Base
+    def self.resource(*resources)
+      options = resources.pop if resources.last.is_a?(Hash)
+      options ||= {}
+      resources.each do |resource|
+        resource = resource.to_s
+        klass = "backstage/#{resource}".constantize
+        view_path = options[:view_path] || resource.pluralize
+        get "/#{resource.pluralize}" do
+          @collection = klass.all
+          if html_requested?
+            haml :"#{view_path}/index"
+          else
+            content_type :json
+            collection_to_json( @collection )
+          end
+        end
+
+        get "/#{resource}/:name" do
+          @object = klass.find( Util.decode_name( params[:name] ) )
+          if html_requested?
+            haml :"#{view_path}/show"
+          else
+            content_type :json
+            object_to_json( @object )
+          end
+        end
+
+        (options[:actions] || []).each do |action|
+          post "/#{resource}/:name/#{action}" do
+            object = klass.find( Util.decode_name( params[:name] ) )
+            object.__send__( action )
+            if html_requested?
+              flash[:notice] = "'#{action}' called on #{simple_class_name( object ).humanize} #{object.name}"
+              redirect_to object_path( object )
+            else
+              content_type :json
+              object_to_json( object )
+            end
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/runtimes.rb

@@ -0,0 +1,19 @@
+#
+# Copyright 2011 Red Hat, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require 'runtimes/models/runtime'
+require 'runtimes/routes'
+

data/lib/runtimes/models/job.rb

@@ -0,0 +1,35 @@
+#
+# Copyright 2011 Red Hat, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+module Backstage
+  class Job
+    include HasMBean
+    include TorqueBoxManaged
+    include Resource
+    
+    def self.filter
+      "torquebox.jobs:*"
+    end
+
+    def self.to_hash_attributes
+      super + [:name, :app, :app_name, :ruby_class_name, :status, :cron_expression]
+    end
+
+    def available_actions
+      status == 'Started' ? %w{stop} : %w{start}
+    end
+  end
+end

data/lib/runtimes/routes.rb

@@ -0,0 +1,18 @@
+#
+# Copyright 2011 Red Hat, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+Backstage::Application.resource :job, :actions => [:start, :stop]
+

data/lib/services.rb

@@ -0,0 +1,18 @@
+#
+# Copyright 2011 Red Hat, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require 'services/models/service'
+require 'services/routes'

data/lib/services/models/service.rb

@@ -0,0 +1,35 @@
+#
+# Copyright 2011 Red Hat, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+module Backstage
+  class Service
+    include HasMBean
+    include TorqueBoxManaged
+    include Resource
+    
+    def self.filter
+      "torquebox.services:*"
+    end
+
+    def self.to_hash_attributes
+      super + [:name, :app, :app_name, :status]
+    end
+
+    def available_actions
+      status == 'Started' ? %w{ stop } : %w{ start' }
+    end
+  end
+end

data/lib/services/routes.rb

@@ -0,0 +1,17 @@
+#
+# Copyright 2011 Red Hat, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+Backstage::Application.resource :service, :actions => [:start, :stop]

data/lib/torquebox_managed.rb

@@ -0,0 +1,36 @@
+#
+# Copyright 2011 Red Hat, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+module Backstage
+  module TorqueBoxManaged
+    def name
+      return mbean.name if mbean.respond_to?( :name )
+      $1 if full_name =~ /name=(.*?)(,|$)/
+    end
+
+    def app_name
+      $1 if full_name =~ /app=(.*?)(,|$)/
+    end
+
+    def app
+      App.find( "torquebox.apps:app=#{app_name}" )
+    end
+    
+    def status
+      mbean.status.downcase.capitalize
+    end
+  end
+end

data/lib/util.rb

@@ -0,0 +1,33 @@
+#
+# Copyright 2011 Red Hat, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require 'base64'
+
+module Backstage
+  module Util
+    class << self
+      def encode_name(name)
+        #ugh, I'd rather encode a different way, but other attempts
+        #seem to break sinatra?
+        Base64.encode64( name ).gsub("\n", '')
+      end
+
+      def decode_name(name)
+        Base64.decode64( name )
+      end
+    end
+  end
+end

data/spec/api_spec.rb

@@ -0,0 +1,136 @@
+#
+# Copyright 2011 Red Hat, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require 'spec_helper'
+
+module Backstage
+
+  describe '/api' do
+    before(:each) do
+      get '/api'
+      @response = JSON.parse(last_response.body, :symbolize_names => true)
+    end
+
+    it "should work" do
+      last_response.should be_ok
+    end
+
+
+    it "should be a hash" do
+      @response.is_a?(Hash).should be_true
+    end
+
+    it "should contain a hash of collection urls" do
+      collections = [:apps, :queues, :topics, :message_processors, :jobs, :services, :pools]
+      @response[:collections].keys.should =~ collections
+      collections.each do |collection|
+        @response[:collections][collection].should =~ %r{^http://example.org/#{collection}\?format=json$}
+      end
+    end
+
+      end
+
+  describe 'with authentication enabled' do
+    before(:each) do
+      ENV['REQUIRE_AUTHENTICATION'] = 'true'
+      @authenticator = mock(:authenticator)
+      TorqueBox::Authentication.stub(:default).and_return(@authenticator)
+    end
+    
+    it "api should work with authentication" do
+      @authenticator.should_receive(:authenticate).with('blah', 'pw').and_return(true)
+      authorize 'blah', 'pw'
+      get '/api'
+      last_response.should be_ok
+    end
+
+    it "should 401 w/o credentials" do
+      get '/api'
+      last_response.status.should == 401
+    end
+
+    it "should 401 with invalid credentials" do
+      @authenticator.should_receive(:authenticate).with('foo', 'bar').and_return(false)
+      authorize 'foo', 'bar'
+      get '/api'
+      last_response.status.should == 401
+    end
+
+    after(:each) do
+      ENV['REQUIRE_AUTHENTICATION'] = nil
+    end
+  end
+  
+  %w{ app queue topic job message_processor service pool }.each do |resource|
+    klass = "backstage/#{resource}".constantize
+    describe resource do
+      it "should have hash attributes beyond :resource" do
+        klass.to_hash_attributes.size.should > 1
+      end
+      
+      describe "/#{resource.pluralize}" do
+        before(:each) do
+          klass.stub(:all).and_return([resource_with_mock_mbean(klass)])
+          get "/#{resource.pluralize}", :format => 'json'
+          @response = JSON.parse(last_response.body, :symbolize_names => true)
+        end
+
+        it "should work" do
+          last_response.should be_ok
+        end
+
+        it "should be an array" do
+          @response.is_a?(Array).should be_true
+        end
+
+        context "each item" do
+          it "should include the resource" do
+            @response.first[:resource].should =~ %r{/#{resource}/.*format=json$}
+          end
+
+          klass.to_hash_attributes.each do |attribute|
+            it "should include #{attribute}" do
+              @response.first[attribute].should_not be_nil
+            end
+          end
+        end
+      end
+
+      describe "/#{resource}" do
+        before(:each) do
+          klass.stub(:find).and_return(resource_with_mock_mbean(klass))
+          get "/#{resource}/somename", :format => 'json'
+          @response = JSON.parse(last_response.body, :symbolize_names => true)
+        end
+
+        it "should work" do
+          last_response.should be_ok
+        end
+
+        it "should include the resource" do
+          @response[:resource].should =~ %r{/#{resource}/.*format=json$}
+        end
+
+        klass.to_hash_attributes.each do |attribute|
+          it "should include #{attribute}" do
+            @response[attribute.to_sym].should_not be_nil
+          end
+        end
+      end
+    end
+
+  end
+end