improvmx 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6d7859f7b94f30a8fd712321821172498e179e1de7a8a5e893e46a3f131339b1
+  data.tar.gz: c468089b24a881419a854ef0cb2ef7597342f77789304f61293d2b1ff1e134dd
+SHA512:
+  metadata.gz: 54a26c1b99e2eb1136b07d12026b5ffb73fd5900fd61d7658a634d71e711cc8535741f8c6f4756012b8e114246768a712f13445fef809bd6d1c2726b228a08f1
+  data.tar.gz: eed54722a9f29bbaa8d1c7c73b60184d95ec1af7ea13c41e786ff9074d0b30e36f6979eccaf149f8c104cf833147f1fc2944c9eddd1b8af0d0190c21f11e0ace

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Alpha
+
+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,67 @@
+ImprovMX Ruby Gem
+============
+
+Ruby interface to connect to the ImprovMX API.
+
+Currently still work in progress, it only contains the aliases endpoints at the moment.
+
+
+Installation
+------------
+
+```ruby
+gem install improvmx
+```
+
+Usage
+-----
+This is how you can use this gem
+
+```ruby
+require 'improvmx'
+
+# Instantiate the Client with your API key and domain
+client = Improvmx::Client.new 'your-api-key', 'domain.com'
+
+# List all the aliases
+aliases = client.list_aliases
+
+puts aliases['aliases']
+```
+
+Rails
+-----
+
+The library can be initialized with a Rails initializer containing similar:
+```ruby
+Improvmx.configure do |config|
+  config.api_key = 'your-secret-api-key'
+  config.domain = 'your-domain'
+end
+```
+
+
+For usage examples on each API endpoint, head over to our official documentation
+pages. Or the [Snippets](docs/Snippets.md) file.
+
+Testing
+-------
+
+There are different test, they require you to setup an ImprovMX account with domain to run.
+By default:
+```
+bundle exec rake spec
+```
+will run all the tests.
+
+To setup the key information for testing copy `.env.example` to `.env` and fill in the details.
+
+
+Deployment
+------
+
+This part is for maintaincers only. In order to deploy this gem to rubygem follow those steps:
+
+1. Bump the version in `lib/improvmx/version.rb`
+1. Build the gem using `gem build improvmx.gemspec`
+1. 

data/improvmx.gemspec

@@ -0,0 +1,20 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'improvmx/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'improvmx'
+  spec.version = Improvmx::VERSION
+  spec.homepage = 'https://improvmx.com'
+  spec.license = 'MIT'
+  spec.description = 'Ruby interface for the ImprovMX API'
+  spec.summary = 'Ruby interface for the ImprovMX API'
+  spec.authors = ['C.S.V. Alpha', 'Matthijs Vos']
+  spec.email = 'ict@csvalpha.nl'
+
+  spec.files = %w[LICENSE README.md improvmx.gemspec] + Dir['lib/**/*.rb']
+  spec.require_paths = %w[lib]
+
+  spec.required_ruby_version = '>= 2.4'
+  spec.add_dependency 'rest-client', '>= 2.0.2'
+end

data/lib/improvmx.rb

@@ -0,0 +1,18 @@
+require 'rest_client'
+require 'json'
+
+require 'improvmx/client'
+require 'improvmx/version'
+require 'improvmx/exceptions/exceptions'
+
+# Module for interaction with Improvmx
+module Improvmx
+  class << self
+    attr_accessor :api_key, :domain
+
+    def configure
+      yield self
+      true
+    end
+  end
+end

data/lib/improvmx/aliases.rb

@@ -0,0 +1,42 @@
+module Improvmx
+  # All alias related endpoints
+  module Aliases
+    def list_aliases(params = {})
+      get("/domains/#{domain}/aliases/", params).to_h
+    end
+
+    def get_alias(alias_name)
+      get("/domains/#{domain}/aliases/#{alias_name}")
+    rescue NotFoundError
+      nil
+    end
+
+    def create_alias(alias_name, forward_to)
+      response = post("/domains/#{domain}/aliases/", { alias: alias_name, forward: forward(forward_to) })
+
+      response.ok?
+    end
+
+    def update_alias(alias_name, forward_to)
+      response = put("/domains/#{domain}/aliases/#{alias_name}", { forward: forward(forward_to) })
+
+      response.ok?
+    rescue NotFoundError
+      false
+    end
+
+    def create_or_update_alias(alias_name, forward_to)
+      create_alias(alias_name, forward_to)
+    rescue BadRequestError
+      update_alias(alias_name, forward_to)
+    end
+
+    def delete_alias(alias_name)
+      response = delete("/domains/#{domain}/aliases/#{alias_name}")
+
+      response.ok?
+    rescue NotFoundError
+      return true
+    end
+  end
+end

data/lib/improvmx/client.rb

@@ -0,0 +1,100 @@
+require 'improvmx/aliases'
+require 'improvmx/response'
+require 'improvmx/utils'
+require 'improvmx/exceptions/exceptions'
+
+module Improvmx
+  class Client
+    include Improvmx::Aliases
+    include Improvmx::Utils
+
+    def initialize(api_key = Improvmx.api_key, domain = Improvmx.domain)
+      rest_client_params = {
+        user: 'api',
+        password: api_key,
+        user_agent: "improvmx-ruby/#{Improvmx::VERSION}"
+      }
+
+      @http_client = RestClient::Resource.new('https://api.improvmx.com/v3', rest_client_params)
+      @domain = domain
+    end
+
+    # Generic Improvmx POST Handler
+    #
+    # @param [String] resource_path This is the API resource you wish to interact
+    # with. Be sure to include your domain, where necessary.
+    # @param [Hash] data This should be a standard Hash
+    # containing required parameters for the requested resource.
+    # @param [Hash] headers Additional headers to pass to the resource.
+    # @return [Improvmx::Response] A Improvmx::Response object.
+    def post(resource_path, data, headers = {})
+      response = @http_client[resource_path].post(data, headers)
+      Response.new(response)
+    rescue StandardError => e
+      raise communication_error e
+    end
+
+    # Generic Improvmx GET Handler
+    #
+    # @param [String] resource_path This is the API resource you wish to interact
+    # with.
+    # @param [Hash] params This should be a standard Hash
+    # containing required parameters for the requested resource.
+    # @param [String] accept Acceptable Content-Type of the response body.
+    # @return [Improvmx::Response] A Improvmx::Response object.
+    def get(resource_path, params = nil, accept = '*/*')
+      response = @http_client[resource_path].get(params: params, accept: accept)
+      Response.new(response)
+    rescue StandardError => e
+      raise communication_error e
+    end
+
+    # Generic Improvmx PUT Handler
+    #
+    # @param [String] resource_path This is the API resource you wish to interact
+    # with.
+    # @param [Hash] data This should be a standard Hash
+    # containing required parameters for the requested resource.
+    # @return [Improvmx::Response] A Improvmx::Response object.
+    def put(resource_path, data)
+      response = @http_client[resource_path].put(data)
+      Response.new(response)
+    rescue StandardError => e
+      raise communication_error e
+    end
+
+    # Generic Improvmx DELETE Handler
+    #
+    # @param [String] resource_path This is the API resource you wish to interact
+    # with.
+    # @return [Improvmx::Response] A Improvmx::Response object.
+    def delete(resource_path)
+      response = @http_client[resource_path].delete
+      Response.new(response)
+    rescue StandardError => e
+      raise communication_error e
+    end
+
+    attr_reader :domain
+
+    private
+
+    # Raises CommunicationError and stores response in it if present
+    #
+    # @param [StandardException] e upstream exception object
+    def communication_error(e) # rubocop:disable Metrics/AbcSize
+      if e.respond_to? :response
+        code = e.response.code
+
+        return BadRequestError.new(e.message, e.response) if code == 400
+        return AuthenticationError.new(e.message, e.response) if code == 401
+        return NotFoundError.new(e.message, e.response) if code == 404
+        return RateLimitError.new(e.message, e.response) if code == 429
+
+        return CommunicationError.new(e.message, e.response)
+      end
+
+      CommunicationError.new(e.message)
+    end
+  end
+end

data/lib/improvmx/exceptions/exceptions.rb

@@ -0,0 +1,59 @@
+module Improvmx
+  class Error < StandardError
+    attr_reader :object
+
+    # Public: initialize a Improvmx:Error object
+    #
+    # message - a String describing the error
+    # object  - an object with details about the error
+    def initialize(message = nil, object = nil)
+      super(message)
+      @object = object
+    end
+  end
+
+  # Public: Class for managing communications (eg http) response errors
+  class CommunicationError < Error
+    attr_reader :code
+
+    # Public: initialization of new error given a message and/or object
+    #
+    # message  - a String detailing the error
+    # response - a RestClient::Response object
+    #
+    def initialize(message = nil, response = nil)
+      @response = response
+      @code = response.code
+
+      json = JSON.parse(response.body)
+      api_message = json['error'] || json['errors']
+
+      message ||= ''
+      message = "#{message} #{api_message}"
+
+      super(message, response)
+    rescue NoMethodError, JSON::ParserError
+      super(message, response)
+    end
+  end
+
+  class BadRequestError < CommunicationError
+  end
+
+  class AuthenticationError < CommunicationError
+  end
+
+  class NotFoundError < CommunicationError
+  end
+
+  class RateLimitError < CommunicationError
+    attr_reader :wait_seconds
+
+    def initialize(message = nil, response = nil)
+      super(message, response)
+
+      reset_at = response.headers[:x_ratelimit_reset]
+      @wait_seconds = reset_at.to_i - Time.now.to_i
+    end
+  end
+end

data/lib/improvmx/response.rb

@@ -0,0 +1,26 @@
+module Improvmx
+  # Ruby representation of ImprovMX response
+  class Response
+    attr_accessor :body, :code
+
+    def initialize(response)
+      @body = response.body
+      @code = response.code
+    end
+
+    # Return response as Ruby Hash
+    #
+    # @return [Hash] A standard Ruby Hash containing the HTTP result.
+    def to_h
+      JSON.parse(@body)
+    rescue StandardError => e
+      raise ParseError.new(e), e
+    end
+
+    attr_reader :headers
+
+    def ok?
+      @code == 200
+    end
+  end
+end

data/lib/improvmx/utils.rb

@@ -0,0 +1,15 @@
+require 'improvmx/aliases'
+require 'improvmx/response'
+require 'improvmx/exceptions/exceptions'
+
+module Improvmx
+  # Utils to help processing data
+  module Utils
+    # Parse the forward to parameter into a comma separated string
+    def forward(forward_to)
+      return forward_to.join(',') if forward_to.is_a? Array
+
+      forward_to
+    end
+  end
+end

data/lib/improvmx/version.rb

@@ -0,0 +1,3 @@
+module Improvmx
+  VERSION = '0.1.0'.freeze
+end

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification
+name: improvmx
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- C.S.V. Alpha
+- Matthijs Vos
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-03-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+description: Ruby interface for the ImprovMX API
+email: ict@csvalpha.nl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- improvmx.gemspec
+- lib/improvmx.rb
+- lib/improvmx/aliases.rb
+- lib/improvmx/client.rb
+- lib/improvmx/exceptions/exceptions.rb
+- lib/improvmx/response.rb
+- lib/improvmx/utils.rb
+- lib/improvmx/version.rb
+homepage: https://improvmx.com
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.4'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.8
+signing_key:
+specification_version: 4
+summary: Ruby interface for the ImprovMX API
+test_files: []