zero_auth 0.0.2.beta → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8e5293b8a8a5c64cb80f819e0afc5fe0da191223
-  data.tar.gz: 52511c99d61691eaf31db9a9effb837ef285ed0d
+  metadata.gz: 9cbb0922638b9a01abf7e9621a870ae1b0d57667
+  data.tar.gz: ae5e0cd3fb41ec43ad920f5d0fa7e936f53b8521
 SHA512:
-  metadata.gz: 32125971bae43ce2cae06f9dab77afae3eb58daa9f834ad288024067facd7afff2d5c1a9793e2c8e881419c6e30809ea7076203fc7dc4937cff7b40e7cac8c3a
-  data.tar.gz: 84c2a65e27f0a4d64f642196fdff381fb76105141633b3400fe6882879c766ae13b92c2255d87919e0e531968264bc29a54e3673275a3feddf235d24cf9072c3
+  metadata.gz: af57951c911288bbf78e0e607983e2a035d8f0bf9404ea95ffeaf92b05afaca4c4a05fd348db5932e9f91667592d8262d4d839f17105e25717e3218dd29b49a4
+  data.tar.gz: 28e1a5f264f5bd9fd7d5e1e701bea45eaadc5c9098f5b3e35a5af13bfaff32d70ecb8a17e50ce0f5e02d1c57987dc7d53d37f4150097c19677fb0b5f087e62a6

data/lib/zero_auth.rb

@@ -1,5 +1,9 @@
-require "zero_auth/version"
+require 'thread'
+require 'zero_auth/version'
+require 'zero_auth/config'
 
+# Namespace for the ZeroAuth library
+#
 module ZeroAuth
   autoload :Utils, 'zero_auth/utils'
   autoload :Password, 'zero_auth/password'
@@ -8,6 +12,22 @@ module ZeroAuth
     autoload :Password, 'zero_auth/model/password'
   end
 
+  # The current {ZeroAuth::Config} object for the thread.
+  #
+  # @return [ZeroAuth::Config]
+  #
+  def self.config
+    Thread.current[:zero_auth_config] ||= Config.new
+  end
+
+  # Enables configuration of the ZeroAuth library.
+  #
+  # @yieldparam [ZeroAuth::Config] config
+  #
+  def self.configure
+    yield config
+  end
+
   # Exception raised througout the library when a method expected to
   # perform some type of authentication on user supplied parameters cannot be
   # authenticated.

data/lib/zero_auth/config.rb

@@ -0,0 +1,22 @@
+module ZeroAuth
+
+  # Holds configuration values for the ZeroAuth library.
+  #
+  class Config
+
+    # @return [Integer] The cost param when generating BCrypt passwords.
+    #   Defaults to 9.
+    #
+    attr_accessor :password_cost
+
+    def initialize
+      reset!
+    end
+
+    # Resets the current configuration values to their defaults.
+    #
+    def reset!
+      self.password_cost = 9
+    end
+  end
+end

data/lib/zero_auth/model/password.rb

@@ -121,6 +121,7 @@ module ZeroAuth
     module Password
 
       # Calls `attr_reader :password` on the including class.
+      # @!visibility private
       #
       def self.included(base)
         base.class_eval { attr_reader :password }

data/lib/zero_auth/password.rb

@@ -1,16 +1,20 @@
 require 'bcrypt'
-
 module ZeroAuth
+
+  # Provides helper methods for generating and comparing BCrypt passwords
+  #
   class Password
 
-    # @return [String] a salt created by `BCrypt::Engine.generate_salt`
+    # Generates a password salt using `BCrypt::Engine.generate_salt`
+    #
+    # @return [String] the password salt
     #
     def self.generate_salt
       BCrypt::Engine.generate_salt
     end
 
-    # Generates a `BCrypt::Password` with a hard-coded cost of **9** (which
-    # will probably change soon).
+    # Generates a `BCrypt::Password` using they {ZeroAuth::Config#password_cost}
+    # configuration value.
     #
     # @param password [String] the given password
     # @param salt [Sting] the password salt
@@ -18,7 +22,8 @@ module ZeroAuth
     # @return [BCrypt::Password]
     #
     def self.create(password, salt)
-      BCrypt::Password.create("#{password}#{salt}", cost: 9)
+      cost = ZeroAuth.config.password_cost
+      BCrypt::Password.create("#{password}#{salt}", cost: cost)
     end
 
     # Compares a given encrypted password and the salt used to generate it with

data/lib/zero_auth/utils.rb

@@ -1,6 +1,9 @@
 require 'bcrypt'
 
 module ZeroAuth
+
+  # Provides general helper methods used throughout the ZeroAuth library.
+  #
   class Utils
 
     # Uses a "constant time" comparison algorithm I would never have thought

data/lib/zero_auth/version.rb

@@ -1,3 +1,3 @@
 module ZeroAuth
-  VERSION = "0.0.2.beta"
+  VERSION = "0.0.3"
 end

data/spec/lib/zero_auth/configuration_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+RSpec.describe ZeroAuth::Config do
+
+  let(:config) { described_class.new }
+
+  describe "#reset!" do
+    it "resets the configuration" do
+      old_cost = config.password_cost
+      config.password_cost = 25
+      config.reset!
+      expect(config.password_cost).to eq(old_cost)
+    end
+  end
+
+  shared_examples_for :config_attribute do |config_name, default_value|
+    describe "##{config_name}" do
+      it "has a default_value of #{default_value.inspect}" do
+        expect(config.send(config_name)).to eq(default_value)
+      end
+
+      it "can be set to a new value" do
+        config.send("#{config_name}=", :test)
+        expect(config.send(config_name)).to eq(:test)
+      end
+    end
+  end
+
+  include_examples :config_attribute, :password_cost, 9
+end

data/spec/lib/zero_auth/password_spec.rb

@@ -9,6 +9,13 @@ RSpec.describe ZeroAuth::Password do
   end
 
   describe ".create" do
+    it 'creates the password correctly' do
+      expect(BCrypt::Password).to receive(:create)
+        .with("passwordsalt", {cost: ZeroAuth.config.password_cost})
+
+      ZeroAuth::Password.create("password", "salt")
+    end
+
     it "returns a BCrypt::Password" do
       password = ZeroAuth::Password.create("password", "salt")
       expect(password).to be_a(BCrypt::Password)

data/spec/spec_helper.rb

@@ -19,4 +19,8 @@ RSpec.configure do |config|
     mocks.syntax = :expect
     mocks.verify_partial_doubles = true
   end
+
+  config.after(:each) do
+    ZeroAuth.config.reset!
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zero_auth
 version: !ruby/object:Gem::Version
-  version: 0.0.2.beta
+  version: 0.0.3
 platform: ruby
 authors:
 - Braden Schaeffer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-27 00:00:00.000000000 Z
+date: 2015-11-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bcrypt
@@ -110,10 +110,12 @@ files:
 - README.md
 - Rakefile
 - lib/zero_auth.rb
+- lib/zero_auth/config.rb
 - lib/zero_auth/model/password.rb
 - lib/zero_auth/password.rb
 - lib/zero_auth/utils.rb
 - lib/zero_auth/version.rb
+- spec/lib/zero_auth/configuration_spec.rb
 - spec/lib/zero_auth/model/password_spec.rb
 - spec/lib/zero_auth/password_spec.rb
 - spec/lib/zero_auth/utils_spec.rb
@@ -134,18 +136,18 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Zero configuration authentication starter for Rails.
 test_files:
+- spec/lib/zero_auth/configuration_spec.rb
 - spec/lib/zero_auth/model/password_spec.rb
 - spec/lib/zero_auth/password_spec.rb
 - spec/lib/zero_auth/utils_spec.rb
 - spec/spec_helper.rb
-has_rdoc: