balaclava 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 94d63b7d24667a0a158018eb7dcd218585d261eba703ca346c3905f9173ca169
+  data.tar.gz: bd961d7dd7eebe028e5f310b494b07c02952e6f4655f67a67e198bb1ce1491a0
+SHA512:
+  metadata.gz: d46efbbf262f8b66762ebde8a0b16df2a0e66f7b98f4c829275583e71bb1f6399d6d38994c893d9999a4f12bd708ba63b53a3b52a75f5b2561675f0c78402289
+  data.tar.gz: 5a51499354ed9e388f8f165ecb99484550e55f753a2ab326f336ebfdb687dda412288dbb55edef8e8c0884a5b3d80d5a185ab79b351ff862fc4294547e9f91d6

data/.rspec

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

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-03-02
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at heysante@proton.me. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/README.md

@@ -0,0 +1,67 @@
+# Balaclava
+
+![Balaclava Logo](balaclava_logo.png)
+
+Balaclava is a minimalistic gem designed to provide simple user validation functionalities.
+
+## Installation
+
+To install Balaclava, add this line to your application's Gemfile:
+
+```ruby
+gem 'balaclava'
+```
+
+And then execute:
+
+```bash
+bundle install
+```
+
+Or install it yourself as:
+
+```bash
+gem install balaclava
+```
+
+## Usage
+
+Once Balaclava is installed, you can use it as follows:
+
+1. **Generate Balaclava Model**: To generate the Balaclava model for your user, run the following command:
+
+```bash
+rails generate balaclava:install
+```
+
+2. **Initialize Balaclava Authenticator**: Initialize an instance of the `Balaclava::Authenticator` class with the user's email address and an optional cache object:
+
+```ruby
+authenticator = Balaclava::Authenticator.new("user@example.com")
+```
+
+3. **Register a User**: Use the `registration` method to register a user and store verification data in the cache:
+
+```ruby
+user = authenticator.registration
+```
+
+4. **Validate Code**: To validate a code provided by the user, use the `validate_code` method:
+
+```ruby
+authenticator.validate_code("user@example.com", "provided_code")
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at [https://github.com/santedime/balaclava](https://github.com/santedime/balaclava). This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/santedime/balaclava/blob/master/CODE_OF_CONDUCT.md).
+
+## Code of Conduct
+
+Everyone interacting in the Balaclava project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/santedime/balaclava/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/balaclava.gemspec

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require_relative "lib/balaclava/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "balaclava"
+  spec.version = Balaclava::VERSION
+  spec.authors = ["Sante"]
+  spec.email = ["imsantiago@proton.me"]
+
+  spec.summary = "A minimalistic way to validate your users."
+  spec.description = "Validate users througt 6 digits codes sent by email."
+  spec.homepage = "https://github.com/santedime/balaclava"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/santedime/balaclava"
+  spec.metadata["changelog_uri"] = "https://github.com/santedime/balaclava/blob/main/CHANGELOG.md"
+
+  # 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(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) ||
+        f.start_with?(*%w[bin/ test/ spec/ features/ .git .github appveyor Gemfile])
+    end
+  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 "example-gem", "~> 1.0"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+  spec.add_runtime_dependency 'mail'
+end

data/lib/balaclava/authenticator.rb

@@ -0,0 +1,51 @@
+require 'securerandom'
+require_relative 'errors/invalid_code_error'
+
+class Balaclava::Authenticator
+  attr_accessor :cache
+
+  def initialize(user_email, cache = Rails.cache)
+    valid_email?(user_email)
+    @user_email = user_email
+    @cache = cache
+  end
+
+  def registration
+    user = create_user
+    verification_data = { code: generate_code.to_s }
+    cache.write("verification_data#{user.id}", verification_data)
+    user
+  rescue => e
+    raise StandardError, "Registration failed: #{e.message}"
+  end
+
+  def generate_code
+    rand(100000..999999)
+  end
+
+  def validate_code(user_email, provided_code)
+    user = find_user_by_email(user_email)
+    cached_code = cache.read("verification_data#{user.id}")
+    raise InvalidCodeError, "Invalid code" unless cached_code == provided_code
+    true
+  rescue => e
+    raise InvalidCodeError, "Code validation failed: #{e.message}"
+  end
+
+  private
+
+  def valid_email?(email)
+    # Simple regex pattern for email validation
+    email_regex = /\A[\w+\-.]+@[a-z\d\-.]+\.[a-z]+\z/i
+    raise StandardError, "Invalid email address" unless email =~ email_regex
+    true
+  end
+
+  def create_user
+    Balaclava.user_model.constantize.create(email: @user_email)
+  end
+
+  def find_user_by_email(email)
+    Balaclava.user_model.constantize.find_by(email: email)
+  end
+end

data/lib/balaclava/errors/invalid_code_error.rb

@@ -0,0 +1,5 @@
+class InvalidCodeError < StandardError
+  def initialize(message = "Invalid verification code")
+    super
+  end
+end

data/lib/balaclava/version.rb

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

data/lib/balaclava.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require_relative "balaclava/version"
+require_relative "balaclava/authenticator"
+
+module Balaclava
+  class << self
+    attr_accessor :user_model
+  end
+
+  def self.configure
+    yield self
+  end
+end

data/lib/generators/install_generator.rb

@@ -0,0 +1,19 @@
+# lib/generators/install_generator.rb
+require 'rails/generators'
+
+module Balaclava
+  class InstallGenerator < Rails::Generators::Base
+    def ask_for_user_model_name
+      @user_model_name = ask("What is the name of your user model?(sometimes it could be, client, user... I mean, what final user you need to validate???) [User will be set if you left it blank]")
+      @user_model_name = "User" if @user_model_name.blank?
+    end
+
+    def create_initializer_file
+      create_file "config/initializers/balaclava.rb", <<~EOF
+        Balaclava.configure do |config|
+          config.user_model = "#{@user_model_name}"
+        end
+      EOF
+    end
+  end
+end

data/sig/balaclava.rbs

@@ -0,0 +1,4 @@
+module Balaclava
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification
+name: balaclava
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sante
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2024-03-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mail
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Validate users througt 6 digits codes sent by email.
+email:
+- imsantiago@proton.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- README.md
+- Rakefile
+- balaclava.gemspec
+- balaclava_logo.png
+- lib/balaclava.rb
+- lib/balaclava/authenticator.rb
+- lib/balaclava/errors/invalid_code_error.rb
+- lib/balaclava/version.rb
+- lib/generators/install_generator.rb
+- sig/balaclava.rbs
+homepage: https://github.com/santedime/balaclava
+licenses: []
+metadata:
+  homepage_uri: https://github.com/santedime/balaclava
+  source_code_uri: https://github.com/santedime/balaclava
+  changelog_uri: https://github.com/santedime/balaclava/blob/main/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.5
+signing_key: 
+specification_version: 4
+summary: A minimalistic way to validate your users.
+test_files: []