omniauth-wild-apricot 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f0c62dcf02e3d0513ff7299b3b9abc039bfd33e774561678cebb57d61eeca913
+  data.tar.gz: a7aaa8b0cfbbd7962c663866f373e0731b8dfac31ca113844b4c5d7d6a35eba5
+SHA512:
+  metadata.gz: 3916f9ac8974301f7a89ee3526c8a5d30abb7a3fd644985334b7d184c9e125ac770967a06037e1636b3f124b6eab726402de5271b54f79e9d9e3d54c500b6102
+  data.tar.gz: 1bfa9dbb3ff22ddda09582f2b2ede7d1b7aa4d872a6e416bf3c251385d56ea0609adc1b3180c630921960769ad8508133f522fb639b86819f4336d600266ad8d

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+.ruby-gemset
+.ruby-version
+.rvmrc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.powenv
+.idea/

data/CHANGELOG.md

@@ -0,0 +1,17 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+## 0.1.0 - 2023-08-31
+
+### Added
+- First version
+
+### Deprecated
+- Nothing
+
+### Removed
+- Nothing
+
+### Fixed
+- Nothing
+

data/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec

data/README.md

@@ -0,0 +1,210 @@
+# OmniAuth WildApricot OAuth2 Strategy
+
+Strategy to authenticate with WildApricot via OAuth2 in OmniAuth.
+
+For more details, read the WildApricot docs: https://gethelp.wildapricot.com/en/articles/200-single-sign-on-service-sso
+
+## Installation
+
+First start by adding this gem to your Gemfile:
+
+```ruby
+gem 'omniauth-wild-apricot'
+```
+
+If you need to use the latest HEAD version, you can do so with:
+
+```ruby
+gem 'omniauth-wild-apricot', github: 'rocket-house/omniauth-wild-apricot'
+```
+
+Then `bundle install`.
+
+## WildApricot API Setup
+
+Go to 'https://myWAsite.com/admin/apps/integration/authorized-applications/' then:
+
+* Select 'Authorize Application', then select 'Server Application'
+* Name your application
+* Select desired permission level: read/write
+* Click 'Generate client secret'
+* Select 'Authorize users via Wild Apricot single sign-on service'
+* Fill in your app's redirect domain
+* Take note of the following information:
+  * Client ID
+  * Client Secret
+
+Additionally, you'll need your Wild Apricot Account # which can be found on the admin/billing page. You also need your site's url. If you're billing page is 'https://myWAsite.com/admin/billing/' then your site url is 'https://myWAsite.com/'.
+
+The above information can be placed into your project's `.env` file (see `examples/.env-example`), or set as environment variables in your hosting provider's application settings.
+
+## Usage using OmniAuth
+
+Here's an example for adding the middleware to a Rails app in `config/initializers/omniauth.rb`. In this example, we are storing the key variables in the project's `.env` file (see `examples/.env-example`).
+
+```ruby
+Rails.application.config.middleware.use OmniAuth::Builder do
+  provider :wild_apricot, ENV['WA_CLIENT_ID'], ENV['WA_CLIENT_SECRET'],
+    {
+      account_num: ENV['WA_ACCT_NUM'], # found at: https://myWAsite.com/admin/billing/
+      site_url: ENV['WA_SITE_URL'],    # set to: 'https://myWAsite.com/'
+      callback_path: '/path/to/callback'
+    }
+end
+```
+
+## Usage using Devise
+
+If you are using [Devise](https://github.com/plataformatec/devise) then it will look like this:
+
+```ruby
+Devise.setup do |config|
+  # other stuff...
+
+  config.omniauth :wild_apricot, ENV['WA_CLIENT_ID'], ENV['WA_CLIENT_SECRET'],
+    {
+      account_num: ENV['WA_ACCT_NUM'], # found at: https://myWAsite.com/admin/billing/
+      site_url: ENV['WA_SITE_URL']     # set to: 'https://myWAsite.com/'
+    }
+
+  # other stuff...
+end
+```
+
+**NOTE:** If you are using this gem with devise with above snippet in `config/initializers/devise.rb` then do not create `config/initializers/omniauth.rb` which will conflict with devise configurations.
+
+Then add the following to 'config/routes.rb' so the callback routes are defined.
+
+```ruby
+devise_for :users, controllers: { omniauth_callbacks: 'users/omniauth_callbacks' }
+```
+
+Make sure your model is omniauthable. Generally this is "/app/models/user.rb"
+
+```ruby
+devise :omniauthable, omniauth_providers: [:wild_apricot]
+```
+
+Then make sure your callbacks controller is setup.
+
+```ruby
+# app/controllers/users/omniauth_callbacks_controller.rb:
+
+class Users::OmniauthCallbacksController < Devise::OmniauthCallbacksController
+  def wild_apricot
+      # You need to implement the method below in your model (e.g. app/models/user.rb)
+      @user = User.from_omniauth(request.env['omniauth.auth'])
+
+      if @user.persisted?
+        flash[:notice] = I18n.t 'devise.omniauth_callbacks.success', kind: 'Wild Apricot'
+        sign_in_and_redirect @user, event: :authentication
+      else
+        session['devise.wild_apricot_data'] = request.env['omniauth.auth'].except('extra') # Removing extra as it can overflow some session stores
+        redirect_to new_user_registration_url, alert: @user.errors.full_messages.join("\n")
+      end
+  end
+end
+```
+
+and bind to or create the user
+
+```ruby
+def self.from_omniauth(access_token)
+    data = access_token.info
+    user = User.where(email: data['email']).first
+
+    # Uncomment the section below if you want users to be created if they don't exist
+    # unless user
+    #     user = User.create(name: data['name'],
+    #        email: data['email'],
+    #        password: Devise.friendly_token[0,20]
+    #     )
+    # end
+    user
+end
+```
+
+For your views you can login using:
+
+```erb
+<%# omniauth-wild-apricot 1.0.x uses OmniAuth 2 and requires using HTTP Post to initiate authentication: %>
+<%= link_to "Sign in with Wild Apricot", user_wild_apricot_omniauth_authorize_path, method: :post %>
+
+<%# omniauth-wild-apricot prior 1.0.0: %>
+<%= link_to "Sign in with Wild Apricot", user_wild_apricot_omniauth_authorize_path %>
+
+<%# Devise prior 4.1.0: %>
+<%= link_to "Sign in with Wild Apricot", user_omniauth_authorize_path(:wild_apricot) %>
+```
+
+An overview is available at https://github.com/plataformatec/devise/wiki/OmniAuth:-Overview
+
+## Auth Hash
+
+Here's an example of an authentication hash available in the callback by accessing `request.env['omniauth.auth']`:
+
+```ruby
+{
+  "provider":"wild_apricot",
+  "uid":"50152421",
+  "info":{
+    "email":"anita.borg@example.com",
+    "first_name":"Anita",
+    "last_name":"Borg",
+    "name":"Anita Borg"
+  },
+  "credentials":{
+    "token":"thaXd6xjo4qpQnwraebbGA40vzg-",
+    "refresh_token":"rt_2023-09-02_VguuDxHFznplhQk1YaOtNrxcgyk-",
+    "expires_at":1693689961,
+    "expires":true
+  },
+  "extra":{
+    "raw_info":{
+      "AdministrativeRoleTypes":["AccountAdministrator"],
+      "FirstName":"Anita",
+      "LastName":"Anita",
+      "Email":"anita.borg@example.com",
+      "DisplayName":"Anita, Anita",
+      "PasswordExpiration":"2024-08-17T05:42:03+00:00",
+      "MembershipLevel":{
+        "Id":1253690,
+        "Url":"https://api.wildapricot.org/v2/accounts/321456/MembershipLevels/1253690",
+        "Name":"FREE"
+      },
+      "Status":"Active",
+      "Id":50152421,
+      "Url":"https://api.wildapricot.org/v2/accounts/321456/Contacts/50152421",
+      "IsAccountAdministrator":true,
+      "TermsOfUseAccepted":true
+    }
+  }
+}
+```
+
+## Fixing Protocol Mismatch for `redirect_uri` in Rails
+
+Just set the `full_host` in OmniAuth based on the Rails.env.
+
+```
+# config/initializers/omniauth.rb
+OmniAuth.config.full_host = Rails.env.production? ? 'https://domain.com' : 'http://localhost:3000'
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## License
+
+Copyright (c) 2023 by Fred Zirdung
+
+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 @@
+# frozen_string_literal: true
+
+require File.join('bundler', 'gem_tasks')
+require File.join('rspec', 'core', 'rake_task')
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/examples/.env-example

@@ -0,0 +1,4 @@
+WA_ACCT_NUM='FIXME'
+WA_SITE_URL='FIXME'
+WA_CLIENT_ID='FIXME'
+WA_CLIENT_SECRET='FIXME'

data/lib/omniauth/strategies/wild_apricot.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+require 'oauth2'
+require 'omniauth-oauth2'
+
+module OmniAuth
+  module Strategies
+    class WildApricot < OmniAuth::Strategies::OAuth2
+
+      DEFAULT_SCOPE = 'contacts_me'
+      AUTHORIZE_URL = '/sys/login/OAuthLogin'
+      BASE_API_URL  = 'https://api.wildapricot.org/v2'
+      TOKEN_URL     = 'https://oauth.wildapricot.org/auth/token'
+
+      option :name, 'wild_apricot'
+
+      # override the base class param functions -- this
+      # allows us to use values in the `options` hash at
+      # run time insead of setting the values at load time
+      #
+      # the options hash contains user-defined values not
+      # available at class load time
+
+      def authorize_params
+        super.merge({
+          scope: DEFAULT_SCOPE,
+          response_type: 'authorization_code',
+          claimed_account_id: options.account_num
+        })
+      end
+
+      def token_params
+        super.merge({
+          headers: {
+            'Authorization' => "Basic #{authorization_header}"
+          },
+        })
+      end
+
+      # pull values from the options hash at run time instead
+      # of static values at class load time (using `option`)
+
+      def client_options
+        {
+          site: options.site,
+          authorize_url: AUTHORIZE_URL,
+          token_url: TOKEN_URL
+        }
+      end
+
+      # override the default client so we can use the `client_options`
+      # funciton instead of the values set via the `option` function
+
+      def client
+        ::OAuth2::Client.new(options.client_id, options.client_secret, deep_symbolize(client_options))
+      end
+
+      # standard strategy implementation stuff below here
+
+      uid { raw_info['Id'].to_s }
+
+      info do
+        {
+          email: raw_info['Email'],
+          first_name: raw_info['FirstName'],
+          last_name: raw_info['LastName'],
+          name: "#{raw_info['FirstName']} #{raw_info['LastName']}"
+        }
+      end
+
+      extra do
+        {
+          raw_info: raw_info
+        }
+      end
+
+      def raw_info
+        @raw_info ||= access_token.get(contact_url).parsed
+      end
+
+      def callback_url
+        full_host + script_name + callback_path
+      end
+
+      private #######################################################
+
+      def contact_url
+        "#{BASE_API_URL}/Accounts/#{options.account_num}/Contacts/Me"
+      end
+
+      def authorization_header
+        Base64.strict_encode64("#{options.client_id}:#{options.client_secret}")
+      end
+
+    end
+  end
+end

data/lib/omniauth/wild_apricot/version.rb

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

data/lib/omniauth/wild_apricot.rb

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

data/lib/omniauth-wild-apricot.rb

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

data/omniauth-wild-apricot.gemspec

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require File.expand_path(
+  File.join('..', 'lib', 'omniauth', 'wild_apricot', 'version'),
+  __FILE__
+)
+
+Gem::Specification.new do |gem|
+  gem.name          = 'omniauth-wild-apricot'
+  gem.version       = OmniAuth::WildApricot::VERSION
+  gem.license       = 'MIT'
+  gem.summary       = %(A WildApricot OAuth2 strategy for OmniAuth 1.x)
+  gem.description   = %(A WildApricot OAuth2 strategy for OmniAuth 1.x. This allows you to login to WildApricot with your ruby app.)
+  gem.authors       = ['Fred Zirdung']
+  gem.email         = ['fred@rocket-house.com']
+  gem.homepage      = 'https://github.com/rocket-house/omniauth-wild-apricot'
+
+  gem.files         = `git ls-files`.split("\n")
+  gem.require_paths = ['lib']
+
+  gem.required_ruby_version = '>= 2.2'
+
+  gem.add_runtime_dependency 'oauth2', '~> 2.0'
+  gem.add_runtime_dependency 'omniauth', '~> 2.0'
+  gem.add_runtime_dependency 'omniauth-oauth2', '~> 1.8'
+
+  gem.add_development_dependency 'rake', '~> 12.0'
+  gem.add_development_dependency 'rspec', '~> 3.6'
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require File.join('bundler', 'setup')
+require 'rspec'

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: omniauth-wild-apricot
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Fred Zirdung
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-09-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: oauth2
+  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
+  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.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+description: A WildApricot OAuth2 strategy for OmniAuth 1.x. This allows you to login
+  to WildApricot with your ruby app.
+email:
+- fred@rocket-house.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CHANGELOG.md
+- Gemfile
+- README.md
+- Rakefile
+- examples/.env-example
+- lib/omniauth-wild-apricot.rb
+- lib/omniauth/strategies/wild_apricot.rb
+- lib/omniauth/wild_apricot.rb
+- lib/omniauth/wild_apricot/version.rb
+- omniauth-wild-apricot.gemspec
+- spec/spec_helper.rb
+homepage: https://github.com/rocket-house/omniauth-wild-apricot
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.32
+signing_key:
+specification_version: 4
+summary: A WildApricot OAuth2 strategy for OmniAuth 1.x
+test_files: []