yohoushi-client 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 54873f9cbb996e8f68580ca1cd876a325397b466
+  data.tar.gz: 1e19703153e7b8f2b79f96b9b2c9bae76a48f187
+SHA512:
+  metadata.gz: 3b45495fabcb9db59a96580614f0eb84093459f8b1392c850799863b8c1cc6ea7445ab94ef056f39577d5e39f309d6fcd5674e9586be7fb255157cd99709175c
+  data.tar.gz: 6b72cfd2cc77fa1574ae452eca3cc39b6f01345405c45338c4e359bd3f5bab6d369a00ca7222a3a6c5374c8825179cf937bfa229f10fb89c047ee4daefa2b7a6

data/.gitignore

@@ -0,0 +1,12 @@
+/*.gem
+~*
+#*
+*~
+.bundle
+Gemfile.lock
+.rbenv-version
+.ruby-version
+vendor
+doc/*
+tmp/*
+.yardoc

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,6 @@
+rvm:
+#  - 1.8.7
+  - 1.9.3
+  - 2.0.0
+gemfile:
+  - Gemfile

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+# 0.0.1 (2013/08/29)
+
+Initial Release

data/Gemfile

@@ -0,0 +1,5 @@
+# encoding: utf-8
+source 'https://rubygems.org'
+
+gemspec
+gem 'yohoushi-client', path: '.'

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 DeNA Co., Ltd.
+
+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,29 @@
+# Yohoushi Client [![Build Status](https://secure.travis-ci.org/yohoushi/yohoushi-client.png?branch=master)](http://travis-ci.org/yohoushi/yohoushi-client) [![Dependency Status](https://gemnasium.com/yohoushi/yohoushi-client.png)](https://gemnasium.com/yohoushi/yohoushi-client)
+
+testing ruby: 1.9.3, 2.0.0; Yohoushi: >= 0.62.3
+
+## About Yohoushi Client
+
+yohoushi-client is a ruby client library for Yohoushi API where [yohoushi](http://yohoushi.github.io/yohoushi/) is a visualization graph tool.
+
+## USAGE
+
+    gem install yohoushi-client
+
+See [examples](examples) directory.
+
+## ChangeLog
+
+See [CHANGELOG.md](CHANGELOG.md) for details.
+
+## 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](../../pull/new/master)
+
+## Copyright
+
+Copyright (c) 2013 DeNA Co., Ltd. See [LICENSE](LICENSE) for details.

data/Rakefile

@@ -0,0 +1,15 @@
+# encoding: utf-8
+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
+
+desc 'Open an irb session preloaded with the gem library'
+task :console do
+    sh 'irb -rubygems -I lib -r yohoushi-client.rb'
+end
+task :c => :console

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/bin/yohoushi-client

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+# -*- encoding: utf-8 -*-
+
+require 'yohoushi/cli'
+Yohoushi::CLI.start(ARGV)

data/examples/create_graph.rb

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+# An example to create complex graphs
+
+# require anyway
+require 'yohoushi-client'
+
+# Create a Yohoushi Client, given the base URI of Yohoushi
+client = Yohoushi::Client.new('http://localhost:4804')
+
+# Create a graph!
+path = "foo/bar"
+number = 10.1
+begin
+  client.debug_dev = STDOUT
+  client.post_graph(path, {"number" => number})
+rescue Yohoushi::AlreadyExists => e
+  puts "\tclass:#{e.class}\t#{e.message}"
+rescue Yohoushi::NotFound => e
+  puts "\tclass:#{e.class}\t#{e.message}"
+end

data/lib/yohoushi/cli.rb

@@ -0,0 +1,37 @@
+# -*- encoding: utf-8 -*-
+require 'thor'
+require 'yohoushi-client'
+
+class Yohoushi::CLI < Thor
+  class_option :silent, :aliases => ["-S"], :type => :boolean
+
+  desc 'post <json> <url>', 'Post a parameter to a graph'
+  long_desc <<-LONGDESC
+    Post a parameter to a graph
+
+    ex)
+    $ yohoushi-client post '{"number":0}' http://localhost:4804/api/graphs/foo/bar
+  LONGDESC
+  def post(json, url)
+    uri = URI.parse(url)
+    client = client(uri)
+    path = graph_path(uri.path)
+    begin
+      res = client.post_graph(path, JSON.parse(json))
+      $stdout.puts res unless @options['silent']
+    rescue => e
+      $stderr.puts "\tclass:#{e.class}\t#{e.message}"
+    end
+  end
+
+  no_tasks do
+    def graph_path(path)
+      path.split("/api/graphs/").last
+    end
+
+    def client(uri)
+      Yohoushi::Client.new("#{uri.scheme}://#{uri.host}:#{uri.port}")
+    end
+  end
+end
+

data/lib/yohoushi/client.rb

@@ -0,0 +1,147 @@
+# -*- encoding: utf-8 -*-
+require 'httpclient'
+require 'json'
+require 'cgi'
+require 'pp'
+
+module Yohoushi
+  class Error < StandardError; end
+  class NotFound < Error; end
+  class AlreadyExists < Error; end
+
+  class Client
+    attr_accessor :debug
+    attr_accessor :client
+    attr_reader   :debug_dev
+    attr_reader   :base_uri
+
+    # @param [String] base_uri The base uri of Yohoushi
+    def initialize(base_uri = 'http://127.0.0.1:4804')
+      @base_uri = base_uri
+    end
+
+    def client
+      @client ||= HTTPClient.new
+    end
+
+    # set the `debug_dev` attribute of HTTPClient
+    # @param [IO] debug_dev such as STDOUT
+    def debug_dev=(debug_dev)
+      client.debug_dev = debug_dev
+    end
+
+    def last_response
+      @res
+    end
+
+    # GET the JSON API
+    # @param [String] path
+    # @return [Hash] response body
+    def get_json(path)
+      @res = client.get("#{@base_uri}#{path}")
+      handle_error(@res)
+      JSON.parse(@res.body)
+    end
+
+    # POST the JSON API
+    # @param [String] path
+    # @param [Hash] data 
+    # @return [Hash] response body
+    def post_json(path, data = {})
+      pp data if @debug
+      @res = client.post("#{@base_uri}#{path}", data)
+      handle_error(@res)
+      JSON.parse(@res.body)
+    end
+
+    # Post parameters to a graph, POST /api/graphs/:path
+    # @param [String] path
+    # @param [Hash] params The POST parameters. 
+    # @return [Hash] the error code and graph property
+    # @example
+    # {"error":0,
+    # "data":{
+    #   "number":"1",
+    #   "llimit":"-1000000000",
+    #   "mode":"gauge",
+    #   "stype":"AREA",
+    #   "adjustval":"1",
+    #   "meta":"",
+    #   "service_name":"multiforecast",
+    #   "gmode":"gauge",
+    #   "color":"#cc6633",
+    #   "created_at":"2013/08/29 11:58:15",
+    #   "section_name":"foo%2Fbar%2Ffoo",
+    #   "ulimit":"1000000000",
+    #   "id":"2",
+    #   "graph_name":"bar",
+    #   "description":"",
+    #   "sulimit":"100000",
+    #   "unit":"","sort":"0",
+    #   "updated_at":"2013/08/29 11:58:15",
+    #   "adjust":"*",
+    #   "path":"foo/bar/foo/bar",
+    #   "type":"AREA",
+    #   "sllimit":"-100000",
+    #   "md5":"c81e728d9d4c2f636f067f89cc14862c"}
+    def post_graph(path, params)
+      post_json("/api/graphs/#{escape path}", params)
+    end
+
+    # Get parameters from a graph, GET /api/graphs/:path
+    # @param [String] path
+    # @return [Hash] the graph property
+    # @example
+    # {
+    #   "number":"1",
+    #   "llimit":"-1000000000",
+    #   "mode":"gauge",
+    #   "stype":"AREA",
+    #   "adjustval":"1",
+    #   "meta":"",
+    #   "service_name":"multiforecast",
+    #   "gmode":"gauge",
+    #   "color":"#cc6633",
+    #   "created_at":"2013/08/29 11:58:15",
+    #   "section_name":"foo%2Fbar%2Ffoo",
+    #   "ulimit":"1000000000",
+    #   "id":"2",
+    #   "graph_name":"bar",
+    #   "description":"",
+    #   "sulimit":"100000",
+    #   "unit":"","sort":"0",
+    #   "updated_at":"2013/08/29 11:58:15",
+    #   "adjust":"*",
+    #   "path":"foo/bar/foo/bar",
+    #   "type":"AREA",
+    #   "sllimit":"-100000",
+    #   "md5":"c81e728d9d4c2f636f067f89cc14862c"}
+    def get_graph(path)
+      get_json("/api/graphs/#{escape path}")
+    end
+
+    private
+
+    def escape(str)
+      URI.escape(str) if str
+    end
+
+    def handle_error(res)
+      case res.status
+      when 200
+      when 201
+      when 404
+        raise NotFound.new(error_message(res))
+      when 409
+        raise AlreadyExists.new(error_message(res))
+      else
+        raise Error.new(error_message(res))
+      end
+    end
+
+    def error_message(res)
+      "status:#{res.status}\turi:#{res.http_header.request_uri.to_s}\tmessage:#{res.body}"
+    end
+  end
+end
+

data/lib/yohoushi-client.rb

@@ -0,0 +1 @@
+require 'yohoushi/client'

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+# encoding: utf-8
+require "bundler/setup"
+
+ENV['MOCK'] ||= 'on'
+require "pry"
+require "pry-nav"
+require 'yohoushi-client'
+require 'webmock/rspec'
+require 'cgi'
+WebMock.allow_net_connect! if ENV['MOCK'] == 'off'
+
+ROOT = File.dirname(__FILE__)
+Dir[File.expand_path("support/**/*.rb", ROOT)].each {|f| require f }
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+end

data/spec/support/helper.rb

@@ -0,0 +1,42 @@
+module Yohoushi::SpecHelper
+  def escape(str)
+    URI.escape(str) if str
+  end
+
+  def base_uri
+    'http://localhost:4804'
+  end
+
+  def client
+    Yohoushi::Client.new(base_uri)
+  end
+
+  def graph_example
+    {
+      "number"=>0,
+      "llimit"=>-1000000000,
+      "mode"=>"gauge",
+      "stype"=>"AREA",
+      "adjustval"=>"1",
+      "meta"=>"",
+      "service_name"=>"multiforecast",
+      "gmode"=>"gauge",
+      "color"=>"#cc6633",
+      "created_at"=>"2013/02/02 00:41:11",
+      "section_name"=>"foo%2Fbar%2Ffoo",
+      "ulimit"=>1000000000,
+      "id"=>1,
+      "graph_name"=>"bar",
+      "description"=>"",
+      "sulimit"=>100000,
+      "unit"=>"",
+      "sort"=>0,
+      "updated_at"=>"2013/02/02 02:32:10",
+      "adjust"=>"*",
+      "path"=>"foo/bar/foo/bar",
+      "type"=>"AREA",
+      "sllimit"=>-100000,
+      "md5"=>"3c59dc048e8850243be8079a5c74d079"
+    }
+  end
+end

data/spec/support/mock.rb

@@ -0,0 +1,17 @@
+# -*- encoding: utf-8 -*-
+
+shared_context "stub_get_graph" do
+  proc = Proc.new do
+    stub_request(:get, "#{base_uri}/api/graphs/#{escape graph['path']}").
+    to_return(:status => 200, :body => graph_example.to_json)
+  end
+  before(:each, &proc)
+end
+
+shared_context "stub_post_graph" do
+  include_context "stub_get_graph"
+  before do
+    stub_request(:post, "#{base_uri}/api/graphs/#{escape graph['path']}").
+    to_return(:status => 200, :body => { "error" => 0, "data" => graph_example }.to_json)
+  end
+end

data/spec/yohoushi/cli_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+require 'yohoushi/cli'
+
+describe Yohoushi::CLI do
+  before(:all) { @cli = Yohoushi::CLI.new }
+
+  context "#graph_path" do
+    before { @url = 'http://localhost:4804/api/graphs/foo/bar' }
+    before { @path = @cli.graph_path(URI.parse(@url).path) }
+    it { @path.should == 'foo/bar' }
+  end
+
+  context "post" do
+    pending
+  end
+end
+

data/spec/yohoushi/client_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+describe Yohoushi::Client do
+  include Yohoushi::SpecHelper
+
+  graph_keys = %w[number llimit mode stype adjustval gmode color created_at ulimit description
+                  sulimit unit sort updated_at adjust type sllimit meta md5 path]
+
+  context "#post_graph" do
+    include_context "stub_post_graph" if ENV['MOCK'] == 'on'
+    include_context "stub_get_graph" if ENV['MOCK'] == 'on'
+    params = {
+      'number' => 0,
+    }
+    let(:graph) { graph_example }
+    subject { client.post_graph(graph["path"], params) }
+    it { subject["error"].should == 0 }
+    # params.keys.each {|key| it { subject["data"][key].should == params[key] } }
+  end
+
+  describe 'http://blog.64p.org/?page=1366971426' do
+    before { @client ||= client }
+    context "#client=" do
+      before { @client.client = HTTPClient.new(agent_name: 'TestAgent/0.1') }
+      it { @client.client.agent_name.should == 'TestAgent/0.1' }
+    end
+  end
+end
+

data/yohoushi-client.gemspec

@@ -0,0 +1,29 @@
+#! /usr/bin/env gem build
+# encoding: utf-8
+
+Gem::Specification.new do |gem|
+  gem.name          = 'yohoushi-client'
+  gem.version       = File.read(File.expand_path('VERSION', File.dirname(__FILE__))).chomp
+  gem.authors       = ["Naotoshi Seo"]
+  gem.email         = ["sonots@gmail.com"]
+  gem.homepage      = "https://github.com/yohoushi/yohoushi-client"
+  gem.summary       = "A Ruby Client Library for Yohoushi API"
+  gem.description   = gem.summary
+
+  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_runtime_dependency "httpclient"
+  gem.add_runtime_dependency "thor"
+
+  # for testing
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency "rspec", "~> 2.11"
+  gem.add_development_dependency "webmock"
+
+  # for debug
+  gem.add_development_dependency "pry"
+  gem.add_development_dependency "pry-nav"
+end

metadata

@@ -0,0 +1,168 @@
+--- !ruby/object:Gem::Specification
+name: yohoushi-client
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Naotoshi Seo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httpclient
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.11'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-nav
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A Ruby Client Library for Yohoushi API
+email:
+- sonots@gmail.com
+executables:
+- yohoushi-client
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- VERSION
+- bin/yohoushi-client
+- examples/create_graph.rb
+- lib/yohoushi-client.rb
+- lib/yohoushi/cli.rb
+- lib/yohoushi/client.rb
+- spec/spec_helper.rb
+- spec/support/helper.rb
+- spec/support/mock.rb
+- spec/yohoushi/cli_spec.rb
+- spec/yohoushi/client_spec.rb
+- yohoushi-client.gemspec
+homepage: https://github.com/yohoushi/yohoushi-client
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.2
+signing_key: 
+specification_version: 4
+summary: A Ruby Client Library for Yohoushi API
+test_files:
+- spec/spec_helper.rb
+- spec/support/helper.rb
+- spec/support/mock.rb
+- spec/yohoushi/cli_spec.rb
+- spec/yohoushi/client_spec.rb
+has_rdoc: