triglav-client 0.0.1

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--colour
+--format documentation

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in triglav-client.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Kentaro Kuribayashi
+
+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,53 @@
+# Triglav::Client
+
+Triglav::Client is a Ruby interface to [Triglav](http://github.com/kentaro/triglav) API.
+
+## Synopsis
+
+```ruby
+require 'triglav/client'
+
+client = Triglav::Client.new(
+  base_url:  'http://example.com/',  # Base URL which your Triglav is located at
+  api_token: 'xxxxxxxxxx'            # You can get it from your page on Triglav
+)
+
+# Services
+client.services #=> Returns all the services registered on Triglav
+
+# Roles
+client.roles    #=> Returns all the roles registered on Triglav
+client.roles_in('service') #=> Only roles in the service
+
+# Active Hosts (default behaviour)
+client.hosts    #=> Returns all the hosts registered on Triglav
+client.hosts_in('service')         #=> Only hosts in the service
+client.hosts_in('service', 'role') #=> Only hosts in the service and which have the role
+
+# Inactive Hosts
+client.hosts(with_inactive: true)
+client.hosts_in('service', nil, with_inactive: true)
+client.hosts_in('service', 'role', with_inactive: true)
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'triglav-client'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install triglav-client
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+task :default => :spec

data/lib/triglav/client/version.rb

@@ -0,0 +1,5 @@
+module Triglav
+  class Client
+    VERSION = "0.0.1"
+  end
+end

data/lib/triglav/client.rb

@@ -0,0 +1,95 @@
+require 'json'
+require 'net/http'
+
+require 'triglav/client/version'
+
+module Triglav
+  class Client
+    class Error < StandardError; end
+
+    attr_accessor :base_url, :api_token
+
+    def initialize(args)
+      @base_url  = args[:base_url]
+      @api_token = args[:api_token]
+
+      if !@base_url || !@api_token
+        raise ArgumentError.new("Both `base_url` and `api_token` are required.")
+      end
+    end
+
+    def services
+      response = dispatch_request('get', '/api/services.json')
+      response.map { |e| e['service'] }
+    end
+
+    def roles
+      response = dispatch_request('get', '/api/roles.json')
+      response.map { |e| e['role'] }
+    end
+
+    def roles_in (service)
+      response = dispatch_request('get', "/api/services/#{service}/roles.json")
+      response.map { |e| e['role'] }
+    end
+
+    def hosts (options = {})
+      response = dispatch_request('get', '/api/hosts.json')
+      response.map { |e| e['host'] }.select do |h|
+        if options[:with_inactive]
+          true
+        else
+          h['active']
+        end
+      end
+    end
+
+    def hosts_in (service, role = nil, options = {})
+      if role.is_a?(Hash)
+        raise ArgumentError.new(
+          "`role` must be passed (even if it's nil) when you want to pass `options`."
+        )
+      end
+
+      if (role)
+        response = dispatch_request('get', "/api/services/#{service}/roles/#{role}/hosts.json")
+      else
+        response = dispatch_request('get', "/api/services/#{service}/hosts.json")
+      end
+
+      response.map { |e| e['host'] }.select do |h|
+        if options[:with_inactive]
+          true
+        else
+          h['active']
+        end
+      end
+    end
+
+    def dispatch_request(method, path, params = {})
+      if !method || !path
+        raise ArgumentError.new("Both `method` and `path` are required.")
+      end
+
+      json = do_request(method, path, params)
+      JSON.parse(json)
+    end
+
+    private
+
+    def do_request(method, path, params = {})
+      uri = URI.parse(base_url)
+      uri.path  = path
+
+      response = Net::HTTP.start(uri.host, uri.port) do |http|
+        http.__send__(method, "#{uri.path}?api_token=#{api_token}")
+      end
+
+      if response.code.to_i >= 300
+        raise Error.new("#{response.code}: #{response.message}")
+      end
+
+      response.body
+    end
+  end
+end

data/spec/client_spec.rb

@@ -0,0 +1,216 @@
+require 'spec_helper'
+
+describe Triglav::Client do
+  describe '.initialize' do
+    context 'when no arguments are passed' do
+      include_context 'initialize client'
+
+      it {
+        expect(subject).to be_an_instance_of Triglav::Client
+      }
+    end
+
+    context 'when no arguments are passed' do
+      it {
+        expect { Triglav::Client.new }.to raise_error(ArgumentError)
+      }
+    end
+
+    context 'when only `base_url` is passed' do
+      it {
+        expect { Triglav::Client.new }.to raise_error(ArgumentError)
+      }
+    end
+
+    context 'when `api_token` is passed' do
+      it {
+        expect { Triglav::Client.new }.to raise_error(ArgumentError)
+      }
+    end
+  end
+
+  describe '#services' do
+    include_context 'initialize client with fixtures'
+
+    before {
+      subject.stub(:dispatch_request).and_return(services)
+    }
+
+    it {
+      response = subject.services
+
+      expect(response).to be_an_instance_of Array
+      expect(response.size).to be == services.size
+    }
+  end
+
+  describe '#roles' do
+    include_context 'initialize client with fixtures'
+
+    before {
+      subject.stub(:dispatch_request).and_return(roles)
+    }
+
+    it {
+      response = subject.roles
+
+      expect(response).to be_an_instance_of Array
+      expect(response.size).to be == roles.size
+    }
+  end
+
+  describe '#roles_in' do
+    include_context 'initialize client with fixtures'
+
+    before {
+      subject.stub(:dispatch_request).and_return(roles)
+    }
+
+    it {
+      response = subject.roles_in('triglav')
+
+      expect(response).to be_an_instance_of Array
+      expect(response.size).to be == roles.size
+    }
+
+    context 'when `service` is not passed' do
+      include_context 'initialize client with fixtures'
+
+      it {
+        expect { subject.roles_in }.to raise_error(ArgumentError)
+      }
+    end
+  end
+
+  describe '#hosts' do
+    include_context 'initialize client with fixtures'
+
+    before {
+      subject.stub(:dispatch_request).and_return(hosts)
+    }
+
+    context 'and `with_inactive` option is not passed' do
+      it {
+        response = subject.hosts
+
+        expect(response).to be_an_instance_of Array
+        expect(response.size).to be == (hosts.size - 1)
+      }
+    end
+
+    context 'when `with_inactive` option passed as true' do
+      it {
+        response = subject.hosts(with_inactive: true)
+
+        expect(response).to be_an_instance_of Array
+        expect(response.size).to be == hosts.size
+      }
+    end
+  end
+
+  describe '#hosts_in' do
+    include_context 'initialize client with fixtures'
+
+    before {
+      subject.stub(:dispatch_request).and_return(hosts)
+    }
+
+    context 'when `role` is passed' do
+      context 'and `with_inactive` option is not passed' do
+        it {
+          response = subject.hosts_in('triglav', 'app')
+
+          expect(response).to be_an_instance_of Array
+          expect(response.size).to be == (hosts.size - 1)
+        }
+      end
+
+      context 'and `with_inactive` option passed as true' do
+        it {
+          response = subject.hosts_in('triglav', 'app', with_inactive: true)
+
+          expect(response).to be_an_instance_of Array
+          expect(response.size).to be == hosts.size
+        }
+      end
+    end
+
+    context 'when `role` is not passed' do
+      context 'and `with_inactive` option is not passed' do
+        it {
+          response = subject.hosts_in('triglav')
+
+          expect(response).to be_an_instance_of Array
+          expect(response.size).to be == (hosts.size - 1)
+        }
+      end
+
+      context 'and `with_inactive` option passed as true' do
+        it {
+          expect {
+            subject.hosts_in('triglav', with_inactive: true)
+          }.to raise_error(ArgumentError)
+        }
+      end
+    end
+  end
+
+  describe '#dispatch_request' do
+    include_context 'initialize client'
+
+    context 'when arguments are passed correctly' do
+      context 'and request is successfully dispatched' do
+        before {
+          subject.stub(:do_request).and_return('{ "result": "ok" }')
+        }
+
+        it {
+          response = subject.dispatch_request('get', '/foo')
+
+          expect(response).to be_an_instance_of Hash
+          expect(response['result']).to be == 'ok'
+        }
+      end
+
+      context 'and request fails by an error' do
+        before {
+          subject.stub(:do_request).and_raise(
+            Triglav::Client::Error.new('403: 403 Forbidden')
+          )
+        }
+
+        it {
+          expect {
+            subject.dispatch_request('get', '/foo')
+          }.to raise_error(Triglav::Client::Error)
+        }
+      end
+    end
+
+    context 'when arguments are not passed correctly' do
+      context 'and no arguments are passed' do
+        it {
+          expect {
+            subject.dispatch_request
+          }.to raise_error(ArgumentError)
+        }
+      end
+
+      context 'and only `base_url` is passed' do
+        it {
+          expect {
+            subject.dispatch_request('get')
+          }.to raise_error(ArgumentError)
+        }
+      end
+
+      context 'and `api_token` is passed' do
+        it {
+          expect {
+            subject.dispatch_request(nil, '/foo')
+          }.to raise_error(ArgumentError)
+        }
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,38 @@
+require 'triglav/client'
+
+require 'rspec'
+RSpec.configure do |config|
+end
+
+shared_context 'initialize client' do
+  let(:client) {
+    Triglav::Client.new(base_url: 'http://example.com/', api_token: 'xxxxxxxxxx')
+  }
+  subject { client }
+end
+
+shared_context 'initialize client with fixtures' do
+  include_context 'initialize client'
+
+  let(:services) {
+    [
+      { 'service' => { 'id' => 1 } },
+      { 'service' => { 'id' => 2 } },
+    ]
+  }
+
+  let(:roles) {
+    [
+      { 'role' => { 'id' => 1 } },
+      { 'role' => { 'id' => 2 } },
+    ]
+  }
+
+  let(:hosts) {
+    [
+      { 'host' => { 'id' => 1, 'active' => true }  },
+      { 'host' => { 'id' => 2, 'active' => false } },
+      { 'host' => { 'id' => 2, 'active' => true }  },
+    ]
+  }
+end

data/triglav-client.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'triglav/client/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "triglav-client"
+  gem.version       = Triglav::Client::VERSION
+  gem.authors       = ["Kentaro Kuribayashi"]
+  gem.email         = ["kentarok@gmail.com"]
+  gem.description   = %q{A Ruby interface to Triglav API.}
+  gem.summary       = %q{A Ruby interface to Triglav API.}
+  gem.homepage      = "http://github.com/kentaro/triglav-client-ruby"
+
+  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.require_paths = ["lib"]
+
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'rake'
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: triglav-client
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Kentaro Kuribayashi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A Ruby interface to Triglav API.
+email:
+- kentarok@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/triglav/client.rb
+- lib/triglav/client/version.rb
+- spec/client_spec.rb
+- spec/spec_helper.rb
+- triglav-client.gemspec
+homepage: http://github.com/kentaro/triglav-client-ruby
+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'
+      segments:
+      - 0
+      hash: -1294770554663767277
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -1294770554663767277
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: A Ruby interface to Triglav API.
+test_files:
+- spec/client_spec.rb
+- spec/spec_helper.rb