misty 1.3.3 → 1.4.0

data/test/unit/misty_test.rb

@@ -75,7 +75,7 @@ describe Misty do
     end
 
     it 'has dns service' do
-      service = Misty::services.find { |s| s.name == :domain_name_server}
+      service = Misty::services.find { |s| s.name == :dns}
       validate_service(service)
       validate_versions(service)
     end

data/test/unit/openstack/service_test.rb

@@ -0,0 +1,52 @@
+require 'test_helper'
+require 'service_helper'
+require 'misty/openstack/service'
+
+describe Misty::Openstack::Service do
+  describe '#prefix_path_to_ignore' do
+    let(:service) do
+      service = Object.new
+      service.extend(Misty::Openstack::Service)
+      service
+    end
+
+    it "returns empty String when undefined in API's module" do
+      service.prefix_path_to_ignore.must_be_empty
+    end
+
+    it "returns String when defined in API's module" do
+      class << service
+        def prefix_path_to_ignore
+          '/v3/{tenant_id}'
+        end
+      end
+
+      service.prefix_path_to_ignore.must_equal '/v3/{tenant_id}'
+    end
+  end
+
+  describe '#requests' do
+    it 'returns list of requests' do
+      list = service.requests
+      list.must_be_kind_of Array
+      list.must_include :list_service_profiles
+    end
+  end
+
+  describe '#baseclass' do
+    it 'returns base class name' do
+      service.send(:baseclass).must_equal 'V2_0'
+    end
+  end
+
+  describe 'headers' do
+    it 'returns default global along with token' do
+      service.headers.get.must_equal ({"Accept"=>"application/json; q=1.0"})
+    end
+
+    it 'inject headers parameter' do
+      service(content_type = :hash, params = {:headers => {'Oh' => 'my!'}}).
+        headers.get.must_equal ({"Accept"=>"application/json; q=1.0", "Oh"=>"my!"})
+    end
+  end
+end

data/test/unit/service_helper.rb

@@ -1,31 +1,34 @@
 require 'misty/client_pack'
+require 'auth_helper'
 
 def request_header
   {'Accept' => 'application/json; q=1.0'}
 end
 
-def service(content_type = :ruby, params = {})
-  auth = Minitest::Mock.new
+def service(param_content_type = :hash, params = {})
+  arg = {
+    :auth => {
+      :url             => 'http://localhost:5000',
+      :user_id         => 'user_id',
+      :password        => 'secret',
+      :project_id      => 'project_id',
+      :ssl_verify_mode => false
+    },
+    :content_type => param_content_type,
+  }
+  arg.merge!(params)
 
-  def auth.get_url(*args)
-    'http://localhost'
-  end
+  stub_request(:post, "http://localhost:5000/v3/auth/tokens").
+    with(:body => "{\"auth\":{\"identity\":{\"methods\":[\"password\"],\"password\":{\"user\":{\"id\":\"user_id\",\"password\":\"secret\"}}},\"scope\":{\"project\":{\"id\":\"project_id\"}}}}",
+       :headers => {'Accept'=>'application/json', 'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', 'Content-Type'=>'application/json', 'User-Agent'=>'Ruby'}).
+    to_return(:status => 200, :body =>  JSON.dump(auth_response_v3('networking', 'neutron')), :headers => {'x-subject-token'=>'token_data'})
 
-  def auth.get_token
-    'token_id'
-  end
+  config = Misty::Config.new(arg)
 
-  setup = Misty::Cloud::Config.new
-  setup.content_type = content_type
-  setup.log = Logger.new('/dev/null')
-  setup.interface = Misty::INTERFACE
-  setup.region_id = Misty::REGION_ID
-  setup.ssl_verify_mode = Misty::SSL_VERIFY_MODE
-  setup.headers = Misty::HTTP::Header.new('Accept' => 'application/json; q=1.0')
+# TODO: remove
+#  stub_request(:post, 'http://localhost:5000/v3/auth/tokens').
+#    with(:body => "{\"auth\":{\"identity\":{\"methods\":[\"password\"],\"password\":{\"user\":{\"id\":\"user_id\",\"password\":\"secret\"}}},\"scope\":{\"project\":{\"id\":\"project_id\"}}}}").
+#    to_return(:status => 200, :body => JSON.dump(auth_response_v3('identity', 'keystone')), :headers => {'x-subject-token'=>'token_data'})
 
-  stub_request(:get, 'http://localhost/').
-    with(:headers => request_header).
-    to_return(:status => 200, :body => '', :headers => {})
-
-  Misty::Openstack::Neutron::V2_0.new(auth, setup, params)
+  Misty::Openstack::Neutron::V2_0.new(config.get_service(:networking))
 end

data/test/unit/services_test.rb

@@ -13,7 +13,7 @@ describe 'Services' do
       service.project.must_equal :project_name
       service.versions.must_include 'v1'
       service.microversion.must_equal 'v3'
-      service.version.must_equal 'v3'
+      service.default_version.must_equal 'v3'
       services.to_s.must_equal %Q{service_name: project_name, versions: ["v1", "v2.0"], microversion: v3\n}
     end
   end

data/test/unit/test_helper.rb

@@ -4,7 +4,3 @@ require 'minitest/autorun'
 require 'webmock/minitest'
 require 'misty'
 require 'pry-byebug'
-
-module Misty
-  LOG_FILE = '/dev/null'
-end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: misty
 version: !ruby/object:Gem::Version
-  version: 1.3.3
+  version: 1.4.0
 platform: ruby
 authors:
 - Gilles Dubreuil
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-02-06 00:00:00.000000000 Z
+date: 2018-03-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -45,47 +45,61 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.10'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '5.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '5.10'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.10'
+        version: '3.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.10'
+        version: '3.4'
 - !ruby/object:Gem::Dependency
-  name: webmock
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.3'
+        version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.3'
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: vcr
   requirement: !ruby/object:Gem::Requirement
@@ -101,21 +115,20 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: pry-byebug
+  name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: '2.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.4'
-description: Misty is a dedicated HTTP client for OpenStack providing dynamic APIs
-  requests management.
+        version: '2.3'
+description: Misty is a HTTP client for OpenStack APIs, aiming to be slick and dynamic.
 email:
 - gilles@redhat.com
 executables: []
@@ -130,12 +143,12 @@ files:
 - lib/misty/auth.rb
 - lib/misty/auth/auth_v2.rb
 - lib/misty/auth/auth_v3.rb
-- lib/misty/auth/errors.rb
 - lib/misty/auth/name.rb
 - lib/misty/autoload.rb
-- lib/misty/client.rb
 - lib/misty/client_pack.rb
 - lib/misty/cloud.rb
+- lib/misty/config.rb
+- lib/misty/errors.rb
 - lib/misty/http/direct.rb
 - lib/misty/http/header.rb
 - lib/misty/http/method_builder.rb
@@ -192,6 +205,7 @@ files:
 - lib/misty/openstack/searchlight/v1.rb
 - lib/misty/openstack/senlin/senlin_v1.rb
 - lib/misty/openstack/senlin/v1.rb
+- lib/misty/openstack/service.rb
 - lib/misty/openstack/swift/swift_v1.rb
 - lib/misty/openstack/swift/v1.rb
 - lib/misty/openstack/tacker/tacker_v1_0.rb
@@ -204,16 +218,16 @@ files:
 - lib/misty/services.rb
 - lib/misty/version.rb
 - test/integration/compute_test.rb
-- test/integration/network_test.rb
+- test/integration/networking_test.rb
 - test/integration/orchestration_test.rb
 - test/integration/test_helper.rb
 - test/integration/vcr/compute_using_nova_v2_1.yml
-- test/integration/vcr/network_using_neutron_v2_0.yml
+- test/integration/vcr/networking_using_neutron_v2_0.yml
 - test/integration/vcr/orchestration_using_heat_v1.yml
 - test/unit/auth/name_test.rb
 - test/unit/auth_helper.rb
 - test/unit/auth_test.rb
-- test/unit/client_test.rb
+- test/unit/cloud/config_test.rb
 - test/unit/cloud/requests_test.rb
 - test/unit/cloud/services_test.rb
 - test/unit/cloud_test.rb
@@ -225,6 +239,7 @@ files:
 - test/unit/misty_test.rb
 - test/unit/openstack/APIs_test.rb
 - test/unit/openstack/extension_test.rb
+- test/unit/openstack/service_test.rb
 - test/unit/service_helper.rb
 - test/unit/services_test.rb
 - test/unit/test_helper.rb
@@ -249,7 +264,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 2.6.14.1
 signing_key: 
 specification_version: 4
 summary: Misty is an OpenStack API client

data/lib/misty/client.rb

@@ -1,104 +0,0 @@
-module Misty
-  module Client
-    class Options
-      attr_accessor :base_path, :base_url, :headers, :interface, :region_id,
-                    :service_names, :ssl_verify_mode, :version
-    end
-
-    class InvalidDataError < StandardError; end
-
-    INTERFACES = %w{admin public internal}
-
-    attr_reader :headers, :microversion
-
-    # Options - Values shown are the default
-    #   Base path can be forced (Not recommended, mainly used for test purposes)
-    #    :base_path => nil
-    #   URL can be forced (Helps when setup is broken)
-    #    :base_url => nil
-    #   Optional headers
-    #    :headers => {}
-    #   Endpoint type (admin, public or internal)
-    #    :interface => "public"
-    #   Region ID
-    #    :region_id => "regionOne"
-    #   Service name
-    #    The Service names are pre defined but more can be added using this option.
-    #    :service_name
-    #   SSL Verify Mode
-    #    :ssl_verify_mode => true
-    #   (micro)version: Can be numbered (3.1) or by state (CURRENT, LATEST or SUPPORTED)
-    #     :version => "CURRENT"
-    def initialize(auth, config, options = {})
-      @auth = auth
-      @config = config
-      @options = setup(options)
-      @uri = URI.parse(@auth.get_url(@options.service_names, @options.region_id, @options.interface))
-      @base_path = @options.base_path ? @options.base_path : @uri.path
-      @base_path = @base_path.chomp('/')
-      @version = nil
-      @microversion = false
-      @headers = Misty::HTTP::Header.new(@config.headers.get.clone)
-      @headers.add(microversion_header) if microversion
-      @headers.add(@options.headers) unless @options.headers.empty?
-    end
-
-    # Mixing classes to override
-    # When a catalog provides a base path and the Service API definition containts the generic equivalent as prefix
-    # then the preifx is redundant and must be removed from the path.
-    # For example:
-    # Catalog provides 'http://192.0.2.21:8004/v1/48985e6b8da145699d411f12a3459fca'
-    # and Service API has '/v1/{tenant_id}/stacks'
-    # then the path prefix is ignored and path is only '/stacks'
-    def prefix_path_to_ignore
-      ''
-    end
-
-    def requests
-      requests_api + requests_custom
-    end
-
-    private
-
-    def baseclass
-      self.class.to_s.split('::')[-1]
-    end
-
-    def requests_api
-      @requests_api_list ||= begin
-        list = []
-        api.each do |_path, verbs|
-          verbs.each do |_verb, requests|
-            list << requests
-          end
-        end
-        list.flatten!
-      end
-    end
-
-    def requests_custom
-      []
-    end
-
-    def setup(params)
-      options = Options.new()
-      options.base_path           = params[:base_path]       ? params[:base_path] : nil
-      options.base_url            = params[:base_url]        ? params[:base_url] : nil
-      options.headers             = params[:headers]         ? params[:headers] : {}
-      options.interface           = params[:interface]       ? params[:interface] : @config.interface
-      options.region_id           = params[:region_id]       ? params[:region_id] : @config.region_id
-      options.service_names       = params[:service_name]    ? service_names << params[:service_name] : service_names
-      options.ssl_verify_mode     = params[:ssl_verify_mode].nil? ? @config.ssl_verify_mode : params[:ssl_verify_mode]
-      options.version             = params[:version]         ? params[:version] : 'CURRENT'
-
-      unless INTERFACES.include?(options.interface)
-        raise InvalidDataError, "Options ':interface' must be one of #{INTERFACES}"
-      end
-
-      unless options.ssl_verify_mode == !!options.ssl_verify_mode
-        raise InvalidDataError, "Options ':ssl_verify_mode' must be a boolean"
-      end
-      options
-    end
-  end
-end

data/test/unit/client_test.rb

@@ -1,97 +0,0 @@
-require 'test_helper'
-require 'service_helper'
-require 'misty/client'
-
-describe Misty::Client do
-  describe '#prefix_path_to_ignore' do
-    let(:client) do
-      client = Object.new
-      client.extend(Misty::Client)
-      client
-    end
-
-    it "returns empty String when undefined in API's module" do
-      client.prefix_path_to_ignore.must_be_empty
-    end
-
-    it "returns String when defined in API's module" do
-      class << client
-        def prefix_path_to_ignore
-          '/v3/{tenant_id}'
-        end
-      end
-
-      client.prefix_path_to_ignore.must_equal '/v3/{tenant_id}'
-    end
-  end
-
-  describe '#requests' do
-    it 'returns list of requests' do
-      list = service.requests
-      list.must_be_kind_of Array
-      list.must_include :list_service_profiles
-    end
-  end
-
-  describe '#baseclass' do
-    it 'returns base class name' do
-      service.send(:baseclass).must_equal 'V2_0'
-    end
-  end
-
-  describe '#setup' do
-    it 'use default options' do
-      options = service.send(:setup, {})
-      options.must_be_kind_of Misty::Client::Options
-      options.base_path.must_be_nil
-      options.base_url.must_be_nil
-      options.headers.must_equal ({})
-      options.interface.must_equal 'public'
-      options.region_id.must_equal 'regionOne'
-      options.service_names.must_include 'network'
-      options.ssl_verify_mode.must_equal true
-      options.version.must_equal 'CURRENT'
-    end
-
-    it 'use custom options' do
-      options = service.send(:setup, {
-        :base_path       => '/test_path',
-        :base_url        => 'test_url',
-        :headers         => {'Key 1' => 'Value 1'},
-        :region_id       => 'regionTwo',
-        :interface       => 'internal',
-        :ssl_verify_mode => false,
-        :version         => 'LATEST'})
-      options.base_path.must_equal '/test_path'
-      options.base_url.must_equal 'test_url'
-      options.headers.must_equal ({'Key 1' => 'Value 1'})
-      options.interface.must_equal 'internal'
-      options.region_id.must_equal 'regionTwo'
-      options.ssl_verify_mode.must_equal false
-      options.version.must_equal 'LATEST'
-    end
-
-    it 'fails with invalid interface' do
-      proc do
-        service.send(:setup, {:interface => 'something'})
-      end.must_raise Misty::Client::InvalidDataError
-    end
-
-    it 'fails unless ssl_verify_mode is a boolean' do
-      proc do
-        service.send(:setup, {:ssl_verify_mode => 'something'})
-      end.must_raise Misty::Client::InvalidDataError
-    end
-  end
-
-  describe 'headers' do
-    it 'returns default global along with token' do
-      service.headers.get.must_equal ({"Accept"=>"application/json; q=1.0"})
-    end
-
-    it 'inject headers parameter' do
-      service(content_type = :ruby, params = {:headers => {'Oh' => 'my!'}}).
-        headers.get.must_equal ({"Accept"=>"application/json; q=1.0", "Oh"=>"my!"})
-    end
-  end
-end