omniauth-bsmart 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2e6f043f979942458da100c9045bc5926d433e6a922a47970ff495422eefb16a
+  data.tar.gz: d5e9489558f6ae69f4c7c0044a9293dfac744fae0e27e07e622c2c2b3bde6c5e
+SHA512:
+  metadata.gz: c6a315131625ecf0099331b5611f0671dd6de8c11dd00d8941628b6f384f8e29bafbdeecc243a095fa92d051ffc821e947b8151bddd8f7c023cf24d81b5304b6
+  data.tar.gz: 76f8041dbb8d0c28f07931218268ff30dcced94e3b0ca5676023dfd05ab0efba39fcbbfe09fd072c5728bca4b9c03b30b9a029e5cfbdab39d8a8091024e8a81b

data/LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 bsmartlabs
+
+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,135 @@
+# omniauth-bsmart
+
+[![Test](https://github.com/bsmartlabs/omniauth-bsmart/actions/workflows/test.yml/badge.svg?branch=main)](https://github.com/bsmartlabs/omniauth-bsmart/actions/workflows/test.yml)
+[![Release](https://github.com/bsmartlabs/omniauth-bsmart/actions/workflows/release.yml/badge.svg)](https://github.com/bsmartlabs/omniauth-bsmart/actions/workflows/release.yml)
+[![Gem Version](https://badge.fury.io/rb/omniauth-bsmart.svg)](https://badge.fury.io/rb/omniauth-bsmart)
+
+🔌 OmniAuth OAuth2 strategy for bSmart accounts.
+
+## Features
+
+- OAuth2 Authorization Code flow using bSmart Doorkeeper endpoints
+- User profile fetch from `GET /api/v6/user`
+- Automatic fallback to `GET /api/v6/me` when `/user` is unavailable
+- Auth hash with normalized `uid`, `info`, `credentials`, and `extra.raw_info`
+
+## Requirements
+
+- Ruby `>= 3.2`
+- OmniAuth `~> 2.0`
+- `omniauth-oauth2` `>= 1.8`, `< 1.9`
+
+## Installation
+
+```ruby
+gem 'omniauth-bsmart'
+```
+
+## Basic Usage
+
+```ruby
+use OmniAuth::Builder do
+  provider :bsmart,
+           ENV.fetch('BSMART_CLIENT_ID'),
+           ENV.fetch('BSMART_CLIENT_SECRET'),
+           scope: 'public'
+end
+```
+
+### Endpoint Defaults
+
+- Site: `https://www.bsmart.it`
+- Authorize URL: `/oauth/authorize`
+- Token URL: `/oauth/token`
+- User Info URL: `/api/v6/user`
+- Fallback User Info URL: `/api/v6/me`
+
+### Optional Overrides
+
+```ruby
+provider :bsmart,
+         ENV.fetch('BSMART_CLIENT_ID'),
+         ENV.fetch('BSMART_CLIENT_SECRET'),
+         client_options: {
+           site: 'https://www.bsmart.it',
+           authorize_url: '/oauth/authorize',
+           token_url: '/oauth/token'
+         },
+         user_info_url: '/api/v6/user',
+         me_url: '/api/v6/me'
+```
+
+## bSmart OAuth App Setup
+
+Create an OAuth application in bSmart (Doorkeeper) and configure your callback URL:
+
+- Production OAuth base: `https://www.bsmart.it/oauth`
+- Production API base: `https://www.bsmart.it/api/v6`
+
+Typical callback path:
+
+- `/auth/bsmart/callback`
+
+## Auth Hash
+
+```json
+{
+  "uid": "42",
+  "info": {
+    "name": "Ada Lovelace",
+    "email": "teacher@example.test",
+    "first_name": "Ada",
+    "last_name": "Lovelace",
+    "nickname": "teacher@example.test",
+    "image": "https://www.bsmart.it/avatar/42.png",
+    "roles": ["teacher"]
+  },
+  "credentials": {
+    "token": "access-token",
+    "refresh_token": "refresh-token",
+    "expires_at": 1773000000,
+    "expires": true,
+    "scope": "public"
+  },
+  "extra": {
+    "raw_info": {
+      "id": 42,
+      "email": "teacher@example.test",
+      "name": "Ada",
+      "surname": "Lovelace",
+      "avatar_url": "https://www.bsmart.it/avatar/42.png",
+      "roles": ["teacher"]
+    }
+  }
+}
+```
+
+## Development
+
+```bash
+bundle install
+bundle exec rake lint
+bundle exec rake test_unit
+bundle exec rake test_rails_integration
+```
+
+## CI Matrix
+
+- Ruby: `3.2`, `3.3`, `3.4`, `4.0`
+- Rails integration lanes: `~> 7.1.0`, `~> 7.2.0`, `~> 8.0.0`, `~> 8.1.0`
+- `omniauth-oauth2`: `1.8.x`
+
+## Release
+
+Tag a release:
+
+```bash
+git tag vX.Y.Z
+git push origin vX.Y.Z
+```
+
+The GitHub `Release` workflow publishes the gem through RubyGems Trusted Publishing.
+
+## License
+
+MIT

data/lib/omniauth/bsmart/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module OmniAuth
+  module Bsmart
+    VERSION = '1.0.0'
+  end
+end

data/lib/omniauth/bsmart.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require 'omniauth/bsmart/version'
+require 'omniauth/strategies/bsmart'

data/lib/omniauth/strategies/bsmart.rb

@@ -0,0 +1,105 @@
+# frozen_string_literal: true
+
+require 'omniauth-oauth2'
+
+module OmniAuth
+  module Strategies
+    # OmniAuth strategy for bSmart OAuth2.
+    class Bsmart < OmniAuth::Strategies::OAuth2
+      option :name, 'bsmart'
+      option :authorize_options, %i[scope]
+      option :scope, 'public'
+
+      option :client_options,
+             site: 'https://www.bsmart.it',
+             authorize_url: '/oauth/authorize',
+             token_url: '/oauth/token',
+             connection_opts: {
+               headers: {
+                 user_agent: 'bsmartlabs-omniauth-bsmart gem',
+                 accept: 'application/json'
+               }
+             }
+
+      option :user_info_url, '/api/v6/user'
+      option :me_url, '/api/v6/me'
+
+      uid { raw_info['id']&.to_s }
+
+      info do
+        {
+          name: full_name,
+          email: raw_info['email'],
+          first_name: raw_info['name'],
+          last_name: raw_info['surname'],
+          nickname: raw_info['email'],
+          image: raw_info['avatar_url'],
+          roles: raw_info['roles']
+        }.compact
+      end
+
+      credentials do
+        {
+          'token' => access_token.token,
+          'refresh_token' => access_token.refresh_token,
+          'expires_at' => access_token.expires_at,
+          'expires' => access_token.expires?,
+          'scope' => token_scope
+        }.compact
+      end
+
+      extra do
+        {
+          'raw_info' => raw_info
+        }
+      end
+
+      def raw_info
+        @raw_info ||= fetch_raw_info
+      end
+
+      private
+
+      def full_name
+        candidate = [raw_info['name'], raw_info['surname']].compact.join(' ').strip
+        return candidate unless candidate.empty?
+
+        raw_info['email']
+      end
+
+      def fetch_raw_info
+        [options[:user_info_url], options[:me_url]].compact.uniq.each do |path|
+          payload = access_token.get(path).parsed
+          normalized = normalize_raw_info(payload)
+          return normalized if normalized
+        rescue ::OAuth2::Error => e
+          raise unless fallback_user_info_error?(e)
+        end
+
+        {}
+      end
+
+      def normalize_raw_info(payload)
+        return unless payload.is_a?(Hash)
+        return payload if payload['id']
+
+        %w[user data].each do |key|
+          nested_payload = payload[key]
+          return nested_payload if nested_payload.is_a?(Hash) && nested_payload['id']
+        end
+
+        nil
+      end
+
+      def fallback_user_info_error?(error)
+        status = error.response&.status.to_i
+        [404, 405].include?(status)
+      end
+
+      def token_scope
+        token_params = access_token.respond_to?(:params) ? access_token.params : {}
+        token_params['scope'] || (access_token['scope'] if access_token.respond_to?(:[]))
+      end
+    end
+  end
+end

data/lib/omniauth-bsmart.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require 'omniauth/bsmart'

data/omniauth-bsmart.gemspec

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'omniauth/bsmart/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'omniauth-bsmart'
+  spec.version = OmniAuth::Bsmart::VERSION
+  spec.authors = ['Claudio Poli']
+  spec.email = ['masterkain@gmail.com']
+
+  spec.summary = 'OmniAuth strategy for bSmart OAuth2 authentication.'
+  spec.description = 'OAuth2 OmniAuth strategy that authenticates users against bSmart and maps v6 user profile data.'
+  spec.homepage = 'https://github.com/bsmartlabs/omniauth-bsmart'
+  spec.license = 'MIT'
+  spec.required_ruby_version = '>= 3.2'
+
+  spec.metadata['source_code_uri'] = 'https://github.com/bsmartlabs/omniauth-bsmart'
+  spec.metadata['bug_tracker_uri'] = 'https://github.com/bsmartlabs/omniauth-bsmart/issues'
+  spec.metadata['changelog_uri'] = 'https://github.com/bsmartlabs/omniauth-bsmart/releases'
+  spec.metadata['rubygems_mfa_required'] = 'true'
+
+  spec.files = Dir[
+    'lib/**/*.rb',
+    'README*',
+    'LICENSE*',
+    '*.gemspec'
+  ]
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'cgi', '>= 0.3.6'
+  spec.add_dependency 'omniauth-oauth2', '>= 1.8', '< 1.9'
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: omniauth-bsmart
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Claudio Poli
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: cgi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.3.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.3.6
+- !ruby/object:Gem::Dependency
+  name: omniauth-oauth2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.8'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.8'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+description: OAuth2 OmniAuth strategy that authenticates users against bSmart and
+  maps v6 user profile data.
+email:
+- masterkain@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/omniauth-bsmart.rb
+- lib/omniauth/bsmart.rb
+- lib/omniauth/bsmart/version.rb
+- lib/omniauth/strategies/bsmart.rb
+- omniauth-bsmart.gemspec
+homepage: https://github.com/bsmartlabs/omniauth-bsmart
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/bsmartlabs/omniauth-bsmart
+  bug_tracker_uri: https://github.com/bsmartlabs/omniauth-bsmart/issues
+  changelog_uri: https://github.com/bsmartlabs/omniauth-bsmart/releases
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: OmniAuth strategy for bSmart OAuth2 authentication.
+test_files: []