phoenix_password 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2d4eac9a6ff94dc2cc0f4b165c051afdcfb63e75
-  data.tar.gz: 53c8b1891a2847b09068067a7e6092a9545062bb
+  metadata.gz: 83d0eb354fbfdc1b3de02c1c3660273adda26023
+  data.tar.gz: 104b23c7112f0ffe1cf9aec3a065b42d61e8352b
 SHA512:
-  metadata.gz: db1bfaec1ef9a45cf271b078d977e5d8dbc2b9c0bded7fe24cb07742a1dc83b6e385905c8e304ebf745072f4168a6298cf07bf932e9c1b4c436c7beb489010b2
-  data.tar.gz: 3b04f52dacf88299c4ae586ea8fc50d9a7f3d74fa1284c67545a7569aa81a57c37cbbc5e4e47d84887d0acf0f9a230c4f82f96e6883cac826750919cbcb968c3
+  metadata.gz: 00cf5b95bd04ad171621aa365d2fdc98ef6f80bca662e06c04afee7a92fe7cd654580fc03de610b5b06144704192b39db7a93f76b68ae3e214b611aad77f65bb
+  data.tar.gz: 97fdc6eee52695e8fc5ec067bfe401528db35fbba708dbc8de73260e03e23b228a2ce10ccee7d3d71a11e643cb2bae00288f73b9b6a6d93f6574a91c8dff9b94

data/.gitignore

@@ -0,0 +1,17 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/*.gem
+
+/.travis.yml
+/bin
+/*.gemspec
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers 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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at spirosa84@hotmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in phoenix_password.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Spiros Avlonitis
+
+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,186 @@
+# PhoenixPassword
+
+The PhoenixPassword generator gem is intended to be used 
+in password recovery operations or random password generation
+purposes.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'phoenix_password'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install phoenix_password
+
+## Usage
+In order to generate combinations simply add the minimum of the required options here is an irb example:
+
+```ruby
+irb(main):001:0> require 'phoenix_password'
+=> true
+irb(main):002:0>  PhoenixPassword.new.combinations({:piped=>true,:type=>'matching',:cmb_length=>[6],:characters=>[0,1,2,3,4,5,6,7,8,9]})
+```
+001273
+
+001274
+
+001275
+
+.....
+
+## Manual
+This is a list of the options available to you and what they do
+
+```ruby
+obj_a=PhoenixPassword.new() 
+obj_b=PhoenixPassword.new({:rules=>true})
+obj_c=PhoenixPassword.new({:rules=>true,:stricness=>2})
+obj_d=PhoenixPassword.new({:rules=>true,:stricness=>2,:own_rules=>[/regexp_a/,regexp_b]})
+```
+
+You can initialize a PhoenixPassword object in 4 different ways.
+
+**a)No arguments:**
+This means that there will be no extra combination restriction rules other than the ones defined in the combinations method.
+
+```ruby
+obj_a=PhoenixPassword.new()
+```
+
+**b)rules**
+By setting rules to true there is an extra combination filter added, namely any combinations that have alternating letter digit value get discarded: 0a0a0a or a0a0a0 etc.
+
+```ruby
+obj_b=PhoenixPassword.new({:rules=>true})
+```
+**c)strictness**
+
+```ruby
+obj_b=PhoenixPassword.new({:rules=>true,:stricness=>2})
+```
+When using rules you can also change the strictness level of combination filtering.By default it is set to 0 meaning no other combinations will be filtered other than what rules filters on its own.
+
+When using a level say 2 you are implementing the filters provided by 0,1 and 2.If you use 3 the you use 0,1,2 and 3
+filters.
+
+There are 4 levels in total:
+X=digit,A=letter
+
+Level 0:
+default filtering 	XAXAXA or AXAXAX
+
+Level 1:
+Filters combinations that are half digits or half letters
+XXXAAA or AAAXXX.
+
+Level 2:
+Filters combinations that have only digits XXXXXX
+
+Level 3:
+Filters combinations that have only letters AAAAAA
+
+
+**d)own_rules**
+
+```ruby
+obj_d=PhoenixPassword.new({:rules=>true,:stricness=>2,:own_rules=>[/regexp_a/,regexp_b]})
+```
+
+If you want to use your own combination filtering rules you must use the own_rules key and add an array with Regexp objects.
+
+The rules that you will add will be implemented after all the rules that are used by the strictness level have been checked.Make sure when using your rules that you don't filter twice things that have been already checked.
+
+==================================================================================================
+```ruby	
+:piped=>(true or false)
+```
+Lets you decide whether you want to pipe the results to an other program
+or write them to a file.
+
+```ruby
+:cmb_length=>([5] or [5,6])
+```
+Set the length of the possible combinations to be generated if
+there is more than one value first all the combinations with the
+starting value are generated and then once done combinations of
+the following length are generated till all the values have been used.
+
+```ruby
+:characters=>["e","x","m","p","l","e",1]
+```
+Sets the characters that will be used in the combination generation process.
+
+```ruby
+:extra_chars=>["x",1] (Optional)
+```
+Set extra characters to be used one at a time if the initial characters,minimum value 1 char.
+Note that when etxra_chars are used only combinations that include them will be written to file.
+	
+```ruby
+:type=>("matching" or "unique")
+```
+Sets which type of combinations to be generated.
+Matching: Characters repeating them selves any number of times xx or xxx
+Unique:Characters are different in every position xz or xzx
+
+```ruby
+:match_limit=> 2 (:optional)
+```
+Set the max matching characters for each combination example:
+
+2 = xxabc, axxbc,abxxc,abcxx
+
+3 = xxxab, axxxb,abxxx
+
+Note that you can set the limit to more than 3 but file size info will
+not be accurate.
+
+```ruby
+:skip_first=>(true |false) (Optional)
+```
+Used with extra_chars allows you to skip the first iteration with the
+main characters thus starting from the extra characters.Useful if you
+want to continue from where you left off.
+
+```ruby
+:uniqueness_type=>("repeat"|"singe") (Optional)
+```
+If not set all possible unique combinations are generated i.e reappearing char xzx,single char xyz
+When set to repeat only reappearing character combinations are generated xzx
+When set to single only single character appearance combinations are generated xzy.
+
+
+```ruby
+:cap_limit=>1 or more (optional)
+
+```
+When used it ensures that each combination generated will contain only the amount of capital letters specified.
+
+**Note that file size and combination estimates  when using match_limit may not be accurate**
+
+
+
+
+## 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 tags, 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]/phoenix_password. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/phoenix_password/version.rb

@@ -0,0 +1,3 @@
+class PhoenixPassword
+  VERSION = "1.0.1"
+end