grand_id_simple 0.2.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e991889a4280b4b7dc7d30464d36a518d00314975c2f5fb8202f24274e3ed72d
-  data.tar.gz: 8abf5b274f1710ecdce7f527bb723b2b0b8c01fe09ea31e9d9f85c6069096e04
+  metadata.gz: 3d4bd8555409124e1b9e3ada14c4d7f6fa1922a7e589638d6526fdc0667a26db
+  data.tar.gz: 3a7b8476abf8a14266553bc18645a2935f4e44889d75dfb2bb27a8fcef4c8b33
 SHA512:
-  metadata.gz: 100ec89f31208b95ed4715b502cf64899f7e4927d9b8b8fecaafc13fbf6f4fc4b3657a504e7a30bb78b3ec4edba6c87cd2192ac2a35a16cdc13ea3bc4f3947bc
-  data.tar.gz: 8c2999ffe9841ead0d6fad056b5de425478d8348739ece4dddc42ac141ad5ad70f015bc038e2ec63320d3e81ea31913d3542a2d9a0484c61541aa44e7b653724
+  metadata.gz: 641b56153b7fc523839e059d41f5846ecc5ae440e191573e4ff2721aa1cbe62b3ee7370616bcaae5e1234c02de62f69163d85203b597b611d47e509d35476d9b
+  data.tar.gz: fc1aa93521ee825fdd21e99fae60f8dc73fec98794c5d90143b24a1d0deff0c52049f4d13616c311349857d0f99685f768334e35a730929d55c0020d43ed32d5

data/.rubocop.yml

@@ -1,6 +1,3 @@
-require:
-  rubocop-rake
-
 inherit_gem:
   rubocop_fonsan_style:
     - .rubocop.yml

data/Gemfile

@@ -9,4 +9,6 @@ gem 'oj'
 gem 'rake', '~> 13.0'
 gem 'rspec', '~> 3.0'
 gem 'rubocop_fonsan_style'
+gem 'sinatra'
 gem 'typhoeus'
+gem 'webrick'

data/Gemfile.lock

@@ -1,36 +1,68 @@
 PATH
   remote: .
   specs:
-    grand_id_simple (0.2.0)
+    grand_id_simple (1.0.0)
+      sinatra (~> 2.2)
       typhoeus (~> 1.4)
+      webrick (~> 1.8)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (7.0.4)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
+    activesupport (8.0.0)
+      base64
+      benchmark (>= 0.3)
+      bigdecimal
+      concurrent-ruby (~> 1.0, >= 1.3.1)
+      connection_pool (>= 2.2.5)
+      drb
       i18n (>= 1.6, < 2)
+      logger (>= 1.4.2)
       minitest (>= 5.1)
-      tzinfo (~> 2.0)
+      securerandom (>= 0.3)
+      tzinfo (~> 2.0, >= 2.0.5)
+      uri (>= 0.13.1)
     ast (2.4.2)
-    concurrent-ruby (1.1.10)
+    base64 (0.2.0)
+    benchmark (0.4.0)
+    bigdecimal (3.1.8)
+    concurrent-ruby (1.3.4)
+    connection_pool (2.4.1)
     diff-lcs (1.5.0)
+    drb (2.2.1)
     ethon (0.16.0)
       ffi (>= 1.15.0)
     ffi (1.15.5)
-    i18n (1.12.0)
+    haml (6.3.0)
+      temple (>= 0.8.2)
+      thor
+      tilt
+    haml_lint (0.59.0)
+      haml (>= 5.0)
+      parallel (~> 1.10)
+      rainbow
+      rubocop (>= 1.0)
+      sysexits (~> 1.1)
+    i18n (1.14.6)
       concurrent-ruby (~> 1.0)
-    json (2.6.2)
-    minitest (5.16.3)
+    json (2.8.2)
+    language_server-protocol (3.17.0.3)
+    logger (1.6.1)
+    minitest (5.25.2)
+    mustermann (2.0.2)
+      ruby2_keywords (~> 0.0.1)
     oj (3.13.23)
-    parallel (1.22.1)
-    parser (3.1.3.0)
+    parallel (1.26.3)
+    parser (3.3.6.0)
       ast (~> 2.4.1)
-    rack (3.0.1)
+      racc
+    racc (1.8.1)
+    rack (2.2.10)
+    rack-protection (2.2.4)
+      rack
     rainbow (3.1.1)
     rake (13.0.6)
-    regexp_parser (2.6.1)
-    rexml (3.2.5)
+    regexp_parser (2.9.2)
     rspec (3.12.0)
       rspec-core (~> 3.12.0)
       rspec-expectations (~> 3.12.0)
@@ -44,46 +76,60 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
     rspec-support (3.12.0)
-    rubocop (1.39.0)
+    rubocop (1.68.0)
       json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
-      parser (>= 3.1.2.1)
+      parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8, < 3.0)
-      rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.23.0, < 2.0)
+      regexp_parser (>= 2.4, < 3.0)
+      rubocop-ast (>= 1.32.2, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.23.0)
-      parser (>= 3.1.1.0)
-    rubocop-performance (1.15.1)
-      rubocop (>= 1.7.0, < 2.0)
-      rubocop-ast (>= 0.4.0)
-    rubocop-rails (2.17.3)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.36.1)
+      parser (>= 3.3.1.0)
+    rubocop-performance (1.23.0)
+      rubocop (>= 1.48.1, < 2.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
+    rubocop-rails (2.27.0)
       activesupport (>= 4.2.0)
       rack (>= 1.1)
-      rubocop (>= 1.33.0, < 2.0)
-    rubocop-rake (0.6.0)
-      rubocop (~> 1.0)
-    rubocop-rspec (2.15.0)
-      rubocop (~> 1.33)
+      rubocop (>= 1.52.0, < 2.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
+    rubocop-rspec (3.2.0)
+      rubocop (~> 1.61)
     rubocop-rubycw (0.1.6)
       rubocop (~> 1.0)
-    rubocop_fonsan_style (0.1.0)
-      rubocop (~> 1.39)
-      rubocop-performance (~> 1.15)
-      rubocop-rails (~> 2.17)
-      rubocop-rake (~> 0.6.0)
-      rubocop-rspec (~> 2.15)
+    rubocop_fonsan_style (0.1.8)
+      haml_lint (~> 0.52)
+      rubocop (~> 1.68)
+      rubocop-performance (~> 1.22)
+      rubocop-rails (~> 2.27)
+      rubocop-rspec (~> 3.2)
       rubocop-rubycw (~> 0.1)
-    ruby-progressbar (1.11.0)
+    ruby-progressbar (1.13.0)
+    ruby2_keywords (0.0.5)
+    securerandom (0.3.2)
+    sinatra (2.2.4)
+      mustermann (~> 2.0)
+      rack (~> 2.2)
+      rack-protection (= 2.2.4)
+      tilt (~> 2.0)
+    sysexits (1.2.0)
+    temple (0.10.3)
+    thor (1.3.2)
+    tilt (2.1.0)
     typhoeus (1.4.0)
       ethon (>= 0.9.0)
-    tzinfo (2.0.5)
+    tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
-    unicode-display_width (2.3.0)
+    unicode-display_width (2.6.0)
+    uri (1.0.2)
+    webrick (1.8.1)
 
 PLATFORMS
+  arm64-darwin-22
+  arm64-darwin-23
   x86_64-darwin-20
   x86_64-darwin-22
   x86_64-linux
@@ -94,7 +140,9 @@ DEPENDENCIES
   rake (~> 13.0)
   rspec (~> 3.0)
   rubocop_fonsan_style
+  sinatra
   typhoeus
+  webrick
 
 BUNDLED WITH
    2.3.26

data/README.md

@@ -16,7 +16,28 @@ If bundler is not being used to manage dependencies, install the gem by executin
 
 ## Usage
 
-TODO: Write usage instructions here
+
+```bash
+GRAND_ID_API_KEY='123' GRAND_ID_SERVICE_KEY='467' ruby some_app.rb
+```
+
+```ruby
+api_key, service_key = ENV.values_at('GRAND_ID_API_KEY', 'GRAND_ID_SERVICE_KEY')
+
+grand_id_simple = GrandIdSimple.new(api_key, service_key)
+
+grand_id_simple.federated_login(your_callback_url)
+# or if you know the personal number and would like to extend the courtesy of not having to scan qr code or manually fill
+login = grand_id_simple.federated_login(your_callback_url, personal_number: '198801010101')
+# => #<struct GrandIdSimple::Login session_id="123", redirect_url="https://grandid.se/redirect....">
+# redirect your user
+redirect_to(login.redirect_url)
+
+# Then when you receive the callback:
+
+person = grand_id_simple.get_session(params[:grandidsession])
+# => #<struct GrandIdSimple::Person personal_number="198801010101", name="Greta Musk", given_name="Greta", surname="Musk", ip_address=...>
+```
 
 ## Development
 

data/lib/fake_grand_id_simple.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require 'cgi'
+require 'webrick'
+require 'grand_id_simple'
+require 'sinatra/base'
+
+class FakeGrandIdSimple < GrandIdSimple
+  class FakePerson < Person
+    def session_id
+      @session_id ||= Digest::SHA256.hexdigest(rand.to_s)
+    end
+
+    def name
+      "#{given_name} #{surname}"
+    end
+  end
+
+  def self.add_query_parameter(url, name, value)
+    uri = URI.parse(url)
+    new_query_ar = URI.decode_www_form(uri.query || '') << [name, value]
+    uri.query = URI.encode_www_form(new_query_ar)
+    uri.to_s
+  end
+
+  def initialize(&block)
+    super(nil, nil)
+    @block = block
+    @people = []
+    @server = WEBrick::HTTPServer.new(Port: 0)
+    @app = Sinatra.new do
+      get '/' do
+        return redirect params[:callback_url] if params[:session_id]
+
+        settings.people.map do |person|
+          %(<a href="#{FakeGrandIdSimple.add_query_parameter(params[:callback_url], 'grandidsession', person.session_id)}">#{person.name}</a><br/>)
+        end.join
+      end
+    end
+    @app.set :people, @people
+    @server.mount('/', Rack::Handler::WEBrick, @app)
+    @base_url = "http://localhost:#{@server.config[:Port]}"
+  end
+
+  def start!
+    @server_thread = Thread.start { @server.start }
+  end
+
+  def federated_login(**options)
+    @people.concat(@block.call) if @people.empty?
+    redirect_url = FakeGrandIdSimple.add_query_parameter(@base_url, 'callback_url', options[:callbackUrl])
+    Login.new(redirect_url: redirect_url)
+  end
+
+  def get_session(session_id)
+    @people.find {|person| person.session_id == session_id }
+  end
+
+  def logout(_session_id)
+    Logout.new(sessiondeleted: true)
+  end
+end

data/lib/grand_id_simple/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class GrandIdSimple
-  VERSION = '0.2.0'
+  VERSION = '1.0.1'
 end

data/lib/grand_id_simple.rb

@@ -26,6 +26,8 @@ class GrandIdSimple
     :not_after,
     :signature,
     :ocsp_response,
+    :uhi,
+    :bank_id_issue_date,
     keyword_init: true,
   )
 
@@ -46,29 +48,40 @@ class GrandIdSimple
     @base_url = base_url
   end
 
-  def federated_login(callback_url, personal_number: nil)
+  # callbackUrl string  Optional  Where to return end-user after completion.
+  # customerURL string  Optional  Where to return end-user if they press the back button.
+  # userVisibleData base64  Optional  Visible data for the end-user to sign.
+  # userNonVisibleData  base64  Optional  Hidden data included in the signature.
+  # userVisibleDataFormat string  Optional  Used to format the visible signature data.
+  # authMessage base64  Optional  Visible data for the end-user to auth.
+  # mobileBankId  bool  Optional  Set to true to force usage of a Mobile BankID.
+  # desktopBankId bool  Optional  Set to true to force usage of a Desktop BankID.
+  # thisDevice  bool  Optional  Set to true to allow usage of the end-users current device
+  # qr  bool  Optional  Set to true to allow authentication/signing using a QR code
+  # allowFingerprintAuth  string  Optional  Set whether usage of fingerprint biometrics is allowed with the authentication.
+  # allowFingerprintSign  string  Optional  Set whether usage of fingerprint biometrics is allowed with the signature.
+  # gui string  Optional  Set to false to opt out of GrandID’s user interface and build your custom implementation.
+  # appRedirect string  Optional  Can be used to force a redirect to specific application from the BankID application.
+
+  def federated_login(**options)
     body = call_api(
       :FederatedLogin,
       method: :post,
       body: {
-        thisDevice: false,
-        askForSSN: !personal_number,
-        personalNumber: personal_number,
-        qr: true,
-        callbackUrl: callback_url,
+        **options,
       },
     )
-    Login.new(lower_keys(body))
+    Login.new(body)
   end
 
   def get_session(session_id)
     body = call_api(:GetSession, params: {sessionId: session_id})
-    Person.new(lower_keys(body[:userAttributes]))
+    Person.new(body[:user_attributes])
   end
 
   def logout(session_id)
     body = call_api(:Logout, params: {sessionId: session_id})
-    Logout.new(lower_keys(body))
+    Logout.new(body)
   end
 
   private
@@ -81,10 +94,10 @@ class GrandIdSimple
       body: body,
     )
     response = request.run
-    body = Oj.load(response.body, symbol_keys: true)
+    body = json_load(response.body)
     raise StandardError, 'no body' unless body
-    if error_object = body[:errorObject]
-      raise Error.new(*lower_keys(error_object).values_at(:code, :message))
+    if error_object = body[:error_object]
+      raise Error.new(*error_object.values_at(:code, :message))
     end
 
     body
@@ -97,8 +110,26 @@ class GrandIdSimple
     }
   end
 
-  def lower_keys(hash)
-    hash.transform_keys {|k| k.to_s.gsub(/([a-z])([A-Z]+)/, '\1_\2').downcase.to_sym }
+  def json_load(body)
+    deep_underscore_keys(Oj.load(body, symbol_keys: true))
+  end
+
+  def deep_underscore_keys(hash)
+    deep_transform_keys(hash) {|key| key.to_s.gsub(/([a-z])([A-Z]+)/, '\1_\2').downcase.to_sym }
+  end
+
+  def deep_transform_keys(hash, &block)
+    hash.each_with_object({}) do |(key, value), result|
+      new_key = yield(key)
+      new_value = if value.is_a?(Hash)
+        deep_transform_keys(value, &block)
+      elsif value.is_a?(Array)
+        value.map {|item| item.is_a?(Hash) ? deep_transform_keys(item, &block) : item }
+      else
+        value
+      end
+      result[new_key] = new_value
+    end
   end
 
   def url(call)

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: grand_id_simple
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Fonsan
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-01-19 00:00:00.000000000 Z
+date: 2024-11-26 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
 - !ruby/object:Gem::Dependency
   name: typhoeus
   requirement: !ruby/object:Gem::Requirement
@@ -24,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: webrick
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
 description: A simple wrapper around the grandid api
 email:
 - fonsan@gmail.com
@@ -40,7 +68,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- grand_id_simple.gemspec
+- lib/fake_grand_id_simple.rb
 - lib/grand_id_simple.rb
 - lib/grand_id_simple/version.rb
 - sig/grand_id_simple.rbs
@@ -60,14 +88,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.26
+rubygems_version: 3.5.23
 signing_key:
 specification_version: 4
 summary: grandid wrapper

data/grand_id_simple.gemspec

@@ -1,38 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'lib/grand_id_simple/version'
-
-Gem::Specification.new do |spec|
-  spec.name = 'grand_id_simple'
-  spec.version = GrandIdSimple::VERSION
-  spec.authors = ['Fonsan']
-  spec.email = ['fonsan@gmail.com']
-
-  spec.summary = 'grandid wrapper'
-  spec.description = 'A simple wrapper around the grandid api'
-  spec.homepage = 'https://github.com/Fonsan/grand_id_simple'
-  spec.license = 'MIT'
-  spec.required_ruby_version = '>= 2.6.0'
-
-  spec.metadata['homepage_uri'] = spec.homepage
-  spec.metadata['source_code_uri'] = spec.homepage
-  spec.metadata['changelog_uri'] = "#{spec.homepage}/CHANGELOG.md"
-
-  # Specify which files should be added to the gem when it is released.
-  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files = Dir.chdir(File.expand_path(__dir__)) do
-    `git ls-files -z`.split("\x0").reject do |f|
-      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
-    end
-  end
-  spec.bindir = 'exe'
-  spec.executables = spec.files.grep(%r{\Aexe/}) {|f| File.basename(f) }
-  spec.require_paths = ['lib']
-
-  # Uncomment to register a new dependency of your gem
-  spec.add_dependency "typhoeus", "~> 1.4"
-
-  # For more information and examples about making a new gem, check out our
-  # guide at: https://bundler.io/guides/creating_gem.html
-  spec.metadata['rubygems_mfa_required'] = 'true'
-end