omniauth-your-membership-token 1.1.2 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: a3e72458def061151d23a7bc5c8f70a944fce061
-  data.tar.gz: ba57375bb44a13a4be124a369118f33689e32e9b
+SHA256:
+  metadata.gz: fc2f241654369dea6cfbd8592e0b367865c3f49bc8bc9d485a4af8c1c8ee37d0
+  data.tar.gz: 62dbbd185f8c0ff11055910285c1d13aa90142be8eb4d1a32485dd7abfc0c83c
 SHA512:
-  metadata.gz: 360b7f3f30aa07ed16286d6a080a21fac074d4c1a7b456a04079fcee63298ead7802abb6297eb1df524e1fc6e3b24b370d6fbc9464ed9210aebd9b6cdc4c59a2
-  data.tar.gz: d66609aa1877c9c54c1f57a93b54c32e4ae9da204b8e7529c1ad592440ee4b5c8aff1541ad5accfc39825b685e751f5072beb5bf3fc84ed2301de853e55510b5
+  metadata.gz: 5944ec29fa4fba8c0e20a3f7968acec86e569d5202caa79067aa5941f2d7037f7407e37524fdc345cd14dcf53343f929a6a7b3851822a5ad58cf554ecb271826
+  data.tar.gz: 7c577b390c2d21bc79dd9fd9e33c6a02bf02c7232474c32e0b18f5f6cd7f45c6f533b16aab6302483e8b77378a716f5cbe8597adfbd222bebf003eb6103925d5

data/.gitignore

@@ -2,6 +2,7 @@
 *.rbc
 .bundle
 .config
+.ruby-version
 .yardoc
 Gemfile.lock
 InstalledFiles

data/CHANGELOG.md

@@ -1,15 +1,20 @@
-# Change Log
+# Changelog
+
 All notable changes to this project will be documented in this file.
-This project adheres to [Semantic Versioning](http://semver.org/).
 
-## [Unreleased]
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## (Unreleased)
+
+- Nothing yet
+
+## 2.0.0
+
+- Breaking Changes
+  - Requires [OmniAuth 2](https://github.com/omniauth/omniauth/releases/tag/v2.0.0)
 
-## [1.1.2]
-### Changed
-- In request phase, convert `SocketError` into an OmniAuth failure.
-  This allows for easier handling in application code. 
+## Older releases
 
-## [1.1.1] - 2017-02-16
-### Breaking
-- Require omniauth 1.3.2+ or 1.4+ (for compatibility with 
-  https://github.com/omniauth/omniauth/commit/71866c5264122e196847a3980c43051446a03e9b)
+PRs welcome, in the [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) 
+format.

data/lib/omniauth/strategies/your_membership_token.rb

@@ -6,6 +6,13 @@ module OmniAuth
     class YourMembershipToken
       include OmniAuth::Strategy
 
+      E_YM_SESSION_ID_BLANK = <<~EOS
+        Assertion failed: YourMembership ID blank during callback_phase. This ID
+        was stored in the Rack session during the request_phase but has not
+        survived to (is no longer present in) the callback_phase.
+      EOS
+      RACK_SESSION_KEY = 'omniauth_ym_session_id'.freeze
+
       # The UID is going to be the member's API id (member_id)
       # We'll also store the session ID
       option :fields, [:member_id, :ym_session]
@@ -13,30 +20,38 @@ module OmniAuth
 
       def request_phase
 
-        # We're doing this because the callback_url is built from the options.name attribute which is built by downcasing
-        # the name of the class. This returns an uncapitalized url which Rails will not recognize as the same path as the
-        # devise controller. This is a forced way to do this and probably has a more elegant solution.
+        # We're doing this because the callback_url is built from the
+        # options.name attribute which is built by down-casing the name of the
+        # class. This returns an un-capitalized url which Rails will not
+        # recognize as the same path as the devise controller. This is a forced
+        # way to do this and probably has a more elegant solution.
         options.name = 'yourMembershipToken'
+        # Build an Access Token
+        session = YourMembership::Session.create
+        token_hash = session.createToken(:RetUrl => callback_url)
 
-        begin
-          # Build an Access Token
-          session = YourMembership::Session.create
-          token_hash = session.createToken(:RetUrl => callback_url)
-          # Pass the YourMembership session id to the Callback
-          request.GET['ym_session'] = session.to_s
-          # Redirect to token url
-          redirect token_hash['GoToUrl']
-        rescue SocketError => e
-          fail! e.message
-        end
+        # Store the YourMembership session id somewhere it can be retrieved
+        # during the callback_phase.
+        #
+        # In OmniAuth 1, we were able to do:
+        #
+        #     request.params['ym_session'] = session.to_s
+        #
+        # but this seems no longer possible in OmniAuth 2 (as described in
+        # https://github.com/omniauth/omniauth/issues/975). So, the only thing I
+        # can think of is to use `env['rack.session']`. If a better solution
+        # is discovered, we can revisit this decision.
+        env['rack.session'][RACK_SESSION_KEY] = session.to_s
+
+        # Redirect to token url
+        redirect token_hash['GoToUrl']
       end
 
+      # See discussion in `request_phase` re: the use of `env['rack.session']`.
       def callback_phase
-        # create session object
-
-        ym_session_id = request.env['omniauth.params']['ym_session']
-
-        ym_session = YourMembership::Session.new(ym_session_id, 100)
+        ym_session_id = env['rack.session'][RACK_SESSION_KEY]
+        fail!(E_YM_SESSION_ID_BLANK) if ym_session_id.blank?
+        ym_session  = YourMembership::Session.new(ym_session_id, 100)
 
         begin
           fail! 'Failed To Log In' unless ym_session.authenticated?

data/lib/omniauth/your_membership_token/version.rb

@@ -1,5 +1,11 @@
 module OmniAuth
   module YourMembershipToken
-    VERSION = "1.1.2"
+    def self.gem_version
+      Gem::Version.new('2.0.0')
+    end
+
+    # @deprecated But will never be removed. Use `gem_version` instead, which
+    # provides a `Gem::Version` object that is easier to work with.
+    VERSION = gem_version.to_s
   end
 end

data/omniauth-your-membership-token.gemspec

@@ -5,7 +5,7 @@ require 'omniauth/your_membership_token/version'
 
 Gem::Specification.new do |spec|
   spec.name          = "omniauth-your-membership-token"
-  spec.version       = OmniAuth::YourMembershipToken::VERSION
+  spec.version       = OmniAuth::YourMembershipToken.gem_version.to_s
   spec.authors       = ["Nate Flood"]
   spec.email         = ["nflood@echonet.org"]
   spec.summary       = %q{Omniauth Strategy For Authenticating To YourMembership}
@@ -18,9 +18,9 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "omniauth", [">= 1.3.2", "< 2"]
+  spec.add_dependency "omniauth", "~> 2"
   spec.add_dependency "your_membership", "~> 1.1"
 
-  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "bundler", "~> 2"
   spec.add_development_dependency "rake"
 end

metadata

@@ -1,33 +1,27 @@
 --- !ruby/object:Gem::Specification
 name: omniauth-your-membership-token
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 2.0.0
 platform: ruby
 authors:
 - Nate Flood
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-01 00:00:00.000000000 Z
+date: 2021-02-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: omniauth
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.3.2
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.3.2
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2'
 - !ruby/object:Gem::Dependency
@@ -50,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '2'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -109,8 +103,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.10
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Omniauth Strategy For Authenticating To YourMembership