hibp-client 0.1.0

data/lib/hibp/query.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+module Hibp
+  # Hibp::Query
+  #
+  #   Used to build and execute request to the HIBP API
+  #
+  class Query
+    attr_reader :endpoint, :headers, :parser
+
+    # @param endpoint [String] -
+    #   A specific API endpoint to call appropriate method
+    #
+    # @param headers [Hash] -
+    #   Specific request headers
+    #
+    # @param parser [Hibp::Parser] -
+    #   A tool to parse and convert data into appropriate models
+    #
+    def initialize(endpoint:, headers: {}, parser: Parsers::Json.new)
+      @endpoint = endpoint
+      @headers = headers
+
+      @parser = parser
+      @query_params = {}
+    end
+
+    # Apply query filtration
+    #
+    # @param filters [Hash] - (optional, default: {})
+    #   Additional filtration params
+    #
+    # @option filters [String] :domain -
+    #   Filters the result set to only breaches against the domain specified.
+    #   It is possible that one site (and consequently domain), is compromised on multiple occasions.
+    #   (breaches and account_breaches queries)
+    #
+    # @option filters [Boolean] :truncate - (default: true)
+    #   Short/Full data switcher(only name or full breach data)
+    #   (only for account_breaches query)
+    #
+    # @option filters [Boolean] :unverified -
+    #   Returns breaches that have been flagged as "unverified".
+    #   (only for account_breaches query)
+    #
+    # @return [Hibp::Query]
+    #
+    def where(filters = {})
+      tap do
+        @query_params.merge!(convert_filters(filters))
+      end
+    end
+
+    # Perform query execution(data fetching)
+    #
+    # @return [
+    #   Array<String>,
+    #   Array<Hibp::Models::Breach>,
+    #   Array<Hibp::Models::Paste>,
+    #   Hibp::Models::Breach
+    # ]
+    #
+    def fetch
+      confugure_request.get(headers: @headers, params: @query_params)
+    end
+
+    private
+
+    def confugure_request
+      Request.new(parser: @parser, endpoint: @endpoint)
+    end
+
+    def convert_filters(params)
+      mappings = {
+        truncate: 'truncateResponse',
+        domain: 'domain',
+        unverified: 'includeUnverified'
+      }
+
+      params.each_with_object({}) do |(origin_key, value), acc|
+        acc[mappings.fetch(origin_key)] = value
+      end
+    end
+  end
+end

data/lib/hibp/request.rb

@@ -0,0 +1,106 @@
+# frozen_string_literal: true
+
+module Hibp
+  # Hibp::Request
+  #
+  #   Used to make requests to the hibp API
+  #
+  #   @see https://haveibeenpwned.com/API/v3
+  #
+  class Request
+    attr_reader :headers
+
+    # @param parser [Hibp::Parser] -
+    #   A tool to parse and convert data into appropriate models
+    #
+    # @param endpoint [String] -
+    #   A specific API endpoint to call appropriate method
+    #
+    def initialize(endpoint:, parser: Parsers::Json.new)
+      @endpoint = endpoint
+      @parser = parser
+
+      @headers = {
+        'Content-Type' => 'application/json',
+        'User-Agent' => "Ruby HIBP-Client #{Hibp::VERSION}"
+      }
+    end
+
+    # Perform a GET request
+    #
+    # @param params [Hash] -
+    #   Additional query params
+    #
+    # @param headers [Hash] -
+    #   Additional HTTP headers
+    #
+    # @raise [Hibp::ServiceError]
+    #
+    def get(params: nil, headers: nil)
+      response = rest_client.get(@endpoint) do |request|
+        configure_request(request: request, params: params, headers: headers)
+      end
+
+      @parser ? @parser.parse_response(response) : response.body
+    rescue Faraday::ClientError::ResourceNotFound
+      nil
+    rescue StandardError => e
+      handle_error(e)
+    end
+
+    private
+
+    def rest_client
+      Faraday.new do |faraday|
+        faraday.headers = @headers
+
+        faraday.response(:raise_error)
+        faraday.adapter(Faraday.default_adapter)
+      end
+    end
+
+    def configure_request(request: nil, params: nil, headers: nil, body: nil)
+      return if request.nil?
+
+      request.params.merge!(params) if params
+      request.headers.merge!(headers) if headers
+      request.body = body if body
+    end
+
+    def handle_error(error)
+      error_params = parsable_error?(error) ? parse_error(error) : {}
+
+      error_to_raise = ServiceError.new(error.message, error_params)
+
+      raise error_to_raise
+    end
+
+    def parsable_error?(error)
+      error.is_a?(Faraday::Error::ClientError) && error.response
+    end
+
+    def parse_error(error)
+      error_params = {
+        status_code: error.response[:status],
+        raw_body: error.response[:body]
+      }
+
+      begin
+        parsed_response = Oj.load(error.response[:body], {})
+
+        return error_params unless parsed_response
+
+        error_params[:body] = parsed_response
+
+        %w[title detail].each do |section|
+          next if parsed_response[section].nil?
+
+          error_params[section.to_sym] = parsed_response[section]
+        end
+      rescue Oj::ParseError
+      end
+
+      error_params
+    end
+  end
+end

data/lib/hibp/service_error.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module Hibp
+  # Hibp::ServiceError
+  #
+  #   Used to represent an error that may occur when performing a request to the API
+  #
+  class ServiceError < StandardError
+    attr_reader :body, :raw_body, :status_code
+
+    # @param message [String] - (optional, '') Message to describe an error
+    # @param params [Hash] - (optional, {}) Additional error information
+    #
+    # @option params [String] :body -
+    #   A JSON formatted error object that provides more details about the specifics of the error
+    #
+    # @option params [String] :title -
+    #   Error summary
+    #
+    # @option params [String] :detail -
+    #   Error detailed description
+    #
+    # @option params [String] :raw_body -
+    #   Raw body from response
+    #
+    # @option params [String] :status_code  -
+    #   Http status code
+    #
+    def initialize(message = '', params = {})
+      @body         = params[:body]
+      @raw_body     = params[:raw_body]
+      @status_code  = params[:status_code]
+
+      super(message)
+    end
+
+    def to_s
+      "#{super} #{instance_variables_to_s}"
+    end
+
+    private
+
+    def instance_variables_to_s
+      attr_values = %i[body raw_body status_code].map do |attr|
+        attr_value = send(attr)
+
+        "@#{attr}=#{attr_value.inspect}"
+      end
+
+      attr_values.join(', ')
+    end
+  end
+end

data/lib/hibp/version.rb

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

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification
+name: hibp-client
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Warshavski
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-07-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+- !ruby/object:Gem::Dependency
+  name: oj
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.6.13
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.6.13
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: A simple tool to check if an account(email address and username) has
+  been compromised in a data breach
+email:
+- p.warshavski@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- hibp.gemspec
+- lib/hibp.rb
+- lib/hibp/client.rb
+- lib/hibp/helpers/attribute_assignment.rb
+- lib/hibp/helpers/json_conversion.rb
+- lib/hibp/models/breach.rb
+- lib/hibp/models/password.rb
+- lib/hibp/models/paste.rb
+- lib/hibp/parsers/breach.rb
+- lib/hibp/parsers/json.rb
+- lib/hibp/parsers/password.rb
+- lib/hibp/parsers/paste.rb
+- lib/hibp/query.rb
+- lib/hibp/request.rb
+- lib/hibp/service_error.rb
+- lib/hibp/version.rb
+homepage: https://github.com/Warshavski/hibp
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/Warshavski/hibp
+  source_code_uri: https://github.com/Warshavski/hibp
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: A simple tool to check if an account(email address and username) has been
+  compromised in a data breach
+test_files: []