oath 1.1.0

data/lib/oath/failure_app.rb

@@ -0,0 +1,48 @@
+module Oath
+  class FailureApp
+    def self.call(env)
+      request = Rack::Request.new(env)
+      new(request).response
+    end
+
+    def initialize(request)
+      @request = request
+    end
+
+    def response
+      [401, headers, body]
+    end
+
+    private
+
+    attr_reader :request
+
+    def headers
+      if http_auth_header?
+        basic_headers.merge(auth_headers)
+      else
+        basic_headers
+      end
+    end
+
+    def basic_headers
+      {
+        "Content-Type" => request.content_type.to_s
+      }
+    end
+
+    def auth_headers
+      {
+        "WWW-Authenticate" => 'Basic realm="Application"'
+      }
+    end
+
+    def body
+      ["Authorization Failed"]
+    end
+
+    def http_auth_header?
+      !request.xhr?
+    end
+  end
+end

data/lib/oath/field_map.rb

@@ -0,0 +1,56 @@
+module Oath
+  # FieldMap is used to allow multiple lookup fields. For instance if you
+  # wanted to allow a user to sign in via email or username. This is used
+  # internally by the authenticate_session controller helper
+  # @since 0.0.15
+  class FieldMap
+    # @param params [Hash] hash of parameters
+    # @param field_map [Hash] hash of values to map
+    def initialize params, field_map
+      @params = params
+      @field_map = field_map
+    end
+
+    # converts params into values that can be passed into a where clause
+    #
+    # @return [Array] if initialized with field_map
+    # @return [Hash] if not initialized with field_map
+    def to_fields
+      if @field_map
+        params_from_field_map
+      else
+        params_with_symbolized_keys
+      end
+    end
+
+    private
+
+    def params_with_symbolized_keys
+      @params.inject(default_fields){|hash,(key,value)| hash.merge(key.to_sym => value) }
+    end
+
+    def default_fields
+      { Oath.config.user_lookup_field => nil }
+    end
+
+    def params_from_field_map
+      [query_string, *([value] * lookup_keys.length)]
+    end
+
+    def query_string
+      lookup_keys.map { |key| "#{key} = ?" }.join(" OR ")
+    end
+
+    def session_key
+      @field_map.keys.first
+    end
+
+    def lookup_keys
+      @field_map.values.first
+    end
+
+    def value
+      @params[session_key]
+    end
+  end
+end

data/lib/oath/param_transformer.rb

@@ -0,0 +1,38 @@
+module Oath
+  # Parameter transformer. Sanitizes and transforms parameter values
+  # @since 1.0.0
+  class ParamTransformer
+    # Initialize parameter transformer
+    #
+    # @param params [ActionController::Parameters] parameters to be altered
+    def initialize(params, transformations)
+      @params = params
+      @transformations = transformations
+    end
+
+    # Returns the transformed parameters
+    def to_h
+      sanitized_params.each_with_object({}) do |(key, value), hash|
+        hash[key] = transform(key, value)
+      end
+    end
+
+    private
+
+    attr_reader :params, :transformations
+
+    def sanitized_params
+      params.to_h
+    end
+
+    def transform(key, value)
+      return value unless value.is_a? String
+
+      if transformations.key?(key)
+        transformations[key].call(value)
+      else
+        value
+      end
+    end
+  end
+end

data/lib/oath/railtie.rb

@@ -0,0 +1,11 @@
+require 'warden'
+
+module Oath
+  # Railtie for Oath. Injects the Warden middleware and initializes Oath.
+  # @since 0.0.15
+  class Railtie < Rails::Railtie
+    config.app_middleware.use Warden::Manager do |config|
+      Oath.initialize(config)
+    end
+  end
+end

data/lib/oath/services.rb

@@ -0,0 +1,5 @@
+require 'oath/services/sign_in'
+require 'oath/services/sign_out'
+require 'oath/services/sign_up'
+require 'oath/services/authentication'
+require 'oath/services/password_reset'

data/lib/oath/services/authentication.rb

@@ -0,0 +1,40 @@
+module Oath
+  module Services
+    # Authentication service. Checks to see if the credentials provided are valid
+    # @since 0.0.15
+    class Authentication
+      # Initialize service
+      #
+      # @param user [User] A user object
+      # @param undigested_token [String] An undigested password
+      def initialize user, undigested_token
+        @user = user
+        @undigested_token = undigested_token
+      end
+
+      # Perform the service
+      #
+      # @return [User] if authentication succeeds
+      # @return [false] if authentication fails
+      def perform
+        if authenticated?
+          user
+        else
+          false
+        end
+      end
+
+      private
+
+      attr_reader :user, :undigested_token
+
+      def authenticated?
+        user && Oath.compare_token(user.send(token_store_field), undigested_token)
+      end
+
+      def token_store_field
+        Oath.config.user_token_store_field
+      end
+    end
+  end
+end

data/lib/oath/services/password_reset.rb

@@ -0,0 +1,27 @@
+module Oath
+  module Services
+    # Password reset service. Updates the password on a User
+    # @since 0.0.15
+    class PasswordReset
+      # Initialize service
+      #
+      # @param user [User] A user object
+      # @param new_password [String] The new undigested password for a user
+      def initialize user, new_password
+        @user = user
+        @new_password = new_password
+      end
+
+      # Perform the service.
+      def perform
+        field = Oath.config.user_token_store_field
+        digested_password = Oath.hash_token(new_password)
+        user[field] = digested_password
+      end
+
+      private
+
+      attr_reader :user, :new_password
+    end
+  end
+end

data/lib/oath/services/sign_in.rb

@@ -0,0 +1,25 @@
+module Oath
+  module Services
+    # Sign in service. Signs the user in via warden
+    # @since 0.0.15
+    class SignIn
+      # Initialize service
+      #
+      # @param user [User] A user object
+      # @param warden [Warden] warden
+      def initialize user, warden
+        @user = user
+        @warden = warden
+      end
+
+      # Perform the service
+      def perform
+        warden.set_user(user)
+      end
+
+      private
+
+      attr_reader :warden, :user
+    end
+  end
+end

data/lib/oath/services/sign_out.rb

@@ -0,0 +1,24 @@
+module Oath
+  module Services
+    # Sign out service. Signs the user out via warden
+    # @since 0.0.15
+    class SignOut
+      # Initialize service
+      #
+      # @param warden [Warden] warden
+      def initialize warden
+        @warden = warden
+        @user = warden.user
+      end
+
+      # Perform the service
+      def perform
+        warden.logout
+      end
+
+      private
+
+      attr_reader :warden, :user
+    end
+  end
+end

data/lib/oath/services/sign_up.rb

@@ -0,0 +1,42 @@
+module Oath
+  module Services
+    # Sign up service. Signs the user up
+    # @since 0.0.15
+    class SignUp
+      # Initialize service
+      #
+      # @param user_params [Hash] A hash of user credentials. Should contain the lookup and token fields
+      def initialize user_params
+        digested_token = token_digest(user_params)
+        @user_params = user_params.
+          except(token_field).
+          merge(token_store_field.to_sym => digested_token)
+      end
+
+      # Performs the service
+      # @see Oath::Configuration.default_creation_method
+      def perform
+        Oath.config.creation_method.call(user_params)
+      end
+
+      private
+
+      attr_reader :user_params
+
+      def token_digest(user_params)
+        undigested_token = user_params[token_field]
+        unless undigested_token.blank?
+          Oath.hash_token(undigested_token)
+        end
+      end
+
+      def token_store_field
+        Oath.config.user_token_store_field
+      end
+
+      def token_field
+        Oath.config.user_token_field
+      end
+    end
+  end
+end

data/lib/oath/strategies/password_strategy.rb

@@ -0,0 +1,42 @@
+require 'warden'
+
+module Oath
+  module Strategies
+    # Password strategy for warden
+    # @since 0.0.15
+    class PasswordStrategy < ::Warden::Strategies::Base
+
+      # Checks if strategy should be executed
+      # @return [Boolean]
+      def valid?
+        lookup_field_value || token_field_value
+      end
+
+
+      # Authenticates for warden
+      def authenticate!
+        user = Oath.config.user_class.find_by(lookup_field => lookup_field_value)
+        auth = Oath.config.authentication_service.new(user, token_field_value)
+        auth.authenticated? ? success!(user) : fail!("Could not log in")
+      end
+
+      private
+
+      def lookup_field_value
+        params[lookup_field]
+      end
+
+      def token_field_value
+        params[token_field]
+      end
+
+      def lookup_field
+        Oath.config.user_lookup_field
+      end
+
+      def token_field
+        Oath.config.user_token_field
+      end
+    end
+  end
+end

data/lib/oath/test/controller_helpers.rb

@@ -0,0 +1,43 @@
+require 'warden'
+
+module Oath
+  module Test
+    # These are test helpers for controller specs
+    # @note these have only been tested with rspec controller specs
+    # @since 0.0.15
+    module ControllerHelpers
+      def self.included(base)
+        base.class_eval do
+          setup :store_controller_for_warden, :warden if respond_to?(:setup)
+        end
+      end
+
+      # Signs a user in for tests
+      # @param user [User] the user to sign in
+      def sign_in(user)
+        @controller.sign_in(user)
+      end
+
+      # Signs the user out in tests
+      def sign_out
+        @controller.sign_out
+      end
+
+      # A mock of warden for tests
+      def warden
+        @warden ||= begin
+          manager = Warden::Manager.new(nil) do |config|
+            config.merge! Oath.warden_config
+          end
+          @request.env['warden'] = Warden::Proxy.new(@request.env, manager)
+        end
+      end
+
+      private
+      def store_controller_for_warden
+        @request.env['action_controller.instance'] = @controller
+      end
+
+    end
+  end
+end

data/lib/oath/test/helpers.rb

@@ -0,0 +1,24 @@
+module Oath
+  module Test
+    # Helpers for integration or feature specs
+    # @note these have only been tested with rspec integration and feature specs
+    # @since 0.0.15
+    module Helpers
+      include Warden::Test::Helpers
+
+      # Sign a user in
+      # @param user [User] user to sign in
+      # @returns user [User] signed in user
+      def sign_in user
+        login_as user
+
+        user
+      end
+
+      # Sign a user out
+      def sign_out
+        logout
+      end
+    end
+  end
+end

data/lib/oath/version.rb

@@ -0,0 +1,4 @@
+module Oath
+  # 1.1.0
+  VERSION = "1.1.0"
+end