phoenix_password 0.1.1 → 0.1.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: 38394d2c8e3ea4b79601f843c71a0e955e86a54e
4
- data.tar.gz: b34dd40504267f84d970fda0f70ed6559cdc7604
3
+ metadata.gz: eb66a294e0cb0f8b791281732ae3ab34c9508c53
4
+ data.tar.gz: fe4fc95d8eb76f33921ff84407d410fe88b9ac32
5
5
  SHA512:
6
- metadata.gz: 5ffc168512e8e567c627a77bf05488f811b96e46e71820c52110a447e450ea98c1bd78989db07858b39ebb47e74adfc2fd090655077e39d7cef7170135424030
7
- data.tar.gz: 5935ff4314ced67a5410e6cc0392466b8fc9cdc4d9540f3c9f187121a778cbdf2cbb74f515bf7abec674bb161d26b0280764769a5d6f7806e483000d3fab4963
6
+ metadata.gz: dd99cf1ef1f7af136849c71a4525fa0cc131dd2abcebe96df0054ae05e2f91dd39c760308d7959ce0dcf7693a096c186310f97c7c780f0a4eb1516273f06462b
7
+ data.tar.gz: e0e8fc92ce1f08e08111649ac2007d405b4ef1025571ee6b981fd8e6d59ab218b17516a69095b4d3218009a601d03afea562405bb58af486c544a896f58e2b1b
data/README.md CHANGED
@@ -1,8 +1,13 @@
1
1
  # PhoenixPassword
2
2
 
3
- 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/phoenix_password`. To experiment with that code, run `bin/console` for an interactive prompt.
3
+ The PhoenixPassword generator gem is intended to be used
4
+ in password recovery operations or random password generation
5
+ purposes.
4
6
 
5
- TODO: Delete this and the text above, and describe your gem
7
+ It comes with a variety of tools to help you in accomplishing your
8
+ task but do note that it has not been thoroughly tested.
9
+
10
+ *Caution is advised when using it.*
6
11
 
7
12
  ## Installation
8
13
 
@@ -21,8 +26,83 @@ Or install it yourself as:
21
26
  $ gem install phoenix_password
22
27
 
23
28
  ## Usage
29
+ In order to generate combinations simply add the minimum or the required options
30
+ here is an irb example:
31
+
32
+ ```ruby
33
+ irb(main):001:0> require 'phoenix_password'
34
+ => true
35
+ irb(main):002:0> PhoenixPassword.combinations({:piped=>true,:characters=>[0,1,2,3,4,5,6,7,8,9],:cmb_length=>[6],:type=>'matching'})
36
+ ```
37
+ 001273
38
+
39
+ 001274
40
+
41
+ 001275
42
+
43
+ .....
44
+
45
+ ## Manual
46
+ This is a list of the options available to you and what they do
47
+
48
+ ```ruby
49
+ :piped=>(true or false)
50
+ ```
51
+ Lets you decide whether you want to pipe the results to an other program
52
+ or write them to a file.
53
+
54
+ ```ruby
55
+ :cmb_length=>([5] or [5,6])
56
+ ```
57
+ Set the length of the possible combinations to be generated if
58
+ there is more than one value first all the combinations with the
59
+ starting value are generated and then once done combinations of
60
+ the following length are generated till all the values have been used.
61
+
62
+ ```ruby
63
+ :characters=>["e","x","m","p","l","e",1]
64
+ ```
65
+ Sets the characters that will be used in the combination generation process.
66
+
67
+ ```ruby
68
+ :extra_chars=>["x",1] (Optional)
69
+ ```
70
+ Set extra characters to be used one at a time if the initial characters,minimum value 1 char.
71
+ Note that when etxra_chars are used only combinations that include them will be written to file.
72
+
73
+ ```ruby
74
+ :type=>("matching" or "unique")
75
+ ```
76
+ Sets which type of combinations to be generated.
77
+ Matching: Characters repeating them selves any number of times xx or xxx
78
+ Unique:Characters are different in every position xz or xzx
79
+
80
+ ```ruby
81
+ :match_limit=> 2 (:optional)
82
+ ```
83
+ Set the max matching characters for each combination example:
84
+
85
+ 2 = xxabc, axxbc,abxxc,abcxx
86
+
87
+ 3 = xxxab, axxxb,abxxx
88
+
89
+ Note that you can set the limit to more than 3 but file size info will
90
+ not be accurate.
91
+
92
+ ```ruby
93
+ :skip_first=>(true |false) (Optional)
94
+ ```
95
+ Used with extra_chars allows you to skip the first iteration with the
96
+ main characters thus starting from the extra characters.Useful if you
97
+ want to continue from where you left off.
98
+
99
+ ```ruby
100
+ :uniqueness_type=>("repeat"|"singe") (Optional)
101
+ ```
102
+ If not set all possible unique combinations are generated i.e reappearing char xzx,single char xyz
103
+ When set to repeat only reappearing character combinations are generated xzx
104
+ When set to single only single character appearance combinations are generated xzy.
24
105
 
25
- TODO: Write usage instructions here
26
106
 
27
107
  ## Development
28
108
 
@@ -1,3 +1,3 @@
1
1
  class PhoenixPassword
2
- VERSION = "0.1.1"
2
+ VERSION = "0.1.2"
3
3
  end
Binary file
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: phoenix_password
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.1.1
4
+ version: 0.1.2
5
5
  platform: ruby
6
6
  authors:
7
7
  - Spiros Avlonitis
@@ -73,7 +73,7 @@ files:
73
73
  - bin/setup
74
74
  - lib/phoenix_password.rb
75
75
  - lib/phoenix_password/version.rb
76
- - phoenix_password-0.1.0.gem
76
+ - phoenix_password-0.1.1.gem
77
77
  - phoenix_password.gemspec
78
78
  homepage: https://github.com/spirosavlonitis/phoenix_password
79
79
  licenses:
Binary file