omniauth-usosumk 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f83d5eece64b0ca9987909f7304b2990ead843125e88c3ace244b54f76355f94
-  data.tar.gz: 24c3aeb0e26c83d32e723e91905178ecacb3c8764982a2b73ac8ee2f75a214e5
+  metadata.gz: 8188df14878e11e99f173b3061d0c506c46710fec6f167b58121a0ab11efc22a
+  data.tar.gz: 0d7c9b377a91e119da6ed0e29a07b3f3ee5a8efcc0ace9594512ac5654c6e9ee
 SHA512:
-  metadata.gz: 6ae7360e51230e1ce3ea9aacc51db8e96a20fb4fda5845a223f9c2329612ebfc72afa76543bb341cceb6be5d49d198c2bd024286530117f1ed64667b3fb8b3bb
-  data.tar.gz: 05e528398a3bd1fdb730cf09e659e0b6d755762b39ee04f63aadc046a0972c7ac50175365a24f7d736bdcceeb4744b60809f655d235f8dee5494772042ab0af8
+  metadata.gz: 8e284d37f47badf3d10b03f42100b75c7d30d6f5c08c4a705153114a3fd75badd5b9c60933a8d65239b7d4362308e09b554cc63604f2b3e4e8d5a1750c748b24
+  data.tar.gz: b912738b17a9620e7f76cde2d1e09c2a735dc8705d667a9cc3ac7049637c395f7744cc58a85553706eff318524269c6f13257d8945143d25f8c46a6244676ec2

data/MIT-LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 mikolajczu
+
+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

@@ -1,28 +1,59 @@
-# Omniauth::Usosumk
-Short description and motivation.
+# omniauth-usosumk
 
-## Usage
-How to use my plugin.
+OmniAuth OAuth 1.0a strategy for authenticating against the USOS API at Nicolaus Copernicus University in Toruń (`usosapps.umk.pl`).
 
 ## Installation
-Add this line to your application's Gemfile:
+
+Add to your application's `Gemfile`:
 
 ```ruby
 gem "omniauth-usosumk"
 ```
 
-And then execute:
+Then:
+
 ```bash
-$ bundle
+bundle install
 ```
 
-Or install it yourself as:
-```bash
-$ gem install omniauth-usosumk
+## Usage
+
+Register your application with the USOS UMK administrators to obtain a `consumer_key` and `consumer_secret`. When registering, set the callback URL to `/oauth/callback` (or whatever you configure below).
+
+Add the strategy to your OmniAuth middleware. In a Rails app, `config/initializers/omniauth.rb`:
+
+```ruby
+Rails.application.config.middleware.use OmniAuth::Builder do
+  provider :usosumk, ENV["USOSUMK_CONSUMER_KEY"], ENV["USOSUMK_CONSUMER_SECRET"]
+end
 ```
 
-## Contributing
-Contribution directions go here.
+Then send users to `/auth/usosumk` to start the OAuth flow. After the user authorizes, USOS redirects to your `callback_url` and OmniAuth populates `request.env["omniauth.auth"]` with:
+
+```ruby
+{
+  "provider" => "usosumk",
+  "uid"      => "12345",
+  "info"     => {
+    "email"      => "student@umk.pl",
+    "first_name" => "Jan",
+    "last_name"  => "Kowalski"
+  },
+  "extra"    => { "raw_info" => { ... } }
+}
+```
+
+### Options
+
+- `callback_url` — path or full URL USOS will redirect to after authorization. Defaults to `/oauth/callback`. Must match what you registered on the USOS side.
+
+## Development
+
+```bash
+bundle install
+bundle exec rspec
+```
 
 ## License
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+[MIT](MIT-LICENSE).

data/Rakefile

@@ -1,3 +1,7 @@
 require "bundler/setup"
-
 require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/omniauth/strategies/usosumk.rb

@@ -1,35 +1,37 @@
-require 'omniauth-oauth'
-require 'json'
-
-module OmniAuth
-  module Strategies
-    class Usosumk < OmniAuth::Strategies::OAuth
-      option :name, 'usosumk'
-      option :callback_url, "http://127.0.0.1:3000/oauth/callback"
-
-      option :client_options, {site: "https://usosapps.umk.pl",
-                               request_token_url: "/services/oauth/request_token?scopes=email",
-                               authorize_url: "https://usosapps.umk.pl/services/oauth/authorize",
-                               access_token_url: "/services/oauth/access_token"}
-
-      uid { raw_info["id"] }
-
-      info do
-        {
-          :email => raw_info["email"],
-          :first_name => raw_info["first_name"],
-          :last_name => raw_info["last_name"],
-        }
-      end
-
-      extra do
-        skip_info? ? {} : { :raw_info => raw_info }
-      end
-
-      def raw_info
-        @raw_info ||= JSON.load(access_token.get("/services/users/user?fields=id|first_name|last_name|email").body)
-      end
-
-    end
-  end
-end
+require 'omniauth'
+require 'omniauth-oauth'
+require 'json'
+
+module OmniAuth
+  module Strategies
+    class Usosumk < OmniAuth::Strategies::OAuth
+      option :name, 'usosumk'
+      option :callback_url, "/oauth/callback"
+
+      option :client_options, {
+        site:              "https://usosapps.umk.pl",
+        request_token_url: "/services/oauth/request_token?scopes=email",
+        authorize_url:     "https://usosapps.umk.pl/services/oauth/authorize",
+        access_token_url:  "/services/oauth/access_token"
+      }
+
+      uid { raw_info["id"] }
+
+      info do
+        {
+          email:      raw_info["email"],
+          first_name: raw_info["first_name"],
+          last_name:  raw_info["last_name"]
+        }
+      end
+
+      extra do
+        skip_info? ? {} : { raw_info: raw_info }
+      end
+
+      def raw_info
+        @raw_info ||= JSON.parse(access_token.get("/services/users/user?fields=id|first_name|last_name|email").body)
+      end
+    end
+  end
+end

data/lib/omniauth-usosumk/version.rb

@@ -1,5 +1,5 @@
-module Omniauth
-  module Usosumk
-    VERSION = "0.1.0"
-  end
-end
+module Omniauth
+  module Usosumk
+    VERSION = "0.2.0"
+  end
+end

data/lib/omniauth-usosumk.rb

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

metadata

@@ -1,47 +1,61 @@
 --- !ruby/object:Gem::Specification
 name: omniauth-usosumk
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - mikolajczu
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-01-12 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: omniauth
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 7.0.4
+        version: '2.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 7.0.4
-description: Oauth strategy for Usos umk
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: omniauth-oauth
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+description: OmniAuth strategy for authenticating against the USOS API at Nicolaus
+  Copernicus University in Toruń (usosapps.umk.pl).
 email:
 - mikeyczu@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- MIT-LICENSE
 - README.md
 - Rakefile
 - lib/omniauth-usosumk.rb
 - lib/omniauth-usosumk/version.rb
 - lib/omniauth/strategies/usosumk.rb
-homepage: https://github.com/mikolajczu/omniauth-usosumk.git
-licenses: []
+homepage: https://github.com/mikolajczu/omniauth-usosumk
+licenses:
+- MIT
 metadata:
-  homepage_uri: https://github.com/mikolajczu/omniauth-usosumk.git
-  source_code_uri: https://github.com/mikolajczu/omniauth-usosumk.git
-post_install_message:
+  source_code_uri: https://github.com/mikolajczu/omniauth-usosumk
 rdoc_options: []
 require_paths:
 - lib
@@ -49,15 +63,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.26
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
-summary: summary
+summary: OmniAuth OAuth 1.0a strategy for USOS UMK
 test_files: []