omniauth-moloni 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 115c7065e361f52e80786ab9f0b2c83747d541003014a5bc6244dbbae4e4db50
+  data.tar.gz: 4d84fa28b39dcb037b64abaec860ebe35d4dab0fa7917ae667cd0acb19a624cd
+SHA512:
+  metadata.gz: 2fdcdfb91a28444c9f243e29e8044a819c3b6dac9263c2dbd5db3a7839de26af4be14f3d9f5e95612d4e14dc2a73a3d65e6e69c534e7931507679600a3908d0b
+  data.tar.gz: afdc7f2501b9ebbb2cf20baade83b14b0a1e5b58f2d0f4c62464efc83a7d26e1b2a1ef0d2eb1c6b788008ddd298cadad16522a36a7e9f93db5fdd873c983336a

data/.github/workflows/ruby.yml

@@ -0,0 +1,26 @@
+name: Ruby
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.4', '2.5', '2.6', '2.7', '3.0', '3.1', 'truffleruby-head']
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby ${{ matrix.ruby-version }}
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+    - name: Build and test with Rake
+      run: |
+        gem install bundler
+        bundle install --jobs 4 --retry 3
+        bundle exec rake

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+/pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1 @@
+--colour

data/Dockerfile

@@ -0,0 +1,11 @@
+FROM ruby:3.0
+
+WORKDIR /usr/src/app
+
+COPY Gemfile .
+COPY omniauth-moloni.gemspec .
+COPY lib/omniauth-moloni/version.rb lib/omniauth-moloni/version.rb
+
+RUN bundle install
+
+COPY . .

data/Gemfile

@@ -0,0 +1,13 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in omniauth-moloni.gemspec
+gemspec
+
+group :development, :test do
+  gem 'guard'
+  gem 'guard-rspec'
+  gem 'guard-bundler'
+  gem 'rb-fsevent'
+  gem 'growl'
+  gem 'rake'
+end

data/Guardfile

@@ -0,0 +1,10 @@
+guard 'rspec', :version => 2 do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end
+
+guard 'bundler' do
+  watch('Gemfile')
+  watch('omniauth-moloni.gemspec')
+end

data/LICENSE.txt

@@ -0,0 +1,7 @@
+Copyright (c) 2022 Dinis Lage
+
+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,61 @@
+![Ruby](https://github.com/dlage/omniauth-moloni/workflows/Ruby/badge.svg?branch=master)
+
+# OmniAuth Moloni
+
+This is an unofficial OmniAuth strategy for authenticating to Moloni. To
+use it, you'll need to sign up for an OAuth2 Application ID and Secret
+on the [Moloni Applications Page](https://www.moloni.pt/dev/autenticacao/).
+
+## Installation
+
+```ruby
+gem 'omniauth-moloni', github: 'dlage/omniauth-moloni', branch: 'master'
+```
+
+## Basic Usage
+
+```ruby
+use OmniAuth::Builder do
+  provider :moloni, ENV['MOLONI_KEY'], ENV['MOLONI_SECRET']
+end
+```
+
+## Basic Usage Rails
+
+In `config/initializers/moloni.rb`
+
+```ruby
+Rails.application.config.middleware.use OmniAuth::Builder do
+  provider :moloni, ENV['MOLONI_KEY'], ENV['MOLONI_SECRET']
+end
+```
+
+## Moloni Sandbox Usage
+
+```ruby
+provider :moloni, ENV['MOLONI_KEY'], ENV['MOLONI_SECRET'],
+         {
+           :client_options => {
+             :site => 'https://api.moloni.pt/sandbox/',
+             :authorize_url => 'https://api.moloni.pt/sandbox/authorize/',
+             :token_url => 'https://api.moloni.pt/sandbox/grant/'
+           }
+         }
+```
+
+## License
+
+Copyright (c) 2022 Dinis Lage
+
+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/Rakefile

@@ -0,0 +1,8 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new
+
+desc 'Run specs'
+task :default => :spec

data/docker-compose.yml

@@ -0,0 +1,7 @@
+version: "3.9"
+services:
+  app:
+    build: .
+    command: bash -c "rake"
+    volumes:
+      - .:/usr/src/app

data/lib/omniauth/strategies/moloni.rb

@@ -0,0 +1,62 @@
+require 'omniauth-oauth2'
+
+module OmniAuth
+  module Strategies
+    class Moloni < OmniAuth::Strategies::OAuth2
+      option :client_options, {
+        :site => 'https://api.moloni.pt/v1/',
+        :authorize_url => 'https://api.moloni.pt/v1/authorize/',
+        :token_url => 'https://api.moloni.pt/v1/grant/'
+      }
+
+      def request_phase
+        super
+      end
+
+      def authorize_params
+        super.tap do |params|
+          %w[client_options].each do |v|
+            if request.params[v]
+              params[v.to_sym] = request.params[v]
+            end
+          end
+        end
+      end
+
+      uid { raw_info['user_id'].to_s }
+
+      info do
+        {
+          'name' => raw_info['name'],
+          'email' => raw_info['email'],
+          'cellphone' => raw_info['cellphone'],
+          'language_id' => raw_info['language_id'],
+          'language' => raw_info['language'],
+          'registered_since' => raw_info['registered_since'],
+          'last_login' => raw_info['last_login'],
+        }
+      end
+
+      extra do
+        { :raw_info => raw_info }
+      end
+
+      def raw_info
+        access_token.options[:mode] = :header
+        @raw_info ||= access_token.get('users/getMe/').parsed
+      end
+
+      def email
+        raw_info['email']
+      end
+
+      def scope
+        access_token['scope']
+      end
+
+      def callback_url
+        full_host + callback_path
+      end
+    end
+  end
+end

data/lib/omniauth-moloni/version.rb

@@ -0,0 +1,5 @@
+module OmniAuth
+  module Moloni
+    VERSION = "0.1.0"
+  end
+end

data/lib/omniauth-moloni.rb

@@ -0,0 +1,2 @@
+require "omniauth-moloni/version"
+require 'omniauth/strategies/moloni'

data/omniauth-moloni.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/omniauth-moloni/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Dinis Lage"]
+  gem.email         = ["dinis@lage.pw"]
+  gem.description   = %q{Unofficial OmniAuth strategy for Moloni.}
+  gem.summary       = %q{Unofficial OmniAuth strategy for Moloni.}
+  gem.homepage      = "https://github.com/dlage/omniauth-moloni"
+  gem.license       = "MIT"
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name          = "omniauth-moloni"
+  gem.require_paths = ["lib"]
+  gem.version       = OmniAuth::Moloni::VERSION
+
+  gem.add_dependency 'omniauth', '~> 2.0'
+  gem.add_dependency 'omniauth-oauth2', '~> 1.7.1'
+  gem.add_development_dependency 'rspec', '~> 3.5'
+  gem.add_development_dependency 'rack-test'
+  gem.add_development_dependency 'simplecov'
+  gem.add_development_dependency 'webmock'
+end

data/spec/omniauth/strategies/moloni_spec.rb

@@ -0,0 +1,102 @@
+require 'spec_helper'
+
+describe OmniAuth::Strategies::Moloni do
+  let(:moloni_user_path) { 'users/getMe/' }
+  let(:access_token) { instance_double('AccessToken', :options => {}, :[] => moloni_user_path) }
+  let(:parsed_response) { instance_double('ParsedResponse') }
+  let(:response) { instance_double('Response', :parsed => parsed_response) }
+
+  let(:sandbox_site) { 'https://api.moloni.pt/sandbox/' }
+  let(:sandbox_authorize_url) { 'https://api.moloni.pt/sandbox/authorize/' }
+  let(:sandbox_token_url) { 'https://api.moloni.pt/sandbox/grant/' }
+  let(:sandbox) do
+    OmniAuth::Strategies::Moloni.new(
+      'MOLONI_KEY', 'MOLONI_SECRET',
+      {
+        :client_options => {
+          :site => sandbox_site,
+          :authorize_url => sandbox_authorize_url,
+          :token_url => sandbox_token_url
+        }
+      }
+    )
+  end
+
+  subject do
+    OmniAuth::Strategies::Moloni.new({})
+  end
+
+  before(:each) do
+    allow(subject).to receive(:access_token).and_return(access_token)
+  end
+
+  context 'client options' do
+    it 'should have correct site' do
+      expect(subject.options.client_options.site).to eq('https://api.moloni.pt/v1/')
+    end
+
+    it 'should have correct authorize url' do
+      expect(subject.options.client_options.authorize_url).to eq('https://api.moloni.pt/v1/authorize/')
+    end
+
+    it 'should have correct token url' do
+      expect(subject.options.client_options.token_url).to eq('https://api.moloni.pt/v1/grant/')
+    end
+
+    describe 'should be overrideable' do
+      it 'for site' do
+        expect(sandbox.options.client_options.site).to eq(sandbox_site)
+      end
+
+      it 'for authorize url' do
+        expect(sandbox.options.client_options.authorize_url).to eq(sandbox_authorize_url)
+      end
+
+      it 'for token url' do
+        expect(sandbox.options.client_options.token_url).to eq(sandbox_token_url)
+      end
+    end
+  end
+
+  context '#email' do
+    it 'should return email from raw_info if available' do
+      allow(subject).to receive(:raw_info).and_return({ 'email' => 'you@example.com' })
+      expect(subject.email).to eq('you@example.com')
+    end
+
+    it 'should return nil if there is no raw_info and email access is not allowed' do
+      allow(subject).to receive(:raw_info).and_return({})
+      expect(subject.email).to be_nil
+    end
+  end
+
+  context '#raw_info' do
+    it 'should use relative paths' do
+      expect(access_token).to receive(:get).with(moloni_user_path).and_return(response)
+      expect(subject.raw_info).to eq(parsed_response)
+    end
+
+    it 'should use the header auth mode' do
+      expect(access_token).to receive(:get).with(moloni_user_path).and_return(response)
+      subject.raw_info
+      expect(access_token.options[:mode]).to eq(:header)
+    end
+  end
+
+  context '#info.email' do
+    it 'should use any available email' do
+      allow(subject).to receive(:raw_info).and_return({ 'email' => 'you@example.com' })
+      allow(subject).to receive(:email).and_return('you@example.com')
+      expect(subject.info['email']).to eq('you@example.com')
+    end
+  end
+
+  describe '#callback_url' do
+    it 'is a combination of host, script name, and callback path' do
+      allow(subject).to receive(:full_host).and_return('https://example.com')
+      allow(subject).to receive(:script_name).and_return('/sub_uri')
+
+      expect(subject.callback_url).to eq('https://example.com/sub_uri/auth/moloni/callback')
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+$:.unshift File.expand_path('..', __FILE__)
+$:.unshift File.expand_path('../../lib', __FILE__)
+require 'simplecov'
+SimpleCov.start
+require 'rspec'
+require 'rack/test'
+require 'webmock/rspec'
+require 'omniauth'
+require 'omniauth-moloni'
+
+RSpec.configure do |config|
+  config.include WebMock::API
+  config.include Rack::Test::Methods
+  config.extend  OmniAuth::Test::StrategyMacros, :type => :strategy
+end

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification
+name: omniauth-moloni
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Dinis Lage
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2022-08-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: omniauth
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: omniauth-oauth2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.7.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.7.1
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Unofficial OmniAuth strategy for Moloni.
+email:
+- dinis@lage.pw
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/ruby.yml"
+- ".gitignore"
+- ".rspec"
+- Dockerfile
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- docker-compose.yml
+- lib/omniauth-moloni.rb
+- lib/omniauth-moloni/version.rb
+- lib/omniauth/strategies/moloni.rb
+- omniauth-moloni.gemspec
+- spec/omniauth/strategies/moloni_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/dlage/omniauth-moloni
+licenses:
+- MIT
+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: []
+rubygems_version: 3.0.3.1
+signing_key: 
+specification_version: 4
+summary: Unofficial OmniAuth strategy for Moloni.
+test_files:
+- spec/omniauth/strategies/moloni_spec.rb
+- spec/spec_helper.rb