improvmx 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6d7859f7b94f30a8fd712321821172498e179e1de7a8a5e893e46a3f131339b1
-  data.tar.gz: c468089b24a881419a854ef0cb2ef7597342f77789304f61293d2b1ff1e134dd
+  metadata.gz: 1beb2bc2f4cde29fb6ad32bf378c9ec8df1e9038e182af63d52cf825b9ef040a
+  data.tar.gz: b94c1f17643079e3b8db5392099d3983780e2a9d2efd31d00e52fe92ae8c3de1
 SHA512:
-  metadata.gz: 54a26c1b99e2eb1136b07d12026b5ffb73fd5900fd61d7658a634d71e711cc8535741f8c6f4756012b8e114246768a712f13445fef809bd6d1c2726b228a08f1
-  data.tar.gz: eed54722a9f29bbaa8d1c7c73b60184d95ec1af7ea13c41e786ff9074d0b30e36f6979eccaf149f8c104cf833147f1fc2944c9eddd1b8af0d0190c21f11e0ace
+  metadata.gz: c59717e47ade074c19e188e6e8106d125e2245097851a65347980dfcfda30eab9c25f429242bc53b69b5d32e6d180b60ddcc9e30bd466048b75af36bebb4d672
+  data.tar.gz: 32a7c975cef2ad65c894de582b2b33e15dfc01fd8bb84fe580f149018f606abf7758ef2313985a17c8c8b1841abe97656c86378625a0841bcadba563ada5b147

data/README.md

@@ -21,14 +21,28 @@ This is how you can use this gem
 require 'improvmx'
 
 # Instantiate the Client with your API key and domain
-client = Improvmx::Client.new 'your-api-key', 'domain.com'
+client = Improvmx::Client.new 'your-api-key'
 
 # List all the aliases
-aliases = client.list_aliases
+aliases = client.list_aliases('domain.com')
 
 puts aliases['aliases']
 ```
 
+Improvmx has a rate limit system, to handle this you can do
+```ruby
+require 'improvmx'
+client = Improvmx::Client.new 'your-api-key'
+
+begin
+  client.list_aliases('domain.com')
+rescue Improvmx::RateLimitError => e
+  sleep e.wait_seconds
+  retry
+end
+
+```
+
 Rails
 -----
 
@@ -64,4 +78,4 @@ This part is for maintaincers only. In order to deploy this gem to rubygem follo
 
 1. Bump the version in `lib/improvmx/version.rb`
 1. Build the gem using `gem build improvmx.gemspec`
-1. 
+1. Push it to rubygems `gem push improvmx-x.x.x.gem`

data/improvmx.gemspec

@@ -16,5 +16,5 @@ Gem::Specification.new do |spec|
   spec.require_paths = %w[lib]
 
   spec.required_ruby_version = '>= 2.4'
-  spec.add_dependency 'rest-client', '>= 2.0.2'
+  spec.add_dependency 'rest-client', '~> 2.0'
 end

data/lib/improvmx.rb

@@ -8,7 +8,7 @@ require 'improvmx/exceptions/exceptions'
 # Module for interaction with Improvmx
 module Improvmx
   class << self
-    attr_accessor :api_key, :domain
+    attr_accessor :api_key
 
     def configure
       yield self

data/lib/improvmx/aliases.rb

@@ -1,23 +1,23 @@
 module Improvmx
   # All alias related endpoints
   module Aliases
-    def list_aliases(params = {})
+    def list_aliases(domain, params = {})
       get("/domains/#{domain}/aliases/", params).to_h
     end
 
-    def get_alias(alias_name)
+    def get_alias(alias_name, domain)
       get("/domains/#{domain}/aliases/#{alias_name}")
     rescue NotFoundError
       nil
     end
 
-    def create_alias(alias_name, forward_to)
+    def create_alias(alias_name, forward_to, domain)
       response = post("/domains/#{domain}/aliases/", { alias: alias_name, forward: forward(forward_to) })
 
       response.ok?
     end
 
-    def update_alias(alias_name, forward_to)
+    def update_alias(alias_name, forward_to, domain)
       response = put("/domains/#{domain}/aliases/#{alias_name}", { forward: forward(forward_to) })
 
       response.ok?
@@ -25,13 +25,12 @@ module Improvmx
       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)
+    def create_or_update_alias(alias_name, forward_to, domain)
+      return true if update_alias(alias_name, forward_to, domain)
+      create_alias(alias_name, forward_to, domain)
     end
 
-    def delete_alias(alias_name)
+    def delete_alias(alias_name, domain)
       response = delete("/domains/#{domain}/aliases/#{alias_name}")
 
       response.ok?

data/lib/improvmx/client.rb

@@ -8,7 +8,7 @@ module Improvmx
     include Improvmx::Aliases
     include Improvmx::Utils
 
-    def initialize(api_key = Improvmx.api_key, domain = Improvmx.domain)
+    def initialize(api_key = Improvmx.api_key)
       rest_client_params = {
         user: 'api',
         password: api_key,
@@ -16,17 +16,8 @@ module Improvmx
       }
 
       @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)
@@ -34,14 +25,6 @@ module Improvmx
       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)
@@ -49,13 +32,6 @@ module Improvmx
       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)
@@ -63,11 +39,6 @@ module Improvmx
       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)
@@ -75,13 +46,8 @@ module Improvmx
       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

data/lib/improvmx/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: improvmx
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - C.S.V. Alpha
@@ -15,16 +15,16 @@ dependencies:
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.2
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.2
+        version: '2.0'
 description: Ruby interface for the ImprovMX API
 email: ict@csvalpha.nl
 executables: []
@@ -60,7 +60,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.8
+rubygems_version: 3.2.14
 signing_key:
 specification_version: 4
 summary: Ruby interface for the ImprovMX API