misty 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: '08884c370b4d79670e9d2b9c8adbbed79f1663a5'
-  data.tar.gz: 121229f87354ccfd1c492cc168b9e5ccaed57363
+  metadata.gz: 5dc7dd3f594f1b57498eb00f5ec84950d93f1a7f
+  data.tar.gz: 55db4993251e461c1a0ff34c71b88b4cbc84d475
 SHA512:
-  metadata.gz: d537db25e7d1bcbf6d3e6d55bd480367261d5a6011351c8d0f32dddba91c12af99e2141db3a58051ed1c9a4040c3cdbf5a7f2d9a2ab138e8f72f6ff7f3e8825f
-  data.tar.gz: c32da00cd2ba16c7d5a559ff3905a6e3fdca8a4e97d868a6594f6fc0ae1858b0f3eb84f03a6882bec4c8036206ca14c721bf8ef2d925ba1d415d1e329dfbd638
+  metadata.gz: 25e78f721473b692864310a5adb8a0b59a46a92e704414532647495372711487397f75cedfa0020943624d185dad98985bb25a9be47aeb55e197ebbba1f758ba
+  data.tar.gz: a387e6ba5f95e5c284a1bf9f1b6259d8703ae2e6d019ed2643bf95a5746d9594d70ee6047964e0b279a12ac1c4a2e8465fa67680f0cef182595044a7764566ad

data/README.md

@@ -67,7 +67,7 @@ puts network.body
 ```
 
 ## Services
-Once the Misty::Cloud object is created, the Openstack services can be used.
+Once a Misty::Cloud object is created, the Openstack services can be used.
 
 The Cloud object is authenticated by the identity server (bootstrap) and is provided with a service catalog.
 When an OpenStack API service is required, the catalog entry's endpoint is used and the service is dynamically called.
@@ -111,6 +111,15 @@ search: searchlight, versions: ["v1"]
 shared_file_systems: manila, microversion: v2
 ```
 
+### Headers
+HTTP headers can be defined at 3 different levels:
+* Global headers are applied across all services, see `:headers` in "Global parameters" section.
+* Service level headers are applied on every request of an involved service, see "Services options" section.
+* Request level header are passed on per request basis.
+
+The Headers are cumulative, therefore a request level header will be added on top of the global and Service levels
+headers.
+
 ### Prefixes
 A shorter name can be used to call a service only if it's unique among all services.
 For instance `net` or `network` can be used instead of `networking`.
@@ -249,6 +258,15 @@ openstack = Misty::Cloud.new(:auth => auth, :content_type => :ruby, :log_file =>
 #### Global parameters
 The following options are applied to each service unless specifically provided for a service.
 
+* :content_type  
+  Format of the body of the successful HTTP responses to be JSON or Ruby structures.  
+  Type: Symbol  
+  Allowed values: `:json`, `:ruby`  
+  Default: `:ruby`
+* :headers  
+  HTTP Headers to be applied to all services
+  Type: Hash  
+  Default: {}
 * :region_id  
   Type: String  
   Default: "regionOne"  
@@ -260,11 +278,6 @@ The following options are applied to each service unless specifically provided f
   When using SSL mode (defined by URI scheme => "https://")  
   Type: Boolean  
   Default: `true`  
-* :content_type  
-  Format of the body of the successful HTTP responses to be JSON or Ruby structures.  
-  Type: Symbol  
-  Allowed values: `:json`, `:ruby`  
-  Default: `:ruby`
 
 ### Services Options
 Each service can have specific parameters.
@@ -311,6 +324,23 @@ Example:
 openstack = Misty::Cloud.new(:auth => auth, :log_level => 0, :identity => {:region_id => 'regionTwo'}, :compute => {:version => '2.27', :interface => 'admin'})
 ```
 
+### Services Headers
+HTTP headers can be optionally added to any request.
+A Header object must be created and passed as the last parameter of a request.
+
+For example for an already initialized cloud:
+```ruby
+header = Misty::HTTP::Header.new(
+  'x-container-meta-web-listings' => false,
+  'x-container-meta-quota-count'  => "",
+  'x-container-meta-quota-bytes'  => nil,
+  'x-versions-location'           => "",
+  'x-container-meta-web-index'    => ""
+)
+
+openstack.object_storage.create_update_or_delete_container_metadata(container_name, header)
+```
+
 ## Direct REST HTTP Methods
 To send requests directly use the 'get', 'delete', 'post' and 'put' methods directly:
 ```ruby

data/lib/misty/cloud.rb

@@ -1,5 +1,6 @@
 require 'misty/auth/auth_v2'
 require 'misty/auth/auth_v3'
+require 'misty/http/header'
 
 module Misty
   class Cloud
@@ -13,7 +14,7 @@ module Misty
       val.gsub(/\./,'_')
     end
 
-    def initialize(params)# = {:auth => {}})
+    def initialize(params)
       @params = params
       @config = self.class.set_configuration(params)
       @auth = Misty::Auth.factory(params[:auth], @config)
@@ -27,7 +28,8 @@ module Misty
       config.log.level = params[:log_level] ? params[:log_level] : Misty::LOG_LEVEL
       config.region_id = params[:region_id] ? params[:region_id] : Misty::REGION_ID
       config.ssl_verify_mode = params.key?(:ssl_verify_mode) ? params[:ssl_verify_mode] : Misty::SSL_VERIFY_MODE
-      config.headers = params[:headers]
+      config.headers = Misty::HTTP::Header.new('Accept' => 'application/json; q=1.0')
+      config.headers.add(params[:headers]) if params[:headers] && !params[:headers].empty?
       config
     end
 

data/lib/misty/http/client.rb

@@ -2,13 +2,14 @@ require 'misty/http/net_http'
 require 'misty/http/method_builder'
 require 'misty/http/request'
 require 'misty/http/direct'
+require 'misty/http/header'
 
 module Misty
   module HTTP
     class Client
       class Options
-        attr_accessor :base_path, :base_url, :interface, :region_id,
-                      :service_names, :ssl_verify_mode, :version, :headers
+        attr_accessor :base_path, :base_url, :headers, :interface, :region_id,
+                      :service_names, :ssl_verify_mode, :version
       end
 
       class InvalidDataError < StandardError; end
@@ -20,7 +21,7 @@ module Misty
 
       INTERFACES = %w{admin public internal}
 
-      attr_reader :microversion
+      attr_reader :headers, :microversion
 
       def requests
         list = []
@@ -50,7 +51,7 @@ module Misty
       #    :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)
+      def initialize(auth, config, options = {})
         @auth = auth
         @config = config
         @options = setup(options)
@@ -59,6 +60,10 @@ module Misty
         @base_path = @base_path.chomp('/')
         @version = nil
         @microversion = false
+        @headers = Misty::HTTP::Header.new(@config.headers.get.clone)
+        @headers.add('X-Auth-Token' => @auth.get_token.to_s)
+        @headers.add(microversion_header) if microversion
+        @headers.add(@options.headers) unless @options.headers.empty?
       end
 
       # Sub classes to override
@@ -72,16 +77,6 @@ module Misty
         ''
       end
 
-      def headers
-        header = {}
-        header.merge!({'Accept' => 'application/json; q=1.0'})
-        header.merge!('X-Auth-Token' => @auth.get_token.to_s)
-        header.merge!(@config.headers) if @config.headers
-        header.merge!(@options.headers) if @options.headers
-        header.merge!(microversion_header) if microversion
-        header
-      end
-
       private
 
       def baseclass
@@ -92,11 +87,11 @@ module Misty
         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]    ? self.class.service_names << params[:service_name] : self.class.service_names
-        options.ssl_verify_mode     = params[:ssl_verify_mode] ? params[:ssl_verify_mode] : @config.ssl_verify_mode
-        options.headers             = params[:headers]         ? params[:headers] : {}
+        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)

data/lib/misty/http/direct.rb

@@ -7,19 +7,19 @@ module Misty
       end
 
       def delete(path, base_path = nil)
-        http_delete(base_set(base_path) + path, headers)
+        http_delete(base_set(base_path) + path, @headers.get)
       end
 
       def get(path, base_path = nil)
-        http_get(base_set(base_path) + path, headers)
+        http_get(base_set(base_path) + path, @headers.get)
       end
 
       def post(path, data, base_path = nil)
-        http_post(base_set(base_path) + path, headers, data)
+        http_post(base_set(base_path) + path, @headers.get, data)
       end
 
       def put(path, data, base_path = nil)
-        http_put(base_set(base_path) + path, headers, data)
+        http_put(base_set(base_path) + path, @headers.get, data)
       end
     end
   end

data/lib/misty/http/header.rb

@@ -0,0 +1,29 @@
+module Misty
+  module HTTP
+    class Header
+      class ArgumentError < RuntimeError; end
+      class TypeError     < RuntimeError; end
+
+      def self.valid?(param)
+        raise Misty::HTTP::Header::TypeError unless param.class == Hash
+        param.each do |key, val|
+          raise Misty::HTTP::Header::ArgumentError unless key.class == String
+          raise Misty::HTTP::Header::ArgumentError unless val.class == String
+        end
+        true
+      end
+
+      def initialize(param = {})
+        @headers = param if self.class.valid?(param)
+      end
+
+      def add(param = {})
+        @headers.merge!(param) if self.class.valid?(param)
+      end
+
+      def get
+        @headers
+      end
+    end
+  end
+end

data/lib/misty/http/method_builder.rb

@@ -12,6 +12,9 @@ module Misty
       private
 
       def method_call(method, *args)
+        header = @headers.get.clone
+        header.merge!(args.pop.get) if args[-1].class == Misty::HTTP::Header
+
         base, path = prefixed_path(method[:path])
         size_path_parameters = count_path_params(path)
         path_params = args[0, size_path_parameters]
@@ -21,23 +24,23 @@ module Misty
 
         case method[:request]
         when :COPY
-          http_copy(final_path, headers)
+          http_copy(final_path, header)
         when :DELETE
-          http_delete(final_path, headers)
+          http_delete(final_path, header)
         when :GET
           final_path << query_param(args_left[0]) if args_left && args_left.size == 1
-          http_get(final_path, headers)
+          http_get(final_path, header)
         when :HEAD
-          http_head(final_path, headers, data)
+          http_head(final_path, header)
         when :POST
           data = args_left[0] if args_left && args_left.size == 1
-          http_post(final_path, headers, data)
+          http_post(final_path, header, data)
         when :PUT
           data = args_left[0] if args_left && args_left.size == 1
-          http_put(final_path, headers, data)
+          http_put(final_path, header, data)
         when :PATCH
           data = args_left[0] if args_left && args_left.size == 1
-          http_patch(final_path, headers, data)
+          http_patch(final_path, header, data)
         else
           raise SyntaxError, "Invalid HTTP request: #{method[:request]}"
         end

data/lib/misty/version.rb

@@ -1,3 +1,3 @@
 module Misty
-  VERSION = '1.0.0'
+  VERSION = '1.1.0'
 end

data/test/unit/cloud/requests_test.rb

@@ -46,6 +46,18 @@ describe Misty::Cloud do
       cloud.image.show_image_member_details('id1', 'id2').response.must_be_kind_of Net::HTTPOK
     end
 
+    it 'successful with an extra header parameter' do
+      stub_request(:post, 'http://localhost:5000/v3/auth/tokens').
+        to_return(:status => 200, :body => JSON.dump(auth_response_v3('network', 'neutron')), :headers => {'x-subject-token'=>'token_data'})
+
+      stub_request(:get, "http://localhost/v2.0/networks?name=value").
+        with(:headers => {'Test-Header'=>'test header value'}).
+        to_return(:status => 200, :body => "", :headers => {})
+
+      header = Misty::HTTP::Header.new('Test-Header' => 'test header value')
+      cloud.network.list_networks('name=value', header).response.must_be_kind_of Net::HTTPOK
+    end
+
     it 'fails when not enough arguments' do
       proc do
         # '/v2/images/{image_id}/members/{member_id}'

data/test/unit/cloud_test.rb

@@ -56,9 +56,12 @@ describe Misty::Cloud do
       Misty::Auth.stub :factory, nil do
         config = Misty::Cloud.set_configuration({})
         config.must_be_kind_of Misty::Cloud::Config
+
         config.content_type.must_equal Misty::CONTENT_TYPE
-        config.log.must_be_kind_of Logger
+        config.headers.must_be_kind_of Misty::HTTP::Header
+        config.headers.get.must_equal({"Accept"=>"application/json; q=1.0"})
         config.interface.must_equal Misty::INTERFACE
+        config.log.must_be_kind_of Logger
         config.region_id.must_equal Misty::REGION_ID
         config.ssl_verify_mode.must_equal Misty::SSL_VERIFY_MODE
       end

data/test/unit/http/client_test.rb

@@ -21,12 +21,6 @@ describe Misty::HTTP::Client do
     end
   end
 
-  describe '#headers' do
-    it 'returns hash' do
-      service.headers.must_be_kind_of Hash
-    end
-  end
-
   describe '#baseclass' do
     it 'returns base class name' do
       service.send(:baseclass).must_equal 'V2_0'
@@ -34,11 +28,12 @@ describe Misty::HTTP::Client do
   end
 
   describe '#setup' do
-    it 'sets default options' do
+    it 'use default options' do
       options = service.send(:setup, {})
       options.must_be_kind_of Misty::HTTP::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'
@@ -46,6 +41,24 @@ describe Misty::HTTP::Client do
       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'})
@@ -58,4 +71,15 @@ describe Misty::HTTP::Client do
       end.must_raise Misty::HTTP::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", "X-Auth-Token"=>"token_id"})
+    end
+
+    it 'inject headers parameter' do
+      service(content_type = :ruby, params = {:headers => {'Oh' => 'my!'}}).
+        headers.get.must_equal ({"Accept"=>"application/json; q=1.0", "X-Auth-Token"=>"token_id", "Oh"=>"my!"})
+    end
+  end
 end

data/test/unit/http/header_test.rb

@@ -0,0 +1,39 @@
+require 'test_helper'
+require 'misty/http/client'
+
+describe Misty::HTTP::Header do
+  describe 'create' do
+    it 'successful with Hash parameter' do
+      header = Misty::HTTP::Header.new('key 1' => 'value 1', 'key 2' => 'value 2')
+
+      header.get.must_equal ({'key 1' => 'value 1', 'key 2' => 'value 2'})
+    end
+
+    it 'fails when parameter is not a Hash' do
+      proc do
+        header = Misty::HTTP::Header.new('A string')
+      end.must_raise Misty::HTTP::Header::TypeError
+    end
+
+    it 'fails when a key is not a String' do
+      proc do
+        header = Misty::HTTP::Header.new('key 1' => 'value 1', 2 => 'value 2')
+      end.must_raise Misty::HTTP::Header::ArgumentError
+    end
+
+    it 'fails when a value is not a String' do
+      proc do
+        header = Misty::HTTP::Header.new('key 1' => 'value 1', 'key 2' => 2)
+      end.must_raise Misty::HTTP::Header::ArgumentError
+    end
+  end
+
+  describe 'add' do
+    it 'merge headers' do
+      header = Misty::HTTP::Header.new('key 1' => 'value 1', 'key 2' => 'value 2')
+      header.add('key 3' => 'value 3', 'key 4' => 'value 4')
+
+      header.get.must_equal ({'key 1' => 'value 1', 'key 2' => 'value 2', 'key 3' => 'value 3', 'key 4' => 'value 4'})
+    end
+  end
+end

data/test/unit/http/method_builder_test.rb

@@ -39,13 +39,13 @@ describe Misty::HTTP::MethodBuilder do
   describe '#get_method' do
     class Service
       def self.api
-          {
-              '/' => { GET: [:list_api_versions] },
-              '/v2.0/' => { GET: [:show_api_v2_details] },
-              '/v2.0/extensions' => { GET: [:list_extensions] },
-              '/v2.0/extensions/{alias}' => { GET: [:show_extension_details] },
-              '/v2.0/networks/{network_id}' => { GET: [:show_network_details], PUT: [:update_network], DELETE: [:delete_network] }
-          }
+        {
+          '/' => { GET: [:list_api_versions] },
+          '/v2.0/' => { GET: [:show_api_v2_details] },
+          '/v2.0/extensions' => { GET: [:list_extensions] },
+          '/v2.0/extensions/{alias}' => { GET: [:show_extension_details] },
+          '/v2.0/networks/{network_id}' => { GET: [:show_network_details], PUT: [:update_network], DELETE: [:delete_network] }
+        }
       end
     end
 

data/test/unit/http/request_test.rb

@@ -71,8 +71,8 @@ describe Misty::HTTP::Request do
 
     it '#http_head' do
       stub_request(:head, 'http://localhost/resource').
-      with(:headers => request_header).
-      to_return(:status => '200')
+        with(:headers => request_header).
+        to_return(:status => '200')
 
       response = service.http_head('/resource', {})
       response.must_be_kind_of Net::HTTPSuccess
@@ -81,8 +81,8 @@ describe Misty::HTTP::Request do
 
     it '#http_options' do
       stub_request(:options, 'http://localhost/resource').
-      with(:headers => request_header).
-      to_return(:status => '200')
+        with(:headers => request_header).
+        to_return(:status => '200')
 
       response = service.http_options('/resource', {})
       response.must_be_kind_of Net::HTTPSuccess

data/test/unit/microversion_test.rb

@@ -37,6 +37,7 @@ describe Misty::Microversion do
     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')
 
     stub_request(:get, 'http://localhost/').
       with(:headers => {'Accept'=>'application/json'}).

data/test/unit/service_helper.rb

@@ -4,7 +4,7 @@ def request_header
   {'Accept' => 'application/json; q=1.0'}
 end
 
-def service(content_type = :ruby)
+def service(content_type = :ruby, params = {})
   auth = Minitest::Mock.new
 
   def auth.get_url(*args)
@@ -21,10 +21,11 @@ def service(content_type = :ruby)
   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')
 
   stub_request(:get, 'http://localhost/').
     with(:headers => request_header).
     to_return(:status => 200, :body => '', :headers => {})
 
-  Misty::Openstack::Neutron::V2_0.new(auth, setup, {})
+  Misty::Openstack::Neutron::V2_0.new(auth, setup, params)
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: misty
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Gilles Dubreuil
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-10-10 00:00:00.000000000 Z
+date: 2017-10-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -135,6 +135,7 @@ files:
 - lib/misty/cloud.rb
 - lib/misty/http/client.rb
 - lib/misty/http/direct.rb
+- lib/misty/http/header.rb
 - lib/misty/http/method_builder.rb
 - lib/misty/http/net_http.rb
 - lib/misty/http/request.rb
@@ -214,6 +215,7 @@ files:
 - test/unit/cloud_test.rb
 - test/unit/http/client_test.rb
 - test/unit/http/direct_test.rb
+- test/unit/http/header_test.rb
 - test/unit/http/method_builder_test.rb
 - test/unit/http/request_test.rb
 - test/unit/microversion_test.rb