omniauth-samedi 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 72b022445a5b50c7242b3643f9116c0a944aa41bfa810a8fadacdf4884021837
+  data.tar.gz: dd564547dfc87150b07f2830d27a8933295255ce2a816ab275b933a3625a232a
+SHA512:
+  metadata.gz: b4927fbdd2cad2ef84d6af90c2e0cfb08673932ffdafca02c75cf769514c8334a304c46f6965756e9dd18d3a968429d5d0aacafb3c5b136ce7f3664091e415b2
+  data.tar.gz: 579810450b60ea98ec6a97eff0ae3d151be3dea5da4241eab0e9053c96fede0ee049b36190c61787d4b6488041953192a3b329fe70c4f8432fb6945532495c0f

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 samedi GmbH
+
+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,59 @@
+# OmniAuth Samedi
+
+[![Build Status](https://travis-ci.com/samedi/omniauth-samedi.svg?branch=master)](https://travis-ci.com/samedi/omniauth-samedi)
+[![Maintainability](https://api.codeclimate.com/v1/badges/3c597b941cd1fdbce47e/maintainability)](https://codeclimate.com/github/samedi/omniauth-samedi/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/3c597b941cd1fdbce47e/test_coverage)](https://codeclimate.com/github/samedi/omniauth-samedi/test_coverage)
+
+Samedi® authentication strategy for OmniAuth.
+
+The strategy implements the OAuth 2.0 flow for authentication with samedi®, as described in [samedi® Booking API docs](https://wiki.samedi.de/display/doc/Booking+API#BookingAPI-AuthenticationandAuthorization) and also fetches basic [user information](https://wiki.samedi.de/display/doc/Booking+API#BookingAPI-UserInformation).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'omniauth-samedi'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install omniauth-samedi
+
+## Usage
+
+Obtain your Client Key and Client Secret by [signing up for samedi® API credentials](https://patient.samedi.de/api/signup).
+
+You can then add the `samedi` provider in the way that is most appropriate for your app. E.g. if you're using Rails with OmniAuth directly, you can add the following to your `conifg/initializers/omniauth.rb`:
+
+```ruby
+Rails.application.config.middleware.use OmniAuth::Builder do
+  provider :samedi, ENV.fetch('CLIENT_ID'), ENV.fetch('CLIENT_SECRET')
+end
+```
+
+After the authentication is performed, the user data is retrieved automatically.
+
+For an example of using the strategy within a Rails application, consult the [rails-booking-api](https://github.com/samedi/rails-booking-api) repo.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/samedi/omniauth-samedi. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the OmniAuth Samedi project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/omniauth-samedi/blob/master/CODE_OF_CONDUCT.md).

data/lib/omniauth-samedi.rb

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

data/lib/omniauth-samedi/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Omniauth
+  module Samedi
+    VERSION = '0.1.0'
+  end
+end

data/lib/omniauth/strategies/samedi.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+require 'omniauth-oauth2'
+
+module OmniAuth
+  module Strategies
+    # Provides implementation of an OmniAuth strategy that works with samedi Booking API.
+    #
+    # For more information, consult the OmniAuth Strategy Contribution Guide:
+    # https://github.com/omniauth/omniauth/wiki/Strategy-Contribution-Guide
+    #
+    # Note: this file is explicitly required by config/initializers/omniauth.rb so changes to it
+    # won't be automatically reloaded and you need to restart the Rails app after every change to the strategy.
+    # Changing `require` to `require_dependency` won't work, because Rails doesn't clear dependencies
+    # required by initializers.
+    class Samedi < OmniAuth::Strategies::OAuth2
+      BOOKING_AUTH_URL = 'https://patient.samedi.de/api/auth/v2'
+      BOOKING_API_URL = 'https://patient.samedi.de/api/booking/v3'
+
+      option :name, 'samedi'
+      option(
+        :client_options,
+        site: BOOKING_AUTH_URL,
+        authorize_url: "#{BOOKING_AUTH_URL}/authorize",
+        token_url: "#{BOOKING_AUTH_URL}/token"
+      )
+
+      uid do
+        user_info.dig('user', 'id')
+      end
+
+      info do
+        user_data = user_info['user']
+
+        if user_data
+          {
+            name: user_data['full_name'],
+            email: user_data['email'],
+            first_name: user_data['first_name'],
+            last_name: user_data['last_name']
+          }
+        else
+          {}
+        end
+      end
+
+      extra do
+        { raw_info: user_info['user'] }
+      end
+
+      private
+
+      # samedi Booking API doesn't like a query string inside redirect_uri, so we need to override it explicitly
+      def query_string
+        ''
+      end
+
+      def user_info
+        return @user_info if @user_info
+
+        user_info_response = fetch_user_info
+        return {} unless user_info_response
+
+        @user_info = MultiJson.load(user_info_response.body)
+      end
+
+      def fetch_user_info
+        response = booking_api_client.get('user')
+
+        return response if response.success?
+
+        fail!("error_#{response.status}_getting_user_info")
+        nil
+      rescue Faraday::TimeoutError => e
+        fail!(:timeout_getting_user_info, e)
+        nil
+      end
+
+      def booking_api_client
+        @booking_api_client ||= Faraday.new(BOOKING_API_URL) do |faraday|
+          faraday.headers = { 'Authorization': "Bearer #{access_token.token}" }
+          faraday.adapter Faraday.default_adapter
+        end
+      end
+    end
+  end
+end

data/omniauth-samedi.gemspec

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'omniauth-samedi/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'omniauth-samedi'
+  spec.version       = Omniauth::Samedi::VERSION
+  spec.authors       = ['Damir Zekić']
+  spec.email         = ['damir.zekic@toptal.com']
+
+  spec.summary       = 'Samedi Booking API authentication strategy for OmniAuth'
+  spec.description   = 'Samedi Booking API authentication strategy for OmniAuth implemented upon OmniAuth OAuth2 strategy.'
+  spec.homepage      = 'https://github.com/samedi/omniauth-samedi'
+  spec.license       = 'MIT'
+
+  if spec.respond_to?(:metadata)
+    spec.metadata['homepage_uri'] = 'https://wiki.samedi.de/display/doc/Booking+API'
+    spec.metadata['source_code_uri'] = spec.homepage
+    spec.metadata['changelog_uri'] = 'https://github.com/samedi/omniauth-samedi/releases'
+  else
+    raise 'RubyGems 2.0 or newer is required to publish metadata'
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").select { |f| f.match(%r{^(lib/|LICENSE|README|omniauth-samedi\.gemspec)}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'omniauth', '~> 1.0'
+  spec.add_dependency 'omniauth-oauth2', '~> 1.0'
+
+  spec.add_development_dependency 'addressable', '~> 2.5'
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'codecov'
+  spec.add_development_dependency 'faraday'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'rack-test', '~> 1.0'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'webmock', '~> 3.4'
+end

metadata

@@ -0,0 +1,236 @@
+--- !ruby/object:Gem::Specification
+name: omniauth-samedi
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Damir Zekić
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-12-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: omniauth
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: omniauth-oauth2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: addressable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: codecov
+  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: faraday
+  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: pry
+  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: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !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.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+description: Samedi Booking API authentication strategy for OmniAuth implemented upon
+  OmniAuth OAuth2 strategy.
+email:
+- damir.zekic@toptal.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/omniauth-samedi.rb
+- lib/omniauth-samedi/version.rb
+- lib/omniauth/strategies/samedi.rb
+- omniauth-samedi.gemspec
+homepage: https://github.com/samedi/omniauth-samedi
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://wiki.samedi.de/display/doc/Booking+API
+  source_code_uri: https://github.com/samedi/omniauth-samedi
+  changelog_uri: https://github.com/samedi/omniauth-samedi/releases
+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
+signing_key: 
+specification_version: 4
+summary: Samedi Booking API authentication strategy for OmniAuth
+test_files: []