graphql-auth 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f94c2a56e51599f277494d890c6b754e7f34933d
+  data.tar.gz: 8b2c569822bd5f09286f68bb240449ecb50ae600
+SHA512:
+  metadata.gz: a3f06d11726fb5538b0cf38b620e4ac7ef59d981412a98730d2baa0fb1faf6cb579f1d9600c5100422e4c26f6f838aa470e223eabc8a8432c1c3589a00c5cb9a
+  data.tar.gz: 9d5ff6f5d125b4afb3673834097aaf287bae87e836c2b4a8cbb483fb7f0491b9cc5cda71f029c4bb2b7f95b3d462d9b709c267ce1519061e1c5e1e2ab1a83a1d

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in graphql-devise-auth.gemspec
+gemspec

data/README.md

@@ -0,0 +1,110 @@
+# GraphQL Auth
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/graphql-auth`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'graphql-auth'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install graphql-auth
+    
+Then run the installer to create `graphql_auth.rb` file in your initializers folder.
+
+```
+rails g graphql_auth:install
+```
+
+Make sure to read all configurations present inside the file and fill them with your own configs.
+
+## Usage
+
+Make 'JWT_SECRET_KEY' and 'APP_URL' available to ENV
+
+```
+JWT_SECRET_KEY=
+APP_URL=
+```
+
+Make sure the `Authorization` header is allowed in your api
+
+```
+Rails.application.config.middleware.insert_before 0, Rack::Cors do
+  allow do
+    origins '*'
+    resource '*',
+             headers: %w(Authorization),
+             methods: :any,
+             expose: %w(Authorization),
+             max_age: 600
+  end
+end
+``` 
+
+Make sure to include `Graphql::AuthHelper` in your `GraphqlController`. A context method returning the current_user will be available
+
+```
+class GraphqlController < ActionController::API
+  
+  include Graphql::AuthHelper
+  
+  def execute
+    variables = ensure_hash(params[:variables])
+    query = params[:query]
+    operation_name = params[:operationName]
+    result = ::GraphqlSchema.execute(query, variables: variables, context: context, operation_name: operation_name)
+    render json: result
+    
+    ...
+```
+
+Make sure to implement `GraphqlAuth` in your MutationType``to make auth mutations available
+
+```
+class Types::MutationType < Types::BaseObject
+  implements GraphqlAuth
+end
+```
+
+## Customization
+
+If you can to customize any mutation, make sure to update the configurations
+
+```
+GraphQL::Auth.configure do |config|
+  # config.token_lifespan = 4.hours
+  # config.jwt_secret_key = ENV['JWT_SECRET_KEY']
+  # config.app_url = ENV['APP_URL']
+
+  config.sign_in_mutation = ::Mutations::CustomSignIn
+  
+  ...
+
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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 `graphql-auth.gemspec`, 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/o2web/graphql-auth. 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](http://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the GraphQL Auth project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/graphql-devise-auth/blob/master/CODE_OF_CONDUCT.md).

data/app/graphql/mutations/forgot_password.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+# mutation {
+#  forgotPassword(email: "email@example.com") {
+#     valid
+#   }
+# }
+
+class Mutations::ForgotPassword < GraphQL::Schema::Mutation
+  argument :email, String, required: true do
+    description 'The email with forgotten password'
+  end
+
+  field :valid, Boolean, null: false
+  
+  def resolve(email:)
+    user = User.find_by email: email
+    user.send_reset_password_instructions if user.present?
+
+    { valid: true }
+  end
+end

data/app/graphql/mutations/reset_password.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+# mutation {
+#   resetPassword(resetPasswordToken: "token", password: "password", passwordConfirmation: "password") {
+#     valid
+#     errors {
+#       field
+#       message
+#     }
+#   }
+# }
+
+class Mutations::ResetPassword < GraphQL::Schema::Mutation
+  argument :reset_password_token, String, required: true do
+    description "Reset password token"
+  end
+
+  argument :password, String, required: true do
+    description "New user's new password"
+  end
+  
+  argument :password_confirmation, String, required: true do
+    description "New user's new password confirmation"
+  end
+
+  field :valid, Boolean, null: false
+  field :errors, [Types::Error], null: true
+  
+  def resolve(args)
+    user = User.reset_password_by_token args
+    
+    if user.errors.any?
+      {
+        valid: false,
+        errors: user.errors.messages.map do |field, messages|
+          field = field == :reset_password_token ? :_error : field.to_s.camelize(:lower)
+          {
+            field: field,
+            message: messages.first.capitalize }
+        end
+      }
+    else
+      { valid: true }
+    end
+  end
+end

data/app/graphql/mutations/sign_in.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+# mutation {
+#   signIn(email: "email@example.com", password: "password") {
+#     user {
+#       email
+#     }
+#     errors {
+#       field
+#       message
+#     }
+#   }
+# }
+
+class Mutations::SignIn < GraphQL::Schema::Mutation
+  argument :email, String, required: true do
+    description "The user's email"
+  end
+
+  argument :password, String, required: true do
+    description "The user's password"
+  end
+
+  field :user, Types::User, null: true
+  field :errors, [Types::Error], null: true
+  
+  def resolve(email:, password:)
+    response = context[:response]
+    user = User.find_by email: email
+    valid_sign_in = user.present? && user.valid_password?(password)
+    
+    if valid_sign_in
+      response.set_header 'Authorization', GraphQL::Auth::JwtManager.issue({ user: user.id }) # TODO use uuid
+      {
+        user: user
+      }
+    else
+      {
+        errors: [
+          {
+            field: :_error,
+            message: I18n.t('devise.failure.invalid',
+                            authentication_keys: I18n.t('activerecord.attributes.user.email'))
+          }
+        ]
+      }
+    end
+  end
+end

data/app/graphql/mutations/sign_up.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+# mutation {
+#   signUp(email: "email@example.com", password: "password", passwordConfirmation: "password") {
+#     user {
+#       email
+#     }
+#     errors {
+#       field
+#       message
+#     }
+#   }
+# }
+
+class Mutations::SignUp < GraphQL::Schema::Mutation
+  argument :email, String, required: true do
+    description "New user's email"
+  end
+
+  argument :password, String, required: true do
+    description "New user's password"
+  end
+
+  argument :password_confirmation, String, required: true do
+    description "New user's password confirmation"
+  end
+
+  field :user, Types::User, null: true
+  field :errors, [Types::Error], null: true
+  
+  def resolve(args)
+    response = context[:response]
+    user = User.new args
+    
+    if user.save
+      response.set_header 'Authorization', GraphQL::Auth::JwtManager.issue({ user: user.id }) # TODO use uuid
+      { user: user }
+    else
+      {
+        errors: user.errors.messages.map do |field, messages|
+          { field: field.to_s.camelize(:lower), message: messages.first.capitalize }
+        end
+      }
+    end
+  end
+end

data/app/graphql/mutations/update_account.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+# mutation {
+#   updateAccount(current_password: "currentPassword", password: "newPassword", password_confirmation: "newPassword") {
+#     user {
+#       email
+#     }
+#     errors {
+#       field
+#       message
+#     }
+#   }
+# }
+
+class Mutations::UpdateAccount < GraphQL::Schema::Mutation
+  argument :current_password, String, required: true do
+    description "User's current password"
+  end
+  
+  argument :password, String, required: true do
+    description "User's new password"
+  end
+  
+  argument :password_confirmation, String, required: true do
+    description "User's new password confirmation"
+  end
+  
+  field :user, Types::User, null: true
+  field :errors, [Types::Error], null: true
+  
+  def resolve(args)
+    user = context[:current_user]
+    user.update_with_password args
+    
+    if user.errors.any?
+      {
+        errors: user.errors.messages.map do |field, messages|
+          { field: field.to_s.camelize(:lower), message: messages.first.capitalize }
+        end
+      }
+    else
+      { user: user }
+    end
+  end
+end

data/app/graphql/mutations/validate_token.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+# mutation {
+#   validateToken {
+#     valid
+#     user {
+#       email
+#     }
+#   }
+# }
+
+class Mutations::ValidateToken < GraphQL::Schema::Mutation
+  field :valid, Boolean, null: false
+  field :user, Types::User, null: true
+  
+  def resolve()
+    user = context[:current_user]
+    
+    {
+      valid: user.present?,
+      user: user,
+    }
+  end
+end

data/app/graphql/types/error.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+class Types::Error < Types::BaseObject
+  description 'Form error'
+
+  field :field, String, null: false do
+    description 'Field of the error'
+  end
+
+  field :message, String, null: false do
+    description 'Error message'
+  end
+end

data/app/graphql/types/graphql_auth.rb

@@ -0,0 +1,15 @@
+# implements GraphQLAuth in in Types::MutationType to access auth mutations
+
+module Types::GraphqlAuth
+  include GraphQL::Schema::Interface
+
+  field :sign_in, mutation: GraphQL::Auth.configuration.sign_in_mutation
+  field :sign_up, mutation: GraphQL::Auth.configuration.sign_up_mutation
+
+  field :forgot_password, mutation: GraphQL::Auth.configuration.forgot_password_mutation
+  field :reset_password, mutation: GraphQL::Auth.configuration.reset_password_mutation
+  
+  field :update_account, mutation: GraphQL::Auth.configuration.update_account_mutation
+  
+  field :validate_token, mutation: GraphQL::Auth.configuration.validate_token_mutation
+end

data/app/graphql/types/user.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+class Types::User < Types::BaseObject
+  description 'Data of a user'
+
+  field :email, String, null: false do
+    description 'Email address of the user'
+  end
+end

data/app/helpers/graphql/auth_helper.rb

@@ -0,0 +1,30 @@
+# include this helper in GraphqlController to use context method so that current_user will be available
+#
+# ::GraphqlSchema.execute(query, variables: variables, context: context, operation_name: operation_name)
+
+module Graphql
+  module AuthHelper
+    def context
+      {
+        current_user: current_user,
+        response: response,
+      }
+    end
+  
+    def current_user
+      return if request.headers['Authorization'].nil?
+      
+      decrypted_token = GraphQL::Auth::JwtManager.decode(request.headers['Authorization'])
+    
+      user_id = decrypted_token['user']
+      user = User.find_by id: user_id  # TODO use uuid
+
+      # update token if user is found with token
+      response.set_header 'Authorization', GraphQL::Auth::JwtManager.issue({ user: user.id }) if user.present?
+
+      user
+    rescue JWT::ExpiredSignature
+      nil
+    end
+  end
+end

data/app/views/devise/mailer/reset_password_instructions.html.erb

@@ -0,0 +1,8 @@
+<p>Hello <%= @resource.email %>!</p>
+
+<p>Someone has requested a link to change your password. You can do this through the link below.</p>
+
+<p><%= link_to 'Change my password', GraphQL::Auth::ResetPassword.url(@token) %></p>
+
+<p>If you didn't request this, please ignore this email.</p>
+<p>Your password won't change until you access the link above and create a new one.</p>

data/lib/generators/graphql_auth/install_generator.rb

@@ -0,0 +1,11 @@
+module GraphqlAuth
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path('../templates', __FILE__)
+
+      def copy_configuration
+        template 'initializer.rb', 'config/initializers/graphql_auth.rb'
+      end
+    end
+  end
+end

data/lib/generators/graphql_auth/templates/initializer.rb

@@ -0,0 +1,15 @@
+GraphQL::Auth.configure do |config|
+  # config.token_lifespan = 4.hours
+  # config.jwt_secret_key = ENV['JWT_SECRET_KEY']
+  # config.app_url = ENV['APP_URL']
+
+  # config.sign_in_mutation = ::Mutations::SignIn
+  # config.sign_up_mutation = ::Mutations::SignUp
+
+  # config.forgot_password_mutation = ::Mutations::ForgotPassword
+  # config.reset_password_mutation = ::Mutations::ResetPassword
+
+  # config.update_account_mutation = ::Mutations::UpdateAccount
+
+  # config.validate_token_mutation = ::Mutations::ValidateToken
+end

data/lib/graphql-auth.rb

@@ -0,0 +1,19 @@
+require 'graphql-auth/configuration'
+require 'graphql-auth/engine'
+require 'graphql-auth/reset_password'
+require 'graphql-auth/jwt_manager'
+
+module GraphQL
+  module Auth
+    class << self
+      attr_accessor :configuration
+    end
+
+    def self.configure
+      @configuration ||= Configuration.new
+      yield(configuration)
+    end
+  end
+end
+
+

data/lib/graphql-auth/configuration.rb

@@ -0,0 +1,31 @@
+module GraphQL
+  module Auth
+    class Configuration
+      attr_accessor :token_lifespan,
+                    :jwt_secret_key,
+                    :app_url,
+                    :sign_in_mutation,
+                    :sign_up_mutation,
+                    :forgot_password_mutation,
+                    :reset_password_mutation,
+                    :update_account_mutation,
+                    :validate_token_mutation
+    
+      def initialize
+        @token_lifespan = 4.hours
+        @jwt_secret_key = ENV['JWT_SECRET_KEY']
+        @app_url = ENV['APP_URL']
+        
+        @sign_in_mutation = ::Mutations::SignIn
+        @sign_up_mutation = ::Mutations::SignUp
+      
+        @forgot_password_mutation = ::Mutations::ForgotPassword
+        @reset_password_mutation = ::Mutations::ResetPassword
+      
+        @update_account_mutation = ::Mutations::UpdateAccount
+      
+        @validate_token_mutation = ::Mutations::ValidateToken
+      end
+    end
+  end
+end

data/lib/graphql-auth/engine.rb

@@ -0,0 +1,7 @@
+module GraphQL
+  module Auth
+    class Engine < ::Rails::Engine
+      config.autoload_paths += Dir["#{config.root}/app/**/"]
+    end
+  end
+end

data/lib/graphql-auth/jwt_manager.rb

@@ -0,0 +1,48 @@
+require 'jwt'
+require 'graphql-auth'
+
+module GraphQL
+  module Auth
+    class JwtManager
+      ALGORITHM = 'HS256'
+      TYPE = 'Bearer'
+      
+      class << self
+        def issue(payload)
+          token = JWT.encode payload.merge(expiration),
+                             auth_secret,
+                             ALGORITHM
+          set_type token
+        end
+    
+        def decode(token)
+          token = extract_token token
+          decrypted_token = JWT.decode token,
+                                       auth_secret,
+                                       true,
+                                       { algorithm: ALGORITHM }
+          decrypted_token.first
+        end
+
+        private
+        
+        def auth_secret
+          GraphQL::Auth.configuration.jwt_secret_key
+        end
+
+        def set_type(token)
+          "#{TYPE} #{token}"
+        end
+
+        def extract_token(token)
+          token.gsub "#{TYPE} ", ''
+        end
+        
+        def expiration
+          exp = Time.now.to_i + GraphQL::Auth.configuration.token_lifespan
+          { exp: exp }
+        end
+      end
+    end
+  end
+end

data/lib/graphql-auth/reset_password.rb

@@ -0,0 +1,14 @@
+require 'jwt'
+
+module GraphQL
+  module Auth
+    class ResetPassword
+      class << self
+        def url(token)
+          url = I18n.locale === :fr ? 'nouveau-mot-de-passe' : 'new-password'
+          "#{GraphQL::Auth.configuration.app_url}/#{I18n.locale}/#{url}/#{token}"
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,135 @@
+--- !ruby/object:Gem::Specification
+name: graphql-auth
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Guillaume Ferland
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-10-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !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: graphql
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.5
+- !ruby/object:Gem::Dependency
+  name: devise
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.4.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.4.3
+- !ruby/object:Gem::Dependency
+  name: jwt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.5.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.5.6
+description: GraphQL + JWT + Devise
+email:
+- ferland182@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- README.md
+- app/graphql/mutations/forgot_password.rb
+- app/graphql/mutations/reset_password.rb
+- app/graphql/mutations/sign_in.rb
+- app/graphql/mutations/sign_up.rb
+- app/graphql/mutations/update_account.rb
+- app/graphql/mutations/validate_token.rb
+- app/graphql/types/error.rb
+- app/graphql/types/graphql_auth.rb
+- app/graphql/types/user.rb
+- app/helpers/graphql/auth_helper.rb
+- app/views/devise/mailer/reset_password_instructions.html.erb
+- lib/generators/graphql_auth/install_generator.rb
+- lib/generators/graphql_auth/templates/initializer.rb
+- lib/graphql-auth.rb
+- lib/graphql-auth/configuration.rb
+- lib/graphql-auth/engine.rb
+- lib/graphql-auth/jwt_manager.rb
+- lib/graphql-auth/reset_password.rb
+homepage: https://github.com/o2web/graphql-auth
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- app
+- 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.6.13
+signing_key: 
+specification_version: 4
+summary: GraphQL + JWT + Devise
+test_files: []