omniauth-munic 1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1e453c7aa6dbba1c851623524a53ff2fa58c8f13
+  data.tar.gz: 4977c2b7818114704acfec7a2369e1a09b3f3cc1
+SHA512:
+  metadata.gz: 6bc1f787c006e54ad0a1f1113816a80fc935c6b50f4d11748f9fa25a2fde8eef3e8698dd0a170ec3734071d617fbb40ce28d1d8316f52ae4ae9c6860aea3dec5
+  data.tar.gz: af1ff396de3b034046265a85af95b08e4c4452a29e678bfe666568702c8ee28bebb5975036312646788be646b957ff14b35c7a4254bd345175411719471d2e68

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in omniauth-munic.gemspec
+gemspec

data/README.md

@@ -0,0 +1,131 @@
+# Omniauth::Munic
+
+This gem contains the MunicConnect strategy for OmniAuth.
+
+## Installation
+
+Add these lines to your Gemfile:
+
+```ruby
+gem 'omniauth-munic'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install omniauth-munic
+
+### Register your application on MunicConnect
+
+First, you need to register your application on MunicConnect. [Here](https://connect.munic.io/oauth/applications) you can create a new application (you need to be logged in with your MunicConnect account).
+
+* Name                : Name of your application
+* Private             : If yes, MunicConnect User must be approved (by you) before be abble to sign in your application; else, any MunicConnect User can sign in.
+* Authorized users    : If your application is private, this allow you to authorize users to acces your application.
+* Redirect uri        : After successfull sign in on MunicConnect, customer will be redirected on your application. E.g. '[yoursite]/auth/munic/callback'. (You will re-use it [here](#routes).)
+
+### Set Application uid and Secret
+[Applications](https://connect.munic.io/oauth/applications) is listing all your applications. By clicking on the name of an application, you can get information about it, especially two strings of 64 hexadecimal characters long : "Application" and "Secret". _DO NOT_ share this credentials !
+
+Put them in `config/initializers/omniauth.rb` like so :
+
+    Rails.application.config.middleware.use OmniAuth::Builder do
+        provider :munic, 'APPLICATION', 'SECRET'
+    end
+
+### Routes
+In `config/routes.rb`, you must `get` the [redirect uri](#register-your-application-on-municconnect) and trigger an action.
+
+Basically you will need to create a session on your site :
+
+    get 'REDIRECT_URI', to: 'SESSION_CONTROLLER_NAME#create'
+
+E.g.
+
+    get '/auth/munic/callback', to: 'sessions#create_from_munic'
+
+
+### Model and Controller
+
+You have to manage your own Model User and Sessions Controller.
+Above are examples.
+
+#### Users Table
+    create_table :users do |t|
+        t.string :provider
+        t.string :uid
+        t.string :email
+    end
+
+#### User Model
+    def self.create_with_omniauth(auth)
+        create! do |user|
+          user.provider = auth["provider"]
+          user.uid = auth["uid"]
+          user.email = auth["info"].email
+        end
+    end
+
+#### Session Controller
+    def create_from_munic
+        auth = request.env["omniauth.auth"]
+        user = User.find_by_provider_and_uid(auth[:provider], auth[:uid]) || User.create_with_omniauth(auth)
+        redirect_to root_url, :notice => "Signed in!"
+    end
+
+### Link to "Sign in with Munic"
+    <%= link_to "Sign in with Munic", "/auth/munic" %>
+
+
+### Redirect to exact same point after successfull sign in (optional)
+In your Session Controller add the following line :
+
+    redirect_to request.env["omniauth.origin"] || root_url, :notice => "Signed in!"
+
+
+## Usage
+
+### User's information
+You can get user's information when [creating a session](#session-controller) with this line :
+
+    auth = request.env["omniauth.auth"]
+    auth["info"]
+
+You can get :
+* Email -> auth["info"].email
+* Full Name -> auth["info"].full_name
+* Company Name -> auth["info"].company_name if present
+* Time Zone -> auth["info"].time_zone if present
+* V.a.t -> auth["info"].vat if present
+* Language -> auth["info"].language
+
+### Update User's information
+If you store information in your database, you may want to update it. This method needs the user to sign-in to update information.
+
+#### User Model
+Add this method to your user model :
+
+    def update_info(info)
+        if self.updated_at < info.updated_at
+        self.update_attribute(:email, info.email)
+        #update other information you have stored
+        end
+    end
+
+#### Session Controller
+Add this line to your session creation :
+
+    def create_from_munic
+        auth = request.env["omniauth.auth"]
+        user = User.find_by_provider_and_uid(auth[:provider], auth[:uid]) || User.create_with_omniauth(auth)
+        user.update_info(auth[:extra][:raw_info])       #
+        redirect_to root_url, :notice => "Signed in!"
+    end
+
+## Refresh token
+Please note that the gem does not provide a helper to refresh the access token once it has expried. Each partner application will have to implment it.
+Please use [munic connect documentation](https://connect.munic.io/docs/api/v1) for implement refresh token fallback.
+

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'omniauth-munic'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/omniauth/strategies/munic.rb

@@ -0,0 +1,37 @@
+module OmniAuth
+    module Strategies
+        autoload :Munic, 'omniauth/strategies/munic'
+
+        class Munic < OmniAuth::Strategies::OAuth2
+            # Give your strategy a name.
+            option :name, 'munic'
+
+            # This is where you pass the options you would pass when
+            # initializing your consumer from the OAuth gem.
+            option :client_options, {:site => 'https://connect.munic.io'}
+
+            # These are called after authentication has succeeded. If
+            # possible, you should try to set the UID without making
+            # additional calls (if the user id is returned with the token
+            # or as a URI parameter). This may not be possible with all
+            # providers.
+            uid { raw_info['uid'] }
+
+            info do
+                i = {
+                    email: raw_info['email'],
+                    full_name: raw_info['full_name'],
+                    language: raw_info['language']
+                }
+                i[:time_zone] = raw_info['time_zone'] unless raw_info['time_zone'].nil?
+                i[:company] = raw_info['company'] unless raw_info['company'].nil?
+                i[:vat] = raw_info['vat'] unless raw_info['vat'].nil?
+                i
+            end
+
+            def raw_info
+                @raw_info ||= access_token.get('/api/v1/users/me.json').parsed
+            end
+        end
+    end
+end

data/lib/omniauth-munic/version.rb

@@ -0,0 +1,5 @@
+module OmniAuth
+    module Munic
+        VERSION = '1.0'
+    end
+end

data/lib/omniauth-munic.rb

@@ -0,0 +1,3 @@
+require 'omniauth-oauth2'
+require 'omniauth-munic/version'
+require 'omniauth/strategies/munic'

data/omniauth-munic.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'omniauth-munic/version'
+
+Gem::Specification.new do |spec|
+    spec.add_dependency 'omniauth-oauth2', '~> 1.3.1'
+
+    spec.name          = 'omniauth-munic'
+    spec.version       = OmniAuth::Munic::VERSION
+    spec.authors       = ['maxime dufay']
+    spec.email         = ['maxime.dufay@mobile-devices.fr']
+
+    spec.description   = 'The Munic OAuth2 strategy for OmniAuth 1.x.'
+    spec.summary       = spec.description
+    spec.homepage      = 'https://github.com/municio/omniauth-munic'
+    spec.license       = 'MIT'
+
+    spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+    spec.bindir        = 'exe'
+    spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+    spec.require_paths = ['lib']
+
+    spec.add_development_dependency 'bundler', '~> 1.9'
+    spec.add_development_dependency 'rake', '~> 10.0'
+    spec.add_development_dependency 'rspec', '~> 3.5', '>= 3.5.0'
+    spec.add_development_dependency 'omniauth-oauth2', '~> 1.3.1'
+end

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: omniauth-munic
+version: !ruby/object:Gem::Version
+  version: '1.0'
+platform: ruby
+authors:
+- maxime dufay
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-02-10 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.3.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.1
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+- !ruby/object:Gem::Dependency
+  name: omniauth-oauth2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.1
+description: The Munic OAuth2 strategy for OmniAuth 1.x.
+email:
+- maxime.dufay@mobile-devices.fr
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/omniauth-munic.rb
+- lib/omniauth-munic/version.rb
+- lib/omniauth/strategies/munic.rb
+- omniauth-munic.gemspec
+homepage: https://github.com/municio/omniauth-munic
+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: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: The Munic OAuth2 strategy for OmniAuth 1.x.
+test_files: []