xkpassword 0.2.3 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f84da1ad0dfef6ea960bb3e03d167ede3b3a45b1
-  data.tar.gz: 838f02e3b6a4bb534c91bfe5fddee5168bf05d2a
+  metadata.gz: 061152ac2dd641996c2df1ca377370413353b013
+  data.tar.gz: c9fc70afd3939902c0e8fe2126e732ca883ac621
 SHA512:
-  metadata.gz: 2fd8e2109dedce564cc2f5d254b4f9ac55da1b2aa2a385f6a2bfd1e2e349b5e75c191aab48e1f7bfb4da121c304087770d001eb68caf5f5832d30208f385ad25
-  data.tar.gz: 8976003191ea7e0caa2170bb334e535c91568c275b3d3cfa338d7be1353c52c0229194a2ebefb1bb8dc358c16be640f504ad9dcf40a2a0b897a73dec67ca0fc5
+  metadata.gz: f78e99e873150aa39dfc2d7670ca31027c2fc088cf9155960b16b9671c8ea1341c9a79d1b8f821db0d1d53b5d30db3f161cff4aadc8bda7264a5b23cffa73dc3
+  data.tar.gz: d96badedc11caa4552814f2afe9523533e799e60512ebef9bc0cef495ed20566e2427c3d91714dc917f2d14111f2bb596ad4b85a0c1635a5a460fa92ddd7e8dd

data/.travis.yml

@@ -0,0 +1,12 @@
+language: ruby
+rvm:
+  - 1.9
+  - 2.0
+  - 2.1
+  - 2.2
+  - 2.3.1
+before_install: gem install bundler
+script: bundle exec rspec
+addons:
+  code_climate:
+    repo_token: 1a754006a15f983b39ddc25c65543fab4a956a4ff607a636e135415c5350e4e0

data/README.md

@@ -1,11 +1,37 @@
+[![Gem Version](https://badge.fury.io/rb/xkpassword.svg)](https://badge.fury.io/rb/xkpassword)
+[![Build Status](https://travis-ci.org/jdeen/xkpassword.svg?branch=master)](https://travis-ci.org/jdeen/xkpassword)
+[![Inline docs](http://inch-ci.org/github/jdeen/xkpassword.svg?branch=master)](http://inch-ci.org/github/jdeen/xkpassword)
+[![Code Climate](https://codeclimate.com/github/jdeen/xkpassword/badges/gpa.svg)](https://codeclimate.com/github/jdeen/xkpassword)
+
 # XKPassword
 
-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/xkpassword`. To experiment with that code, run `bin/console` for an interactive prompt.
+A password is a key for a lock. The more secure the lock, the more complicated the key would
+be. The idea of locking things up is to keep them safe from unwanted parties accessing it
+while you can still easily access it. But is it the case with most password generators? The
+generated psswords are hard to remember and most of the time you your self are locked out
+in times of need.
+
+Bjoern Rennhak, the CTO of ClothesNetwork (now Graylon), Skyped me an interesting cartoon,
+that mentioned about the security of passwords that contain just few words been stronger
+than those strong passwords generated. I didn't believe it, but the math sure does add up.
+
+Here is a lib that you can use to generate passwords in your Ruby applications or a
+command line utility which you can use to generate passwords standalone.
+
+While there are some more planned updates over the next few months, this is what I need for
+my new blog. Thus I will pause development for a while and go back to make my website/blog.
+If you do have any suggestions, I would be glad to hear. Make an issue and lets talk about
+it.
 
-TODO: Delete this and the text above, and describe your gem
+<p align="center">
+  <img src="https://imgs.xkcd.com/comics/password_strength.png"/>
+</p>
 
 ## Installation
 
+Developed in Linux/Ubuntu, this should work fine in a Linux machine. How ever I can't say
+the same is true with Mac or Windows systems.
+
 Add this line to your application's Gemfile:
 
 ```ruby
@@ -14,11 +40,15 @@ gem 'xkpassword'
 
 And then execute:
 
-    $ bundle
+```bash
+~# bundle
+```
 
 Or install it yourself as:
 
-    $ gem install xkpassword
+```bash
+~# gem install xkpassword
+```
 
 ## Usage
 
@@ -38,7 +68,7 @@ full list of options.
 ### Ruby Apps
 
 ```ruby
-require 'xkpassword/generator'
+require 'xkpassword'
 
 options = {
   max_length: 8,
@@ -69,15 +99,42 @@ generator.generate(options)
 # 10.times { generator.generate(options) }
 ```
 
+## The GEM
+
+I run a policy of tagging any improvement done for the code base. For example, I just
+bumped a minor (resulting 0.2.3 ~> 0.3.0) for adding Travis CI which doesn't change any
+functional aspect of the app.
+
+I am thinking of releasing gems only on functional updates (real code changes) that
+happen with new features and bug fixes. So for now, there will be no 0.3.0v available
+in Ruby GEMs and the latest would be 0.2.3.
+
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `bin/setup` to install dependencies. 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).
+
+## TODO
+
+Some of the things I am interested in doing in the near future.
 
-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).
+- More tests, didn't have the time to write it all
+- Local configuration file -> ex: `~/.xkpassword`
+- Check for a better dictionary
+- Ability to provide a dictionary (this should help languages other than English)
+- A black-list - words that will not show up in the generation
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/xkpassword. 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.
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/xkpassword.
+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

data/lib/xkpassword/store.rb

@@ -11,6 +11,6 @@ class XKPassword::Store
 
   def load_data
     path = "#{ File.dirname(__FILE__) }/data/#{ SOURCE }"
-    @data = IO.readlines(path).map{ |item| item.gsub(/\n/, '') }
+    @data = IO.readlines(path).map{ |item| item.delete("\n") }
   end
 end

data/lib/xkpassword/version.rb

@@ -1,3 +1,3 @@
 module XKPassword
-  VERSION = '0.2.3'
+  VERSION = '0.3.1'
 end

data/lib/xkpassword/words.rb

@@ -43,7 +43,7 @@ class XKPassword::Words
   #
   # @return [Array<Integer>]      A collection of lengths of words available
   def lengths
-    words.keys.map{ |key| gsub(/l/, '').to_i }
+    words.keys.map{ |key| key.delete("l").to_i }
   end
 
   # The lenght of the shortest word

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: xkpassword
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.3.1
 platform: ruby
 authors:
 - Ziyan Junaideen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-08-26 00:00:00.000000000 Z
+date: 2016-09-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: artii
@@ -83,6 +83,7 @@ files:
 - ".rspec"
 - ".ruby-gemset"
 - ".ruby-version"
+- ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt