mobile_id 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dd821489ca866a30d97debb4b24438558dc578a94b20e34c1620481c7a0fc54d
-  data.tar.gz: 8c1f3d4f40d90698c05f8d7112e7507966e480baa6c8c3a37cb8035d2dddf4d1
+  metadata.gz: 7d38624f18a2ecc7fc1118e8f4cbe3d02276d13a1e04a2cd224c65b63eecab66
+  data.tar.gz: 3fe078951586eca758a792918c705306f2a2058f2f63385cfe4eb18cd1455a16
 SHA512:
-  metadata.gz: c90fde223c4830be512c78682421fc06848346a9ec81193e8afe8b13379878301c9c1479a04dddc872d2f19a34d72dee986233031c51c9a607601259c6b69cf0
-  data.tar.gz: 6118400c09a3a34bb687420338be9757f28c7f7273d39a56b352348f0dbcea3908768752998101a28ed7c4d006e39e7020e57b99f7be8fc4859a6dc3cb85711a
+  metadata.gz: 68b5151f552cdc6ef5730ef3a9ed21cffed2cf18a839deb32f91039cbbabf73b47bd0aad4f2046f57b9452c395b41f23c525d35aa6935adca7f80139a32ff805
+  data.tar.gz: 8eff21fe89c9a3f6c3328e326cae799ad4c727d3545255d41c643a53702058b544ba811e2083635ba303077e57bbc7c493f1fdf1e94ba9b6dcfdf39b83fffc3c

data/CHANGELOG.md

@@ -0,0 +1,8 @@
+Release 0.0.3
+* Gemspec update
+
+Release 0.0.2
+* Readme update
+
+Release 0.0.1
+* Init

data/MIT-LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2019-2020, Priit Tark, priit@gitlab.eu
+
+Permission is hereby granted, free of charge, to any person
+obtaining a copy of this software and associated documentation
+files (the "Software"), to deal in the Software without
+restriction, including without limitation the rights to use,
+copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,127 @@
+# MobileId::Ruby::Gem
+
+Estonia Mobile ID authentication, more info at https://www.id.ee/en/
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'mobile_id'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mobile_id
+
+## Test usage
+
+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):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)
+    => {"personal_code"=>"60001019906", "first_name"=>"MARY ÄNN", "last_name"=>"O’CONNEŽ-ŠUSLIK TESTNUMBER", "phone"=>"00000766", "phone_calling_code"=>"+372", "auth_provider"=>"mobileid"}
+
+You get verified attributes: personal_code, first_name, last_name, phone, phone_calling_code, auth_provider
+
+
+## Live usage
+
+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')
+```
+
+Rails with Devise example controller:
+
+```ruby
+class MobileSessionsController < ApplicationController
+  include Devise::Controllers::Helpers
+  skip_authorization_check only: [:new, :show, :create, :update]
+  before_action :init_mobile_id, only: [:create, :update]
+  
+  def new
+    @user = User.new
+  end
+
+  # makes Mobile ID authentication
+  def create
+    session[:auth] = @mid.authenticate!(phone: params[:phone], personal_code: params[:personal_code])
+    render :show, locals: { verification_code: @mid.verification_code }
+  rescue MobileId::Error => e
+    render :error, locals: { message: e }
+  end
+
+  # verifices Mobile ID user
+  def update
+    session[:auth] = @mid.verify!(session[:auth])
+    find_or_create_user_and_redirect(personal_code: @mid.personal_code)
+  rescue MobileId::Error => e
+    render :error, locals: { message: e }
+  end
+
+  private
+
+  def init_mobile_id
+    @mid = MobileId.new(live: true, uuid: ENV['sk_mid_uuid'], name: ENV['sk_mid_name'])
+  end
+
+  # It's pure your system business logic what to do here with validated user attributes, example code:
+  def find_or_create_user_and_redirect(personal_code:)
+    @user = User.find_by(personal_code: personal_code)
+
+    # bind currently present email only account with mobile-id
+    if @user.nil? && current_user&.confirmed_email_only_account?
+      @user = current_user 
+      @user.personal_code = personal_code
+      @user.save!
+    end
+
+    return redirect_to new_omniuser_url, notice: t(:finish_setup) if @user.nil? || @user.new_record?
+    return redirect_to root_url, alert: t(:unlock_info) if @user.access_locked?
+
+    if @user.valid? && @user.confirmed_at
+      # overwrite name changes
+      @user.first_name = session[:auth]['first_name'] if session[:auth]['first_name'].present?
+      @user.last_name  = session[:auth]['last_name']  if session[:auth]['last_name'].present?
+      @user.save! if @user.changed?
+
+      sign_in_and_redirect(@user, notice: t('devise.sessions.signed_in'))
+    else
+      redirect_to edit_omniuser_url(@user), notice: t('devise.failure.unconfirmed')
+    end
+  end
+end
+```
+
+## Development
+
+After checking out the repo, run `bundle` to install dependencies. For testing code, run `rspec`
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/gitlabeu/mobile_id
+
+## Roadmap
+
+* Document sign
+* Rails generators
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+## Sponsors
+
+Gem development and testing is sponsored by [GiTLAB](https://gitlab.eu).

data/lib/mobile_id/locales/en.yml

@@ -0,0 +1,10 @@
+en:
+  mobile_id:
+    some_error: There was some error
+    timeout: "Mobile-ID session got timeout"
+    user_is_not_mobile_id_client: User is not Mobile-ID client.
+    user_cancelled: User cancelled the Mobile ID operation
+    signature_hash_mismatch: "Mobile-ID has signiture issue. User needs to contact his/her mobile operator."
+    phone_absent: Mobile-ID SIM not available
+    delivery_error: Mobile-ID SMS sending error.
+    sim_error: Invalid response from Mobile-ID SIM card

data/lib/mobile_id/locales/et.yml

@@ -0,0 +1,10 @@
+et:
+  mobile_id:
+    some_error: Tekkis viga
+    timeout: "Mobiil-ID sisselogimine aegus"
+    user_is_not_mobile_id_client: Kasutaja ei ole Mobiil-ID klient
+    user_cancelled: Kasutaja katkestas Mobiil-ID sisselogimise.
+    signature_hash_mismatch: "Mobiil-ID digiallkiri on vigane. Palun pöörduge oma mobiilioperaatori poole."
+    phone_absent: Kasutaja telefon ei asu levipiirkonnas või on välja lülitatud.
+    delivery_error: Mobiil-ID SMS saatmisel tekkis viga.
+    sim_error: Mobiil-ID telefoni SIM viga.

data/lib/mobile_id/locales/ru.yml

@@ -0,0 +1,10 @@
+ru:
+  mobile_id:
+    some_error: Была некоторая ошибка
+    timeout: "Mobile-ID session got timeout"
+    user_is_not_mobile_id_client: User is not Mobile-ID client.
+    user_cancelled: User cancelled the Mobile ID operation
+    signature_hash_mismatch: "Mobile-ID has signiture issue. User needs to contact his/her mobile operator."
+    phone_absent: Mobile-ID SIM not available
+    delivery_error: Mobile-ID SMS sending error.
+    sim_error: Invalid response from Mobile-ID SIM card

data/lib/mobile_id/railtie.rb

@@ -0,0 +1,13 @@
+require 'rails'
+
+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"]
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mobile_id
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Priit Tark
@@ -100,7 +100,14 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
+- MIT-LICENSE
+- README.md
 - lib/mobile_id.rb
+- lib/mobile_id/locales/en.yml
+- lib/mobile_id/locales/et.yml
+- lib/mobile_id/locales/ru.yml
+- lib/mobile_id/railtie.rb
 homepage: https://github.com/gitlabeu/mobile_id
 licenses:
 - MIT