yao 0.1.1 → 0.2.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7de241c1b6e0fd16fbebd77ef168fb35672be6b6
-  data.tar.gz: 4985a66290b6ef759ebe5b010d86b94f2355db02
+  metadata.gz: 496e37a3be347d2be82ee61a2297dd8bd7271c97
+  data.tar.gz: 920987ae4956f2cc74be462eefd5fcd67c906c4a
 SHA512:
-  metadata.gz: 56ba2523368eaf6886d81b250f15e3b80b7c89919eec0e24c286129c991ede9518f10ffaab2400ecf661ebc0a2143114046b0c3c9af3e268b0f15d1ab859dbca
-  data.tar.gz: bfad2eef1088c14dc96cbc20a33838b687c8be6d17dbaf42a59d663186a3bd83b3524dd26a84cc41b90e459c5420bd3eda31483bf589f3b3e59b5eaefb4078b6
+  metadata.gz: 8ca3a1ad84d0d95d36aa0802ea71df5455435bcd2eebdfda3b54c9b4bd468b9ed51a36665d063d330dd42e5625f83af73089e4563abd490e7a4b341be6597c8b
+  data.tar.gz: 1ddced2029721ec76beabce11277085d4044b76223e2e3049e19dc9f32e4d8d5cc63dd7935a53dfd8c898bce18594cacb054b169efe4697b2b3c51701817cb26

data/lib/yao/client.rb

@@ -1,8 +1,7 @@
 require 'yao'
 require 'yao/config'
 require 'faraday'
-require 'faraday_middleware'
-require 'yao/faraday_middlewares'
+require 'yao/plugins/default_client_generator'
 
 module Yao
   module Client
@@ -42,34 +41,13 @@ module Yao
     class << self
       attr_accessor :default_client
 
-      def client_generator_hook
-        lambda do |f, token|
-          f.request :url_encoded
-          f.request :json
-
-          if token
-            f.request :os_token, token
-          end
-
-          f.response :os_error_detector
-          f.response :json, :content_type => /\bjson$/
-
-          if Yao.config.debug
-            f.response :logger
-            f.response :os_dumper
-          end
-
-          if Yao.config.debug_record_response
-            f.response :os_response_recorder
-          end
-
-          f.adapter Faraday.default_adapter
-        end
+      def client_generator
+        Plugins::Registry.instance[:client_generator][Yao.config.client_generator].new
       end
 
       def gen_client(endpoint, token: nil)
         Faraday.new( endpoint ) do |f|
-          client_generator_hook.call(f, token)
+          client_generator.call(f, token)
         end
       end
 

data/lib/yao/faraday_middlewares.rb

@@ -1,5 +1,18 @@
 require 'faraday'
 
+class Faraday::Request::Accept
+  def initialize(app, accept=nil)
+    @app = app
+    @accept = accept || 'application/json'
+  end
+
+  def call(env)
+    env[:request_headers]['Accept'] = @accept
+    @app.call(env)
+  end
+end
+Faraday::Request.register_middleware accept: -> { Faraday::Request::Accept }
+
 class Faraday::Request::OSToken
   def initialize(app, token)
     @app = app

data/lib/yao/plugins/default_client_generator.rb

@@ -0,0 +1,37 @@
+require 'yao/plugins'
+require 'faraday'
+require 'faraday_middleware'
+require 'yao/faraday_middlewares'
+
+module Yao::Plugins
+  class DefaultClientGenerator
+    def call(f, token)
+      f.request :accept, 'application/json'
+      f.request :url_encoded
+
+      if token
+        f.request :os_token, token
+      end
+
+      f.response :os_error_detector
+      f.response :json, :content_type => /\bjson$/
+
+      if Yao.config.debug
+        f.response :logger
+        f.response :os_dumper
+      end
+
+      if Yao.config.debug_record_response
+        f.response :os_response_recorder
+      end
+
+      f.adapter Faraday.default_adapter
+    end
+
+    Yao::Plugins.register(self, type: :client_generator)
+
+    Yao.config.param :client_generator, :default do |v|
+      raise("Invalid client_generator name %s.\nNote: name must be a Symbol" % v.inspect) unless Registry.instance[:client_generator][v]
+    end
+  end
+end

data/lib/yao/plugins/registry.rb

@@ -0,0 +1,25 @@
+require 'singleton'
+
+module Yao::Plugins
+  class Registry
+    include Singleton
+
+    def initialize
+      @types = {}
+    end
+
+    def [](type)
+      @types[type]
+    end
+
+    def register(klass, type: nil, name: :default)
+      raise("Plugin registration requires both type and name.") if !type or !name
+      @types[type] ||= {}
+      @types[type][name] = klass
+    end
+  end
+
+  def self.register(*a)
+    Registry.instance.register(*a)
+  end
+end

data/lib/yao/plugins.rb

@@ -0,0 +1,3 @@
+module Yao::Plugins; end
+
+require 'yao/plugins/registry'

data/lib/yao/resources/action.rb

@@ -0,0 +1,16 @@
+module Yao::Resources
+  module Action
+    def action(id, query)
+      res = POST(action_path(id)) do |req|
+        req.body = query.to_json
+        req.headers['Content-Type'] = 'application/json'
+      end
+      return_resource(res.body[resource_name_in_json])
+    end
+
+    private
+    def action_path(id)
+      [resources_name, id, "action"].join("/")
+    end
+  end
+end

data/lib/yao/resources/meter.rb

@@ -0,0 +1,36 @@
+module Yao::Resources
+  class Meter < Base
+    friendly_attributes :meter_id, :name, :user_id, :resource_id, :project_id, :source, :type, :unit
+
+    def id
+      meter_id
+    end
+
+    def resource
+      @resource ||= Yao::Resource.get(resource_id)
+    end
+
+    def tenant
+      @tenant ||= Yao::User.get(project_id)
+    end
+
+    def user
+      @user ||= Yao::User.get(user_id)
+    end
+
+    self.service        = "metering"
+    self.api_version    = "v2"
+    self.resources_name = "meters"
+
+    class << self
+      private
+      def resource_from_json(json)
+        json
+      end
+
+      def resources_from_json(json)
+        json
+      end
+    end
+  end
+end

data/lib/yao/resources/resource.rb

@@ -0,0 +1,54 @@
+require 'time'
+module Yao::Resources
+  class Resource < Base
+    friendly_attributes :user_id, :resource_id, :project_id,
+                        :last_sample_timestamp, :first_sample_timestamp,
+                        :metadata,
+                        :links
+
+    def id
+      resource_id
+    end
+
+    def tenant
+      @tenant ||= Yao::User.get(project_id)
+    end
+
+    def user
+      @user ||= Yao::User.get(user_id)
+    end
+
+    def last_sampled_at
+      Time.parse last_sample_timestamp
+    end
+
+    def first_sampled_at
+      Time.parse first_sample_timestamp
+    end
+
+    def get_meter(name)
+      if link = links.find{|l| l["rel"] == name }
+        Yao::Sample.list(link["href"])
+      end
+    end
+
+    def meters
+      links.map{|l| l["rel"] }.delete_if{|n| n == 'self' }
+    end
+
+    self.service        = "metering"
+    self.api_version    = "v2"
+    self.resources_name = "resources"
+
+    class << self
+      private
+      def resource_from_json(json)
+        json
+      end
+
+      def resources_from_json(json)
+        json
+      end
+    end
+  end
+end

data/lib/yao/resources/restfully_accessible.rb

@@ -18,10 +18,17 @@ module Yao::Resources
     def service=(name)
       @service = name
     end
+    attr_reader :service
 
-    def service
-      @service
+    def api_version=(v)
+      raise("Set api_version after service is declared") unless service
+      @api_version = v
+      if cli = client
+        cli.url_prefix.path = "/#{api_version}"
+      end
+      api_version
     end
+    attr_reader :api_version
 
     def admin=(bool)
       @admin = bool
@@ -71,14 +78,18 @@ module Yao::Resources
     def list(query={})
       json = GET(resources_path, query).body
       if @return_single_on_querying && !query.empty?
-        return_resource(json[resource_name_in_json])
+        return_resource(resource_from_json(json))
       else
-        return_resources(json[resources_name_in_json])
+        return_resources(resources_from_json(json))
       end
     end
 
     def list_detail(query={})
-      return_resources(GET([resources_path, "detail"].join("/"), query).body[resources_name_in_json])
+      return_resources(
+        resources_from_json(
+          GET([resources_path, "detail"].join("/"), query).body
+        )
+      )
     end
 
     def get(id_or_permalink, query={})
@@ -87,7 +98,7 @@ module Yao::Resources
             else
               GET([resources_path, id_or_permalink].join("/"), query)
             end
-      return_resource(res.body[resource_name_in_json])
+      return_resource(resource_from_json(res.body))
     end
     alias find get
 
@@ -99,7 +110,7 @@ module Yao::Resources
         req.body = params.to_json
         req.headers['Content-Type'] = 'application/json'
       end
-      return_resource(res.body[resource_name_in_json])
+      return_resource(resource_from_json(res.body))
     end
 
     def update(id, resource_params)
@@ -110,7 +121,7 @@ module Yao::Resources
         req.body = params.to_json
         req.headers['Content-Type'] = 'application/json'
       end
-      return_resource(res.body[resource_name_in_json])
+      return_resource(resource_from_json(res.body))
     end
 
     def destroy(id)
@@ -119,12 +130,14 @@ module Yao::Resources
     end
 
     private
-    def resource_name_in_json
+    def resource_from_json(json)
       @resource_name_in_json  ||= resource_name.sub(/^os-/, "").tr("-", "_")
+      json[@resource_name_in_json]
     end
 
-    def resources_name_in_json
+    def resources_from_json(json)
       @resources_name_in_json ||= resources_name.sub(/^os-/, "").tr("-", "_")
+      json[@resources_name_in_json]
     end
 
     def return_resource(d)

data/lib/yao/resources/sample.rb

@@ -0,0 +1,43 @@
+module Yao::Resources
+  class Sample < Base
+    friendly_attributes :counter_name, :counter_type, :counter_unit, :counter_volume,
+                        :message_id, :project_id, :resource_id, :timestamp, :resource_metadata, :user_id
+                        :source
+
+    def recorded_at
+      Time.parse(self["recorded_at"] || self["timestamp"])
+    end
+    alias timestamp recorded_at
+
+    def id
+      meter_id
+    end
+
+    def resource
+      @resource ||= Yao::Resource.get(resource_id)
+    end
+
+    def tenant
+      @tenant ||= Yao::User.get(project_id)
+    end
+
+    def user
+      @user ||= Yao::User.get(user_id)
+    end
+
+    self.service        = "metering"
+    self.api_version    = "v2"
+
+    # get /v2/meters/{id} returns samples!
+    def self.list(id_or_url, query={})
+      json = if id_or_url =~ /^https?:\/\//
+               GET(id_or_url).body
+             else
+               GET("meters/#{id_or_url}", query).body
+             end
+      return_resources(json)
+    end
+
+    # TODO: implement `def self.create'
+  end
+end

data/lib/yao/resources/server.rb

@@ -1,4 +1,5 @@
 require 'yao/resources/metadata_available'
+require 'yao/resources/action'
 module Yao::Resources
   class Server < Base
     friendly_attributes :addresses, :metadata, :name, :progress,
@@ -21,6 +22,19 @@ module Yao::Resources
     self.resource_name  = "server"
     self.resources_name = "servers"
 
+    def self.shutoff(id)
+      action(id, "os-stop" => nil)
+    end
+
+    def self.reboot(id)
+      action(id,"reboot" => { "type" => "HARD" })
+    end
+
+    def self.resize(id, flavor_id)
+      action(id,"resize" => { "flavorRef" => flavor_id })
+    end
+
     extend MetadataAvailable
+    extend Action
   end
 end

data/lib/yao/resources.rb

@@ -17,6 +17,10 @@ module Yao
     autoload :Host,              "yao/resources/host"
     autoload :User,              "yao/resources/user"
     autoload :Role,              "yao/resources/role"
+
+    autoload :Resource,          "yao/resources/resource"
+    autoload :Meter,             "yao/resources/meter"
+    autoload :Sample,            "yao/resources/sample"
   end
 
   def self.const_missing(name)

data/lib/yao/version.rb

@@ -1,3 +1,3 @@
 module Yao
-  VERSION = "0.1.1"
+  VERSION = "0.2.0.rc1"
 end

data/lib/yao.rb

@@ -4,6 +4,7 @@ module Yao
 end
 
 require 'yao/config'
+require 'yao/plugins'
 require 'yao/client'
 require 'yao/auth'
 require 'yao/resources'

data/test/yao/test_client.rb

@@ -9,8 +9,8 @@ class TestClient < Test::Unit::TestCase
     assert { cli.url_prefix.to_s == "http://cool-api.example.com:12345/v3.0" }
 
     handlers = [
+      Faraday::Request::Accept,
       Faraday::Request::UrlEncoded,
-      FaradayMiddleware::EncodeJson,
       Faraday::Response::OSErrorDetector,
       FaradayMiddleware::ParseJson,
       Faraday::Adapter::NetHttp
@@ -21,8 +21,8 @@ class TestClient < Test::Unit::TestCase
   def test_gen_with_token
     cli = Yao::Client.gen_client("http://cool-api.example.com:12345/v3.0", token: "deadbeaf")
     handlers = [
+      Faraday::Request::Accept,
       Faraday::Request::UrlEncoded,
-      FaradayMiddleware::EncodeJson,
       Faraday::Request::OSToken,
       Faraday::Response::OSErrorDetector,
       FaradayMiddleware::ParseJson,
@@ -36,8 +36,8 @@ class TestClient < Test::Unit::TestCase
 
     cli = Yao::Client.gen_client("http://cool-api.example.com:12345/v3.0")
     handlers = [
+      Faraday::Request::Accept,
       Faraday::Request::UrlEncoded,
-      FaradayMiddleware::EncodeJson,
       Faraday::Response::OSErrorDetector,
       FaradayMiddleware::ParseJson,
       Faraday::Response::Logger,

data/test/yao/test_client_plugin.rb

@@ -0,0 +1,38 @@
+class TestClientPlugin < Test::Unit::TestCase
+  def setup
+    stub(Yao.config).debug { false }
+    stub(Yao.config).debug_record_response { false }
+  end
+
+  def teardown
+    Yao.config.set :client_generator, :default
+  end
+
+  def test_raise_invalid_name
+    e = nil
+    begin
+      Yao.config.set :client_generator, :nonexist
+    rescue => e
+    end
+
+    assert { e.is_a? StandardError }
+    assert { e.message == "Invalid client_generator name :nonexist.\nNote: name must be a Symbol" }
+  end
+
+  class ::Yao::Plugins::TestCustomClientGenerator
+    def call(f, t)
+      f.response :xml, :content_type => /\/xml$/
+    end
+    ::Yao::Plugins.register self, type: :client_generator, name: :test_custom
+  end
+
+  def test_gen_client_with_custom
+    Yao.config.set :client_generator, :test_custom
+
+    cli = Yao::Client.gen_client("http://cool-api.example.com:12345/v3.0")
+    handlers = [
+      FaradayMiddleware::ParseXml,
+    ]
+    assert { cli.builder.handlers == handlers }
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yao
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0.rc1
 platform: ruby
 authors:
 - Uchio, KONDO
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-05 00:00:00.000000000 Z
+date: 2015-11-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -170,7 +170,11 @@ files:
 - lib/yao/config.rb
 - lib/yao/faraday_middlewares.rb
 - lib/yao/is_openstack_client.rb
+- lib/yao/plugins.rb
+- lib/yao/plugins/default_client_generator.rb
+- lib/yao/plugins/registry.rb
 - lib/yao/resources.rb
+- lib/yao/resources/action.rb
 - lib/yao/resources/base.rb
 - lib/yao/resources/flavor.rb
 - lib/yao/resources/floating_ip.rb
@@ -179,10 +183,13 @@ files:
 - lib/yao/resources/image.rb
 - lib/yao/resources/keypair.rb
 - lib/yao/resources/metadata_available.rb
+- lib/yao/resources/meter.rb
 - lib/yao/resources/network.rb
 - lib/yao/resources/port.rb
+- lib/yao/resources/resource.rb
 - lib/yao/resources/restfully_accessible.rb
 - lib/yao/resources/role.rb
+- lib/yao/resources/sample.rb
 - lib/yao/resources/security_group.rb
 - lib/yao/resources/security_group_rule.rb
 - lib/yao/resources/server.rb
@@ -195,6 +202,7 @@ files:
 - test/config.rb
 - test/yao/test_auth.rb
 - test/yao/test_client.rb
+- test/yao/test_client_plugin.rb
 - test/yao/test_config.rb
 - test/yao/test_server_error.rb
 - test/yao/test_token.rb
@@ -214,12 +222,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.3
+rubygems_version: 2.2.5
 signing_key: 
 specification_version: 4
 summary: Yet Another OpenStack API Wrapper that rocks!!
@@ -227,6 +235,7 @@ test_files:
 - test/config.rb
 - test/yao/test_auth.rb
 - test/yao/test_client.rb
+- test/yao/test_client_plugin.rb
 - test/yao/test_config.rb
 - test/yao/test_server_error.rb
 - test/yao/test_token.rb