seraph 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9062ea4972e3a44b97a05b4935c8f5936b05fe24
-  data.tar.gz: a0117bd6c8d5b547b1ff0f2dcb018fa6e06946c4
+  metadata.gz: 87711ece6861da7a244448c707b9588c22d1e8fc
+  data.tar.gz: 74326bd119d70bffaf09c5a1737a14e20359e934
 SHA512:
-  metadata.gz: 0e5b596ae436664b9b9f38cc1d51e86e2be6e1fefdb63e51268daf8bc46fc7d13f9c1667930fd4dfc072d086045fec12cadc63a4f315b9a524c90f0015e9fde1
-  data.tar.gz: 2b619e40492e7663987ba48d6684b5382ff38c4f02961a57d30bf525359880e1197fcf9a35401e11ced508ff0e25f55420290fc724d680cae51282b09377d453
+  metadata.gz: c934f404675ce042d89c3649dd916f80826c96c764951bb5670df12930ff1afa51306e8bff831371f9262718e7ad7104ad5894457fd937af52a1b8653a5b588c
+  data.tar.gz: 4e554eb21423cf534cf7f54efa054457701dbba43fd7e6e22425f97f7bf2fe70acfbb2e57056982a8feef330f6abebbfb3ec1c79c17c586825283757034dcf08

data/.travis.yml

@@ -1,6 +1,11 @@
 ---
 language: ruby
 rvm:
+  - 1.9.3
+  - 2.0.0
   - 2.1.9
   - 2.2.5
   - 2.3.1
+addons:
+  code_climate:
+    repo_token: 6194b4057a3a760a2b37afe44119bb0ecb7d34f34087c076a8cc84c38e48826a

data/README.md

@@ -1,5 +1,7 @@
 # seraph
 [![Build Status](https://travis-ci.org/Szeliga/seraph.svg?branch=master)](https://travis-ci.org/Szeliga/seraph)
+[![Code Climate](https://codeclimate.com/github/Szeliga/seraph/badges/gpa.svg)](https://codeclimate.com/github/Szeliga/seraph)
+[![Test Coverage](https://codeclimate.com/github/Szeliga/seraph/badges/coverage.svg)](https://codeclimate.com/github/Szeliga/seraph/coverage)
 
 A simple framework-agnostic library for authentication. seraph provides an API for implementing User authentication inside your app. It doesn't make any assumptions about your setup, so you do not have to have a `User` class that inherits from `ActiveRecord::Base`.
 
@@ -58,9 +60,9 @@ Seraph::PasswordEncryptor.call('foobar12')
 
 As a result you get the encrypted password, which you can be persisted in the database, alongside other user data (e-mail, login, etc.)
 
-### WIP - Comparing a provided password with the encrypted one
+### Comparing a provided password with the encrypted one
 
-Comparison is done using a constant-time secure comparison method, from the gem (fast_secure_compare)[https://github.com/daxtens/fast_secure_compare]
+Comparison is done using a constant-time secure comparison method from the gem (fast_secure_compare)[https://github.com/daxtens/fast_secure_compare]
 
 To do it simply run:
 
@@ -69,6 +71,8 @@ Seraph::Authenticator.call(encrypted_password, plaintext_password)
 # => true or false
 ```
 
+If the pepper was set in the configuration block, it will be automatically used in the comparison.
+
 ## Copyright
 
 Copyright (c) 2016 Szymon Szeliga

data/lib/seraph/authenticator.rb

@@ -0,0 +1,32 @@
+require 'bcrypt'
+require 'seraph/utils'
+
+module Seraph
+  class Authenticator
+    private_class_method :new
+
+    def self.call(encrypted, plaintext)
+      new(encrypted, plaintext).call
+    end
+
+    def call
+      bcrypt = BCrypt::Password.new(encrypted)
+      peppered_password = pepper.blank? ? plaintext : "#{plaintext}:#{pepper}"
+      password = BCrypt::Engine.hash_secret(peppered_password, bcrypt.salt)
+      Utils.compare(encrypted, password)
+    end
+
+    def initialize(encrypted, plaintext)
+      @encrypted = encrypted
+      @plaintext = plaintext
+    end
+
+    private
+
+    attr_reader :encrypted, :plaintext
+
+    def pepper
+      String(Seraph.configuration.pepper)
+    end
+  end
+end

data/lib/seraph/utils.rb

@@ -0,0 +1,10 @@
+require 'fast_secure_compare/fast_secure_compare'
+
+module Seraph
+  module Utils
+    def compare(a, b)
+      FastSecureCompare.compare(a, b)
+    end
+    module_function :compare
+  end
+end

data/lib/seraph/version.rb

@@ -1,3 +1,3 @@
 module Seraph
-  VERSION = '0.0.4'.freeze
+  VERSION = '0.0.5'.freeze
 end

data/seraph.gemspec

@@ -33,10 +33,10 @@ Gem::Specification.new do |gem|
   gem.add_dependency 'bcrypt', '~> 3.1'
   gem.add_dependency 'fast_secure_compare', '~> 1.0'
   gem.add_dependency 'fast_blank', '~> 1.0'
-  gem.add_development_dependency 'bundler', '~> 1.10'
   gem.add_development_dependency 'rake', '~> 10.0'
   gem.add_development_dependency 'rspec', '~> 3.0'
   gem.add_development_dependency 'rubygems-tasks', '~> 0.2'
   gem.add_development_dependency 'fuubar', '~> 2.0'
   gem.add_development_dependency 'pry', '~> 0.10'
+  gem.add_development_dependency 'codeclimate-test-reporter', '~> 0.1'
 end

data/spec/seraph/authenticator_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+require 'seraph/authenticator'
+require 'seraph/password_encryptor'
+
+RSpec.describe Seraph::Authenticator do
+  describe '.call' do
+    let(:plaintext) { 'foobar12' }
+    let(:encrypted) { Seraph::PasswordEncryptor.call(plaintext).to_s }
+    subject(:authenticated) { described_class.call(encrypted, provided) }
+
+    context 'when the provided password is the same as the encrypted one' do
+      let(:provided) { plaintext }
+      it { is_expected.to be_truthy }
+    end
+
+    context 'when the provided password is different than the encrypted one' do
+      let(:provided) { 'wrongpassword' }
+      it { is_expected.to be_falsey }
+    end
+
+    context 'when pepper is set' do
+      include_context 'pepper set in configuration'
+
+      context 'when the provided password is the same as the encrypted one' do
+        let(:provided) { plaintext }
+        it { is_expected.to be_truthy }
+      end
+
+      context 'when the provided password is different than the encrypted one' do
+        let(:provided) { 'wrongpassword' }
+        it { is_expected.to be_falsey }
+      end
+    end
+  end
+end

data/spec/seraph/password_encryptor_spec.rb

@@ -13,12 +13,7 @@ RSpec.describe Seraph::PasswordEncryptor do
     end
 
     context 'when pepper is set' do
-      let(:pepper) { '9b8177d1d835fad6cc19b455d41ec64f6dcbe83a1af60eb598973f8fb6e29fb1' }
-      before do
-        Seraph.configure do |config|
-          config.pepper = pepper
-        end
-      end
+      include_context 'pepper set in configuration'
 
       it 'uses the pepper for encrypting the password' do
         expect(encrypted_password).to eq BCrypt::Engine.hash_secret("#{password}:#{pepper}", salt)

data/spec/spec_helper.rb

@@ -1,5 +1,10 @@
 require 'rspec'
 require 'seraph/version'
+require 'codeclimate-test-reporter'
+
+Dir['./spec/support/**/*.rb'].sort.each { |f| require f }
+
+CodeClimate::TestReporter.start
 
 RSpec.configure do |config|
   config.expect_with :rspec do |expectations|

data/spec/support/pepper_configuration.rb

@@ -0,0 +1,8 @@
+RSpec.shared_context "pepper set in configuration" do
+  let(:pepper) { '9b8177d1d835fad6cc19b455d41ec64f6dcbe83a1af60eb598973f8fb6e29fb1' }
+  before do
+    Seraph.configure do |config|
+      config.pepper = pepper
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: seraph
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Szymon Szeliga
@@ -52,20 +52,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.10'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.10'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -136,6 +122,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
 description: Looking for an authentication gem that doesn't make any assumptions about
   your setup? You've came to the right place.
 email: szeliga.szymon@gmail.com
@@ -155,14 +155,17 @@ files:
 - README.md
 - Rakefile
 - lib/seraph.rb
+- lib/seraph/authenticator.rb
 - lib/seraph/configuration.rb
-- lib/seraph/extensions/nil_class_blank.rb
 - lib/seraph/password_encryptor.rb
+- lib/seraph/utils.rb
 - lib/seraph/version.rb
 - seraph.gemspec
+- spec/seraph/authenticator_spec.rb
 - spec/seraph/password_encryptor_spec.rb
 - spec/seraph_spec.rb
 - spec/spec_helper.rb
+- spec/support/pepper_configuration.rb
 homepage: https://rubygems.org/gems/seraph
 licenses:
 - MIT
@@ -188,6 +191,8 @@ signing_key:
 specification_version: 4
 summary: A simple framework-agnostic library for authentication
 test_files:
+- spec/seraph/authenticator_spec.rb
 - spec/seraph/password_encryptor_spec.rb
 - spec/seraph_spec.rb
 - spec/spec_helper.rb
+- spec/support/pepper_configuration.rb

data/lib/seraph/extensions/nil_class_blank.rb

@@ -1,11 +0,0 @@
-module Seraph
-  module Extensions
-    module NilClassBlank
-      refine NilClass do
-        def blank?
-          true
-        end
-      end
-    end
-  end
-end