svelte 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a8aabcb7e5bafe83a0ad58ec737e2714afc5b2a6cb11264755dda73d2fd23a41
-  data.tar.gz: 96215b0581084eb9d196838ab9ef329030ec6e1cb80103a6b6e9ae0c15627ffd
+  metadata.gz: d515f944eb4733ad04a53f899efcb9d92d42e9186e4b182d209593f5486b9a10
+  data.tar.gz: d2a523d6ba449aa86b0b67262a91ff21b398fc04a7205d91c15e836124ae95b7
 SHA512:
-  metadata.gz: 2324bc8a06b283b780e6cff3f711609de82c0e1f06e504baaad12cf0200ef2a31ccf05c0027e785f1a00f9b542d5a8dfa2f868385cd6758928463a96eae4aca3
-  data.tar.gz: 92d72d2a0538d3aee9eb6e27826812dc489e0fb6ff3c200a2cb543e817d146a7756d833131c50c2df678ce42505d59c795b897e3e27b89c6269b4e951f9d8af7
+  metadata.gz: 20e46f345e5554de3954a6937aaf08cc810a558f14f2cd8795f70d65ffd4bcf2ff5c80c955d11a3f6521d6f48dc098617e5e56ba5d030cc4fea8ac45abd09585
+  data.tar.gz: 2694aa185dd3b8aef3c2f5bf6d19b0c63f75ae5d9767c6bc66d987b057e649f8690b2b765cf2bd95732a4c09f013981fe3fa5719619b1d6999cf9b8a10d29f60

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+# Changelog
+
+## [0.3.0] - 2019-08-14
+
+- Added support for headers ([#20](https://github.com/notonthehighstreet/svelte/pull/20))
+

data/lib/svelte/generic_operation.rb

@@ -13,18 +13,21 @@ module Svelte
       # @param configuration [Configuration] Swagger API configuration
       # @param parameters [Hash] payload of the request, i.e. `{ petId: 1}`
       # @param options [Hash] request options, i.e. `{ timeout: 10 }`
-      def call(verb:, path:, configuration:, parameters:, options:)
+      # @param headers [Hash] headers to be included in the request
+      def call(verb:, path:, configuration:, parameters:, options:, headers: nil)
         url = url_for(configuration: configuration,
                       path: path,
                       parameters: parameters)
         request_parameters = clean_parameters(path: path,
                                               parameters: parameters)
-        request_options = build_request_options(configuration: configuration,
-                                                options: options)
+        request_headers = build_request_headers(configuration: configuration,
+                                                options: options,
+                                                headers: headers)
         RestClient.call(verb: verb,
                         url: url,
                         params: request_parameters,
-                        options: request_options)
+                        headers: request_headers,
+                        options: options)
       end
 
       private
@@ -58,12 +61,12 @@ module Svelte
         clean_parameters
       end
 
-      def build_request_options(configuration:, options:)
-        if configuration.headers&.any?
-          return (options || {}).merge(headers: configuration.headers)
-        end
+      def build_request_headers(configuration:, options:, headers:)
+        configuration_headers = configuration.headers || {}
+        options_headers = options[:headers] || {}
+        request_headers = headers || {}
 
-        options
+        configuration_headers.merge(options_headers).merge(request_headers)
       end
     end
   end

data/lib/svelte/operation_builder.rb

@@ -12,11 +12,17 @@ module Svelte
         builder = self
         method_name = StringManipulator.method_name_for(operation.id)
         module_constant.define_singleton_method(method_name) do |*parameters|
+          request_parameters = builder.request_parameters(full_parameters: parameters)
+          headers = builder.strip_headers!(
+            operation_parameters: operation.properties["parameters"],
+            request_parameters: request_parameters)
+
           GenericOperation.call(
             verb: operation.verb,
             path: operation.path,
             configuration: configuration,
-            parameters: builder.request_parameters(full_parameters: parameters),
+            headers: headers,
+            parameters: request_parameters,
             options: builder.options(full_parameters: parameters)
           )
         end
@@ -46,6 +52,21 @@ module Svelte
       def options(full_parameters:)
         full_parameters[1] || {}
       end
+
+      # Strips headers from parameters and returns them.
+      # @param operation_parameters [Array] The parameters defined by the operation
+      # @param request_parameters [Hash] The parameters given by the caller
+      # @return [Hash] The headers for GenericOperation to build the request
+      def strip_headers!(operation_parameters:, request_parameters:)
+        header_names = operation_parameters.reduce([]) do |memo, param|
+          memo.push(param["name"].downcase) if param["in"] == 'header'
+          memo
+        end
+
+        headers = request_parameters.select { |key, val| header_names.include?(key)}
+        request_parameters.reject! { |key, val| header_names.include?(key) }
+        headers.empty? ? nil : headers
+      end
     end
   end
 end

data/lib/svelte/rest_client.rb

@@ -17,12 +17,12 @@ module Svelte
       # @param options [Hash] options
       # @raise [HTTPError] if an HTTP layer error occurs,
       #   an exception will be raised
+      # @param headers [Hash] headers to be sent along with the request
       #
       # @return [Faraday::Response] http response from the service
-      def call(verb:, url:, params: {}, options: {})
-        connection.send verb, url, params do |request|
+      def call(verb:, url:, params: {}, options: {}, headers: {})
+        connection.send verb, url, params, headers do |request|
           request.options.timeout = options[:timeout] if options[:timeout]
-          options[:headers]&.each { |key, value| request.headers[key] = value }
         end
       rescue Faraday::TimeoutError => e
         raise HTTPError.new(parent: e)

data/lib/svelte/version.rb

@@ -2,5 +2,5 @@
 
 module Svelte
   # Version
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: svelte
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - notonthehighstreet.com
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-10 00:00:00.000000000 Z
+date: 2019-08-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -178,6 +178,7 @@ files:
 - ".ruby-version"
 - ".travis.yml"
 - ".yardopts"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt