truemail-client 0.1.0

data/CONTRIBUTING.md

@@ -0,0 +1,45 @@
+# Contributing to Truemail
+
+Please take a moment to review this document in order to make the contribution process easy and effective for everyone involved.
+
+Following these guidelines helps to communicate that you respect the time of the developers managing and developing this open source project. In return, they should reciprocate that respect in addressing your issue or assessing patches and features.
+
+## Using the issue tracker
+
+The issue tracker is the preferred channel for [bug reports](#bugs), [features requests](#features) and [submitting pull requests](#pull-requests).
+
+<a name="bugs"></a>
+## Bug/issue reports
+
+A bug is a _demonstrable problem_ that is caused by the code in the repository.
+Good bug reports are extremely helpful - thank you!
+
+Guidelines for bug reports:
+
+1. **Use the GitHub issue search** &mdash; check if the issue has already been reported
+2. **Check if the issue has been fixed** &mdash; try to reproduce it using the latest `master` or development branch in the repository
+3. Truemail [issue template](.github/ISSUE_TEMPLATE.md)
+
+A good bug report shouldn't leave others needing to chase you up for more information. Please try to be as detailed as possible in your report. What is your environment? What steps will reproduce the issue? What would you expect to be the outcome? All these details will help people to fix any potential bugs.
+
+<a name="features"></a>
+## Feature requests
+
+Feature requests are welcome. But take a moment to find out whether your idea fits with the scope and aims of the project. It's up to *you* to make a strong case to convince the project's developers of the merits of this feature. Please provide as much detail and context as possible.
+
+<a name="pull-requests"></a>
+## Pull requests
+
+Good pull requests - patches, improvements, new features - are a fantastic help. They should remain focused in scope and avoid containing unrelated commits.
+
+**Please ask first** before embarking on any significant pull request (e.g. implementing features, refactoring code, porting to a different language), otherwise you risk spending a lot of time working on something that the project's developers might not want to merge into the project.
+
+Please adhere to the coding conventions used throughout a project (indentation, accurate comments, etc.) and any other requirements (such as test coverage). Not all features proposed will be added but we are open to having a conversation about a feature you are championing.
+
+Guidelines for pull requests:
+
+1. Truemail [pull request template](.github/PULL_REQUEST_TEMPLATE.md)
+2. Fork the repo
+3. Run the tests. This is to make sure your starting point works. Tests can be run via ```rspec```
+4. Create a new branch and make your changes. This includes tests for features!
+5. Push to your fork and submit a pull request

data/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+gemspec

data/Gemfile.lock

@@ -0,0 +1,141 @@
+PATH
+  remote: .
+  specs:
+    truemail-client (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    ast (2.4.0)
+    axiom-types (0.1.1)
+      descendants_tracker (~> 0.0.4)
+      ice_nine (~> 0.11.0)
+      thread_safe (~> 0.3, >= 0.3.1)
+    bundler-audit (0.6.1)
+      bundler (>= 1.2.0, < 3)
+      thor (~> 0.18)
+    byebug (11.1.1)
+    childprocess (3.0.0)
+    codeclimate-engine-rb (0.4.1)
+      virtus (~> 1.0)
+    coderay (1.1.2)
+    coercible (1.0.0)
+      descendants_tracker (~> 0.0.1)
+    colorize (0.8.1)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    descendants_tracker (0.0.4)
+      thread_safe (~> 0.3, >= 0.3.1)
+    diff-lcs (1.3)
+    docile (1.3.2)
+    equalizer (0.0.11)
+    fasterer (0.8.2)
+      colorize (~> 0.7)
+      ruby_parser (>= 3.14.1)
+    ffaker (2.14.0)
+    hashdiff (1.0.1)
+    ice_nine (0.11.2)
+    iniparse (1.5.0)
+    jaro_winkler (1.5.4)
+    json (2.3.0)
+    json_matchers (0.11.1)
+      json_schema
+    json_schema (0.20.8)
+    kwalify (0.7.2)
+    method_source (0.9.2)
+    overcommit (0.52.1)
+      childprocess (>= 0.6.3, < 4)
+      iniparse (~> 1.4)
+    parallel (1.19.1)
+    parser (2.7.0.4)
+      ast (~> 2.4.0)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    pry-byebug (3.8.0)
+      byebug (~> 11.0)
+      pry (~> 0.10)
+    psych (3.1.0)
+    public_suffix (4.0.3)
+    rainbow (3.0.0)
+    rake (13.0.1)
+    reek (5.6.0)
+      codeclimate-engine-rb (~> 0.4.0)
+      kwalify (~> 0.7.0)
+      parser (>= 2.5.0.0, < 2.8, != 2.5.1.1)
+      psych (~> 3.1.0)
+      rainbow (>= 2.0, < 4.0)
+    rexml (3.2.4)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.1)
+      rspec-support (~> 3.9.1)
+    rspec-expectations (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.2)
+    rubocop (0.80.1)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.7.0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      rexml
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.7)
+    rubocop-performance (1.5.2)
+      rubocop (>= 0.71.0)
+    rubocop-rspec (1.38.1)
+      rubocop (>= 0.68.1)
+    ruby-progressbar (1.10.1)
+    ruby_parser (3.14.2)
+      sexp_processor (~> 4.9)
+    safe_yaml (1.0.5)
+    sexp_processor (4.14.1)
+    simplecov (0.17.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    thor (0.20.3)
+    thread_safe (0.3.6)
+    unicode-display_width (1.6.1)
+    virtus (1.0.5)
+      axiom-types (~> 0.1)
+      coercible (~> 1.0)
+      descendants_tracker (~> 0.0, >= 0.0.3)
+      equalizer (~> 0.0, >= 0.0.9)
+    webmock (3.8.3)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  bundler-audit (~> 0.6.1)
+  fasterer (~> 0.8.2)
+  ffaker (~> 2.14)
+  json_matchers (~> 0.11.1)
+  overcommit (~> 0.52.1)
+  pry-byebug (~> 3.8)
+  rake (~> 13.0, >= 13.0.1)
+  reek (~> 5.6)
+  rspec (~> 3.9)
+  rubocop (~> 0.80.1)
+  rubocop-performance (~> 1.5, >= 1.5.2)
+  rubocop-rspec (~> 1.38, >= 1.38.1)
+  simplecov (~> 0.17.1)
+  truemail-client!
+  webmock (~> 3.8, >= 3.8.3)
+
+BUNDLED WITH
+   1.16.6

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Vladislav Trotsenko
+
+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,177 @@
+# <img src='https://repository-images.githubusercontent.com/246571655/128eda80-63af-11ea-8a0e-d1a7b9043c29' height='250' alt='Truemail web API client library for Ruby' />
+
+
+[![Maintainability](https://api.codeclimate.com/v1/badges/ccc7167f4f49d4a10146/maintainability)](https://codeclimate.com/github/truemail-rb/truemail-ruby-client/maintainability) [![Test Coverage](https://api.codeclimate.com/v1/badges/ccc7167f4f49d4a10146/test_coverage)](https://codeclimate.com/github/truemail-rb/truemail-ruby-client/test_coverage) [![CircleCI](https://circleci.com/gh/truemail-rb/truemail-ruby-client/tree/develop.svg?style=svg)](https://circleci.com/gh/truemail-rb/truemail-ruby-client/tree/develop) [![Gem Version](https://badge.fury.io/rb/truemail-client.svg)](https://badge.fury.io/rb/truemail-client) [![Downloads](https://img.shields.io/gem/dt/truemail-client.svg?colorA=004d99&colorB=0073e6)](https://rubygems.org/gems/truemail-client) [![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-v1.4%20adopted-ff69b4.svg)](CODE_OF_CONDUCT.md)
+
+`truemail-client` gem - Truemail web API client library for Ruby.
+
+## Table of Contents
+
+- [Installation](#installation)
+- [Usage](#usage)
+  - [Setting global configuration](#setting-global-configuration)
+  - [Establishing connection with Truemail API](#establishing-connection-with-truemail-api)
+  - [Additional features](#additional-features)
+- [Truemail family](#truemail-family)
+- [Contributing](#contributing)
+- [License](#license)
+- [Code of Conduct](#code-of-conduct)
+- [Versioning](#versioning)
+- [Changelog](CHANGELOG.md)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'truemail-client'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install truemail-client
+
+## Usage
+
+To have an access for `Truemail::Client` you must configure it first as in the example below:
+
+
+### Setting global configuration
+
+```ruby
+require 'truemail/client'
+
+Truemail::Client.configure do |config|
+  # Optional parameter (Boolean). By default it is equal false
+  config.secure_connection = true
+
+  # Required parameter (String). It should be a hostname or an ip address where Truemail server runs
+  config.host = 'example.com'
+
+  # Optional parameter (Integer). By default it is equal 9292
+  config.port = 80
+
+  # Required parameter (String). It should be valid Truemail server access token
+  config.token = 'token'
+end
+```
+
+### Establishing connection with Truemail API
+
+After successful configuration, you can establish connection with Truemail server.
+
+```ruby
+Truemail::Client.validate('admin@bestweb.com.ua')
+
+=>
+
+{
+  "date": "2020-02-26 17:00:56 +0200",
+  "email": "admin@bestweb.com.ua",
+  "validation_type": "smtp",
+  "success": true,
+  "errors": null,
+  "smtp_debug": null,
+  "configuration": {
+    "validation_type_by_domain": null,
+    "whitelist_validation": false,
+    "whitelisted_domains": null,
+    "blacklisted_domains": null,
+    "smtp_safe_check": false,
+    "email_pattern": "default gem value",
+    "smtp_error_body_pattern": "default gem value"
+  }
+}
+```
+
+`Truemail::Client.validate` always returns JSON data. If something goes wrong you will receive JSON with error details:
+
+```json
+{
+  "truemail_client_error": "error details"
+}
+```
+
+### Additional features
+
+#### Read global configuration
+
+After successful configuration, you can read current `Truemail::Client` configuration instance anywhere in your application.
+
+```ruby
+Truemail::Client.configuration
+
+=> #<Truemail::Client::Configuration:0x000055eafc588878
+  @host="example.com",
+  @port=80,
+  @secure_connection=true,
+  @token="token">
+```
+
+#### Update global configuration
+
+```ruby
+Truemail::Client.configuration.port = 8080
+=> 8080
+
+Truemail::Client.configuration
+
+=> #<Truemail::Client::Configuration:0x000055eafc588878
+  @host="example.com",
+  @port=8080,
+  @secure_connection=true,
+  @token="token">
+```
+
+#### Reset global configuration
+
+Also you can reset Truemail::Client configuration.
+
+```ruby
+Truemail::Client.reset_configuration!
+=> nil
+Truemail::Client.configuration
+=> nil
+```
+
+---
+
+## Truemail family
+
+All Truemail extensions: https://github.com/truemail-rb
+
+### truemail
+
+gem `truemail` - Configurable plain Ruby email validator, https://github.com/rubygarage/truemail
+
+### truemail server
+
+Lightweight rack based web API wrapper for Truemail, https://github.com/truemail-rb/truemail-rack
+
+### truemail-rack-docker-image
+
+Lightweight rack based web API [dockerized image](https://hub.docker.com/r/truemail/truemail-rack) :whale: of Truemail server, https://github.com/truemail-rb/truemail-rack-docker-image
+
+### truemail-rspec
+
+gem `truemail-rspec` - Truemail configuration and validator RSpec helpers, https://github.com/truemail-rb/truemail-rspec
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/truemail-rb/truemail-ruby-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. Please check the [open tikets](https://github.com/truemail-rb/truemail-ruby-client/issues). Be shure to follow Contributor Code of Conduct below and our [Contributing Guidelines](CONTRIBUTING.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the `truemail-ruby-client` project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](CODE_OF_CONDUCT.md).
+
+## Versioning
+
+`truemail-ruby-client` uses [Semantic Versioning 2.0.0](https://semver.org)

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'truemail/client'
+
+# 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/truemail/client.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require 'truemail/client/version'
+require 'truemail/client/configuration'
+require 'truemail/client/http'
+
+module Truemail
+  module Client
+    INCOMPLETE_CONFIG = 'required args not passed'
+    NOT_CONFIGURED = 'use Truemail::Client.configure before'
+
+    class << self
+      def configuration(&block)
+        @configuration ||= begin
+          return unless block_given?
+          configuration = Truemail::Client::Configuration.new(&block)
+          raise_unless(configuration.complete?, Truemail::Client::INCOMPLETE_CONFIG)
+          configuration
+        end
+      end
+
+      def configure(&block)
+        configuration(&block)
+      end
+
+      def reset_configuration!
+        @configuration = nil
+      end
+
+      def validate(email)
+        raise_unless(Truemail::Client.configuration, Truemail::Client::NOT_CONFIGURED)
+        Truemail::Client::Http.new(email).run
+      end
+
+      private
+
+      def raise_unless(condition, message)
+        raise Truemail::Client::Configuration::Error, message unless condition
+      end
+    end
+  end
+end