truemail-client 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ed0062cf7b8d5dffcda7197b78c35693e0e3c6fc35e69c01948de4a8bf2e4df8
-  data.tar.gz: c5f1c8249883336d12c4c0c9248f9fb3725a055333b2f5bde49fa86180439e56
+  metadata.gz: c1b42e36e9d9d70a91dd951c594d3b3afc3ee8815ed3a50fbaa4b179b0488b59
+  data.tar.gz: 4af09437d71822e86365eb59cef631b52f3ddf2d49db65d528949296f904d780
 SHA512:
-  metadata.gz: f18bb396644f028cb9b2d269fe9bf44c52ff3378443d6b795b64939763736a3610467d40dd4b2365aef9d8bc2d94c0cd37993040e06ad14c447b97de2b75160c
-  data.tar.gz: 2de0b0b9a3f3efa114c3960c7adf221ac381304e5d38b744c604c1f8e9a68d023a9c9a143190f09a0f231befffd62c98874a93f626f9c588478864e4f21bcc9a
+  metadata.gz: 162f18138f8764672e8e416c5f30f46a63092aadde2d7592bf828be002991632dba30b184c0873764c9802032b605b8c43ab9609993a95de407425bd9c051c58
+  data.tar.gz: 4296b7edb2acc4a22be663bc2c14ba5b0af3375e3ddcf5d5419ce80c3c7fb6849e19792430e4e6c34369c500f6e7b76bdca6a8d38ba27921e22ab2d1572cac5b

data/.github/ISSUE_TEMPLATE.md

@@ -4,7 +4,7 @@
 
 - [ ] I have updated truemail-ruby-client to the latest version
 - [ ] I have read the [Contribution Guidelines](https://github.com/truemail-rb/truemail-ruby-client/blob/master/CONTRIBUTING.md)
-- [ ] I have read the [documentation](https://github.com/truemail-rb/truemail-ruby-client/blob/master/README.md)
+- [ ] I have read the [documentation](https://truemail-rb.org/truemail-ruby-client)
 - [ ] I have searched for [existing GitHub issues](https://github.com/truemail-rb/truemail-ruby-client/issues)
 
 ### Issue Description

data/CHANGELOG.md

@@ -2,6 +2,21 @@
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.2.0] - 2020-10-04
+
+### Added
+
+Ability to use Truemail healthcheck endpoint
+
+- Added `Truemail::Client.server_healthy?`
+
+### Changed
+
+- Updated `Truemail::Client::Http#uri`
+- Updated gem dependencies
+- Updated gem documentation
+- Updated gem version
+
 ## [0.1.1] - 2020-07-21
 
 ### Changed

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    truemail-client (0.1.1)
+    truemail-client (0.2.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -1,15 +1,19 @@
-# <img src='https://repository-images.githubusercontent.com/246571655/128eda80-63af-11ea-8a0e-d1a7b9043c29' height='250' alt='Truemail web API client library for Ruby' />
+# ![Truemail web API client library for Ruby](https://repository-images.githubusercontent.com/246571655/128eda80-63af-11ea-8a0e-d1a7b9043c29)
 
 [![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](https://github.com/truemail-rb/truemail-rack) client library for Ruby.
 
+
+> Actual and maintainable documentation :books: for developers is living [here](https://truemail-rb.org/truemail-ruby-client).
+
 ## Table of Contents
 
 - [Installation](#installation)
 - [Usage](#usage)
   - [Setting global configuration](#setting-global-configuration)
   - [Establishing connection with Truemail API](#establishing-connection-with-truemail-api)
+  - [Checking server health status](#checking-server-health-status)
   - [Additional features](#additional-features)
 - [Truemail family](#truemail-family)
 - [Contributing](#contributing)
@@ -92,6 +96,16 @@ Truemail::Client.validate('admin@bestweb.com.ua')
 }
 ```
 
+### Checking server health status
+
+After successful configuration, you can check health-status of Truemail server.
+
+```ruby
+Truemail::Client.server_healthy?
+
+=> true
+```
+
 ### Additional features
 
 #### Read global configuration
@@ -136,7 +150,7 @@ Truemail::Client.configuration
 
 ## Truemail family
 
-All Truemail extensions: https://github.com/truemail-rb
+All Truemail extensions: https://truemail-rb.org
 
 | Name | Type | Description |
 | --- | --- | --- |

data/lib/truemail/client.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require 'truemail/client/version'
-require 'truemail/client/configuration'
-require 'truemail/client/http'
+require_relative '../truemail/client/version'
+require_relative '../truemail/client/configuration'
+require_relative '../truemail/client/http'
 
 module Truemail
   module Client
@@ -29,7 +29,12 @@ module Truemail
 
       def validate(email)
         raise_unless(Truemail::Client.configuration, Truemail::Client::NOT_CONFIGURED)
-        Truemail::Client::Http.new(email).run
+        Truemail::Client::Http.new(email: email).run
+      end
+
+      def server_healthy?
+        raise_unless(Truemail::Client.configuration, Truemail::Client::NOT_CONFIGURED)
+        Truemail::Client::Http.new(Truemail::Client::Http::HEALTHCHECK_ENDPOINT).run.empty?
       end
 
       private

data/lib/truemail/client/http.rb

@@ -5,16 +5,20 @@ module Truemail
     class Http
       require 'uri'
       require 'net/http'
+      require 'json'
 
-      URI_ATTRS = %i[secure_connection host port email].freeze
+      URI_ATTRS = %i[secure_connection host port endpoint uri_params].freeze
       USER_AGENT = 'Truemail Ruby client'
       MIME_TYPE = 'application/json'
+      VALIDATION_ENDPOINT = '/'
+      HEALTHCHECK_ENDPOINT = '/healthcheck'
 
-      def initialize(email)
-        Truemail::Client::Http::URI_ATTRS[0..-2].each do |attribute|
+      def initialize(endpoint = Truemail::Client::Http::VALIDATION_ENDPOINT, **uri_params)
+        Truemail::Client::Http::URI_ATTRS[0..2].each do |attribute|
           instance_variable_set(:"@#{attribute}", Truemail::Client.configuration.public_send(attribute))
         end
-        @email = email
+        @endpoint = endpoint
+        @uri_params = uri_params
       end
 
       def run
@@ -34,8 +38,15 @@ module Truemail
 
       attr_reader(*Truemail::Client::Http::URI_ATTRS)
 
+      def request_uri
+        URI::HTTP.build(
+          path: endpoint,
+          query: uri_params.empty? ? nil : URI.encode_www_form(uri_params)
+        ).request_uri.gsub(/%40/, '@') # TODO: should be removed after new Truemail server release with encoding uri param values
+      end
+
       def uri
-        @uri ||= URI("#{secure_connection ? 'https' : 'http'}://#{host}:#{port}/?email=#{email}")
+        @uri ||= URI("#{secure_connection ? 'https' : 'http'}://#{host}:#{port}#{request_uri}")
       end
     end
   end

data/lib/truemail/client/version.rb

@@ -2,6 +2,6 @@
 
 module Truemail
   module Client
-    VERSION = '0.1.1'
+    VERSION = '0.2.0'
   end
 end

data/truemail-client.gemspec

@@ -16,6 +16,14 @@ Gem::Specification.new do |spec|
   spec.homepage      = 'https://github.com/truemail-rb/truemail-ruby-client'
   spec.license       = 'MIT'
 
+  spec.metadata = {
+    'homepage_uri' => 'https://truemail-rb.org',
+    'changelog_uri' => 'https://github.com/truemail-rb/truemail-ruby-client/blob/master/CHANGELOG.md',
+    'source_code_uri' => 'https://github.com/truemail-rb/truemail-ruby-client',
+    'documentation_uri' => 'https://truemail-rb.org/truemail-ruby-client',
+    'bug_tracker_uri' => 'https://github.com/truemail-rb/truemail-ruby-client/issues'
+  }
+
   spec.required_ruby_version = '>= 2.5.0'
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: truemail-client
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Vladislav Trotsenko
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-07-21 00:00:00.000000000 Z
+date: 2020-10-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -280,7 +280,12 @@ files:
 homepage: https://github.com/truemail-rb/truemail-ruby-client
 licenses:
 - MIT
-metadata: {}
+metadata:
+  homepage_uri: https://truemail-rb.org
+  changelog_uri: https://github.com/truemail-rb/truemail-ruby-client/blob/master/CHANGELOG.md
+  source_code_uri: https://github.com/truemail-rb/truemail-ruby-client
+  documentation_uri: https://truemail-rb.org/truemail-ruby-client
+  bug_tracker_uri: https://github.com/truemail-rb/truemail-ruby-client/issues
 post_install_message:
 rdoc_options: []
 require_paths: