omniauth-suomifi 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3bba7a20e137303ea20efd3d2d829c9e37e103b5c47d864188b50a16cce7d758
-  data.tar.gz: 481a5fe89956132db550b05d7ffd9e997ae377b6dafb4ba096c4e011edaf0fed
+  metadata.gz: 29541d8a6b97e782ec1714090cf213e0d8d7d3a439ed687c626bb0150a40b0d8
+  data.tar.gz: 6fc90b20d63255872a8993190ace3ab2f083270cfb78885bb1727f12268360ad
 SHA512:
-  metadata.gz: 5e58186eca6d49643657a3e421a5417b9caf988d212c78230224ca1e0e7e0819a46c04adf19f3e94554730cb7090c1cdc786cc4e6cdac61cffe96b9ab3cccd5e
-  data.tar.gz: 4cac68f67dab309856e7919c2b894322dcb90370968ec2772b5b19d738486afd0b8977ec4ece944c653e65fc862372e881f9553e94ea64afceaa77cd7bd6b876
+  metadata.gz: 4e906f7e048944692417c877ef345526cc0f93d9ce3f367d75a8841d0e85b80960f76c2388689fa0b98db96cb29ca5df84432d01c5b4ed1b642111b5187d83a5
+  data.tar.gz: b3e33e543d3a058a581d8cd5d524431afcd01d47ca724182cf36d82435bf9402aac2555f1a59bb145462900ec850104c57890173fe7f8809fa85d89aa0bf5366

data/lib/omniauth/strategies/suomifi.rb

@@ -16,6 +16,29 @@ module OmniAuth
       # The private key file to define the private key.
       option :private_key_file, nil
 
+      # Defines the locale parameters to check from the request phase request
+      # parameters. A valid language will be added to the IdP sign in redirect
+      # URL as the last parameter (with the name `locale` as expected by
+      # Suomi.fi).
+      #
+      # Suomi.fi accepts `fi`, `sv` or `en` in this parameter. The language can
+      # be parsed from the following kind of strings:
+      # - fi
+      # - sv-SE
+      # - en_US
+      #
+      # In case a valid language cannot be parsed from the parameter, the locale
+      # parameter will default to `:idp_sso_target_url_default_locale`.
+      #
+      # Note that the locale parameter is always added as the last parameter in
+      # in the redirect URL as expected by Suomi.fi.
+      option :idp_sso_target_url_locale_params, %w[locale language lang]
+
+      # This is the default locale to be passed to IdP sign in redirect URL as
+      # defined above. In case a valid locale is not found from the request
+      # parameters, this will be used instead.
+      option :idp_sso_target_url_default_locale, 'fi'
+
       # The request attributes for Suomi.fi
       option :possible_request_attributes, [
         ##############################
@@ -493,6 +516,20 @@ module OmniAuth
         )
       end
 
+      # Override the request phase to be able to pass the locale parameter to
+      # the redirect URL. Note that this needs to be the last parameter to
+      # be passed to the redirect URL.
+      def request_phase
+        authn_request = OneLogin::RubySaml::Authrequest.new
+        locale = locale_for_authn_request
+
+        with_settings do |settings|
+          url = authn_request.create(settings, additional_params_for_authn_request)
+          url += "&locale=#{CGI.escape(locale)}" unless locale.nil?
+          redirect(url)
+        end
+      end
+
       # This method can be used externally to fetch information about the
       # response, e.g. in case of failures.
       def response_object
@@ -508,6 +545,13 @@ module OmniAuth
         end
       end
 
+      # Override the callback URL so that it always matches the one expected by
+      # Suomi.fi. No additional query string parameters can be included in the
+      # string.
+      def callback_url
+        full_host + script_name + callback_path
+      end
+
     private
 
       # Suomi.fi requires that the service provider needs to end the local user
@@ -603,6 +647,25 @@ module OmniAuth
           end
         end
       end
+
+      def locale_for_authn_request
+        if options.idp_sso_target_url_locale_params.is_a?(Array)
+          options.idp_sso_target_url_locale_params.each do |param|
+            next unless request.params.key?(param.to_s)
+
+            locale = parse_language_value(request.params[param.to_s])
+            return locale unless locale.nil?
+          end
+        end
+
+        options.idp_sso_target_url_default_locale
+      end
+
+      def parse_language_value(string)
+        language = string.sub('_', '-').split('-').first
+
+        language if language =~ /^(fi|sv|en)$/
+      end
     end
   end
 end

data/lib/omniauth-suomifi/version.rb

@@ -2,6 +2,6 @@
 
 module OmniAuth
   module Suomifi
-    VERSION = '0.1.0'
+    VERSION = '0.2.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: omniauth-suomifi
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Antti Hukkanen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-15 00:00:00.000000000 Z
+date: 2019-10-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: omniauth-saml