have-i-been-pwned 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c1fae8e9609676b44b47bacba29a2ee73b9d326262592f016826d404d941d3a1
-  data.tar.gz: 14560b63260a53af339ad2499faa4cbff780500e574ec0dd2a37466aaf4b4191
+  metadata.gz: 6f95a981da0f20f1e2c806004d2a3da6f7e79b8ed57ac42d9e6ffe273d57d271
+  data.tar.gz: cf2d95d6bbe8fc36194231a73df3064f5204c024e6a21721f352be403103642f
 SHA512:
-  metadata.gz: 7b9d2e52e61e4751487bb89914ecb3fc313bd6bf5c093d79d8b83134a77927c1fd5064e0bfb475e783f2d587f6b3f78ca6b775d1e04f9aad7ff6f5477629179c
-  data.tar.gz: 80fe8f5e423e9164a63b60e7fcb0832f5a7dab0ad21b2db701c058534deb3941917de2adef288164a6e34c384a8c4fe52fd1c4a7257a0350750601ad776d8c46
+  metadata.gz: 921d961fb4f5b67ad7a5722ab79b6e2d119dbeba59840ca42a4727d782a411b4d360c6987ebcb25f4644d4a94531e2dcedfd7541dfeb81a886e896f717153c82
+  data.tar.gz: a9871a8501af72618ee35f540f8a2f88e66bc60baa8049e24e587ed1da061b1bcb35f5b19f48e0d54a14a0952b4840b00bd3354bd1373b5bd995bdc461a9dd6c

data/.gitignore

@@ -0,0 +1,5 @@
+Gemfile.lock
+pkg/
+coverage/
+bin/*
+*.gem

data/.simplecov

@@ -0,0 +1 @@
+SimpleCov.start "test_frameworks"

data/.travis.yml

@@ -0,0 +1,17 @@
+language: ruby
+rvm:
+- 2.3.1
+script:
+- bundle exec rake
+deploy:
+  provider: rubygems
+  api_key:
+    secure: s7JXwHn+i4yWBshlBfkAa6H0ePUsXOZa40r0yiFvziGqh5RGtqT4MlGcYp/en8vSlBq1cHqxk1rkqBhN6uUlaKRTfLTRmOqBX/bLVzTwO8uRO6MgU3JkGxkL1YAFmQs6w/q5ZnYVhI35LN0dEi0vk2eDJayFvo1zw4nBJYWqAKqAw0uzoiCarEjqfknh8ZmMDr0KstJ1pDBVTsrUiQ/K0mfBCRK2Ho5qxk4uDed0UKSvmghhIg644K5SEHSA9tj1gelQTKxROCQB4kOXKl2y9+klUfDXAd27pzCYzt3Jt8ggZxDCZmFIun0YZzFoiEkDeHW0l9sxhntKncxQxyR0m2s6H8jE3fJBFJhg3/NAa9NBmED0evCrn2u1gqWM6rsDqlvLV3mA2Kh1irZsrGx78c1A54QAgPVZbN5CCKDymZibtkrGANyLPHOF/1oLl08Y3Y80UW+859yiR0qeixe6cJ6GsEg0e0Nhe6qeUcMGAstItzY6SzHCQCjL+bknnYILvupnvZQHyFUmY5lWYJDCD8k4+hg00LyAILrk6uIAx/TdH270s6Ep0liXtE6uCoGtcqjrCl9ENOsK9W5xSSe6c8CjBUhhnwO5fYdMtNYR7G44QwGb5FvisD+6jR8xxjUYdQsVOfjTq01jFz+Lgr/XZIn3mLbd8HSzq6jLiUt2zmY=
+  gem: have-i-been-pwned
+  on:
+    tags: true
+    repo: Dales-Lab/haveibeenpwned-ruby-sdk
+notification:
+  slack:
+    rooms:
+      secure: YtIdbbN6Fflga3zJI9mN6OLmz6+8fxcJuvHlQO77NIea2CvBUP9jvJ5b2nc2aBxw8MJjJtVwvc0p5DlnA2w3tMSrk5KTJuoGNQa83LgzZEBNZOrvwSTwXoHRVWP+KoSnMwdhzknzZqC7dbskku/1MAfVnEvgpJxdrjeGF4z6/lDMb2GPHhRyYOaIiTLM8Ig/j8TeGAB5Javt4MbrQOgmhl76lNzNb6BhHUgVice4HNAEJKnYB+aKElGdVC1L+gy1Qqf7bGBpciz0omODo0UXxADV+KA2NzApFctEiElarvb2MN+K9PAu70ouz5q9GQ97KbGuVQzzpNJ2R5WHxrYTj4tRsAkhjHeUnv1Otues6Uhnc6jYLGZZHtQs5qyC3sFJz2bVMqJd0VIUl9BLnBPhRaZ2pOHYHJoLpVgNUX2WurEDew46MwnvojBnxOQ1A4/PLttH/n8ApYSQVM2Ynrgr7ZRdPCm14YfCrG6jDZylL6RqX5NsJFUKLP5wl5q8siESDVgecyMBFcTSitKI+BF7asIAth4Mw/Q3IUEPT8LwcQqVvvzssYbMUsJayhOC5aNXBQbadJeFRDZBdMeL1buNuZnITtBQTOdkkTxnf2DbK3eb5rBz9MDaUICm01QArADbANDrIl8qugnKta7o7xgn3yxa8FghmoklC9z+QCyYHSM=

data/Gemfile

@@ -1,3 +1,2 @@
 source 'https://rubygems.org'
-gem 'codecov', :require => false, :group => :test
 gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Dales-Lab
+
+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,44 @@
+# haveibeenpwned-ruby-sdk
+Ruby wrapper for V2 haveibeenpwned.com API.
+
+[![Build Status](https://travis-ci.org/Dales-Lab/haveibeenpwned-ruby-sdk.svg?branch=master)](https://travis-ci.org/Dales-Lab/haveibeenpwned-ruby-sdk) [![codecov](https://codecov.io/gh/Dales-Lab/haveibeenpwned-ruby-sdk/branch/master/graph/badge.svg)](https://codecov.io/gh/Dales-Lab/haveibeenpwned-ruby-sdk) [![Gem](https://img.shields.io/gem/v/have-i-been-pwned.svg?style=flat)](http://rubygems.org/gems/have-i-been-pwned "View this project on Rubygems")
+
+## Installation
+```
+gem install have-i-been-pwned
+```
+
+## Use
+#### General Use
+```
+require 'have-i-been-pwned'
+...
+# returns true if the password is found, false otherwise
+result = HaveIBeenPwned::pwned 'abc123'
+```
+
+#### Rails
+```
+# Gemfile
+gem 'have-i-been-pwned'
+```
+
+```
+# some controller
+# check the password
+if !HaveIBeenPwned::pwned params[:password]
+   puts "Yay! You can use this password!"
+else
+   puts "No! Bad!!"
+end
+```
+
+## Contributing
+- Open an issue about your change
+- Fork it, DL it
+- Run `bundle`
+- Run `rake test`
+- Make your additions, changes, fixes, etc. (Do not make changes to version, Rakefile or spec
+- Add tests for the above (no pr acceptance without them)
+- Run `rake test`
+- Make your PR. :smile:

data/codecov.yml

@@ -0,0 +1,2 @@
+ignore:
+  - "**/version.rb"

data/have-i-been-pwned.gemspec

@@ -0,0 +1,31 @@
+# -*- encoding: utf-8 -*-
+$LOAD_PATH.push File.expand_path("../lib", __FILE__)
+require "version"
+
+Gem::Specification.new do |s|
+  s.name = 'have-i-been-pwned'
+  s.version = HaveIBeenPwned::VERSION # see: lib/version.rb
+  s.platform = Gem::Platform::RUBY
+  s.licenses = ['MIT']
+  s.date = '2019-06-27'
+  s.summary = 'Check to see if your passwords are safe'
+  s.description = 'A simple gem to check and see if a given password was compromised by a hack. Special thanks to Troy Hunt for facilitating haveibeenpwned.'
+  s.authors = ["Dale Myszewski"]
+  s.email = 'dale@daleslab.com'
+  s.homepage = "https://github.com/Dales-Lab/haveibeenpwned-ruby-sdk"
+
+  s.add_runtime_dependency "httparty"
+
+  s.add_development_dependency "simplecov"
+  s.add_development_dependency "codecov", ">= 0.1.10"
+  s.add_development_dependency "rake"
+  s.add_development_dependency "mocha"
+  s.add_development_dependency "test-unit"
+
+  all_files = `git ls-files`.split("\n")
+  test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
+
+  s.files         = all_files - test_files
+  s.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/lib/have_i_been_pwned.rb

@@ -9,28 +9,25 @@ module HaveIBeenPwned
         # get a digest of the password
         digest = Digest::SHA1.hexdigest password
         # get the first 5 characters of the hash
-        firstFive = digest[0..4]
+        first_five = digest[0..4]
         # make the API call
-        results = HTTParty.get("https://api.pwnedpasswords.com/range/#{firstFive}")
-        # if we get something back
-        if results.code == 200
-          # split the string based on line breaks into an array
-          resArray = results.split("\n")
-          # interate through the list of hashes
-          resArray.each do |partial_hash|
-            # hashes are formatted hash:count
-            # ex. 0018A45C4D1DEF81644B54AB7F969B88D65:1
-            # return true if we find a match
-            return true if "#{firstFive}#{partial_hash.split(":")[0]}".upcase == digest.upcase
-          end
+        results = HTTParty.get("https://api.pwnedpasswords.com/range/#{first_five}")
+        
+        # guard: if we dont get something back
+        return unless results.code == 200
 
-          # return false if we dont find anything
-          return false
-        else
-          raise 'Troy Hunt has failed us. The API returned something not 200.'
+        # split the string based on line breaks into an array
+        res_array = results.split("\n")
+        # interate through the list of hashes
+        res_array.each do |partial_hash|
+          # hashes are formatted hash:count
+          # ex. 0018A45C4D1DEF81644B54AB7F969B88D65:1
+          # return true if we find a match
+          return true if "#{first_five}#{partial_hash.split(":")[0]}".upcase == digest.upcase
         end
-      else
-        raise 'You must provide a password to check!'
+
+        # return false if we dont find anything
+        return false
       end
     end
   end

data/lib/version.rb

@@ -1,3 +1,3 @@
 module HaveIBeenPwned
-  VERSION = "0.1.2"
+  VERSION = '0.1.3'.freeze
 end

data/test/helper.rb

@@ -0,0 +1,14 @@
+require 'simplecov'
+# SimpleCov.start
+SimpleCov.start 'rails' do
+    add_filter "/test/"
+end
+
+require 'codecov'
+SimpleCov.formatter = SimpleCov::Formatter::Codecov
+
+require 'test/unit'
+require 'mocha/setup'
+
+require 'have_i_been_pwned'
+require 'version'

data/test/test_have_i_been_pwned.rb

@@ -1,7 +1,6 @@
-require 'minitest/autorun'
-require 'have_i_been_pwned'
+require 'helper'
 
-class HolaTest < Minitest::Test
+class PwnedTest < Test::Unit::TestCase #Minitest::Test
   def test_abc123_is_found
     assert_equal true, HaveIBeenPwned::pwned('abc123')
   end
@@ -17,4 +16,10 @@ class HolaTest < Minitest::Test
   def test_not_actually_providing_a_password_is_silly
     assert_equal false, HaveIBeenPwned::pwned('')
   end
+
+  def test_no_password_at_all_raises
+    assert_raise("RuntimeError") {
+      HaveIBeenPwned::pwned
+    }
+  end
 end

data/test/test_version.rb

@@ -0,0 +1,11 @@
+require 'helper'
+
+class VersionTest < Test::Unit::TestCase
+    def test_version_valid
+      assert_match(/^\d+.\d+.\d$/, HaveIBeenPwned::VERSION)
+    end
+
+    def test_version_exists
+      assert_not_nil(HaveIBeenPwned::VERSION)
+    end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: have-i-been-pwned
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Dale Myszewski
@@ -24,6 +24,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: codecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.10
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.10
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -39,7 +67,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: test-unit
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -59,11 +101,20 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitignore"
+- ".simplecov"
+- ".travis.yml"
 - Gemfile
+- LICENSE
+- README.md
 - Rakefile
+- codecov.yml
+- have-i-been-pwned.gemspec
 - lib/have_i_been_pwned.rb
 - lib/version.rb
+- test/helper.rb
 - test/test_have_i_been_pwned.rb
+- test/test_version.rb
 homepage: https://github.com/Dales-Lab/haveibeenpwned-ruby-sdk
 licenses:
 - MIT
@@ -72,7 +123,6 @@ post_install_message:
 rdoc_options: []
 require_paths:
 - lib
-- test
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="