oas_request 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ebadd3bb6a13145a40bfaca069cacbe7e626b042f683ff6eb6e166a6e9a975e6
-  data.tar.gz: f9d3a245d1cd7d8407b94e9cccf39f89e9be52f245f0bf88ab3c7034df2ad1b1
+  metadata.gz: 18554b61f849e1beb2c9d0b19e4169f6cef4486cf77677246b9886a316290bd6
+  data.tar.gz: 2531349d54469d32b3fdf7357edea1243dbfef9038363d4f4c885a81395577e6
 SHA512:
-  metadata.gz: 694d14c453f5872509e0961155d25d15199b0faf85d45e4b81b9975ca5e93281bdd91e25ad36ad4be62a99808227ff809b8f941912085e0b500869d24aad0db9
-  data.tar.gz: 0db8ae9120ab145b5a9b44abd67797a2c97f99b15834fbac665c468d6d8fb98155e6be7514e5a02ffc3f5718ac090eba773c65e612d731b6748a6f5fe082b1c4
+  metadata.gz: 492836ae6c38677efc157712fa4328e4a02c58d47ef15d85d86637313e757644bc4940848315c9de40d644e2c59458d793aea1e40fcac7f49382f55d147fce0b
+  data.tar.gz: 8a27d7d5130e82d844dd7552f2e195be96c4bd57f75e088bbd76d2f87c9812ee2fc10d76e4c2822a5a4ace1b7bd48ef292db38a9861e9c9ca058af5d87a4d740

data/lib/oas_request.rb

@@ -1,18 +1,24 @@
 require "rack"
 require "string"
 
-module OASRequest
+class OASRequest
   def self.spec(oas)
+    @@oas_security_schemes = (oas["components"] && oas["components"]["securitySchemes"]) ? oas["components"]["securitySchemes"] : nil
+
     Class.new do
-      def initialize(server:, headers: {}, params: {}, query: {})
-        @server = server
+      def initialize(server:, headers: {}, params: {}, query: {}, secret: nil, jwt: {})
+        # TODO analyze oas.servers
+        @server = server.chomp("/")
 
+        # default properties
         @headers = headers
         @params = params
         @query = query
+        @secret = secret
+        @jwt = jwt
       end
 
-      def __request(method:, url:, options: {})
+      def __request(method:, url:, security_requirements: {}, options: {})
         # merge params with global defaults
         params = @params.merge(options.fetch(:params, {}))
 
@@ -22,20 +28,36 @@ module OASRequest
         # construct final host & url parts
         uri = URI "#{@server}#{url_path}"
 
+        # Get security options from global config and per API method config
+        method_security = {}
+        if options.fetch(:secret, nil)
+          method_security[:secret] = options.fetch(:secret, nil)
+        end
+        if options.fetch(:jwt, nil)
+          method_security[:jwt] = options.fetch(:jwt, nil)
+        end
+
+        security_options = {}.merge({secret: @secret, jwt: @jwt}).merge(method_security)
+
+        # Get security values in headers and queries from the required security schemas, and the given security options
+        security_headers, security_queries = OASRequest::Security::parse_security(@@oas_security_schemes, security_requirements, security_options)
+
         # convert query back to regular hash
         search_obj = Rack::Utils.parse_query uri.query
 
-        authorization_headers = {}
-
         # Overrides
-        headers = @headers.merge(authorization_headers).merge(options.fetch(:headers, {}))
-        query = search_obj.merge(@query).merge(options.fetch(:query, {}))
+        headers = {}.merge(@headers).merge(security_headers).merge(options.fetch(:headers, {}))
+        query = search_obj.merge(@query).merge(security_queries).merge(options.fetch(:query, {}))
 
         # final query string
         search = Rack::Utils.build_query query
 
         OASRequest::HTTP.http(
-            headers: headers,
+            headers: headers.reduce({}) do |headers, raw_header|
+              header_name, header_value = raw_header
+              headers[header_name] = header_value.kind_of?(Array) ? header_value.join(',') : header_value
+              headers
+            end,
             host: uri.host,
             method: method,
             port: uri.port,
@@ -45,6 +67,7 @@ module OASRequest
         )
       end
 
+      global_security = oas["security"] ? oas["security"][0] || {} : {}
 
       oas["paths"].each do |url, methods|
         methods.each do |method, definition|
@@ -54,15 +77,23 @@ module OASRequest
           operation_id = definition["operationId"]
           underscored_operation_id = operation_id.underscore
 
-          request_method = Proc.new do |headers: {}, params: {}, query: {}, body: nil|
+          method_security = definition["security"] ? definition["security"][0] || {} : {}
+
+          # Get the global security requirements, followed by the per method security requirements
+          security_requirements = {}.merge(global_security).merge(method_security)
+
+          request_method = Proc.new do |headers: {}, params: {}, query: {}, body: nil, secret: nil, jwt: {}|
             __request(
                 method: method,
                 url: url,
+                security_requirements: security_requirements,
                 options: {
                     headers: headers,
                     params: params,
                     query: query,
-                    body: body
+                    body: body,
+                    secret: secret,
+                    jwt: jwt
                 }
             )
           end
@@ -80,3 +111,4 @@ end
 
 require "oas_request/path_template"
 require "oas_request/http"
+require "oas_request/security"

data/lib/oas_request/http.rb

@@ -10,7 +10,7 @@ REQUEST_CLASSES = {
   delete: Net::HTTP::Delete
 }
 
-module OASRequest::HTTP
+class OASRequest::HTTP
   def self.config(opts = {})
     # set default options
     opts[:host] ||= "localhost"

data/lib/oas_request/path_template.rb

@@ -1,4 +1,4 @@
-module OASRequest::PathTemplate
+class OASRequest::PathTemplate
   def self.template(url, params)
     params_symbol = params.transform_keys(&:to_s)
 

data/lib/oas_request/security.rb

@@ -0,0 +1,83 @@
+require 'jwt'
+
+class OASRequest::Security
+  def self.is_number?(input)
+    true if Float(input) rescue false
+  end
+
+  def self.parse_security(oas_security_schemes, security_requirements, security_options)
+    headers = {}
+    queries = {}
+
+    if oas_security_schemes
+      security_requirements.each do |key, value|
+        security_scheme = oas_security_schemes.fetch(key, nil)
+
+        # Security scheme is not defined in the global scheme, throw error
+        unless security_scheme
+          raise "Security scheme #{key} not defined in spec."
+        end
+
+        secret = security_options[:secret]
+        jwt = security_options[:jwt]
+
+        case security_scheme["type"]
+        when "http"
+          unless headers.include?(:authorization)
+            headers[:authorization] = []
+          end
+
+          case security_scheme['scheme']
+          when 'bearer'
+
+            case security_scheme['bearerFormat']
+            when 'JWT'
+              payload = {}
+
+              if jwt
+                exp = jwt[:exp]
+
+                if exp
+                  raise "exp must be a number." unless self.is_number?(exp)
+                  payload[:exp] = Time.now.to_i + (exp.to_i * 60)
+                end
+              end
+
+              headers[:authorization].push("Bearer #{JWT.encode(payload, secret)}")
+
+            else
+              headers[:authorization].push("Bearer #{secret}")
+            end
+          else
+            raise "#{security_scheme["scheme"]} scheme type not implemented."
+          end
+
+        when "apiKey"
+          # apiKey type
+
+          case security_scheme["in"]
+          when "header"
+            unless headers.include?(security_scheme["name"])
+              headers[security_scheme["name"]] = []
+            end
+            headers[security_scheme["name"]].push(secret)
+
+          when "query"
+            unless queries.include?(security_scheme["name"])
+              queries[security_scheme["name"]] = []
+            end
+            queries[security_scheme["name"]].push(secret)
+
+          else
+            raise "#{security_scheme["in"]} type not implemented."
+          end
+
+        else
+          raise "#{security_scheme["type"]} type not implemented."
+        end
+      end
+    end
+
+    [headers, queries]
+  end
+end

data/lib/oas_request/version.rb

@@ -0,0 +1,3 @@
+module OASRequest
+  VERSION = "0.0.5".freeze
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: oas_request
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - ''
@@ -10,34 +10,66 @@ bindir: bin
 cert_chain: []
 date: 2020-07-28 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: jwt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.2.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.2.2
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.2.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.2.3
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.8.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.8.3
 description: A simple OAS request generator
 email: ''
 executables: []
@@ -47,6 +79,8 @@ files:
 - lib/oas_request.rb
 - lib/oas_request/http.rb
 - lib/oas_request/path_template.rb
+- lib/oas_request/security.rb
+- lib/oas_request/version.rb
 - lib/string.rb
 homepage: https://rubygems.org/gems/oas_request
 licenses: