hibp-client 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b0cfa93448ab5ba699ccf06ac4ca9804fcaa5effd45eb2f76c8a44002efd37f8
-  data.tar.gz: 4e62ca0302d615f411069604503823bc45224090ae6dd8c9ddce49b9a4181e22
+  metadata.gz: 84ccd66e330884154b8984ffe576d04a352c949927ca20620dde9a16c1951bc2
+  data.tar.gz: 727b750b4507f5db31f2640b1f7802f5486a2092ecd3829ae4a5de80aac8bc85
 SHA512:
-  metadata.gz: d3dd01fbe7202f178cd86927e17d5f54b1b6976b9afbaaa3432c0c1989c405fe58ff836ee1daab0a810bbf38bc18f85ec3da7ba19a90fd5d90fd73bb99a21ede
-  data.tar.gz: 52460687b7e9c93413bc2397827adcac2cbd23af7b7d99173e8a43cd34aeae26f0bee47c8d5603d31def57b1ad78e632f6ed4a9aee094cede44a30018f9512d0
+  metadata.gz: 4c061ecaaf20e07a69169517b848d4cdf515723d45508120c89de9f552fa0e23e658c0a52ab7ac39f8715ad1a74745ef002528102bf6f6ff5bd30eb2861f1350
+  data.tar.gz: 8d0562c84adf765357b5e532311ccd685a22de1842754cbc4b832213d09f0fb075bf5a14a6156d752cd5b9b6cb9250dcb035091937ed9743f06aa79c10d0f2e1

data/.travis.yml

@@ -1,13 +1,17 @@
----
 sudo: false
 language: ruby
-
 cache: bundler
-
 before_install: gem install bundler
-
 rvm:
-  - 2.6
-  - 2.5
-  - 2.4
-  - 2.3
+- 2.6
+- 2.5
+- 2.4
+- 2.3
+deploy:
+  provider: rubygems
+  api_key:
+    secure: YXtt8Rv0+4c78eoIE7na1jsavtk4ELbcdGvvwFKlqaVlFufnDobt917r17Fikn+/8mSz3nYHQ4psAXAUgU9RBjlphsh2Lks/jJq87DoG8BoaCi+vatIgd3dyQLh+PYWLlYQBT0f8R3TCbDw3AZL0hBfOd09ltS6wKn4aWFMor3Yhb8+1qxUTze3p2OntlRAaUD32tx8uTSYDxZc0oewQlIBxRTkxO9obHozqBLo7EZMJFUYle1GdTnuFvYFAkrN/tD6jsz++qd2Qf56jFkSqmDIcUkDZeSIZmdCDMysh4p5ZHKyhmaETgcD2r2r2W9cA7RfFaMYzUaekGpr9IBbalAH/26lifigLKf9JdsiLel8aV4y1+UIkrcMEWf7PcYCMI6hs6pu45DjgTyyUqqse8cwyQ3XjoYH4SX3a5mSQ4xfzTnMRkZ61e/vVATgkSgT0EGlXXLjf+YHRgZoYwV8j2xECJt2Wnu6v0bEOSbGBWhrmMyS8vWShamOx1hzbGSv8y8kYWLPDPf0t4gBZLWNW1960Ct6p2xGQoPsQ/F9sVuR25y/cTuHVFVziwW3cfdhQxgKnefCSHbVVCY8RXKx2xuW3LAF3vfpQrNr3SbufUhD/yO5x5TjpCko97SY9TogrA5U8C4kD4C67q1p+2fUsFeNykm6RB+SMz1OZK5irEs4=
+  gem: hibp-client
+  on:
+    tags: true
+    repo: Warshavski/hibp-client

data/Gemfile

@@ -5,7 +5,7 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in hibp.gemspec
 
 group :development, :test do
-  gem 'webmock', '~>1.24.0'
+  gem 'webmock', '~>2.3.2'
 end
 
 gemspec

data/README.md

@@ -1,6 +1,6 @@
-# Hibp
+# Hibp-client
 
-[![Build Status](https://travis-ci.com/Warshavski/hibp.svg?branch=master)](https://travis-ci.com/Warshavski/hibp)
+[![Build Status](https://travis-ci.com/Warshavski/hibp-client.svg?branch=master)](https://travis-ci.com/Warshavski/hibp-client)
 
 A simple Ruby client for interacting with [Have I Been Pwned](https://haveibeenpwned.com/) REST API.
 
@@ -11,7 +11,7 @@ This gem based on [API v3](https://haveibeenpwned.com/API/v3)
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'hibp'
+gem 'hibp-client'
 ```
 
 And then execute:
@@ -20,7 +20,7 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install hibp
+    $ gem install hibp-client
 
 ## Usage
 
@@ -50,6 +50,79 @@ client = Hibp::Client.new('api-key')
 
 ### Breaches
 
+#### Breach model
+
+```ruby
+Hibp::Models::Breach
+```
+
+A "breach" is an instance of a system having been compromised by an attacker and the data disclosed.   
+For example, Adobe was a breach, Gawker was a breach etc.
+
+A "breach" is an incident where data is inadvertently exposed in a vulnerable system, usually due to insufficient access controls or security weaknesses in the software.
+
+- `name [String]` - A name representing the breach which is unique across all other breaches. 
+                    This value never changes and may be used to name dependent assets (such as images) but should not be shown directly to end users(see the "title" attribute instead).
+
+- `title [String]` - A descriptive title for the breach suitable for displaying to end users.
+                     It's unique across all breaches but individual values may change in the future
+                     (i.e. if another breach occurs against an organisation already in the system).
+                     If a stable value is required to reference the breach, refer to the "Name" attribute instead.
+
+- `domain [String]` - The domain of the primary website the breach occurred on.
+                      This may be used for identifying other assets external systems may have for the site. 
+
+- `breach_data [Date]` - The date (with no time) the breach originally occurred on in ISO 8601 format.
+                         This is not always accurate — frequently breaches are discovered and reported long after the original incident.
+                         Use this attribute as a guide only. 
+
+- `added_date [DateTime]` - The date and time (precision to the minute) the breach was added to the system in ISO 8601 format. 
+
+- `modified_date [DateTime]` - The date and time (precision to the minute) the breach was modified in ISO 8601 format.
+                               This will only differ from the AddedDate attribute if other attributes
+                               represented here are changed or data in the breach itself is changed
+                               (i.e. additional data is identified and loaded).
+                               It is always either equal to or greater then the AddedDate attribute, never less than.   
+
+- `pwn_count [Integer]` - The total number of accounts loaded into the system.
+                This is usually less than the total number reported by the media due to
+                duplication or other data integrity issues in the source data.
+
+- `description [String]` - Contains an overview of the breach represented in HTML markup.
+                           The description may include markup such as emphasis and strong tags as well as hyperlinks. 
+
+- `data_classes [Array<String>]` - This attribute describes the nature of the data compromised in the breach and
+                                   contains an alphabetically ordered string array of impacted data classes.
+
+- `is_verified [Boolean]` - Indicates that the breach is considered unverified.
+                            An unverified breach may not have been hacked from the indicated website.
+                            An unverified breach is still loaded into HIBP when there's
+                            sufficient confidence that a significant portion of the data is legitimate.
+                            (<b>alias</b> `verified?`)
+
+- `is_fabricated [Boolean]` - Indicates that the breach is considered fabricated.
+                              A fabricated breach is unlikely to have been hacked from the
+                              indicated website and usually contains a large amount of manufactured data.
+                              However, it still contains legitimate email addresses and asserts that
+                              the account owners were compromised in the alleged breach.
+                              (<b>alias</b> `fabricated?`)
+
+- `is_sensitive [Boolean]` - Indicates if the breach is considered sensitive.
+                             The public API will not return any accounts for a breach flagged as sensitive.
+                             (<b>alias</b> `sensitive?`)
+
+- `is_retired [Boolean]` - Indicates if the breach has been retired.
+                           This data has been permanently removed and will not be returned by the API.
+                           (<b>alias</b> `retired?`)
+
+- `is_spam_list [Boolean]` - Indicates if the breach is considered a spam list.
+                             This flag has no impact on any other attributes but
+                             it means that the data has not come as a result of a security compromise.
+                             (<b>alias</b> `spam_list?`) 
+
+- `logo_path [String]` - A URI that specifies where a logo for the breached service can be found.
+                         Logos are always in PNG format.
+
 #### Getting all breached sites in the system
 
 ```ruby
@@ -57,13 +130,14 @@ client = Hibp::Client.new
  
 # Return the details of each breach in the system.
 #
-# => Array<Hibp::Breach> 
+# => Array<Hibp::Models::Breach> 
 # 
 client.breaches.fetch
 
 # Return the details of each breach associated with a specific domain.
 # 
-# => Array<Hibp::Breach> 
+# => Array<Hibp::Models::Breach> 
+#
 client.breaches.where(domain: 'adobe.com').fetch
 ```
 
@@ -74,7 +148,7 @@ client = Hibp::Client.new
 
 # Return the details of a single breach, by breach name.
 #
-# => Hibp::Breach
+# => Hibp::Models::Breach
 # 
 client.breach('000webhost').fetch
 ```
@@ -103,31 +177,71 @@ client = Hibp::Client.new('api-key')
 
 # Get all breaches for an account across all domains. 
 #
-# => Array<Hibp::Breach>
+# => Array<Hibp::Models::Breach>
 # 
 client.account_breaches('example@email.com').fetch
 
 # Get all breaches for an account across a specific domain. 
 #
-# => Array<Hibp::Breach> 
+# => Array<Hibp::Models::Breach> 
 # 
 client.account_breaches('example@email.com').where(domain: 'adobe.com').fetch
 
 # Get all breaches info for an account with detailed information. 
 #
-# => Array<Hibp::Breach> 
+# => Array<Hibp::Models::Breach> 
 # 
 client.account_breaches('example@email.com').where(truncate: false).fetch
 
 # Returns breaches that have been flagged as "unverified"
 #
-# => Array<Hibp::Breach> 
+# => Array<Hibp::Models::Breach> 
 #
 client.account_breaches('example@email.com').where(unverified: true).fetch
 ```
 
 ### Pastes
 
+#### Paste model
+
+A "paste" is information that has been "pasted" to a publicly facing
+website designed to share content such as Pastebin.
+
+These services are favoured by hackers due to the ease of anonymously
+sharing information and they're frequently the first place a breach appears.
+
+<b>NOTE</b> : In the future, these attributes may expand without the API being versioned.
+
+```ruby
+Hibp::Models::Paste
+```
+
+- `source [String]` - The paste service the record was retrieved from.
+                      Current values are:
+    - Pastebin
+    - Pastie
+    - Slexy
+    - Ghostbin
+    - QuickLeak
+    - JustPaste
+    - AdHocUrl
+    - PermanentOptOut
+    - OptOut
+   
+- `id [String]` - The ID of the paste as it was given at the source service.
+                  Combined with the "Source" attribute, this can be used to resolve the URL of the paste. 
+
+- `title [String]` - The title of the paste as observed on the source site.
+                    This may be null. 
+
+- `date [String]` -  The date and time (precision to the second) that the paste was posted.
+                     This is taken directly from the paste site when this information is
+                     available but may be null if no date is published.
+
+- `email_count [Integer]` - The number of emails that were found when processing the paste.
+                            Emails are extracted by using the regular expression:
+                            \b+(?!^.{256})[a-zA-Z0-9\.\-_\+]+@[a-zA-Z0-9\.\-_]+\.[a-zA-Z]+\b
+
 #### Getting all pastes for an account
 
 ```ruby
@@ -136,13 +250,25 @@ client = Hibp::Client.new('api-key')
 
 # Return any pastes that contain the given email address
 #
-# => Array<Hibp::Paste>
+# => Array<Hibp::Models::Paste>
 # 
 client.pastes('example@email.com').fetch
 ```
 
 ### Passwords
 
+#### Password model
+
+Represents password by the suffix of and a count of how many times it appears in the data set
+
+```ruby
+Hibp::Models::Password
+```
+
+- `suffix [String]` - Password suffix(password hash without first five symbols)
+
+- `occurrences [Integer]` - Count of how many times suffix appears in the data set
+
 #### Getting passwords suffixes by range
 
 ```ruby
@@ -150,7 +276,7 @@ client = Hibp::Client.new
 
 # Get all suffixes of every hash beginning with the specified prefix, and a count of how many times it appears in the data set.
 #
-# => Array<Hibp::Password>
+# => Array<Hibp::Models::Password>
 # 
 client.passwords('password').fetch
 
@@ -178,7 +304,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/warshavski/hibp. 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/warshavski/hibp-client. 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/hibp.gemspec

@@ -28,10 +28,10 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency('faraday', '>= 0.9.1')
+  spec.add_dependency('faraday', '>= 0.17.3')
   spec.add_dependency('oj', '>= 3.6.13')
 
   spec.add_development_dependency 'bundler'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rake', '>= 12.3.3'
   spec.add_development_dependency 'rspec', '~> 3.0'
 end

data/lib/hibp/request.rb

@@ -42,7 +42,7 @@ module Hibp
       end
 
       @parser ? @parser.parse_response(response) : response.body
-    rescue Faraday::ClientError::ResourceNotFound
+    rescue Faraday::ResourceNotFound
       nil
     rescue StandardError => e
       handle_error(e)
@@ -76,7 +76,7 @@ module Hibp
     end
 
     def parsable_error?(error)
-      error.is_a?(Faraday::Error::ClientError) && error.response
+      error.is_a?(Faraday::ClientError) && error.response
     end
 
     def parse_error(error)

data/lib/hibp/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Hibp
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hibp-client
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Warshavski
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-07-28 00:00:00.000000000 Z
+date: 2020-05-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.1
+        version: 0.17.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.1
+        version: 0.17.3
 - !ruby/object:Gem::Dependency
   name: oj
   requirement: !ruby/object:Gem::Requirement
@@ -56,16 +56,16 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -134,8 +134,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: A simple tool to check if an account(email address and username) has been