mobile_id 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7d38624f18a2ecc7fc1118e8f4cbe3d02276d13a1e04a2cd224c65b63eecab66
-  data.tar.gz: 3fe078951586eca758a792918c705306f2a2058f2f63385cfe4eb18cd1455a16
+  metadata.gz: ac2213a077be1331007897be4a68ddde6e428cb7b4a0ca712950367d38c5d6c7
+  data.tar.gz: 7d7736fb27da9413c707b30ea98797a5dcbe05160ff2fc434b802fdf58310645
 SHA512:
-  metadata.gz: 68b5151f552cdc6ef5730ef3a9ed21cffed2cf18a839deb32f91039cbbabf73b47bd0aad4f2046f57b9452c395b41f23c525d35aa6935adca7f80139a32ff805
-  data.tar.gz: 8eff21fe89c9a3f6c3328e326cae799ad4c727d3545255d41c643a53702058b544ba811e2083635ba303077e57bbc7c493f1fdf1e94ba9b6dcfdf39b83fffc3c
+  metadata.gz: 3e04950d1fda22037f6e7f5f72bbf1b0f4038632028940e80bb020626efa54b46d94bd1af4f01c99113db5cf6f58fa6f6e2a6578543ef6b85771e6a88ef86487
+  data.tar.gz: bee3d0498d13db91e956c8daf69df2bd4e3c659be5379e40b1a6a9e1d3e7ddbd5f58c310f01c1bd9ed16f6ee92ee4ed6ea027627f770a7915fedda5a3e198382

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+Release 0.0.4
+* Refactored MobileId to MobileId::Auth
+
 Release 0.0.3
 * Gemspec update
 

data/README.md

@@ -25,8 +25,8 @@ Execute irb:
     $ bundle exec irb
     irb(main):001:0> require 'mobile_id'
     => true
-    irb(main):002:0> @mid = MobileId.new(live: false)
-    => #<MobileId:0x000055ac4cb25630 @url="https://tsp.demo.sk.ee/mid-api", @uuid="00000000-0000-0000-0000-000000000000", @name="DEMO", @hash="two+e7UMoFCAXHo8q9AnWqSC58Hhil74RowY8Gg9xQY=">
+    irb(main):002:0> @mid = MobileId::Auth.new(live: false)
+    => #<MobileId::Auth:0x000055ac4cb25630 @url="https://tsp.demo.sk.ee/mid-api", @uuid="00000000-0000-0000-0000-000000000000", @name="DEMO", @hash="two+e7UMoFCAXHo8q9AnWqSC58Hhil74RowY8Gg9xQY=">
     irb(main):003:0> auth = @mid.authenticate!(phone: '00000766', personal_code: '60001019906')
     => {"session_id"=>"34e7eff0-691b-4fad-9798-8db680587b18", "phone"=>"00000766", "phone_calling_code"=>"+372"}
     irb(main):004:0> verify = @mid.verify!(auth)
@@ -40,7 +40,7 @@ You get verified attributes: personal_code, first_name, last_name, phone, phone_
 For live usage, add your relyingPartyUUID (RPUUID) and relyingPartyName what you get from https://www.sk.ee
 
 ```ruby
-    @mid = MobileId.new(live: true, uuid: "39e7eff0-241b-4fad-2798-9db680587b20", name: 'My service name')
+    @mid = MobileId::Auth.new(live: true, uuid: "39e7eff0-241b-4fad-2798-9db680587b20", name: 'My service name')
 ```
 
 Rails with Devise example controller:

data/lib/mobile_id.rb

@@ -11,151 +11,10 @@ else
   I18n.load_path << Dir[File.expand_path("lib/mobile_id/locales") + "/*.yml"]
 end
 
-class MobileId
+module MobileId
   class Error < StandardError; end
 
-  # API documentation https://github.com/SK-EID/MID
-  LIVE_URL = "https://mid.sk.ee/mid-api"
-  TEST_URL = "https://tsp.demo.sk.ee/mid-api"
-
-  TEST_UUID  = "00000000-0000-0000-0000-000000000000"
-  TEST_NAME  = "DEMO"
-
-  attr_accessor :url, :uuid, :name, :hash, :cert, :cert_subject
-
-  def initialize(live:, uuid: nil, name: nil)
-    self.url = live == true ? LIVE_URL : TEST_URL
-    self.uuid = live == true ? uuid : TEST_UUID
-    self.name = live == true ? name : TEST_NAME
-    self.hash = Digest::SHA256.base64digest(SecureRandom.uuid)
-  end
-
-  def authenticate!(phone_calling_code: nil, phone:, personal_code:, language: nil, display_text: nil)
-    phone_calling_code ||= '+372'
-    full_phone = "#{phone_calling_code}#{phone}"
-    language ||= 
-      case I18n.locale
-      when :et
-        display_text ||= 'Autentimine' 
-        'EST'
-      when :ru
-        display_text ||= 'Аутентификация' 
-        'RUS'
-      else
-        display_text ||= 'Authentication' 
-        'ENG'
-      end
-    
-    options = {
-      headers: {
-        "Content-Type": "application/json"
-      },
-      query: {},
-      body: {
-        relyingPartyUUID: uuid,
-        relyingPartyName: name,
-        phoneNumber: full_phone.to_s.strip,
-        nationalIdentityNumber: personal_code.to_s.strip,
-        hash: hash,
-        hashType: 'SHA256',
-        language: language,
-        displayText: display_text,
-        displayTextFormat: 'GSM-7' # or "UCS-2”
-      }.to_json
-    }
-
-    response = HTTParty.post(url + '/authentication', options)
-    raise Error, "#{I18n.t('mobile_id.some_error')} #{response}" unless response.code == 200
-
-    ActiveSupport::HashWithIndifferentAccess.new(
-      session_id: response['sessionID'],
-      phone: phone,
-      phone_calling_code: phone_calling_code
-    )
-  end
-
-  def verify!(auth)
-    long_poll!(session_id: auth['session_id'])
-
-    ActiveSupport::HashWithIndifferentAccess.new(
-      personal_code: personal_code,
-      first_name: first_name,
-      last_name: last_name,
-      phone: auth['phone'],
-      phone_calling_code: auth['phone_calling_code'],
-      auth_provider: 'mobileid' # User::MOBILEID
-    )
-  end
-
-  def long_poll!(session_id:)
-    response = HTTParty.get(url + "/authentication/session/#{session_id}")
-    raise Error, "#{I18n.t('mobile_id.some_error')} #{response.code} #{response}" if response.code != 200
-
-    if response['state'] == 'COMPLETE' && response['result'] != 'OK'
-      message = 
-        case response['result']
-        when "TIMEOUT"
-          I18n.t('mobile_id.timeout')
-        when "NOT_MID_CLIENT"
-          I18n.t('mobile_id.user_is_not_mobile_id_client')
-        when "USER_CANCELLED"
-          I18n.t('mobile_id.user_cancelled')
-        when "SIGNATURE_HASH_MISMATCH"
-          I18n.t('mobile_id.signature_hash_mismatch')
-        when "PHONE_ABSENT"
-          I18n.t('mobile_id.phone_absent')
-        when "DELIVERY_ERROR"
-          I18n.t('mobile_id.delivery_error')
-        when "SIM_ERROR"
-          I18n.t('mobile_id.sim_error')
-        end
-      raise Error, message
-    end
-
-    self.cert = OpenSSL::X509::Certificate.new(Base64.decode64(response['cert']))
-    self.cert_subject = build_cert_subject
-    cert
-  end
-
-  def verification_code
-    format("%04d", (Digest::SHA2.new(256).digest(Base64.decode64(hash))[-2..-1].unpack1('n') % 10000))
-  end
-
-  def given_name
-    cert_subject["GN"].tr(",", " ")
-  end
-  alias first_name given_name
-
-  def surname
-    cert_subject["SN"].tr(",", " ")
-  end
-  alias last_name surname
-  
-  def country
-    cert_subject["C"].tr(",", " ")
-  end
-
-  def common_name
-    cert_subject["CN"]
-  end
-
-  def organizational_unit
-    cert_subject["OU"]
-  end
-
-  def serial_number
-    cert_subject["serialNumber"]
-  end
-  alias personal_code serial_number
-
-  private
-
-  def build_cert_subject
-    self.cert_subject = cert.subject.to_utf8.split(/(?<!\\)\,+/).each_with_object({}) do |c, result|
-      next unless c.include?("=")
-
-      key, val = c.split("=")
-      result[key] = val
-    end
-  end
+  LOCALES = [:en, :et, :ru]
 end
+
+require 'mobile_id/auth'

data/lib/mobile_id/auth.rb

@@ -0,0 +1,150 @@
+# frozen_string_literal: true
+
+module MobileId
+  class Auth
+    # API documentation https://github.com/SK-EID/MID
+    LIVE_URL = "https://mid.sk.ee/mid-api"
+    TEST_URL = "https://tsp.demo.sk.ee/mid-api"
+
+    TEST_UUID  = "00000000-0000-0000-0000-000000000000"
+    TEST_NAME  = "DEMO"
+
+    attr_accessor :url, :uuid, :name, :hash, :cert, :cert_subject
+
+    def initialize(live:, uuid: nil, name: nil)
+      self.url = live == true ? LIVE_URL : TEST_URL
+      self.uuid = live == true ? uuid : TEST_UUID
+      self.name = live == true ? name : TEST_NAME
+      self.hash = Digest::SHA256.base64digest(SecureRandom.uuid)
+    end
+
+    def authenticate!(phone_calling_code: nil, phone:, personal_code:, language: nil, display_text: nil)
+      phone_calling_code ||= '+372'
+      full_phone = "#{phone_calling_code}#{phone}"
+      language ||= 
+        case I18n.locale
+        when :et
+          display_text ||= 'Autentimine' 
+          'EST'
+        when :ru
+          display_text ||= 'Аутентификация' 
+          'RUS'
+        else
+          display_text ||= 'Authentication' 
+          'ENG'
+        end
+      
+      options = {
+        headers: {
+          "Content-Type": "application/json"
+        },
+        query: {},
+        body: {
+          relyingPartyUUID: uuid,
+          relyingPartyName: name,
+          phoneNumber: full_phone.to_s.strip,
+          nationalIdentityNumber: personal_code.to_s.strip,
+          hash: hash,
+          hashType: 'SHA256',
+          language: language,
+          displayText: display_text,
+          displayTextFormat: 'GSM-7' # or "UCS-2”
+        }.to_json
+      }
+
+      response = HTTParty.post(url + '/authentication', options)
+      raise Error, "#{I18n.t('mobile_id.some_error')} #{response}" unless response.code == 200
+
+      ActiveSupport::HashWithIndifferentAccess.new(
+        session_id: response['sessionID'],
+        phone: phone,
+        phone_calling_code: phone_calling_code
+      )
+    end
+
+    def verify!(auth)
+      long_poll!(session_id: auth['session_id'])
+
+      ActiveSupport::HashWithIndifferentAccess.new(
+        personal_code: personal_code,
+        first_name: first_name,
+        last_name: last_name,
+        phone: auth['phone'],
+        phone_calling_code: auth['phone_calling_code'],
+        auth_provider: 'mobileid' # User::MOBILEID
+      )
+    end
+
+    def long_poll!(session_id:)
+      response = HTTParty.get(url + "/authentication/session/#{session_id}")
+      raise Error, "#{I18n.t('mobile_id.some_error')} #{response.code} #{response}" if response.code != 200
+
+      if response['state'] == 'COMPLETE' && response['result'] != 'OK'
+        message = 
+          case response['result']
+          when "TIMEOUT"
+            I18n.t('mobile_id.timeout')
+          when "NOT_MID_CLIENT"
+            I18n.t('mobile_id.user_is_not_mobile_id_client')
+          when "USER_CANCELLED"
+            I18n.t('mobile_id.user_cancelled')
+          when "SIGNATURE_HASH_MISMATCH"
+            I18n.t('mobile_id.signature_hash_mismatch')
+          when "PHONE_ABSENT"
+            I18n.t('mobile_id.phone_absent')
+          when "DELIVERY_ERROR"
+            I18n.t('mobile_id.delivery_error')
+          when "SIM_ERROR"
+            I18n.t('mobile_id.sim_error')
+          end
+        raise Error, message
+      end
+
+      self.cert = OpenSSL::X509::Certificate.new(Base64.decode64(response['cert']))
+      self.cert_subject = build_cert_subject
+      cert
+    end
+
+    def verification_code
+      format("%04d", (Digest::SHA2.new(256).digest(Base64.decode64(hash))[-2..-1].unpack1('n') % 10000))
+    end
+
+    def given_name
+      cert_subject["GN"].tr(",", " ")
+    end
+    alias first_name given_name
+
+    def surname
+      cert_subject["SN"].tr(",", " ")
+    end
+    alias last_name surname
+    
+    def country
+      cert_subject["C"].tr(",", " ")
+    end
+
+    def common_name
+      cert_subject["CN"]
+    end
+
+    def organizational_unit
+      cert_subject["OU"]
+    end
+
+    def serial_number
+      cert_subject["serialNumber"]
+    end
+    alias personal_code serial_number
+
+    private
+
+    def build_cert_subject
+      self.cert_subject = cert.subject.to_utf8.split(/(?<!\\)\,+/).each_with_object({}) do |c, result|
+        next unless c.include?("=")
+
+        key, val = c.split("=")
+        result[key] = val
+      end
+    end
+  end
+end

data/lib/mobile_id/railtie.rb

@@ -4,8 +4,8 @@ module MobileId
   class Railtie < ::Rails::Railtie #:nodoc:
     initializer 'mobile_id' do |app|
       DeviseI18n::Railtie.instance_eval do
-        app.config.i18n.available_locales.each do |loc|
-          I18n.load_path << Dir[File.expand_path("lib/mobile_id/locales") + "/#{loc}.yml"]
+        (app.config.i18n.available_locales & MobileId::LOCALES).each do |loc|
+          I18n.load_path << File.expand_path("locales/#{loc}.yml", __dir__)
         end
       end
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mobile_id
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Priit Tark
@@ -104,6 +104,7 @@ files:
 - MIT-LICENSE
 - README.md
 - lib/mobile_id.rb
+- lib/mobile_id/auth.rb
 - lib/mobile_id/locales/en.yml
 - lib/mobile_id/locales/et.yml
 - lib/mobile_id/locales/ru.yml