cryptophysh 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 957a63052b088f7b15a1620ae066317d8bb3c9dbca75c6a0b2012859372eb640
+  data.tar.gz: 430c1aff9f6feaf25ae884150c54eece6cc75ac2e720ad55f6bb35652f1b73dd
+SHA512:
+  metadata.gz: b49cb9ee4064ae7819d6e7f0645ae87be210717e742f4e02c79426da2e34ca155035212765a4038ec7e46f71b2421e43b9f29497a5feaa014c70265e366b5e20
+  data.tar.gz: 2ec170aa3d7ad70d554c52da14ed3527a373fd539692af4325b31ad7fac68c37ed0e082e309cbf87025f0b1fbfaf98c53a327d2631b19b25d99d9a379b8a4a2f

data/.rspec

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

data/.standard.yml

@@ -0,0 +1,3 @@
+# For available configuration options, see:
+#   https://github.com/standardrb/standard
+ruby_version: 3.0

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-07-10
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# 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, caste, color, 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 email 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
+[INSERT CONTACT METHOD].
+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.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/Guardfile

@@ -0,0 +1,42 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+# directories %w(app lib config test spec features) \
+#  .select{|d| Dir.exist?(d) ? d : UI.warning("Directory #{d} does not exist")}
+
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), then you will want to move
+## the Guardfile to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+
+# Note: The cmd option is now required due to the increasing number of ways
+#       rspec may be run, below are examples of the most common uses.
+#  * bundler: 'bundle exec rspec'
+#  * bundler binstubs: 'bin/rspec'
+#  * spring: 'bin/rspec' (This will use spring if running and you have
+#                          installed the spring binstubs per the docs)
+#  * zeus: 'zeus rspec' (requires the server to be started separately)
+#  * 'just' rspec: 'rspec'
+
+guard :rspec, cmd: "bundle exec rspec" do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # Feel free to open issues for suggestions and improvements
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Kryptyk Physh
+
+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

@@ -0,0 +1,47 @@
+# Cryptophysh
+
+My attempt to produce a solution to the requirements listed [here](https://github.com/krystal/code-tasks/blob/main/password-generator.md). Essentially, a library/gem you can include in to your own code to add a `::generate_password` class method on a class.
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/cryptophysh`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add cryptophysh
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install cryptophysh
+
+## Usage
+
+### Extending your own class
+
+`require cryptophysh` and
+
+Add to your class: `extend Cryptophysh`
+
+Your class will now have access to the `::generate_password` class method.
+
+### Using the Cryptophysh::PasswordGenerator Class
+
+See the YARD documentation on the class itself for details.
+
+## 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/[USERNAME]/cryptophysh. 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/[USERNAME]/cryptophysh/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Cryptophysh project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/kryptykphysh/cryptophysh/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

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

data/lib/cryptophysh/password_generator.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+require "securerandom"
+
+module Cryptophysh
+  class PasswordGenerator
+    DEFAULT_LENGTH = 12
+    DEFAULT_UPPERCASE = true
+    DEFAULT_LOWERCASE = true
+    DEFAULT_NUMBER_COUNT = 3
+    DEFAULT_SPECIAL_COUNT = 3
+    SPECIAL_CHARACTERS = %w[@ % ! ? * ^ &].freeze
+
+    # @param length [Integer] the total length of any password generated with the #generate_password method
+    # @param uppercase [true, false] include one or more uppercase `A-Z` characters
+    # @param lowercase [true, false] include one or more lowercase `a-z` characters
+    # @param number [Integer] exact number of numeric `0-9- characters
+    # @param special [Integer] exact number of special `@%!?*^&` characters
+    # @return [Cryptophysh::PasswordGenerator]
+    def initialize(
+      length: DEFAULT_LENGTH,
+      uppercase: DEFAULT_UPPERCASE,
+      lowercase: DEFAULT_LOWERCASE,
+      number: DEFAULT_NUMBER_COUNT,
+      special: DEFAULT_SPECIAL_COUNT
+    )
+      @length = length
+      @uppercase = uppercase
+      @lowercase = lowercase
+      @number = number
+      @special = special
+
+      validate_attributes
+    end
+
+    # @return [String] the generated password of @length characters
+    def generate_password
+      password = ""
+      @special.times { password += SPECIAL_CHARACTERS.sample }
+      password += number_string if @number > 0
+      password += character_string(@length - password.size)
+      password.chars.shuffle.join
+    end
+
+    private
+
+    def actual_minimum_length
+      @number + @special + [@uppercase, @lowercase].count(true)
+    end
+
+    def can_meet_length_requirement?
+      actual_minimum_length < @length && [@uppercase, @lowercase].any?(true)
+    end
+
+    def character_string(size)
+      chars = ("a".."z").to_a
+      result = ""
+      size.times { result += chars.sample }
+      return result unless @uppercase
+      return result.swapcase unless @lowercase
+
+      number_to_upcase = SecureRandom.random_number(1...size)
+      result[...-number_to_upcase] + result[-number_to_upcase..].swapcase
+    end
+
+    def number_string
+      SecureRandom.random_number(0..10**@number).to_s.rjust(@number, "0")
+    end
+
+    def validate_attributes
+      raise ArgumentError, ":length, :number and :special keyword arguments must be non-negative Integers" if [@length, @number, @special].any? { |val| !val.is_a?(Integer) || val.negative? }
+      raise ArgumentError, ":uppercase and :lowercase keyword arguments must be Boolean values" unless [@uppercase, @lowercase].all? { |val| [true, false].include? val }
+      raise ArgumentError, ":length keyword argument is not long enough to meet other requirements" if actual_minimum_length > @length
+      raise ArgumentError, "cannot meet :length requirement, set at least one of :uppercase or :lowercase to true" unless can_meet_length_requirement?
+    end
+  end
+end

data/lib/cryptophysh/version.rb

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

data/lib/cryptophysh.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require_relative "cryptophysh/version"
+require_relative "cryptophysh/password_generator"
+
+module Cryptophysh
+  class Error < StandardError; end
+
+  def generate_password(**kwargs)
+    PasswordGenerator.new(**kwargs).generate_password
+  end
+end

data/sig/cryptophysh.rbs

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

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: cryptophysh
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Kryptyk Physh
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2024-07-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.7
+description: |
+  # Cryptophysh
+
+  My attempt to produce a solution to the requirements listed [here](https://github.com/krystal/code-tasks/blob/main/password-generator.md). Essentially, a library/gem you can include in to your own code to add a `::generate_password` class method on a class.
+
+  Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/cryptophysh`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+  ## Installation
+
+  Install the gem and add to the application's Gemfile by executing:
+
+      $ bundle add cryptophysh
+
+  If bundler is not being used to manage dependencies, install the gem by executing:
+
+      $ gem install cryptophysh
+
+  ## Usage
+
+  ### Extending your own class
+
+  `require cryptophysh` and
+
+  Add to your class: `extend Cryptophysh`
+
+  Your class will now have access to the `::generate_password` class method.
+
+  ### Using the Cryptophysh::PasswordGenerator Class
+
+  See the YARD documentation on the class itself for details.
+
+  ## 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/[USERNAME]/cryptophysh. 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/[USERNAME]/cryptophysh/blob/master/CODE_OF_CONDUCT.md).
+
+  ## License
+
+  The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+  ## Code of Conduct
+
+  Everyone interacting in the Cryptophysh project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/kryptykphysh/cryptophysh/blob/master/CODE_OF_CONDUCT.md).
+email:
+- kryptykphysh@kryptykphysh.xyz
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".standard.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/cryptophysh.rb
+- lib/cryptophysh/password_generator.rb
+- lib/cryptophysh/version.rb
+- sig/cryptophysh.rbs
+homepage: https://github.com/kryptykphysh/cryptophysh
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/kryptykphysh/cryptophysh
+  source_code_uri: https://github.com/kryptykphysh/cryptophysh.git
+  changelog_uri: https://github.com/kryptykphysh/cryptophysh/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.15
+signing_key: 
+specification_version: 4
+summary: A simple gem to add a ::generate_password class method to your classes
+test_files: []