password_utils 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a36aecdd62517839fc750686c4feb24bb2f811d32d9e86238c468e4697abaf71
-  data.tar.gz: f9e8c738b0fd74596716a45f8fd6e1d8a72cfb781250e545dabfe7eddff7f458
+  metadata.gz: d5c6dee713ac0c6f70895a2edc12e170b3d8299d3e567bb8c2776959571e706e
+  data.tar.gz: c6062090132c7583f3e422429d45b14a81e249f608107a15d879f30d5f728463
 SHA512:
-  metadata.gz: ff7bd7f76f78a286ee88659d5f491780d6591e610295eda60bf67a078bdfcd63c7e331e510da923afd9c3281b3638619ab1e12d97606dae4ab58737e13b75713
-  data.tar.gz: 3401ab9e705a82ddac6b4038c42ef4db07016a8c8ef8d06a5a08d031ba7c5b0d70d54164fab09d0c25594bb2c814c4ffd13ba1b7c2f3551d1abd0d5fe6cb80cb
+  metadata.gz: 8ec710b1f114f9f5d0595af04ed1533839bc7227953a0e978f7c417462b8a76afb6f0ad3bfc035c0a5b2f31356179619783a3fab399a19559e19b75fffc9be31
+  data.tar.gz: 82202510e74f6c84f500f81869a94c7ca5eb59d689642482747c3c43b910e17fdbf1c5ed23067311ae1eafc6930ec82340da4de75c3f224f2f7acc1c6c274454

data/.github/workflows/main.yml

@@ -0,0 +1,18 @@
+name: Ruby
+
+on: [push,pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 3.0.0
+    - name: Run the default task
+      run: |
+        gem install bundler -v 2.2.3
+        bundle install
+        bundle exec rake

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,10 @@
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in password_utils.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+
+gem "rubocop", "~> 0.80"

data/Gemfile.lock

@@ -0,0 +1,59 @@
+PATH
+  remote: .
+  specs:
+    password_utils (0.1.0)
+      bcrypt (~> 3.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    bcrypt (3.1.20)
+    diff-lcs (1.5.1)
+    parallel (1.26.3)
+    parser (3.3.5.0)
+      ast (~> 2.4.1)
+      racc
+    racc (1.8.1)
+    rainbow (3.1.1)
+    rake (13.2.1)
+    regexp_parser (2.9.2)
+    rexml (3.3.8)
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.1)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.1)
+    rubocop (0.93.1)
+      parallel (~> 1.10)
+      parser (>= 2.7.1.5)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8)
+      rexml
+      rubocop-ast (>= 0.6.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (1.32.3)
+      parser (>= 3.3.1.0)
+    ruby-progressbar (1.13.0)
+    unicode-display_width (1.8.0)
+
+PLATFORMS
+  x86_64-darwin-23
+
+DEPENDENCIES
+  password_utils!
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 0.80)
+
+BUNDLED WITH
+   2.2.3

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 riyandika
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -21,7 +21,17 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+```ruby
+require 'password_utils'
+
+# Example usage
+password = 'super_secret'
+hashed_password = PasswordUtils.password_hash(password)
+
+# Verify the password
+puts PasswordUtils.password_verify('super_secret', hashed_password)  # should return true
+puts PasswordUtils.password_verify('wrong_password', hashed_password)  # should return false
+```
 
 ## Development
 

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "password_utils"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/password_utils/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module PasswordUtils
+  VERSION = "0.1.1"
+end

data/lib/password_utils.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require_relative "password_utils/version"
+require "bcrypt"
+
+# PasswordUtils provides functionality for hashing and verifying passwords using bcrypt.
+# It includes methods to hash a password and verify if a given password matches the hash.
+module PasswordUtils
+  class Error < StandardError; end
+
+  # Hashes the password using bcrypt
+  def self.password_hash(password, cost = 12)
+    BCrypt::Password.create(password, cost: cost)
+  end
+
+  # Verifies a password against a hash
+  def self.password_verify(password, password_hash)
+    BCrypt::Password.new(password_hash) == password
+  end
+end

data/password_utils.gemspec

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require_relative "lib/password_utils/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "password_utils"
+  spec.version       = PasswordUtils::VERSION
+  spec.authors       = ["riyandika"]
+  spec.email         = ["riyandika.andhi@gmail.com"]
+
+  spec.summary       = "ruby Password Utils"
+  spec.description   = "inspired by php password_hash, implemented for ruby gems"
+  spec.homepage      = "https://github.com/riyandika/password_utils"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.4.0")
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/riyandika/password_utils"
+  # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features|.*\.gem)\z}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  spec.add_dependency "bcrypt", "~> 3.1"
+
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/spec/password_utils_spec.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require "password_utils"
+
+RSpec.describe PasswordUtils do
+  let(:password) { "super_secret" }
+  let(:hashed_password) { PasswordUtils.password_hash(password) }
+
+  describe ".password_hash" do
+    it "generates a hash for the password" do
+      expect(hashed_password).to be_a(BCrypt::Password)
+    end
+  end
+
+  describe ".password_verify" do
+    it "returns true for a valid password" do
+      expect(PasswordUtils.password_verify(password, hashed_password)).to be true
+    end
+
+    it "returns false for an invalid password" do
+      expect(PasswordUtils.password_verify("wrong_password", hashed_password)).to be false
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "password_utils"
+
+RSpec.configure do |config|
+  # Enable flags like --only-failures and --next-failure
+  config.example_status_persistence_file_path = ".rspec_status"
+
+  # Disable RSpec exposing methods globally on `Module` and `main`
+  config.disable_monkey_patching!
+
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: password_utils
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - riyandika
@@ -14,16 +14,16 @@ dependencies:
   name: bcrypt
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.1'
 description: inspired by php password_hash, implemented for ruby gems
 email:
 - riyandika.andhi@gmail.com
@@ -31,7 +31,22 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/main.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
 - README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/password_utils.rb
+- lib/password_utils/version.rb
+- password_utils.gemspec
+- spec/password_utils_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/riyandika/password_utils
 licenses:
 - MIT