Add support of HTTP basic and API key auth to Ruby codegen

Author: xhh

modules/swagger-codegen/src/main/resources/ruby/swagger.mustache

@@ -16,9 +16,9 @@ module {{moduleName}}
       #
       # @example
       #   Swagger.configure do |config|
-      #     config.api_key = '1234567890abcdef'     # required
-      #     config.username = 'wordlover'           # optional, but needed for user-related functions
-      #     config.password = 'i<3words'            # optional, but needed for user-related functions
+      #     config.api_key['api_key'] = '1234567890abcdef'     # api key authentication
+      #     config.username = 'wordlover'           # http basic authentication
+      #     config.password = 'i<3words'            # http basic authentication
       #     config.format = 'json'                  # optional, defaults to 'json'
       #   end
       #

modules/swagger-codegen/src/main/resources/ruby/swagger/configuration.mustache

@@ -1,8 +1,8 @@
 module {{moduleName}}
   module Swagger
     class Configuration
-      attr_accessor :format, :api_key, :username, :password, :auth_token, :scheme, :host, :base_path, :user_agent, :logger, :inject_format, :force_ending_format, :camelize_params, :user_agent
-    
+      attr_accessor :format, :api_key, :api_key_prefix, :username, :password, :auth_token, :scheme, :host, :base_path, :user_agent, :logger, :inject_format, :force_ending_format, :camelize_params, :user_agent
+
       # Defaults go in here..
       def initialize
         @format = 'json'
@@ -13,6 +13,8 @@ module {{moduleName}}
         @inject_format = false
         @force_ending_format = false
         @camelize_params = true
+        @api_key = {}
+        @api_key_prefix = {}
       end
     end
   end

modules/swagger-codegen/src/main/resources/ruby/swagger/request.mustache

@@ -13,24 +13,14 @@ module {{moduleName}}
         attributes[:format] ||= Swagger.configuration.format
         attributes[:params] ||= {}
 
+        update_params_for_auth(attributes)
+
         # Set default headers
         default_headers = {
           'Content-Type' => "application/#{attributes[:format].downcase}",
-          :api_key => Swagger.configuration.api_key,
           'User-Agent' => Swagger.configuration.user_agent
         }
 
-        # api_key from headers hash trumps the default, even if its value is blank
-        if attributes[:headers].present? && attributes[:headers].has_key?(:api_key)
-          default_headers.delete(:api_key)
-        end
-
-        # api_key from params hash trumps all others (headers and default_headers)
-        if attributes[:params].present? && attributes[:params].has_key?(:api_key)
-          default_headers.delete(:api_key)
-          attributes[:headers].delete(:api_key) if attributes[:headers].present?
-        end
-
         # Merge argument headers into defaults
         attributes[:headers] = default_headers.merge(attributes[:headers] || {})
 
@@ -46,6 +36,31 @@ module {{moduleName}}
         end
       end
 
+      def update_params_for_auth(attributes)
+        (attributes[:auth_names] || []).each do |auth_name|
+          case auth_name
+          {{#authMethods}}
+          when '{{name}}'
+            {{#isApiKey}}{{#isKeyInHeader}}attributes[:headers] ||= {}
+            attributes[:headers]['{{keyParamName}}'] = get_api_key_with_prefix('{{keyParamName}}'){{/isKeyInHeader}}{{#isKeyInQuery}}attributes[:params] ||= {}
+            attributes[:params]['{{keyParamName}}'] = get_api_key_with_prefix('{{keyParamName}}'){{/isKeyInQuery}}{{/isApiKey}}
+            {{#isBasic}}attributes[:headers] ||= {}
+            http_auth_header = 'Basic ' + ["#{Swagger.configuration.username}:#{Swagger.configuration.password}"].pack('m').delete("\r\n")
+            attributes[:headers]['Authorization'] = http_auth_header{{/isBasic}}
+            {{#isOAuth}}# TODO: support oauth{{/isOAuth}}
+          {{/authMethods}}
+          end
+        end
+      end
+
+      def get_api_key_with_prefix(param_name)
+        if Swagger.configuration.api_key_prefix[param_name].present?
+          "#{Swagger.configuration.api_key_prefix[param_name]} #{Swagger.configuration.api_key[param_name]}"
+        else
+          Swagger.configuration.api_key[param_name]
+        end
+      end
+
       # Construct a base URL
       def url(options = {})
         u = Addressable::URI.new(
@@ -58,9 +73,6 @@ module {{moduleName}}
         # Drop trailing question mark, if present
         u.sub! /\?$/, ''
 
-        # Obfuscate API key?
-        u.sub! /api\_key=\w+/, 'api_key=YOUR_API_KEY' if options[:obfuscated]
-
         u
       end
 
@@ -129,7 +141,7 @@ module {{moduleName}}
           next if self.path.include? "{#{key}}"                                   # skip path params
           next if value.blank? && value.class != FalseClass                       # skip empties
           if Swagger.configuration.camelize_params
-            key = key.to_s.camelize(:lower).to_sym unless key.to_sym == :api_key    # api_key is not a camelCased param
+            key = key.to_s.camelize(:lower).to_sym
           end
           query_values[key] = value.to_s
         end

samples/client/petstore/ruby/spec/request_spec.rb

@@ -2,7 +2,7 @@
 
 describe SwaggerClient::Swagger::Request do
 
-  before(:each) do 
+  before(:each) do
     SwaggerClient::Swagger.configure do |config|
       inject_format = true
       config.api_key = 'special-key'
@@ -22,7 +22,7 @@
     it "sets default response format to json" do
       @request.format.should == 'json'
     end
-    
+
     it "allows params to be nil" do
       @request = SwaggerClient::Swagger::Request.new(@default_http_method, @default_path, :params => nil)
       @request.query_string.should == ""
@@ -55,7 +55,7 @@
     end
 
   end
-  
+
   describe "body" do
 
     it "camelCases parameters" do
@@ -67,7 +67,7 @@
       }))
       @request.body.keys.should == [:badDog, :goodDog]
     end
-    
+
   end
 
   describe "path" do
@@ -140,7 +140,7 @@
       @request.query_string.should =~ /\?limit=100/
       @request.url.should =~ /\?limit=100/
     end
-    
+
     it "camelCases parameters" do
       @request = SwaggerClient::Swagger::Request.new(@default_http_method, @default_path, @default_params.merge({
         :params => {
@@ -150,51 +150,12 @@
       }))
       @request.query_string.should == "?badDog=bud&goodDog=dud"
     end
-    
+
     it "converts boolean values to their string representation" do
       params = {:stringy => "fish", :truthy => true, :falsey => false}
       @request = SwaggerClient::Swagger::Request.new(:get, 'fakeMethod', :params => params)
       @request.query_string.should == "?falsey=false&stringy=fish&truthy=true"
     end
-    
-  end
-  
-  describe "API key" do
-    
-    it "is inferred from the Swagger base configuration by default" do
-      SwaggerClient::Swagger.configure {|c| c.api_key = "xyz" }
-      SwaggerClient::Swagger::Request.new(:get, "word/json").headers[:api_key].should == "xyz"
-    end
-    
-    it "can be obfuscated for public display" do
-      @request = SwaggerClient::Swagger::Request.new(:get, "words/fancy", @default_params.merge({
-        :params => {
-          :word => "dog",
-          :api_key => "123456"
-        }
-      }))
-
-      @request.url.should =~ /api\_key=123456/
-      @request.url(:obfuscated => true).should =~ /api\_key=YOUR\_API\_KEY/
-    end
-
-    it "allows a key in the params to override the configuration-level key, even if it's blank" do
-      SwaggerClient::Swagger.configure {|c| c.api_key = "abc" }
-      @request_with_key = SwaggerClient::Swagger::Request.new(:get, "word/json", :params => {:api_key => "jkl"})
-      @request_with_key.headers[:api_key].should be_nil
-      @request_with_key.params[:api_key].should == "jkl"
-      
-      @request_without_key = SwaggerClient::Swagger::Request.new(:get, "word/json", :params => {:api_key => nil})
-      @request_without_key.headers[:api_key].should be_nil
-      @request_without_key.params[:api_key].should be_nil
-    end
-
-    it "allows a key in the headers to override the configuration-level key, even if it's blank" do
-      SwaggerClient::Swagger.configure {|c| c.api_key = "hij" }
-      SwaggerClient::Swagger::Request.new(:get, "word/json").headers[:api_key].should == "hij"
-      SwaggerClient::Swagger::Request.new(:get, "word/json", :headers => {:api_key => "jkl"}).headers[:api_key].should == "jkl"
-      SwaggerClient::Swagger::Request.new(:get, "word/json", :headers => {:api_key => nil}).headers[:api_key].should be_nil
-    end
 
   end