groovestack-auth 0.1.1

data/readme.adoc

@@ -0,0 +1,52 @@
+= Groovestack Auth
+
+== Introduction
+Groovestack Auth is a https://talysto.com/tech/groovestack/[Groovestack] Groovestack gem that provides a token-based authentication solution for https://rubyonrails.org/[Ruby on Rails] / https://graphql-ruby.org/[GraphQL Ruby] applications. Groovestack Auth is built on top of
+
+* https://github.com/graphql-devise/graphql_devise[graphql_devise] - https://graphql-ruby.org/[GraphQL Ruby] wrapper for https://github.com/lynndylanhurley/devise_token_auth[Devise Token Auth]
+* https://github.com/omniauth/omniauth[OmniAuth] - Multi-Provider Authentication.
+
+Groovestack Auth enables seamless authentication via email and password or through OAuth providers like Google and Apple. Users can connect and authenticate with multiple providers (i.e. email, google or apple). Groovestack Auth also integrates seemlessly with https://guides.rubyonrails.org/action_cable_overview.html[Action Cable].
+
+=== Configuration
+Groovestack Auth ships with email and password authentication out of the box as well as easily configurable https://github.com/zquestz/omniauth-google-oauth2[Google] and https://github.com/nhosoya/omniauth-apple[Apple] OAuth providers.
+
+==== create-groovestack
+When using the https://github.com/groovestack/create-groovestack[create-groovestack] utility to bootstrap a new Groovestack application, enabling OAuth providers is easy. Simply add the required third party keys to your Rails credentials file. For example, to enable Google OAuth, add the following to your Rails credentials file:
+
+[source,yaml]
+----
+GOOGLE_CLIENT_ID: YOUR_CLIENT_ID
+GOOGLE_CLIENT_SECRET: YOUR_CLIENT_SECRET
+----
+
+To enable Apple OAuth, add the following to your Rails credentials file:
+[source,yaml]
+----
+APPLE_CLIENT_ID: YOUR_CLIENT_ID
+APPLE_KEY_ID: YOUR_KEY_ID
+APPLE_PEM_CONTENT: YOUR_PEM_CONTENT
+APPLE_TEAM_ID: YOUR_TEAM_ID
+----
+
+For instructions on how to acquire the required keys, see the https://github.com/zquestz/omniauth-google-oauth2[omniauth-google-oauth2] and https://github.com/nhosoya/omniauth-apple[omniauth-apple] documentation.
+
+Groovestack Auth ships with development and production environment https://edgeguides.rubyonrails.org/security.html#custom-credentials[rails credentials] out of the box. To edit your environment specific Rails credentials file, run 
+[source,shell]
+----
+rails credentials:edit -e [environment]
+----
+Credential master key files are located in the `config/credentials` directory but excluded from source control. When deploying your app to production, make sure you configure your production environment to include the `RAILS_MASTER_KEY` variable. For example, when deploying to Heroku, you can set the `RAILS_MASTER_KEY` variable by running:
+[source,shell]
+----
+heroku config:set RAILS_MASTER_KEY=`cat config/credentials/production.key`
+----
+
+===== Local Development with Apple OAuth
+
+Sign-In with Apple does not allow `localhost` as a valid callback URL. It also requires SSL. This means that you won't be able to test your Apple OAuth integration out of the box. To enable local development with Apple OAuth in your bootstrapped Groovestack app, follow https://github.com/talysto/groovestack-core/tree/main/core-auth/docs/apple-oauth-local-dev.adoc[these instructions].
+
+==== Existing ROR & GraphQL Ruby Applications
+#TODO
+
+

metadata

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification
+name: groovestack-auth
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Max Schridde
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2025-04-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: groovestack-base
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.7
+- !ruby/object:Gem::Dependency
+  name: jsonb_accessor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: omniauth-apple
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: omniauth-google-oauth2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Groovestack::Auth is an authentication extension for the Groovestack
+  Platform.
+email:
+- maxjschridde@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- Gemfile
+- Gemfile.lock
+- config.ru
+- config/initializers/core_config.rb
+- config/initializers/devise.rb
+- config/initializers/devise_token_auth.rb
+- config/initializers/graphql_devise.rb
+- config/initializers/omniauth.rb
+- config/routes.rb
+- db/migrate/20231103172517_create_users.rb
+- db/migrate/20231103174037_create_identities.rb
+- docs/apple-oauth-local-dev.adoc
+- groovestack-auth.gemspec
+- lib/fabricators/user_fabricator.rb
+- lib/graphql/identity/filter.rb
+- lib/graphql/identity/mutations.rb
+- lib/graphql/identity/queries.rb
+- lib/graphql/identity/type.rb
+- lib/graphql/user/filter.rb
+- lib/graphql/user/mutations.rb
+- lib/graphql/user/queries.rb
+- lib/graphql/user/type.rb
+- lib/groovestack/auth.rb
+- lib/groovestack/auth/action_cable.rb
+- lib/groovestack/auth/authenticated_api_controller.rb
+- lib/groovestack/auth/omniauth_callbacks_controller.rb
+- lib/groovestack/auth/provider.rb
+- lib/groovestack/auth/providers/apple.rb
+- lib/groovestack/auth/providers/email.rb
+- lib/groovestack/auth/providers/google.rb
+- lib/groovestack/auth/providers/omni_auth.rb
+- lib/groovestack/auth/railtie.rb
+- lib/groovestack/auth/schema_plugin.rb
+- lib/groovestack/auth/version.rb
+- lib/identity.rb
+- lib/user.rb
+- lib/users/roles.rb
+- readme.adoc
+homepage: https://github.com/talysto/groovestack-core/
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/talysto/groovestack-core/
+  source_code_uri: https://github.com/talysto/groovestack-core/
+  changelog_uri: https://github.com/talysto/groovestack-core/
+  rubygems_mfa_required: 'true'
+post_install_message: Groovestack::Auth installed
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.26
+signing_key:
+specification_version: 4
+summary: Groovestack extension for application authentication
+test_files: []