morpho 0.3.4 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 897ee2fc194496e055864aec5475926004ab7a5665b00c0a4979f4fb686b4c48
-  data.tar.gz: 0e5a7348610783970b1243db39ed40405a47eab4a339f4d88aba4fdaa70e1a0d
+  metadata.gz: de2ce5df93635871bce8162346a183b6eb8b695e9c86dd8c1979ec50cb3f66c2
+  data.tar.gz: 6f18be1aa24bbdc3b9ca630592b4d8b38fde03b69691b5aeb762758b8f5fa267
 SHA512:
-  metadata.gz: c4debc02baf4abf21d34c2ed9c83f9e8ce12e364e46dccf6a8529a74963ec7765af47e49265585af2cbdd7d7b47dd65162ffe06ec0acfa9ecb918f6da2c82fe8
-  data.tar.gz: 571c6a523befd73e153e09ec8d91addb35f8d95654c64e797744702c0066b95bb71a152994c792f9ce60a0adfc1ee5d6bffcca8dcc69af1afb3b8e5fbffa85bb
+  metadata.gz: 2160dffd093818bd31c309acb7aaf0a360567d58a120e76bd2f134099a3d5997ba422c2d36984c62b353c9975d5c47a03acad9e93dfea0466b8b089397ff34dd
+  data.tar.gz: 02e0980867d32dd46af25e967d4971f0f7d58eaeaf569baca44c6affa557eac0567d0cc3fb2414098334298f12646ba52cdc95d0e807338bea64c2492b001b48

data/app/api/morpho/entities/authentication_token.rb

@@ -0,0 +1,9 @@
+module Morpho
+  module Entities
+    class AuthenticationToken < ::Morpho::Entities::Base
+      expose :authentication_token, documentation: { type: 'string', desc: 'User authentication token', required: true }
+      expose :expires_at, documentation: { type: 'string', desc: 'Authentication token expiration date in millis', required: true }
+      expose :refresh_token, documentation: { type: 'string', desc: 'User refresh token', required: true }
+    end
+  end
+end

data/app/api/morpho/entities/credentials.rb

@@ -0,0 +1,8 @@
+module Morpho
+  module Entities
+    class Credentials < ::Morpho::Entities::Base
+      expose :email, documentation: { type: 'string', desc: 'User email address' }
+      expose :password, documentation: { type: 'string', desc: 'User password' }
+    end
+  end
+end

data/app/api/morpho/entities/external.rb

@@ -0,0 +1,10 @@
+module Morpho
+  module Entities
+    class External < ::Morpho::Entities::Base
+      expose :email, documentation: { type: 'string', desc: 'User email address' }
+      expose :name, documentation: { type: 'string', desc: 'User name' }
+      expose :provider, documentation: { type: 'string', desc: 'User authentication provider' }
+      expose :uid, documentation: { type: 'string', desc: 'User provider uid' }
+    end
+  end
+end

data/app/api/morpho/entities/message.rb

@@ -0,0 +1,7 @@
+module Morpho
+  module Entities
+    class Message < ::Morpho::Entities::Base
+      expose :content, documentation: { type: 'string', desc: 'Message content' }
+    end
+  end
+end

data/app/api/morpho/entities/refresh_token.rb

@@ -0,0 +1,7 @@
+module Morpho
+  module Entities
+    class RefreshToken < ::Morpho::Entities::Base
+      expose :refresh_token, documentation: { type: 'string', desc: 'User refresh token', required: true }
+    end
+  end
+end

data/app/api/morpho/entities/user_email.rb

@@ -0,0 +1,7 @@
+module Morpho
+  module Entities
+    class UserEmail < ::Morpho::Entities::Base
+      expose :email, documentation: { type: 'string', desc: 'User email address', required: true }
+    end
+  end
+end

data/app/api/morpho/entities/user_sign_up.rb

@@ -1,9 +1,9 @@
 module Morpho
   module Entities
     class UserSignUp < ::Morpho::Entities::Base
-      expose :email, documentation: { type: 'string', desc: 'User email address' }
-      expose :password, documentation: { type: 'string', desc: 'User password' }
-      expose :password_confirmation, documentation: { type: 'string', desc: 'User password confirmation' }
+      expose :email, documentation: { type: 'string', desc: 'User email address', required: true }
+      expose :password, documentation: { type: 'string', desc: 'User password', required: true }
+      expose :password_confirmation, documentation: { type: 'string', desc: 'User password confirmation', required: true }
     end
   end
 end

data/app/api/morpho/helpers/http_responses.rb

@@ -3,40 +3,76 @@ module Morpho
     module HTTPResponses
       protected
 
-      def render_bad_request
-        error!({ message: I18n.t('morpho.api.messages.bad_request'), with: Morpho::Entities::Error }, 400)
+      def render_bad_request(errors = [])
+        error!({
+          message: I18n.t('morpho.api.messages.bad_request'),
+          errors: errors,
+          with: Morpho::Entities::Error
+        }, 400)
       end
 
-      def render_unauthorized
-        error!({ message: I18n.t('morpho.api.messages.unauthorized'), with: Morpho::Entities::Error }, 401)
+      def render_unauthorized(errors = [])
+        error!({
+          message: I18n.t('morpho.api.messages.unauthorized'),
+          errors: errors,
+          with: Morpho::Entities::Error
+        }, 401)
       end
 
-      def render_unauthorized_detailed(errors)
-        error!({ message: I18n.t('morpho.api.messages.unauthorized'), errors: errors, with: Morpho::Entities::Error }, 401)
+      def render_unauthorized_detailed(errors = [])
+        render_unauthorized(errors)
       end
 
-      def render_payment_required
-        error!({ message: I18n.t('morpho.api.messages.payment_required'), with: Morpho::Entities::Error }, 402)
+      def render_payment_required(errors = [])
+        error!({
+          message: I18n.t('morpho.api.messages.payment_required'),
+          errors: errors,
+          with: Morpho::Entities::Error
+        }, 402)
       end
 
-      def render_forbidden
-        error!({ message: I18n.t('morpho.api.messages.forbidden'), with: Morpho::Entities::Error }, 403)
+      def render_forbidden(errors = [])
+        error!({
+          message: I18n.t('morpho.api.messages.forbidden'),
+          errors: errors,
+          with: Morpho::Entities::Error
+        }, 403)
       end
 
-      def render_not_found
-        error!({ message: I18n.t('morpho.api.messages.not_found'), with: Morpho::Entities::Error }, 404)
+      def render_not_found(errors = [])
+        error!({
+          message: I18n.t('morpho.api.messages.not_found'),
+          errors: errors,
+          with: Morpho::Entities::Error
+        }, 404)
       end
 
-      def render_method_not_allowed
-        error!({ message: I18n.t('morpho.api.messages.method_not_allowed'), with: Morpho::Entities::Error }, 405)
+      def render_method_not_allowed(errors = [])
+        error!({
+          message: I18n.t('morpho.api.messages.method_not_allowed'),
+          errors: errors,
+          with: Morpho::Entities::Error
+        }, 405)
       end
 
-      def render_unprocessable_entity
-        error!({ message: I18n.t('morpho.api.messages.unprocessable_entity'), with: Morpho::Entities::Error }, 422)
+      def render_unprocessable_entity(errors = [])
+        error!({
+          message: I18n.t('morpho.api.messages.unprocessable_entity'),
+          errors: errors,
+          with: Morpho::Entities::Error
+        }, 422)
       end
 
-      def render_unprocessable_entity_detailed(errors)
-        error!({ message: I18n.t('morpho.api.messages.unprocessable_entity'), errors: errors, with: Morpho::Entities::Error }, 422)
+      def render_locked(errors = [])
+        error!({
+          message: I18n.t('morpho.api.messages.locked'),
+          errors: errors,
+          with: Morpho::Entities::Error
+        }, 423)
+      end
+
+      def render_unprocessable_entity_detailed(errors = [])
+        render_unprocessable_entity(errors)
       end
 
       def render_no_content

data/app/api/morpho/helpers/jwt_utils.rb

@@ -3,39 +3,30 @@ module Morpho
     module JWTUtils
       protected
 
-      def current_user
-        @current_user ||= Morpho::User.find_by(email: jwt_token[:email])
-      rescue
-        nil
+      def logged_in?
+        !!current_user
       end
 
-      def http_token
-        @http_token ||= if request.headers[Morpho.config.jwt.header].present?
-          request.headers[Morpho.config.jwt.header].split(' ').last
-        end
+      def require_login
+        render_unauthorized unless logged_in?
       end
 
-      def jwt_token
-        @jwt_token ||= HashWithIndifferentAccess.new(jwt_decode(http_token).first)
-      end
-
-      def jwt_encode(payload)
-        Morpho::Cipher.jwt_encode(payload)
+      def current_user
+        @current_user ||= Morpho::User.find_by(email: token[:email])
+      rescue
+        nil
       end
 
-      def jwt_decode(token)
-        begin
-          return Morpho::Cipher.jwt_decode(token)
-        rescue
-          nil
-        end
+      def authentication_token
+        @authentication_token ||= Morpho::JWT::AuthenticationToken.new(request)
+      rescue
+        nil
       end
 
-      def user_payload(user)
-        expires_at = Time.now.to_i + Morpho.config.jwt.expiration_time
-        issued_at = Time.now.to_i
-
-        { authentication_token: jwt_encode({ exp: expires_at, iat: issued_at, email: user.email }), expires_at: expires_at, refresh_token: user.refresh_token }
+      def token
+        @token ||= Morpho::JWT::Token.new(authentication_token)
+      rescue
+        nil
       end
     end
   end

data/app/api/morpho/resources/activations.rb

@@ -1,27 +1,38 @@
 module Morpho
   module Resources
     class Activations < ::Grape::API
-      helpers Morpho::Helpers::HTTPResponses,
-        Morpho::Helpers::UserActivation
+      helpers Morpho::Helpers::HTTPResponses
 
       namespace :activations do
         desc 'Request user activation token' do
-          success Morpho::Entities::User
+          success Morpho::Grape::DataWrapper.new(Morpho::Entities::User)
+          failure [
+            [ 404, I18n.t('morpho.api.messages.not_found'), Morpho::Entities::Error ],
+            [ 405, I18n.t('morpho.api.messages.method_not_allowed'), Morpho::Entities::Error ],
+            [ 422, I18n.t('morpho.api.messages.unprocessable_entity'), Morpho::Entities::Error ]
+          ]
         end
         params do
-          requires :user, type: Morpho::Entities::User
+          requires :data, type: Morpho::Entities::UserEmail
         end
         post do
-          if current_user
-            if !current_user.active?
-              current_user.resend_activation_needed_email!
+          result = Morpho::User::Operation::Activate.call(params)
 
-              present current_user, with: Morpho::Entities::User
-            else
+          if result.success?
+            present result['model'], with: Morpho::Entities::User
+          else
+            case result['error']
+            when :not_valid
+              render_unprocessable_entity(result['contract'].errors)
+            when :not_found
+              render_not_found
+            when :not_allowed
               render_method_not_allowed
+            when :not_delivered
+              render_unprocessable_entity
+            else
+              render_unprocessable_entity
             end
-          else
-            render_not_found
           end
         end
       end

data/app/api/morpho/resources/externals.rb

@@ -1,19 +1,28 @@
 module Morpho
   module Resources
     class Externals < ::Grape::API
-      helpers Morpho::Helpers::HTTPResponses,
-        Morpho::Helpers::JWTUtils,
-        Morpho::Helpers::UserExternalLogin
+      helpers Morpho::Helpers::HTTPResponses
 
       namespace :externals do
         desc 'Request user authentication from external provider' do
-          success Morpho::Entities::User
+          success Morpho::Grape::DataWrapper.new(Morpho::Entities::AuthenticationToken)
         end
         params do
-          requires :data, type: Morpho::Entities::SignIn::External
+          requires :data, type: Morpho::Entities::External
         end
         post do
-          login(params[:data])
+          result = Morpho::User::Operation::ExternalSignIn.call(params, ip: request.ip)
+
+          if result.success?
+            present result['token'], with: Morpho::Entities::AuthenticationToken
+          else
+            case result['error']
+            when :not_valid
+              render_unprocessable_entity(result['contract'].errors)
+            else
+              render_unprocessable_entity
+            end
+          end
         end
       end
     end

data/app/api/morpho/resources/hello.rb

@@ -0,0 +1,36 @@
+module Morpho
+  module Resources
+    class Hello < ::Grape::API
+      helpers Morpho::Helpers::HTTPResponses, Morpho::Helpers::JWTUtils
+
+      namespace :hello do
+        desc 'Request hello message' do
+          success Morpho::Grape::DataWrapper.new(Morpho::Entities::Message)
+        end
+        get :public do
+          message = { content: 'Hello world!' }
+
+          present message, with: Morpho::Entities::Message
+        end
+
+        namespace do
+          before do
+            require_login
+          end
+
+          desc 'Request hello message' do
+            success Morpho::Grape::DataWrapper.new(Morpho::Entities::Message)
+            failure [
+              [ 401, I18n.t('morpho.api.messages.unauthorized'), Morpho::Entities::Error ]
+            ]
+          end
+          get :private do
+            message = { content: 'Hello world!' }
+
+            present message, with: Morpho::Entities::Message
+          end
+        end
+      end
+    end
+  end
+end

data/app/api/morpho/resources/passwords.rb

@@ -1,23 +1,38 @@
 module Morpho
   module Resources
     class Passwords < ::Grape::API
-      helpers Morpho::Helpers::HTTPResponses,
-        Morpho::Helpers::UserPasswordReset
+      helpers Morpho::Helpers::HTTPResponses
 
       namespace :passwords do
         desc 'Request user reset password token' do
-          success Morpho::Entities::User
+          success Morpho::Grape::DataWrapper.new(Morpho::Entities::User)
+          failure [
+            [ 404, I18n.t('morpho.api.messages.not_found'), Morpho::Entities::Error ],
+            [ 405, I18n.t('morpho.api.messages.method_not_allowed'), Morpho::Entities::Error ],
+            [ 422, I18n.t('morpho.api.messages.unprocessable_entity'), Morpho::Entities::Error ]
+          ]
         end
         params do
-          requires :user, type: Morpho::Entities::User
+          requires :data, type: Morpho::Entities::UserEmail
         end
         post do
-          if current_user
-            current_user.deliver_reset_password_instructions!
+          result = Morpho::User::Operation::ResetPassword.call(params)
 
-            present current_user, with: Morpho::Entities::User
+          if result.success?
+            present result['model'], with: Morpho::Entities::User
           else
-            render_not_found
+            case result['error']
+            when :not_valid
+              render_unprocessable_entity(result['contract'].errors)
+            when :not_found
+              render_not_found
+            when :not_allowed
+              render_method_not_allowed
+            when :not_delivered
+              render_unprocessable_entity
+            else
+              render_unprocessable_entity
+            end
           end
         end
       end

data/app/api/morpho/resources/tokens.rb

@@ -2,35 +2,70 @@ module Morpho
   module Resources
     class Tokens < ::Grape::API
       helpers Morpho::Helpers::HTTPResponses,
-        Morpho::Helpers::JWTUtils,
-        Morpho::Helpers::UserLogin,
-        Morpho::Helpers::UserRefreshAuthenticationToken
+        Morpho::Helpers::JWTUtils
 
       namespace :tokens do
         desc 'Request user authentication token' do
-          success Morpho::Entities::SignIn::Success
+          success Morpho::Grape::DataWrapper.new(Morpho::Entities::AuthenticationToken)
           failure [
-            [ 401, I18n.t('morpho.api.messages.unauthorized'), Morpho::Entities::Error ]
+            [ 401, I18n.t('morpho.api.messages.unauthorized'), Morpho::Entities::Error ],
+            [ 403, I18n.t('morpho.api.messages.forbidden'), Morpho::Entities::Error ],
+            [ 404, I18n.t('morpho.api.messages.not_found'), Morpho::Entities::Error ],
+            [ 422, I18n.t('morpho.api.messages.unprocessable_entity'), Morpho::Entities::Error ],
+            [ 423, I18n.t('morpho.api.messages.locked'), Morpho::Entities::Error ]
           ]
         end
         params do
-          requires :data, type: Morpho::Entities::SignIn::Credentials
+          requires :data, type: Morpho::Entities::Credentials
         end
         post do
-          login(params[:data])
+          result = Morpho::User::Operation::SignIn.call(params, ip: request.ip)
+
+          if result.success?
+            present result['token'], with: Morpho::Entities::AuthenticationToken
+          else
+            case result['error']
+            when :not_valid
+              render_unprocessable_entity(result['contract'].errors)
+            when :not_found
+              render_not_found([I18n.t('morpho.api.messages.sign_in.unexistent')])
+            when :not_active
+              render_forbidden([I18n.t('morpho.api.messages.sign_in.unconfirmed')])
+            when :locked
+              render_locked([I18n.t('morpho.api.messages.sign_in.locked')])
+            when :wrong_password
+              render_unauthorized([I18n.t('morpho.api.messages.sign_in.bad_credentials')])
+            else
+              render_unprocessable_entity
+            end
+          end
         end
 
         desc 'Refresh user authentication token' do
-          success Morpho::Entities::SignIn::Success
+          success Morpho::Grape::DataWrapper.new(Morpho::Entities::AuthenticationToken)
           failure [
+            [ 404, I18n.t('morpho.api.messages.not_found'), Morpho::Entities::Error ],
             [ 422, I18n.t('morpho.api.messages.unprocessable_entity'), Morpho::Entities::Error ]
           ]
         end
         params do
-          requires :data, type: Morpho::Entities::SignIn::RefreshToken
+          requires :data, type: Morpho::Entities::RefreshToken
         end
         post :refresh do
-          refresh_token(params[:data])
+          result = Morpho::User::Operation::RefreshToken.call(params)
+
+          if result.success?
+            present result['token'], with: Morpho::Entities::AuthenticationToken
+          else
+            case result['error']
+            when :not_valid
+              render_unprocessable_entity(result['contract'].errors)
+            when :not_found
+              render_not_found([I18n.t('morpho.api.messages.refresh_token.invalid')])
+            else
+              render_unprocessable_entity
+            end
+          end
         end
       end
     end

data/app/api/morpho/resources/unlocks.rb

@@ -1,27 +1,38 @@
 module Morpho
   module Resources
     class Unlocks < ::Grape::API
-      helpers Morpho::Helpers::HTTPResponses,
-        Morpho::Helpers::UserUnlock
+      helpers Morpho::Helpers::HTTPResponses
 
       namespace :unlocks do
         desc 'Request user unlock token' do
-          success Morpho::Entities::User
+          success Morpho::Grape::DataWrapper.new(Morpho::Entities::UserEmail)
+          failure [
+            [ 404, I18n.t('morpho.api.messages.not_found'), Morpho::Entities::Error ],
+            [ 405, I18n.t('morpho.api.messages.method_not_allowed'), Morpho::Entities::Error ],
+            [ 422, I18n.t('morpho.api.messages.unprocessable_entity'), Morpho::Entities::Error ]
+          ]
         end
         params do
-          requires :user, type: Morpho::Entities::User
+          requires :data, type: Morpho::Entities::UserEmail
         end
         post do
-          if current_user
-            if current_user.login_locked?
-              current_user.resend_unlock_token_email!
+          result = Morpho::User::Operation::Unlock.call(params)
 
-              present current_user, with: Morpho::Entities::User
-            else
+          if result.success?
+            present result['model'], with: Morpho::Entities::User
+          else
+            case result['error']
+            when :not_valid
+              render_unprocessable_entity(result['contract'].errors)
+            when :not_found
+              render_not_found
+            when :not_allowed
               render_method_not_allowed
+            when :not_delivered
+              render_unprocessable_entity
+            else
+              render_unprocessable_entity
             end
-          else
-            render_not_found
           end
         end
       end

data/app/api/morpho/resources/users.rb

@@ -1,18 +1,33 @@
 module Morpho
   module Resources
     class Users < ::Grape::API
-      helpers Morpho::Helpers::HTTPResponses,
-        Morpho::Helpers::UserRegistration
+      helpers Morpho::Helpers::HTTPResponses
 
       namespace :users do
         desc 'User registration' do
-          success Morpho::Entities::User
+          success Morpho::Grape::DataWrapper.new(Morpho::Entities::User)
+          failure [
+            [ 422, I18n.t('morpho.api.messages.unprocessable_entity'), Morpho::Entities::Error ]
+          ]
         end
         params do
           requires :data, type: Morpho::Entities::UserSignUp
         end
         post do
-          register(params[:data])
+          result = Morpho::User::Operation::SignUp.call(params)
+
+          if result.success?
+            present result['model'], with: Morpho::Entities::User
+          else
+            case result['error']
+            when :not_valid
+              render_unprocessable_entity(result['contract'].errors)
+            when :not_saved
+              render_unprocessable_entity(result['model'].errors)
+            else
+              render_unprocessable_entity
+            end
+          end
         end
       end
     end

data/app/concepts/morpho/user/contract/activate.rb

@@ -0,0 +1,8 @@
+module Morpho
+  class User::Contract::Activate < Reform::Form
+    include Reform::Form::ActiveRecord
+
+    property :email
+    validates :email, presence: true, email_format: true
+  end
+end

data/app/concepts/morpho/user/contract/external_sign_in.rb

@@ -0,0 +1,14 @@
+require 'reform/form/validation/unique_validator'
+
+module Morpho
+  class User::Contract::ExternalSignIn < Reform::Form
+    include Reform::Form::ActiveRecord
+
+    property :email
+    validates :email, presence: true, email_format: true
+    property :uid
+    validates :uid, presence: true
+    property :provider
+    validates :provider, presence: true
+  end
+end

data/app/concepts/morpho/user/contract/refresh_token.rb

@@ -0,0 +1,8 @@
+module Morpho
+  class User::Contract::RefreshToken < Reform::Form
+    include Reform::Form::ActiveRecord
+
+    property :refresh_token
+    validates :refresh_token, presence: true
+  end
+end

data/app/concepts/morpho/user/contract/reset_password.rb

@@ -0,0 +1,8 @@
+module Morpho
+  class User::Contract::ResetPassword < Reform::Form
+    include Reform::Form::ActiveRecord
+
+    property :email
+    validates :email, presence: true, email_format: true
+  end
+end

data/app/concepts/morpho/user/contract/sign_in.rb

@@ -0,0 +1,10 @@
+module Morpho
+  class User::Contract::SignIn < Reform::Form
+    include Reform::Form::ActiveRecord
+
+    property :email
+    validates :email, presence: true, email_format: true
+    property :password
+    validates :password, presence: true
+  end
+end

data/app/concepts/morpho/user/contract/sign_up.rb

@@ -0,0 +1,14 @@
+require 'reform/form/validation/unique_validator'
+
+module Morpho
+  class User::Contract::SignUp < Reform::Form
+    include Reform::Form::ActiveRecord
+
+    property :email
+    validates :email, presence: true, unique: true, email_format: true
+    property :password
+    validates :password, presence: true, confirmation: true
+    property :password_confirmation, virtual: true
+    validates :password_confirmation, presence: true
+  end
+end

data/app/concepts/morpho/user/contract/unlock.rb

@@ -0,0 +1,8 @@
+module Morpho
+  class User::Contract::Unlock < Reform::Form
+    include Reform::Form::ActiveRecord
+
+    property :email
+    validates :email, presence: true, email_format: true
+  end
+end