abuseipdb-rb 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bb09d7343787e2514429559e81bfe056219b4e44
+  data.tar.gz: a977cf1993936252b33b15d58f581aa16eb1dd9c
+SHA512:
+  metadata.gz: 1f0325b0180925459fad0f82b00d25084b997769e3e04e95ff341024f907b578bfd2ddd192633047f6f8046c4438832b4db77fea70ca4f900bc9ef76e6f14060
+  data.tar.gz: e577b3e2dfae3de0d10bec32cd93ba255d7547dabb6e5313dad106d11bfd9337683b1a3ac002d7f3e57d219b2b50eeca11abef57ef572fd65d40539da0c88284

data/.gitignore

@@ -0,0 +1,14 @@
+*.gem
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/.idea
+
+# rspec failure tracking
+.rspec_status
+Gemfile.lock

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,39 @@
+# Configurations: http://rubocop.readthedocs.io/en/latest/configuration/#configuration
+
+AllCops:
+  TargetRubyVersion: 2.5
+
+Documentation:
+  Enabled: false
+
+Style/Encoding:
+  Enabled: false
+
+Style/AndOr:
+  Enabled: false
+
+Style/BracesAroundHashParameters:
+  EnforcedStyle: context_dependent
+
+Metrics/LineLength:
+  Max: 120
+
+Metrics/MethodLength:
+  Max: 20
+
+Metrics/AbcSize:
+  Max: 20
+
+TrailingBlankLines:
+  Enabled: false
+
+FrozenStringLiteralComment:
+  Enabled: false
+
+CaseIndentation:
+  # Valid values are: case, end
+  EnforcedStyle: case
+  IndentOneStep: true
+
+#Metrics/CyclomaticComplexity:
+#  Severity: warning

data/.ruby-gemset

@@ -0,0 +1 @@
+abuseipdb-rb

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.5.1

data/.travis.yml

@@ -0,0 +1,8 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.1
+  - 2.4.2
+before_install: gem install bundler -v 2.0.1

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [0.0.1] - 2019-06-12
+### Added
+- Check Endpoint
+- Blacklist Endpoint
+- Check-Block Endpoint

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at falegk1@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in abuseipdb-rb.gemspec
+gemspec

data/README.md

@@ -0,0 +1,84 @@
+# Abuseipdb::Rb
+
+[![Gem Version](https://badge.fury.io/rb/abuseipdb-rb.svg)](https://badge.fury.io/rb/abuseipdb-rb)
+[![Build Status](https://travis-ci.org/falegk/abuseipdb-rb.svg?branch=master)](https://travis-ci.org/falegk/abuseipdb-rb)
+
+A Ruby client gem for the [AbuseIPDB](https://www.abuseipdb.com) service API
+
+| Branch | AbuseIPDB API |
+| ------ | ------ |
+| _Master_ | [v2](https://docs.abuseipdb.com/#introduction) |
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'abuseipdb-rb'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install abuseipdb-rb
+
+## Usage
+
+First set up configurations (Ex. for rails apps into config/initializers)
+
+```ruby
+Abuseipdb.configure do |config|
+    config.api_key = "YOUR_ABUSEIPDB_API_KEY"
+    config.timeout = 20 # Default is 60s
+end
+```
+
+Then just init a client an use it
+
+```ruby
+client = Abuseipdb.client
+
+# CHECK Endpoint
+response = client.check.call(ipAddress: '8.8.8.8')
+
+response.status
+    => 200
+response.body
+    => {"data"=>{"ipAddress"=>"8.8.8.8", "isPublic"=>true, 
+        "ipVersion"=>4, "isWhitelisted"=>true, "abuseConfidenceScore"=>0, 
+        "countryCode"=>"US", "usageType"=>"Data Center/Web Hosting/Transit", 
+        "isp"=>"Google LLC", "domain"=>"google.com", "totalReports"=>16, 
+        "lastReportedAt"=>"2019-06-12T01:09:53+01:00"}}
+
+```
+
+## Current Endpoints
+
+| Command | Endpoint |
+| ------ | ------ |
+| client = Abuseipdb.client | Init a client |
+| client.check.call | https://api.abuseipdb.com/api/v2/check |
+| client.blacklist.call | https://api.abuseipdb.com/api/v2/blacklist |
+| client.check_block.call | https://api.abuseipdb.com/api/v2/check-block |
+
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. 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).
+
+## Contributing
+
+[Report issues / feature requests](https://github.com/falegk/abuseipdb-rb/issues) and [pull requests](https://github.com/falegk/abuseipdb-rb/pulls) are welcome.
+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
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/abuseipdb-rb.gemspec

@@ -0,0 +1,42 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "abuseipdb/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "abuseipdb-rb"
+  spec.version       = Abuseipdb::VERSION
+  spec.authors       = ["Antony Falegkos"]
+  spec.email         = ["afalegk@gmail.com"]
+
+  spec.summary       = %q{A Ruby client gem for [AbuseIPDB](https://www.abuseipdb.com) service API}
+  spec.description   = %q{AbuseIPDB is a project dedicated to helping combat the spread of hackers, spammers, and abusive activity on the internet.}
+  spec.homepage      = "https://github.com/falegk/abuseipdb-rb"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = spec.homepage
+    spec.metadata["changelog_uri"] = "https://github.com/falegk/abuseipdb-rb/CHANGELOG.md"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 2.0", ">= 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "vcr", '~> 4.0', '>= 4.0.0'
+
+  spec.add_runtime_dependency 'faraday', '~> 0.15', '>= 0.15.2'
+  spec.add_runtime_dependency 'faraday_middleware', '~> 0.13', '>= 0.12.2'
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "abuseipdb"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/abuseipdb.rb

@@ -0,0 +1,26 @@
+require "abuseipdb/version"
+require "abuseipdb/client"
+
+module Abuseipdb
+  class Error < StandardError; end
+
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.client
+    @client = Abuseipdb::Client.new(configuration)
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.reset
+    @configuration = Configuration.new
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+end

data/lib/abuseipdb/client.rb

@@ -0,0 +1,62 @@
+require 'faraday'
+require 'faraday_middleware'
+
+require 'abuseipdb/configuration'
+require 'abuseipdb/endpoints/base'
+require 'abuseipdb/endpoints/check'
+require 'abuseipdb/endpoints/blacklist'
+require 'abuseipdb/endpoints/check_block'
+
+module Abuseipdb
+  class Client
+
+    ENDPOINTS = [:check, :blacklist, :check_block].freeze
+
+    attr_reader :configuration
+
+    attr_accessor *ENDPOINTS
+
+    # options
+    #   api_key Your API key
+    #   api_version default v2
+    #   timeout default 60 (seconds)
+    def initialize(configuration = Configuration.new)
+      @configuration = configuration
+      define_endpoint_methods
+    end
+
+    def api_connection(url = nil)
+      url ||= "https://api.abuseipdb.com/api/#{@configuration.api_version}/"
+
+      Faraday.new(url: url) do |faraday|
+        faraday.response :logger
+        faraday.request :json
+        faraday.ssl.verify = false
+        faraday.headers['Accept'] = 'application/json'
+        faraday.options.timeout = @configuration.timeout # open/read timeout in seconds
+        faraday.adapter Faraday.default_adapter
+
+        if @configuration.api_key
+          # faraday.set_authorization_header :Key, @configuration.api_key
+          faraday.headers['Key'] = @configuration.api_key
+        end
+      end
+    end
+
+    private
+
+    def define_endpoint_methods
+      namespace = "Abuseipdb::Endpoints"
+
+      ENDPOINTS.each do |endpoint|
+        begin
+          endpoint_klass = Object.const_get("#{namespace}::#{endpoint.to_s.split('_').collect(&:capitalize).join}")
+          klass = endpoint_klass.new(self)
+          send("#{endpoint.to_s}=", klass)
+        rescue NameError => _ex
+          next
+        end
+      end
+    end
+  end
+end

data/lib/abuseipdb/configuration.rb

@@ -0,0 +1,25 @@
+module Abuseipdb
+  class Configuration
+    attr_accessor :api_version, :timeout, :api_key
+
+    def initialize(options = nil)
+      options = options ? default_options.merge(options) : default_options
+
+      return unless options.is_a?(Hash)
+
+      options.each do |config_name, config_value|
+        send("#{config_name}=", config_value)
+      end
+    end
+
+    private
+
+    def default_options
+      {
+          api_version: 'v2',
+          timeout: 60,
+          api_key: nil
+      }
+    end
+  end
+end

data/lib/abuseipdb/endpoints/base.rb

@@ -0,0 +1,20 @@
+require 'json'
+require 'abuseipdb/responses/base'
+
+module Abuseipdb
+  module Endpoints
+    class Base
+      attr_accessor :client, :config
+      attr_accessor :api, :api_version_path
+
+      def initialize(client)
+        @client = client
+        @config = @client.configuration
+        @api = @client.api_connection
+
+        @api_version_path = @client.configuration.api_version
+      end
+
+    end
+  end
+end

data/lib/abuseipdb/endpoints/blacklist.rb

@@ -0,0 +1,28 @@
+require 'abuseipdb/responses/blacklist'
+
+module Abuseipdb
+  module Endpoints
+    class Blacklist < Base
+      PATH = 'blacklist'
+
+      def url_path
+        PATH
+      end
+
+      # params https://docs.abuseipdb.com/#blacklist-parameters
+      def call(params = {})
+        params = default_params(params)
+        response = @api.get(url_path, params)
+        Abuseipdb::Responses::Blacklist.new(response)
+      end
+
+      private
+
+      def default_params(params)
+        params.select do |key, _value| [:countMinimum, :maxAgeInDays, :confidenceMinimum,
+                                        :limit, :plaintext, :self].include?(key)
+        end
+      end
+    end
+  end
+end

data/lib/abuseipdb/endpoints/check.rb

@@ -0,0 +1,27 @@
+require 'abuseipdb/responses/check'
+
+module Abuseipdb
+  module Endpoints
+    class Check < Base
+      PATH = 'check'
+
+      def url_path
+        PATH
+      end
+
+      # params https://docs.abuseipdb.com/#check-endpoint
+      def call(params = {})
+        params = default_params(params)
+        response = @api.get(url_path, params)
+        Abuseipdb::Responses::Check.new(response)
+      end
+
+      private
+
+      def default_params(params)
+        params.select do |key, _value| [:ipAddress, :maxAgeInDays, :verbose].include?(key)
+        end
+      end
+    end
+  end
+end

data/lib/abuseipdb/endpoints/check_block.rb

@@ -0,0 +1,27 @@
+require 'abuseipdb/responses/check_block'
+
+module Abuseipdb
+  module Endpoints
+    class CheckBlock < Base
+      PATH = 'check-block'
+
+      def url_path
+        PATH
+      end
+
+      # params https://docs.abuseipdb.com/#check-block-endpoint
+      def call(params = {})
+        params = default_params(params)
+        response = @api.get(url_path, params)
+        Abuseipdb::Responses::CheckBlock.new(response)
+      end
+
+      private
+
+      def default_params(params)
+        params.select do |key, _value| [:network, :maxAgeInDays].include?(key)
+        end
+      end
+    end
+  end
+end

data/lib/abuseipdb/responses/base.rb

@@ -0,0 +1,18 @@
+require 'json'
+
+module Abuseipdb
+  module Responses
+    class Base
+
+      attr_accessor :body, :status
+      attr_accessor :raw_response
+
+      # @param response Faraday::Response
+      def initialize(response)
+        @raw_response = response
+        @body = JSON.parse(response.body)
+        @status = response.status
+      end
+    end
+  end
+end

data/lib/abuseipdb/responses/blacklist.rb

@@ -0,0 +1,7 @@
+module Abuseipdb
+  module Responses
+    class Blacklist < Base
+
+    end
+  end
+end

data/lib/abuseipdb/responses/check.rb

@@ -0,0 +1,7 @@
+module Abuseipdb
+  module Responses
+    class Check < Base
+
+    end
+  end
+end

data/lib/abuseipdb/responses/check_block.rb

@@ -0,0 +1,7 @@
+module Abuseipdb
+  module Responses
+    class CheckBlock < Base
+
+    end
+  end
+end

data/lib/abuseipdb/version.rb

@@ -0,0 +1,3 @@
+module Abuseipdb
+  VERSION = "0.0.1"
+end

metadata

@@ -0,0 +1,182 @@
+--- !ruby/object:Gem::Specification
+name: abuseipdb-rb
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Antony Falegkos
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-06-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.15.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.15.2
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.12.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.12.2
+description: AbuseIPDB is a project dedicated to helping combat the spread of hackers,
+  spammers, and abusive activity on the internet.
+email:
+- afalegk@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".idea/workspace.xml"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- README.md
+- Rakefile
+- abuseipdb-rb.gemspec
+- bin/console
+- bin/setup
+- lib/abuseipdb.rb
+- lib/abuseipdb/client.rb
+- lib/abuseipdb/configuration.rb
+- lib/abuseipdb/endpoints/base.rb
+- lib/abuseipdb/endpoints/blacklist.rb
+- lib/abuseipdb/endpoints/check.rb
+- lib/abuseipdb/endpoints/check_block.rb
+- lib/abuseipdb/responses/base.rb
+- lib/abuseipdb/responses/blacklist.rb
+- lib/abuseipdb/responses/check.rb
+- lib/abuseipdb/responses/check_block.rb
+- lib/abuseipdb/version.rb
+homepage: https://github.com/falegk/abuseipdb-rb
+licenses: []
+metadata:
+  homepage_uri: https://github.com/falegk/abuseipdb-rb
+  source_code_uri: https://github.com/falegk/abuseipdb-rb
+  changelog_uri: https://github.com/falegk/abuseipdb-rb/CHANGELOG.md
+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.5.2.1
+signing_key: 
+specification_version: 4
+summary: A Ruby client gem for [AbuseIPDB](https://www.abuseipdb.com) service API
+test_files: []