omniauth-vis 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 629b78fabaac3afbb49bda60037485bf94fd812212b23152c92eb3edb0af57fe
+  data.tar.gz: d619da57ccd0602c3b81f854e5e5cf0e894ea8d872bdf55fb8ac253ab5c99978
+SHA512:
+  metadata.gz: 9c7ff8ee0d11e59c69ae055224decc3bf17cf29bcf53f7d378406817f8d3b3090045fa890bc5f086bac60732d8d779b2b658308a7ae5e67bbe91437cc552db90
+  data.tar.gz: 9d78c3f003085a28194aa6cfb67750027c7b2e3dd142fecd6f8902a7b728d8a3adbdef9c1b54316ace038b8c2d2be53854befa1056180956cfea53d725b41ac8

data/.gitignore

@@ -0,0 +1 @@
+*.gem

data/README.md

@@ -0,0 +1,71 @@
+# omniauth-vis
+
+This small gem will help Rails apps to connect to Vipassana Identity Server (VIS) using Auth2
+
+It provides:
+- a strategy file to be used with `omniauth` gem
+- a service to request VIS APIs endpoints
+
+## Register your app
+
+Contact VIS administrators (sebastian.castro@dhamma.org, ryan.johnson@dhamma.org, nilendu.jani@dhamma.org) and provide following informations about your app:
+
+- Name
+- Home page url
+- Logo url
+- Authorized callback urls (example: https://myapp.org/users/auth/vis/callback)
+
+## Install the gem
+
+```
+gem add omniauth-vis
+```
+
+## Configure
+
+```
+# config/initializers/vis.rb
+
+Rails.application.config.vis = {
+  app_id: "APP_ID_PROVIDED",
+  app_secret: "APP_SECRET_PROVIDED",
+  app_url: "https://identity.server.dhamma.org/"
+}
+```
+
+## Use omniauth strategy
+
+You first need to install `omniauth-oauth2` gem, then add a new provider :
+
+```
+# config/initializers/omniauth.rb
+
+Rails.application.config.middleware.use OmniAuth::Builder do
+  provider :vis, Rails.application.config.vis["app_id"], Rails.application.config.vis["app_secret"],
+    {
+      scope: "default"
+    }
+end
+```
+
+## Use VIS API
+
+`Vis::Api` will implement [Oauth2 Client Credentials Flow](https://auth0.com/docs/get-started/authentication-and-authorization-flow/client-credentials-flow) behind the scene
+
+```
+@vis_api = Vis::Api.new
+@vis_service.get("api_path")
+@vis_service.post("api_path", data)
+```
+
+Documentation about available api can be found at [https://identity.server.dhamma.org/doc](https://identity.server.dhamma.org/doc)
+
+Example
+
+```
+Vis::Api.new.post("/api/v1/users", {
+  email: "email@test.com",
+  username: "test",
+  encrypted_password: "xxxxxxxxxx"
+})
+```

data/lib/omniauth/strategies/vis.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require 'omniauth/strategies/oauth2'
+
+module OmniAuth
+  module Strategies
+    class Vis < OmniAuth::Strategies::OAuth2
+      option :name, :vis
+
+      option :client_options,
+        site: Rails.application.config.vis['app_url'],
+        authorize_path: '/oauth/authorize'
+
+      def on_path?(path)
+        current_path.squeeze('/').casecmp(path.squeeze('/')).zero?
+      end
+
+      def setup_phase
+        # Authorize extra params
+        authorized_params = [:locale, :confirm_identity, :allow_sign_up,
+          :allowed_external_providers, :extra_agreement_title, :extra_agreement_text]
+        authorized_params.each do |param|
+          request.env['omniauth.strategy'].options[:authorize_params][param] = request.params[param.to_s]
+        end
+      end
+
+      uid do
+        raw_info['id']
+      end
+
+      info do
+        raw_info
+      end
+
+      # to fix always getting invalid_grant error
+      # see https://github.com/omniauth/omniauth-oauth2/issues/81#issuecomment-231442739
+      def callback_url
+        full_host + script_name + callback_path
+      end
+
+      def raw_info
+        @raw_info ||= access_token.get('/api/v1/me.json').parsed
+      end
+    end
+  end
+end

data/lib/omniauth_vis.rb

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

data/lib/vis/api.rb

@@ -0,0 +1,79 @@
+# Vipassna Identity Server Service - for server to server Oauth 2 client_credentials grant flow
+# gets tokens so we can use the VIS API
+module Vis
+  class Api
+    def initialize
+      @client_id = Rails.application.config.vis["app_id"]
+      @client_secret = Rails.application.config.vis["app_secret"]
+      @vis_app_url = Rails.application.config.vis["app_url"]
+      @use_ssl = !Rails.env.development?
+    end
+
+    def token
+      return @token if @token && @expiry && Time.now.utc < @expiry
+
+      response = token_post
+      result = JSON.parse(response.body)
+      check_error!(response.code, result)
+
+      @expiry = (Time.now.utc + result["expires_in"] - 1)
+      @token = result["access_token"]
+    end
+
+    # we can catch VisOauthErrors in our code if we decide to use VIS API as part of any request flow or backend task
+    private def check_error!(response_code, response_body_hash)
+      return unless response_body_hash["error"].present? || !response_code.in?(["200", "202"]) # 201 ?
+
+      raise Exceptions::VisOauthError,
+        "#{response_code} Error requesting token from Vipassana Identity Server. "\
+        "#{response_body_hash['error']} #{response_body_hash['error_description']}"
+    end
+
+    private def token_post
+      # uri = URI.parse("#{@vis_app_url})
+      http_client, uri = http_client_and_uri "/oauth/token"
+      request = Net::HTTP::Post.new(uri.request_uri)
+      # request.set_form_data({ "client_id" => @client_id, "client_secret" => @client_secret,
+      request.set_form_data({ "client_id" => @client_id, "client_secret" => @client_secret,
+        "grant_type" => "client_credentials" })
+      http_client.request(request)
+    end
+
+    def get(path)
+      http_client, uri = http_client_and_uri path
+      response = http_client.get(uri, headers)
+      return_response(response)
+    end
+
+    def post(path, post_params_hash)
+      http_client, uri = http_client_and_uri path
+      response = http_client.post(uri, post_params_hash.to_json, headers)
+      return_response(response)
+    end
+
+    private def return_response(response)
+      if response.body.blank?
+        {} # TODO: consider also returning or checking response.status, should be 202 for forward message
+      else
+        JSON.parse(response.body) # this is sometimes a blank string which raises error if JSON.parse is done on it
+      end
+    end
+
+    private def http_client_and_uri(path)
+      path = "/#{path}" unless path&.starts_with?("/")
+      uri = URI.parse("#{@vis_app_url}#{path}")
+      client = Net::HTTP.new(uri.hostname, uri.port)
+      client.use_ssl = @use_ssl
+      [client, uri]
+    end
+
+    private def headers
+      auth_headers.merge({ "Content-type" => "application/json" })
+    end
+
+    private def auth_headers
+      { "Authorization" => "Bearer #{token}" }
+    end
+
+  end
+end

data/omniauth-vis.gemspec

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+Gem::Specification.new do |gem|
+  gem.name          = 'omniauth-vis'
+  gem.version       = '0.0.2'
+  # gem.license       = 'MIT'
+  gem.summary       = 'Helper to connect to Vipassna Identity Server'
+  gem.description   = 'This allows you to connect to Vipassana identity server with your ruby app'
+  gem.authors       = ['Dhamma workers']
+  gem.email         = ['sebastian.castro@dhamma.org', 'ryan.johnson@dhamma.org']
+  # gem.homepage      = 'https://identity.server.dhamma.org/'
+
+  gem.files         = `git ls-files`.split("\n")
+  gem.require_paths = ['lib']
+
+  gem.add_runtime_dependency 'omniauth-oauth2', '~> 1.2'
+end

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification
+name: omniauth-vis
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Dhamma workers
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2022-10-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: omniauth-oauth2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+description: This allows you to connect to Vipassana identity server with your ruby
+  app
+email:
+- sebastian.castro@dhamma.org
+- ryan.johnson@dhamma.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- README.md
+- lib/omniauth/strategies/vis.rb
+- lib/omniauth_vis.rb
+- lib/vis/api.rb
+- omniauth-vis.gemspec
+homepage: 
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6.2
+signing_key: 
+specification_version: 4
+summary: Helper to connect to Vipassna Identity Server
+test_files: []