yao 0.2.7 → 0.2.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 53df9cfa1f201d10e411a9ec3214c6efd8126c5d
-  data.tar.gz: 4ffd45745dcb4e292128acd8fb1a660928fbf65c
+  metadata.gz: 1265dc90ca7a24dc73c1bea6f56dd54170ca1cd2
+  data.tar.gz: ae58d2f7e8b5c8830f2965e072e726bed04c982c
 SHA512:
-  metadata.gz: a7cba58804c3718d3de59e3d314a5ab41021a2c0274397a14e8d83185bae1f9c1b8a708afa87729d6389641cf776a05f644f5f729eaa3050ed9d941b15d9e060
-  data.tar.gz: 2c6d0e4aeabb425076e1fa4597079620489419ecfbc33ad0106c1e8696d617c454efc2aca4e60edb75f388bb181215ffc516d8cb5459255eb7f30b33d5582790
+  metadata.gz: 4c27613a24e52a2e1397e73a18d44d54335cf249a5eed33be21a5f37ec91f8ab9a33ebc8be030a8fa0ecc0faf4a83831c5d46d804f2c2287ff3d4215fb69629a
+  data.tar.gz: f6879388cb203aa0b481d24a5597fffd628e351f253c50ad1d173292ab5e541bcf20e72c0613fee73627a064f1edf7d7fba1542e53cfb2336cb5049c36ac09f2

data/lib/yao/client.rb

@@ -69,6 +69,9 @@ module Yao
     Yao::Client.default_client
   end
 
+  Yao.config.param :noop_on_write, false
+  Yao.config.param :raise_on_write, false
+
   Yao.config.param :debug, false
   Yao.config.param :debug_record_response, false
 end

data/lib/yao/{server_error.rb → error.rb}

@@ -1,4 +1,6 @@
 module Yao
+  class ReadOnlyViolationError < ::StandardError; end
+
   class ServerError < ::StandardError
     def initialize(message, requested_env)
       @status = requested_env.status

data/lib/yao/faraday_middlewares.rb

@@ -1,4 +1,5 @@
 require 'faraday'
+require 'yao/error'
 
 class Faraday::Request::Accept
   def initialize(app, accept=nil)
@@ -30,6 +31,39 @@ class Faraday::Request::OSToken
 end
 Faraday::Request.register_middleware os_token: -> { Faraday::Request::OSToken }
 
+class Faraday::Request::ReadOnly
+  def initialize(app)
+    @app = app
+  end
+
+  def call(env)
+    return @app.call(env) if allowed_request?(env)
+
+    if Yao.config.raise_on_write
+      raise Yao::ReadOnlyViolationError
+    elsif Yao.config.noop_on_write
+      env
+    else
+      @app.call(env)
+    end
+  end
+
+  private
+
+  ALLOWED_REQUESTS = [
+    {method: :post, path: "/v2.0/tokens"}
+  ]
+
+  def allowed_request?(env)
+    return true if env[:method] == :get
+
+    ALLOWED_REQUESTS.any? do |allowed|
+      env[:method] == allowed[:method] && env[:url].path == allowed[:path]
+    end
+  end
+end
+Faraday::Request.register_middleware read_only: -> { Faraday::Request::ReadOnly }
+
 class Faraday::Response::OSDumper < Faraday::Response::Middleware
   def on_complete(env)
     require 'pp'
@@ -74,6 +108,8 @@ class Faraday::Response::OSResponseRecorder < Faraday::Response::Middleware
   def on_complete(env)
     require 'pathname'
     root = Pathname.new(File.expand_path('../../../tmp', __FILE__))
+    Dir.mkdir(root) unless File.exist?(root)
+
     path = [env.method.to_s.upcase, env.url.path.gsub('/', '-')].join("-") + ".json"
 
     puts root.join(path)
@@ -84,7 +120,6 @@ class Faraday::Response::OSResponseRecorder < Faraday::Response::Middleware
 end
 Faraday::Response.register_middleware os_response_recorder: -> { Faraday::Response::OSResponseRecorder }
 
-require 'yao/server_error'
 class Faraday::Response::OSErrorDetector < Faraday::Response::Middleware
   # TODO: Better handling, respecting official doc
   def on_complete(env)

data/lib/yao/mode.rb

@@ -0,0 +1,35 @@
+module Yao
+  module Mode
+    def read_only!(&blk)
+      raise unless block_given?
+
+      raise_on_write_org = Yao.config.raise_on_write
+      noop_on_write_org  = Yao.config.noop_on_write
+
+      Yao.config.set :noop_on_write, false if noop_on_write_org
+      Yao.config.set :raise_on_write, true
+      begin
+        yield
+      ensure
+        Yao.config.set :raise_on_write, raise_on_write_org
+        Yao.config.set :noop_on_write,  noop_on_write_org
+      end
+    end
+
+    def read_only(&blk)
+      raise unless block_given?
+
+      noop_on_write_org  = Yao.config.noop_on_write
+      raise_on_write_org = Yao.config.raise_on_write
+
+      Yao.config.set :raise_on_write, false if raise_on_write_org
+      Yao.config.set :noop_on_write, true
+      begin
+        yield
+      ensure
+        Yao.config.set :noop_on_write,  noop_on_write_org
+        Yao.config.set :raise_on_write, raise_on_write_org
+      end
+    end
+  end
+end

data/lib/yao/plugins/default_client_generator.rb

@@ -13,6 +13,8 @@ module Yao::Plugins
         f.request :os_token, token
       end
 
+      f.request :read_only
+
       f.response :os_error_detector
       f.response :json, :content_type => /\bjson$/
 

data/lib/yao/resources/restfully_accessible.rb

@@ -57,18 +57,18 @@ module Yao::Resources
     def as_member(&blk)
       if @admin
         @admin = false
-        result = yield(blk)
+        result = yield
         @admin = true
         result
       else
-        yield blk
+        yield
       end
     end
 
     def with_resources_path(path, &blk)
       original = @resources_path
       @resources_path = path
-      result = yield(blk)
+      result = yield
       @resources_path = original
 
       result

data/lib/yao/version.rb

@@ -1,3 +1,3 @@
 module Yao
-  VERSION = "0.2.7"
+  VERSION = "0.2.8"
 end

data/lib/yao.rb

@@ -1,6 +1,8 @@
 require "yao/version"
+require 'yao/mode'
 
 module Yao
+  extend Mode
 end
 
 require 'yao/config'

data/test/config.rb

@@ -3,6 +3,8 @@ require 'test/unit/rr'
 require 'power_assert'
 require 'yao'
 
+require 'support/auth_stub'
+
 require 'webmock/test_unit'
 
 WebMock.disable_net_connect!

data/test/support/auth_stub.rb

@@ -0,0 +1,117 @@
+module AuthStub
+  def stub_auth_request(auth_url, username, password, tenant)
+    stub_request(:post, "#{auth_url}/v2.0/tokens")
+      .with(
+        body: auth_json(username, password, tenant)
+      ).to_return(
+        :status => 200,
+        :body => response_json(auth_url, username, tenant),
+        :headers => {'Content-Type' => 'application/json'}
+      )
+  end
+
+  private
+
+  def auth_json(username, password, tenant)
+    json = <<-JSON
+{"auth":{"passwordCredentials":{"username":"#{username}","password":"#{password}"},"tenantName":"#{tenant}"}}
+    JSON
+
+    json.strip
+  end
+
+  def response_json(auth_url, username, tenant)
+    <<-JSON
+{
+  "access": {
+    "token": {
+      "issued_at": "#{Time.now.iso8601}",
+      "expires": "#{(Time.now + 3600).utc.iso8601}",
+      "id": "aaaa166533fd49f3b11b1cdce2430000",
+      "tenant": {
+        "description": "Testing",
+        "enabled": true,
+        "id": "aaaa166533fd49f3b11b1cdce2430000",
+        "name": "#{tenant}"
+      }
+    },
+    "serviceCatalog": [
+      {
+        "endpoints": [
+          {
+            "adminURL": "http://nova-endpoint.example.com:8774/v2/b598bf98671c47e1b955f8c9660e3c44",
+            "region": "RegionOne",
+            "internalURL": "http://nova-endpoint.example.com:8774/v2/b598bf98671c47e1b955f8c9660e3c44",
+            "id": "1a66e6af97c440b2a7bbc4f9735923d9",
+            "publicURL": "http://nova-endpoint.example.com:8774/v2/b598bf98671c47e1b955f8c9660e3c44"
+          }
+        ],
+        "endpoints_links": [],
+        "type": "compute",
+        "name": "nova"
+      },
+      {
+        "endpoints": [
+          {
+            "adminURL": "http://neutron-endpoint.example.com:9696/",
+            "region": "RegionOne",
+            "internalURL": "http://neutron-endpoint.example.com:9696/",
+            "id": "0418104da877468ca65d739142fa3454",
+            "publicURL": "http://neutron-endpoint.example.com:9696/"
+          }
+        ],
+        "endpoints_links": [],
+        "type": "network",
+        "name": "neutron"
+      },
+      {
+        "endpoints": [
+          {
+            "adminURL": "http://glance-endpoint.example.com:9292",
+            "region": "RegionOne",
+            "internalURL": "http://glance-endpoint.example.com:9292",
+            "id": "246f33509ff64802b86eb081307ecec0",
+            "publicURL": "http://glance-endpoint.example.com:9292"
+          }
+        ],
+        "endpoints_links": [],
+        "type": "image",
+        "name": "glance"
+      },
+      {
+        "endpoints": [
+          {
+            "adminURL": "#{auth_url}/v2.0",
+            "region": "RegionOne",
+            "internalURL": "http://endpoint.example.com:5000/v2.0",
+            "id": "2b982236cc084128bf42b647c1b7fb49",
+            "publicURL": "http://endpoint.example.com:5000/v2.0"
+          }
+        ],
+        "endpoints_links": [],
+        "type": "identity",
+        "name": "keystone"
+      }
+    ],
+    "user": {
+      "username": "#{username}",
+      "roles_links": [],
+      "id": "a9994b2dee82423da7da572397d3157a",
+      "roles": [
+        {
+          "name": "admin"
+        }
+      ],
+      "name": "#{username}"
+    },
+    "metadata": {
+      "is_admin": 0,
+      "roles": [
+        "ce5330c512cc4bd289b3a725ad1106b7"
+      ]
+    }
+  }
+}
+    JSON
+  end
+end

data/test/yao/test_auth.rb

@@ -1,107 +1,16 @@
 class TestAuth < Test::Unit::TestCase
-
-  AUTH_JSON = \
-    "{\"auth\":{\"passwordCredentials\":{\"username\":\"udzura\",\"password\":\"XXXXXXXX\"},\"tenantName\":\"example\"}}"
-
-  RESPONSE_JSON = <<-JSON
-{
-  "access": {
-    "token": {
-      "issued_at": "2015-08-31T03:58:36.073232",
-      "expires": "2015-09-01T03:58:36Z",
-      "id": "aaaa166533fd49f3b11b1cdce2430000",
-      "tenant": {
-        "description": "Testing",
-        "enabled": true,
-        "id": "aaaa166533fd49f3b11b1cdce2430000",
-        "name": "example"
-      }
-    },
-    "serviceCatalog": [
-      {
-        "endpoints": [
-          {
-            "adminURL": "http://nova-endpoint.example.com:8774/v2/b598bf98671c47e1b955f8c9660e3c44",
-            "region": "RegionOne",
-            "internalURL": "http://nova-endpoint.example.com:8774/v2/b598bf98671c47e1b955f8c9660e3c44",
-            "id": "1a66e6af97c440b2a7bbc4f9735923d9",
-            "publicURL": "http://nova-endpoint.example.com:8774/v2/b598bf98671c47e1b955f8c9660e3c44"
-          }
-        ],
-        "endpoints_links": [],
-        "type": "compute",
-        "name": "nova"
-      },
-      {
-        "endpoints": [
-          {
-            "adminURL": "http://neutron-endpoint.example.com:9696/",
-            "region": "RegionOne",
-            "internalURL": "http://neutron-endpoint.example.com:9696/",
-            "id": "0418104da877468ca65d739142fa3454",
-            "publicURL": "http://neutron-endpoint.example.com:9696/"
-          }
-        ],
-        "endpoints_links": [],
-        "type": "network",
-        "name": "neutron"
-      },
-      {
-        "endpoints": [
-          {
-            "adminURL": "http://glance-endpoint.example.com:9292",
-            "region": "RegionOne",
-            "internalURL": "http://glance-endpoint.example.com:9292",
-            "id": "246f33509ff64802b86eb081307ecec0",
-            "publicURL": "http://glance-endpoint.example.com:9292"
-          }
-        ],
-        "endpoints_links": [],
-        "type": "image",
-        "name": "glance"
-      },
-      {
-        "endpoints": [
-          {
-            "adminURL": "http://endpoint.example.com:12345/v2.0",
-            "region": "RegionOne",
-            "internalURL": "http://endpoint.example.com:5000/v2.0",
-            "id": "2b982236cc084128bf42b647c1b7fb49",
-            "publicURL": "http://endpoint.example.com:5000/v2.0"
-          }
-        ],
-        "endpoints_links": [],
-        "type": "identity",
-        "name": "keystone"
-      }
-    ],
-    "user": {
-      "username": "udzura",
-      "roles_links": [],
-      "id": "a9994b2dee82423da7da572397d3157a",
-      "roles": [
-        {
-          "name": "admin"
-        }
-      ],
-      "name": "udzura"
-    },
-    "metadata": {
-      "is_admin": 0,
-      "roles": [
-        "ce5330c512cc4bd289b3a725ad1106b7"
-      ]
-    }
-  }
-}
-  JSON
+  include AuthStub
 
   def setup
-    stub_request(:post, "http://endpoint.example.com:12345/v2.0/tokens").with(body: AUTH_JSON)
-      .to_return(:status => 200, :body => RESPONSE_JSON, :headers => {'Content-Type' => 'application/json'})
+    @auth_url = "http://endpoint.example.com:12345"
+    username = "udzura"
+    tenant   = "example"
+    password = "XXXXXXXX"
+
+    stub_auth_request(@auth_url, username, password, tenant)
 
-    Yao.config.set :auth_url, "http://endpoint.example.com:12345"
-    @token = Yao::Auth.new(tenant_name: "example", username: "udzura", password: "XXXXXXXX")
+    Yao.config.set :auth_url, @auth_url
+    @token = Yao::Auth.new(tenant_name: tenant, username: username, password: password)
   end
 
   def teardown
@@ -132,8 +41,7 @@ class TestAuth < Test::Unit::TestCase
 
   def test_token_is_valid
     assert { @token.token == "aaaa166533fd49f3b11b1cdce2430000" }
-    assert { @token.issued_at == Time.parse("2015-08-31T03:58:36.073232") }
-    assert { @token.expire_at == Time.parse("2015-09-01T03:58:36Z") }
+    assert { @token.expire_at - @token.issued_at == 3600 }
     assert { @token.endpoints.size == 4 }
   end
 

data/test/yao/test_client.rb

@@ -11,6 +11,7 @@ class TestClient < Test::Unit::TestCase
     handlers = [
       Faraday::Request::Accept,
       Faraday::Request::UrlEncoded,
+      Faraday::Request::ReadOnly,
       Faraday::Response::OSErrorDetector,
       FaradayMiddleware::ParseJson,
       Faraday::Adapter::NetHttp
@@ -24,6 +25,7 @@ class TestClient < Test::Unit::TestCase
       Faraday::Request::Accept,
       Faraday::Request::UrlEncoded,
       Faraday::Request::OSToken,
+      Faraday::Request::ReadOnly,
       Faraday::Response::OSErrorDetector,
       FaradayMiddleware::ParseJson,
       Faraday::Adapter::NetHttp
@@ -38,6 +40,7 @@ class TestClient < Test::Unit::TestCase
     handlers = [
       Faraday::Request::Accept,
       Faraday::Request::UrlEncoded,
+      Faraday::Request::ReadOnly,
       Faraday::Response::OSErrorDetector,
       FaradayMiddleware::ParseJson,
       Faraday::Response::Logger,

data/test/yao/test_read_only.rb

@@ -0,0 +1,114 @@
+class TestOnly < Test::Unit::TestCase
+  include AuthStub
+
+  def setup
+    auth_url = "http://endpoint.example.com:12345"
+    username = "udzura"
+    tenant   = "example"
+    password = "XXXXXXXX"
+
+    stub_auth_request(auth_url, username, password, tenant)
+
+    Yao.configure do
+      auth_url    auth_url
+      username    username
+      tenant_name tenant
+      password    password
+    end
+
+    @username = username
+    @get_stub  = stub_request(:get,  "#{auth_url}/v2.0/users?name=#{username}")
+    @post_stub = stub_request(:post, "#{auth_url}/v2.0/users")
+  end
+
+  def test_read_only
+    Yao.read_only do
+      Yao::User.get_by_name(@username)
+      Yao::User.create(name: "foo", email: "bar", password: "baz")
+    end
+
+    assert_requested @get_stub
+    assert_not_requested @post_stub
+  end
+
+  def test_read_only!
+    assert_raise Yao::ReadOnlyViolationError do
+      Yao.read_only! do
+        Yao::User.get_by_name(@username)
+        Yao::User.create(name: "foo", email: "bar", password: "baz")
+      end
+    end
+
+    assert_requested @get_stub
+    assert_not_requested @post_stub
+  end
+
+  def test_read_only_flags_life_cycle
+    assert_false Yao.config.noop_on_write
+    assert_false Yao.config.raise_on_write
+
+    assert_raise RuntimeError do
+      Yao.read_only do
+        assert_true Yao.config.noop_on_write
+        raise
+      end
+    end
+
+    assert_false Yao.config.noop_on_write
+    assert_false Yao.config.raise_on_write
+
+    assert_raise RuntimeError do
+      Yao.read_only! do
+        assert_true Yao.config.raise_on_write
+        raise
+      end
+    end
+
+    assert_false Yao.config.noop_on_write
+    assert_false Yao.config.raise_on_write
+  end
+
+  def test_reentrant_condition
+    Yao.read_only do
+      assert_true Yao.config.noop_on_write
+
+      Yao.read_only do
+        assert_true Yao.config.noop_on_write
+      end
+
+      assert_true Yao.config.noop_on_write
+    end
+
+    Yao.read_only! do
+      assert_true Yao.config.raise_on_write
+
+      Yao.read_only! do
+        assert_true Yao.config.raise_on_write
+      end
+
+      assert_true Yao.config.raise_on_write
+    end
+
+    Yao.read_only! do
+      assert_true Yao.config.raise_on_write
+
+      Yao.read_only do
+        assert_true  Yao.config.noop_on_write
+        assert_false Yao.config.raise_on_write
+      end
+
+      assert_true Yao.config.raise_on_write
+    end
+
+    Yao.read_only do
+      assert_true Yao.config.noop_on_write
+
+      Yao.read_only! do
+        assert_true  Yao.config.raise_on_write
+        assert_false Yao.config.noop_on_write
+      end
+
+      assert_true Yao.config.noop_on_write
+    end
+  end
+end

data/test/yao/test_token.rb

@@ -1,4 +1,6 @@
 class TestToken < Test::Unit::TestCase
+  include AuthStub
+
   def setup
     stub(Yao.config).debug { false }
     stub(Yao.config).debug_record_response { false }
@@ -22,37 +24,18 @@ class TestToken < Test::Unit::TestCase
     assert { ! t.expired? }
   end
 
-  AUTH_JSON = \
-    "{\"auth\":{\"passwordCredentials\":{\"username\":\"udzura\",\"password\":\"XXXXXXXX\"},\"tenantName\":\"example\"}}"
-
-  def gen_response_json
-    <<-JSON
-{
-  "access": {
-    "token": {
-      "issued_at": "#{Time.now.iso8601}",
-      "expires": "#{(Time.now + 3600).utc.iso8601}",
-      "id": "aaaa166533fd49f3b11b1cdce2430000",
-      "tenant": {
-        "description": "Testing",
-        "enabled": true,
-        "id": "aaaa166533fd49f3b11b1cdce2430000",
-        "name": "example"
-      }
-    },
-    "serviceCatalog": []
-  }
-}
-    JSON
-  end
-
   def test_reflesh
+    auth_url = "http://endpoint.example.com:12345"
+    username = "udzura"
+    tenant   = "example"
+    password = "XXXXXXXX"
+
     auth_info = {
       auth: {
         passwordCredentials: {
-          username: "udzura", password: "XXXXXXXX"
+          username: username, password: password
         },
-        tenantName: "example"
+        tenantName: tenant
       }
     }
     t = Yao::Token.new(auth_info)
@@ -63,10 +46,9 @@ class TestToken < Test::Unit::TestCase
       })
     assert { t.token == "old_token" }
 
-    stub_request(:post, "http://endpoint.example.com:12345/v2.0/tokens").with(body: AUTH_JSON)
-      .to_return(:status => 200, :body => gen_response_json, :headers => {'Content-Type' => 'application/json'})
+    stub_auth_request(auth_url, username, password, tenant)
 
-    Yao.config.auth_url "http://endpoint.example.com:12345"
+    Yao.config.auth_url auth_url
     t.reflesh(Yao.default_client.default)
 
     assert { t.token == "aaaa166533fd49f3b11b1cdce2430000" }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yao
 version: !ruby/object:Gem::Version
-  version: 0.2.7
+  version: 0.2.8
 platform: ruby
 authors:
 - Uchio, KONDO
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-08 00:00:00.000000000 Z
+date: 2016-01-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -169,8 +169,10 @@ files:
 - lib/yao/auth.rb
 - lib/yao/client.rb
 - lib/yao/config.rb
+- lib/yao/error.rb
 - lib/yao/faraday_middlewares.rb
 - lib/yao/is_openstack_client.rb
+- lib/yao/mode.rb
 - lib/yao/plugins.rb
 - lib/yao/plugins/default_client_generator.rb
 - lib/yao/plugins/registry.rb
@@ -198,14 +200,15 @@ files:
 - lib/yao/resources/subnet.rb
 - lib/yao/resources/tenant.rb
 - lib/yao/resources/user.rb
-- lib/yao/server_error.rb
 - lib/yao/token.rb
 - lib/yao/version.rb
 - test/config.rb
+- test/support/auth_stub.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_read_only.rb
 - test/yao/test_server_error.rb
 - test/yao/test_token.rb
 - yao-logo.png
@@ -230,15 +233,17 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.0
+rubygems_version: 2.2.3
 signing_key: 
 specification_version: 4
 summary: Yet Another OpenStack API Wrapper that rocks!!
 test_files:
 - test/config.rb
+- test/support/auth_stub.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_read_only.rb
 - test/yao/test_server_error.rb
 - test/yao/test_token.rb