jolokia 0.1.0

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.rvmrc
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format Fivemat

data/Gemfile

@@ -0,0 +1,12 @@
+source 'http://ruby.taobao.org'
+
+group :test do
+  gem 'json_expressions'
+  gem 'rspec'
+  gem 'fivemat'
+  gem 'pry'
+  gem 'oj'
+end
+
+# Specify your gem's dependencies in jolokia.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Tower He
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,65 @@
+# Jolokia
+
+The Jolokia Ruby library provides a ruby API to the to the [Jolokia](http://www.jolokia.org) Agent.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'jolokia'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install jolokia
+
+## Usage
+
+First of all, you need to create an instance of Jolokia::Client to
+comunicate with the remote [Jolokia](http://www.jolokia.org) Agent. You just need
+to pass the url of the [Jolokia](http://www.jolokia.org) Agent to the constructor for creating the
+client.
+
+```ruby
+jolokia = Jolokia.new(url: 'http://localhost:8080/jolokia')
+```
+
+And then, you can use the created client to read or write the attributes
+of the MBeans, or execute the operations of the MBeans.
+
+```ruby
+response = jolokia.request(:post, type: 'read',
+                                  mbean: 'java.lang:type=Memory',
+                                  attribute: 'HeapMemoryUsage')
+pp response
+
+# =>
+  {"timestamp"=>1340783789,
+   "status"=>200,
+   "request"=>
+    {"mbean"=>"java.lang:type=Memory",
+     "attribute"=>"HeapMemoryUsage",
+     "type"=>"read"},
+   "value"=>
+    {"max"=>477233152,
+     "committed"=>190382080,
+     "init"=>134217728,
+     "used"=>116851464}}
+```
+
+### API
+
+* `get_attribute(mbean, attribute, path = nil)`
+* `set_attribute(mbean, attribute, value, path = nil)`
+* `execute(mbean, operations, args)`
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/jolokia.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/jolokia/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ['Tower He']
+  gem.email         = ['towerhe@gmail.com']
+  gem.description   = %q{The Jolokia ruby library }
+  gem.summary       = %q{The Jolokia ruby library provides a ruby API to the to the Jolokia agent. }
+  gem.homepage      = 'https://github.com/towerhe/jolokia'
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = 'jolokia'
+  gem.require_paths = ['lib']
+  gem.version       = Jolokia::VERSION
+
+  gem.add_dependency 'faraday', '~> 0.8.1'
+  gem.add_dependency 'faraday_middleware', '~> 0.8.8'
+end

data/lib/jolokia.rb

@@ -0,0 +1,11 @@
+require 'jolokia/version'
+require 'jolokia/client'
+require 'jolokia/remote_error'
+
+module Jolokia
+  class << self
+    def new(opts = {})
+      Jolokia::Client.new(opts)
+    end
+  end
+end

data/lib/jolokia/client.rb

@@ -0,0 +1,67 @@
+require 'faraday'
+require 'faraday_middleware'
+
+module Jolokia
+  class Client
+    attr_accessor :url
+
+    def initialize(opts = {})
+      @url = opts[:url]
+    end
+
+    def get_attribute(mbean, attribute, path = nil)
+      options = { 'type' => 'read', 'mbean' => mbean, 'attribute' => attribute }
+      options['path'] = path if path
+
+      request(:post, options)['value']
+    end
+
+    def set_attribute(mbean, attribute, value, path = nil)
+      options = {
+        'type' => 'write',
+        'mbean' => mbean,
+        'attribute' => attribute,
+        'value' => value
+      }
+      options['path'] = path if path
+
+      request(:post, options)
+    end
+
+    def execute(mbean, operation, args = nil)
+      options = {
+        'type' => 'exec',
+        'mbean' => mbean,
+        'operation' => operation
+      }
+
+      if args
+        options['arguments'] = args.is_a?(Array) ? args : [args]
+      end
+
+      request(:post, options)
+    end
+
+    def request(method, opts)
+      resp = connection.send(method, '', opts)
+
+      if resp.body['status'] != 200
+        raise RemoteError.new(resp.body['status'],
+                              resp.body['error'],
+                              resp.body['stacktrace'])
+      end
+
+      resp.body
+    end
+
+    private
+
+    def connection
+      @conn ||= ::Faraday.new(url) do |f|
+        f.request  :json
+        f.response :json
+        f.adapter  :net_http
+      end
+    end
+  end
+end

data/lib/jolokia/remote_error.rb

@@ -0,0 +1,9 @@
+module Jolokia
+  class RemoteError < RuntimeError
+    attr_reader :status, :message, :stacktrace
+
+    def initialize(status, message, stacktrace)
+      @status, @message, @stacktrace = status, message, stacktrace
+    end
+  end
+end

data/lib/jolokia/version.rb

@@ -0,0 +1,3 @@
+module Jolokia
+  VERSION = "0.1.0"
+end

data/spec/lib/jolokia/client_spec.rb

@@ -0,0 +1,101 @@
+require 'spec_helper'
+
+describe Jolokia::Client do
+  let(:url) { 'http://localhost:8080/jolokia' }
+  let(:client) { Jolokia::Client.new(url: url) }
+
+  before do
+    client.stub(:connection) do
+      @conn = Faraday.new do |b|
+        b.request :json
+        b.response :json
+        b.adapter :test do |stub|
+          stub.post('/') do |env|
+            posted_as = env[:request_headers]['Content-Type']
+            body = Oj.load(env[:body]).merge('status' => 200)
+
+            [200, {'Content-Type' => posted_as }, Oj.dump(body)]
+          end
+        end
+      end
+    end
+  end
+
+  describe '#request' do
+    shared_examples 'Request executed successfully' do
+      it 'passes valid params' do
+        response.should match_json_expression(options)
+      end
+    end
+
+    let(:response) do
+      client.request :post, options
+    end
+
+    context 'when reading attributes' do
+      let(:options) do
+        {
+          'type' => 'read',
+          'mbean' => 'java.lang:type=Memory',
+          'attribute' => attribute,
+          'status' => 200
+        }
+      end
+
+      context 'only a single attribute' do
+        let(:attribute) { 'HeapMemoryUsage' }
+
+        it_should_behave_like 'Request executed successfully'
+      end
+
+      context 'multi-attributes' do
+        let(:attribute) { ['HeapMemoryUsage', 'NonHeapMemoryUsage'] }
+
+        it_should_behave_like 'Request executed successfully'
+      end
+    end
+
+    context 'when writing an attribute' do
+      let(:options) do
+        {
+          'type' => 'write',
+          'mbean' => 'java.lang:type=ClassLoading',
+          'attribute' => 'Verbose',
+          'value' => true,
+          'status' => 200
+        }
+      end
+
+      it_should_behave_like 'Request executed successfully'
+    end
+
+    context 'when executing JMX operations (exec)' do
+      context 'without any params' do
+        let(:options) do
+          {
+            'type' => 'exec',
+            'mbean' => 'java.lang:type=Memory',
+            'operation' => 'gc',
+            'status' => 200
+          }
+        end
+
+        it_should_behave_like 'Request executed successfully'
+      end
+
+      context 'with params' do
+        let(:options) do
+          {
+            'type' => 'exec',
+            'mbean' => 'java.lang:type=Threading',
+            'operation' => 'dumpAllThreads',
+            'arguments' => [true, true],
+            'status' => 200
+          }
+        end
+
+        it_should_behave_like 'Request executed successfully'
+      end
+    end
+  end
+end

data/spec/lib/jolokia_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe Jolokia do
+  it 'creates an instance of Jolokia::Client' do
+    Jolokia.new.should be_a Jolokia::Client
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+require 'rubygems'
+require 'bundler'
+Bundler.setup(:default, :test)
+
+require 'jolokia'
+
+require 'json_expressions/rspec'
+require 'pry'
+require 'oj'
+
+RSpec.configure do |c|
+  c.mock_with :rspec
+end

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification
+name: jolokia
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Tower He
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.8
+description: ! 'The Jolokia ruby library '
+email:
+- towerhe@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- jolokia.gemspec
+- lib/jolokia.rb
+- lib/jolokia/client.rb
+- lib/jolokia/remote_error.rb
+- lib/jolokia/version.rb
+- spec/lib/jolokia/client_spec.rb
+- spec/lib/jolokia_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/towerhe/jolokia
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: The Jolokia ruby library provides a ruby API to the to the Jolokia agent.
+test_files:
+- spec/lib/jolokia/client_spec.rb
+- spec/lib/jolokia_spec.rb
+- spec/spec_helper.rb