mxhero-api 1.2.3 → 1.2.8

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    NDZmOTU2YmQ5ZWI3MDgyYTU1ODdiMjc5ZTllMzY1MmJlMzEwZGMwNg==
-  data.tar.gz: !binary |-
-    YWViNTg2OTAxMGRhYTcwOWI3NjMyMGZjMDE3YmQ3NWZmZGM3MDQ2OQ==
+SHA1:
+  metadata.gz: 98333e3bb84f6ffadd098d5786d3ed69f25f8da4
+  data.tar.gz: 57e0eefff6ee290646606bd24fd0c664932c21e4
 SHA512:
-  metadata.gz: !binary |-
-    NjEwOWYyZTA2YjdjOWFjODMwZTVkOGEyYWMyOGU2NzYxMDRhM2E0M2FiYmQ4
-    MDc1OWZjNzY0N2RlN2Q3ZWYzZjE2NDZkYWIxZTAxYmIxZTJhODc4ZTA3OTIw
-    N2FkMGZlODEwMWMzOTk3YTViNGVjOGQxYWNlNTE1MjBiZGMxYTk=
-  data.tar.gz: !binary |-
-    NzdiNzA2YzQxNWIwZmQ2MTg1M2M3YjI4MzY1ZDgyMTBlY2E3MTFhNThkMWU0
-    NjY2ZDkzNTE5MzE2OTMwY2NhZjc3MWM4OTRhMTA5ZmM5MmU5ZWZiMzc5NGQ1
-    MWIxNjQyMjUzZTE1OTc0MWE1ZTJlYzJlMDU2YTI4N2ZiMWI5Yzg=
+  metadata.gz: d7750ef9ad95224f185224cb8545fd499548ba294c8a080b7052c179935fd9ceb6eedcc1599a92b3b5a6e5d62c01eb20661413006e6ff8176a5a09016d850604
+  data.tar.gz: 91197d516036befbfdddc77044184f294f58f479334b19ccb45b6d9d442d69df382f08d0fb1e34fdbf7e0ca320d1f6bc0932e9bd03e1e0b9999b58df271e0e33

data/VERSION

@@ -1 +1 @@
-1.2.3
+1.2.8

data/lib/communication.rb

@@ -1,6 +1,7 @@
 require 'httpclient'
 require 'json'
 require_relative 'response'
+require 'base64'
 
 module MxHero
   module API
@@ -15,7 +16,7 @@ module MxHero
       # @return [HTTP::Message](http://www.rubydoc.info/gems/httpclient/HTTP/Message)
       def call(method, url, body = nil, more_options = {})
         unless @client
-          @client ||= HTTPClient.new
+          @client ||= HTTPClient.new(:force_basic_auth => true)
         end
         @client.set_auth(url, @username, @password)
         response = @client.request(method, url, nil, body, headers)
@@ -28,7 +29,11 @@ module MxHero
 
       # Default headers
       def headers
-        @headers ||= { 'Accept' => 'application/json', 'Content-Type' => 'application/json' }
+        { 
+          'Accept' => 'application/json', 
+          'Content-Type' => 'application/json',
+          "Authorization" => "Basic " + ::Base64.encode64(@username + ':' + @password).gsub("\n",''),
+        }.merge(@as_user ? { "X-MxHero-As-User" => @as_user } : {})
       end
 
       # @return [Hash]

data/lib/directories.rb

@@ -98,12 +98,20 @@ module MxHero::API
 
     attr_reader :domain
 
+    # @param [String] domain
+    # @param [Hash] config the options of configuration
+    # @option config [String] :api_url The URL to consume the API
+    # @option config [String] :username The username for access the API
+    # @option config [String] :password The password for the user that access the API
+    # @option config [Boolean] :verbose (false) If true puts information about http operations
+    # @option config [String] :as_user Send to the API to indentify the end user (app user email)
     def initialize(domain, config = {})
       @domain       = domain
       @service_url  = config[:api_url]
       @username     = config[:username]
       @password     = config[:password]
       @verbose      = config[:verbose] || false
+      @as_user      = config[:as_user]
     end
 
 
@@ -178,7 +186,7 @@ module MxHero::API
     end
 
     def directories_url
-      domain_by_id_url(domain) + 'adldap'
+      domain_by_id_url(domain) + '/adldap'
     end
   end
 

data/lib/email-sync.rb

@@ -10,13 +10,19 @@ module MxHero::API
 		include Communication
 		include Urls
 
-		#attr_reader :domain
 
+		# @param [Hash] config the options of configuration
+		# @option config [String] :api_url The URL to consume the API
+		# @option config [String] :username The username for access the API
+		# @option config [String] :password The password for the user that access the API
+		# @option config [Boolean] :verbose (false) If true puts information about http operations
+		# @option config [String] :as_user Send to the API to indentify the end user (app user email)
 		def initialize(config = {})
 			@service_url = config[:api_url]
-			@username = config[:username]
-			@password = config[:password]
-			@verbose = config[:verbose] || false
+			@username    = config[:username]
+			@password    = config[:password]
+			@verbose     = config[:verbose] || false
+			@as_user     = config[:as_user]
 		end
 
 		def all(domain, params = {})

data/lib/groups.rb

@@ -2,7 +2,7 @@
 require_relative 'communication'
 require_relative 'urls'
 
-require 'open-uri' 
+require 'open-uri'
 require 'delegate'
 
 module MxHero::API
@@ -24,11 +24,12 @@ module MxHero::API
     attr_reader :domain
 
     def initialize(domain, config = {})
-      @domain = domain
+      @domain      = domain
       @service_url = config[:api_url]
-      @username = config[:username]
-      @password = config[:password]
-      @verbose = config[:verbose] || false
+      @username    = config[:username]
+      @password    = config[:password]
+      @verbose     = config[:verbose] || false
+      @as_user     = config[:as_user]
     end
 
     # Retrieve all the groups
@@ -36,7 +37,7 @@ module MxHero::API
     # @params pagination info. Ex.: page: 2, per_page: 10 or simple page: 2
     #
     # @return [PaginatedElement] that contains an array of Group elements
-    #   Basically its an Array with instances of [MxHero::API::Group] with the methods total_elements, total_pages and actual_page  
+    #   Basically its an Array with instances of [MxHero::API::Group] with the methods total_elements, total_pages and actual_page
     #
     def all(pagination = { page: nil, per_page: nil })
       response = call(:get, groups_url(pagination))
@@ -45,6 +46,12 @@ module MxHero::API
       end
     end
 
+    # Search available accounts
+    def search_accounts(term)
+      response = call(:get, search_accounts_url(term) ,nil, throw_exception: false)
+      Response.new(response.status, json_parse(response.content))
+    end
+
     # Save a new group
     #
     # @param group [MxHero::API::Group]
@@ -59,8 +66,8 @@ module MxHero::API
     #
     # @param group_name [String]
     #
-    # @return [MxHero::API::Response] with content empty. 
-    #   In case on error, may be one of the following: 
+    # @return [MxHero::API::Response] with content empty.
+    #   In case on error, may be one of the following:
     #     + domain.group.not.found : Inexistent group
     def delete(group_name)
       response = call(:delete, group_url(group_name), nil, throw_exception: false)
@@ -86,8 +93,8 @@ module MxHero::API
     # @param group_name [String]
     # @param account_name [String]
     #
-    # @return [MxHero::API::Response] with content empty. 
-    #   In case on error, may be one of the following: 
+    # @return [MxHero::API::Response] with content empty.
+    #   In case on error, may be one of the following:
     #     + domain.account.not.found                : Inexistent account
     #     + domain.group.account.already.has.group  : Try to add an account to a group when already is in that
     def add_account(group_name, account_name)
@@ -98,17 +105,17 @@ module MxHero::API
     # @param group_name [String]
     # @param account_name [String]
     #
-    # @return [MxHero::API::Response] with content empty. 
-    #   In case on error, may be one of the following: 
+    # @return [MxHero::API::Response] with content empty.
+    #   In case on error, may be one of the following:
     #     + domain.account.not.found            : Inexistent account
     #     + domain.group.account.not.in.group   : Try to remove an account that is not in the group
-    #     
+    #
     def remove_account(group_name, account_name)
       response = call(:delete, group_remove_accounts_url(group_name, account_name), nil, throw_exception: false)
       wrap_response_from response
     end
 
-    private 
+    private
 
     def paginate_wrap(response, &block)
       raise 'an error ocurred when try to communicate with the API' if response.status != 200
@@ -118,7 +125,7 @@ module MxHero::API
 
     def wrap_response_from(response)
       content = (200..299).include?(response.code) ? group_from(response) : json_parse(response.content)
-      Response.new(response.status, content) 
+      Response.new(response.status, content)
     end
 
     def group_from(response)
@@ -132,7 +139,7 @@ module MxHero::API
     end
 
     def groups_url(pagination = {})
-      domain_by_id_url(domain) + 'groups' + pagination_query(pagination)
+      domain_by_id_url(domain) + '/groups' + pagination_query(pagination)
     end
 
     def pagination_query(params = { page: nil, per_page: nil })
@@ -142,7 +149,7 @@ module MxHero::API
         section << "offset=#{params[:page]}"    if params[:page]
       end.join('&')
     end
-    
+
     def group_url(group_name)
       groups_url + "/#{URI::encode(group_name)}"
     end
@@ -154,10 +161,15 @@ module MxHero::API
     def group_add_accounts_url(group_name, account_name)
       group_accounts_url(group_name) + "/#{account_name}/add"
     end
-    
+
     def group_remove_accounts_url(group_name, account_name)
       group_accounts_url(group_name) + "/#{account_name}/remove"
     end
+
+    def search_accounts_url(term)
+      "#{groups_url}/accounts/available?account=#{term}"
+    end
+
   end
 
 

data/lib/mxhero-api.rb

@@ -30,11 +30,13 @@ module MxHero::API
 		# @option config [String] :username The username for access the API
 		# @option config [String] :password The password for the user that access the API
 		# @option config [Boolean] :verbose (false) If true puts information about http operations
+		# @option config [String] :as_user Send to the API to indentify the end user (app user email)
 		def initialize(config = {})
 			@service_url = config[:api_url]
 			@username = config[:username]
 			@password = config[:password]
 			@verbose = config[:verbose] || false
+			@as_user = config[:as_user]
 		end
 
 		# Expose directories api
@@ -42,7 +44,8 @@ module MxHero::API
 		# @return MxHero::API::Directories
 		def directories(domain)
 			@directories ||= Directories.new(domain, api_url: @service_url,
-																			 username: @username, password: @password, verbose: @verbose)
+																			 username: @username, password: @password,
+																			 verbose: @verbose, as_user: @as_user)
 		end
 
 		# Find a rule by domain and ID
@@ -502,7 +505,7 @@ module MxHero::API
 		# Validate if the an user and password match
 		#
 		def valid_user_credentials?(user, password)
-			validate_user_credential_url = user_url(user) + "password/#{password}"
+			validate_user_credential_url = user_url(user) + "/password/#{CGI::escape(password)}"
 			response = call(:get, validate_user_credential_url)
 			response.status == 204
 		end
@@ -560,11 +563,11 @@ module MxHero::API
 		end
 
 		def user_url(user)
-			users_url + "/#{user}/"
+			users_url + "/#{user}"
 		end
 
 		def user_domains_url(user)
-			user_url(user) + "domains"
+			user_url(user) + "/domains"
 		end
 
 		def users_for_domain_url(domain)
@@ -572,7 +575,7 @@ module MxHero::API
 		end
 
 		def user_with_domain_url(user,domain)
-			user_url(user) + "domains/#{domain}/"
+			user_url(user) + "/domains/#{domain}/"
 		end
 
 		def user_url_set_password(user,new_password)
@@ -648,7 +651,7 @@ module MxHero::API
 
 		def accounts_by_domain_url(domain, filter_account = nil)
 			filter = filter_account ? "?account=#{filter_account}" : ''
-			domain_by_id_url(domain) + 'accounts' + filter
+			domain_by_id_url(domain) + '/accounts' + filter
 		end
 
 		def domain_rule_url(domain, id)

data/lib/pst-converter.rb

@@ -14,9 +14,10 @@ module MxHero::API
 
     def initialize(config = {})
       @service_url = config[:api_url]
-      @username = config[:username]
-      @password = config[:password]
-      @verbose = config[:verbose] || false
+      @username    = config[:username]
+      @password    = config[:password]
+      @verbose     = config[:verbose] || false
+      @as_user     = config[:as_user]
     end
 
     # Retrieve all tasks for {account} in status {status}

data/lib/urls.rb

@@ -5,15 +5,15 @@ module MxHero
       def service_url
         @service_url
       end
-      
+
       def domains_url
         service_url + '/domains'
       end
 
       def domain_by_id_url(domain)
-        domains_url + "/#{domain}/"
+        domains_url + "/#{domain}"
       end
-    
+
     end
   end
 end

data/mxhero-api.gemspec

@@ -1,23 +1,23 @@
 # -*- encoding: utf-8 -*-
-# stub: mxhero-api 1.2.3 ruby lib
+# stub: mxhero-api 1.2.8 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "mxhero-api"
-  s.version = "1.2.3"
+  s.version = "1.2.8"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.require_paths = ["lib"]
   s.authors = ["Maximiliano Dello Russo", "Juan Pablo Royo", "mxHero"]
-  s.date = "2017-01-31"
+  s.date = "2020-05-27"
   s.description = "A gem to provide easy access to the API of MxHero platform (http://www.mxhero.com/)"
   s.email = ["maxidr@mxhero.com", "juanpablo.royo@gmail.com", "mxhero@mxhero.com"]
-  s.files = [".gitignore", ".ruby-gemset", ".ruby-version", "Gemfile", "LICENSE.txt", "README.md", "Rakefile", "VERSION", "lib/communication.rb", "lib/directories.rb", "lib/dto.rb", "lib/email-sync.rb", "lib/groups.rb", "lib/mxhero-api.rb", "lib/pst-converter.rb", "lib/resource.rb", "lib/resources/account.rb", "lib/resources/domain.rb", "lib/resources/group.rb", "lib/response.rb", "lib/urls.rb", "mxhero-api.gemspec", "test/fixtures/api/account_properties.yml", "test/fixtures/api/account_properties_not_found.yml", "test/fixtures/api/accounts.yml", "test/fixtures/api/accounts_filtered.yml", "test/fixtures/api/accounts_from_domain.yml", "test/fixtures/api/accounts_from_domain_paginated.yml", "test/fixtures/api/accounts_without_group.yml", "test/fixtures/api/add_an_inexistent_account_to_group.yml", "test/fixtures/api/add_and_remove_account.yml", "test/fixtures/api/add_feature.yml", "test/fixtures/api/all_groups.yml", "test/fixtures/api/associate_user_domain.yml", "test/fixtures/api/create_directory.yml", "test/fixtures/api/create_domain.yml", "test/fixtures/api/create_rule_for_domain.yml", "test/fixtures/api/create_user.yml", "test/fixtures/api/delete_directory.yml", "test/fixtures/api/delete_group.yml", "test/fixtures/api/delete_rule.yml", "test/fixtures/api/domain_by_id.yml", "test/fixtures/api/domain_by_id_not_found.yml", "test/fixtures/api/domain_rule.yml", "test/fixtures/api/domains.yml", "test/fixtures/api/emailsync_delete.yml", "test/fixtures/api/emailsync_fetch_all.yml", "test/fixtures/api/emailsync_task_by_id.yml", "test/fixtures/api/fetch_directory.yml", "test/fixtures/api/fetch_user.yml", "test/fixtures/api/ldap_info.yml", "test/fixtures/api/move_to_trial.yml", "test/fixtures/api/pst_inactive_tasks.yml", "test/fixtures/api/refresh_directory.yml", "test/fixtures/api/remove_account_from_group_twice.yml", "test/fixtures/api/remove_inexistente_account_from_group.yml", "test/fixtures/api/rule_status.yml", "test/fixtures/api/rules_for_domain.yml", "test/fixtures/api/rules_for_domain_by_component.yml", "test/fixtures/api/save_group.yml", "test/fixtures/api/system_properties.yml", "test/fixtures/api/system_properties_create.yml", "test/fixtures/api/system_properties_element.yml", "test/fixtures/api/test_domain.yml", "test/fixtures/api/update_account_properties.yml", "test/fixtures/api/update_accounts_group_scope.yml", "test/fixtures/api/update_accounts_properties_scope.yml", "test/fixtures/api/update_directory.yml", "test/fixtures/api/update_rule.yml", "test/fixtures/api/update_user.yml", "test/fixtures/api/user_domains.yml", "test/fixtures/api/users_for_domain.yml", "test/fixtures/api/validate_user_credential.yml", "test/fixtures/domain.rb", "test/helper.rb", "test/test_directories.rb", "test/test_domain.rb", "test/test_dto.rb", "test/test_emailsync.rb", "test/test_feature.rb", "test/test_groups.rb", "test/test_mxhero_api.rb", "test/test_mxhero_api_response.rb", "test/test_pst-converter.rb", "test/test_resource.rb"]
+  s.files = [".gitignore", ".ruby-gemset", ".ruby-version", "Gemfile", "LICENSE.txt", "README.md", "Rakefile", "VERSION", "lib/communication.rb", "lib/directories.rb", "lib/dto.rb", "lib/email-sync.rb", "lib/groups.rb", "lib/mxhero-api.rb", "lib/pst-converter.rb", "lib/resource.rb", "lib/resources/account.rb", "lib/resources/domain.rb", "lib/resources/group.rb", "lib/response.rb", "lib/urls.rb", "mxhero-api.gemspec", "test/fixtures/api/account_properties.yml", "test/fixtures/api/account_properties_not_found.yml", "test/fixtures/api/accounts.yml", "test/fixtures/api/accounts_filtered.yml", "test/fixtures/api/accounts_from_domain.yml", "test/fixtures/api/accounts_from_domain_paginated.yml", "test/fixtures/api/accounts_without_group.yml", "test/fixtures/api/add_an_inexistent_account_to_group.yml", "test/fixtures/api/add_and_remove_account.yml", "test/fixtures/api/add_feature.yml", "test/fixtures/api/all_groups.yml", "test/fixtures/api/associate_user_domain.yml", "test/fixtures/api/create_directory.yml", "test/fixtures/api/create_domain.yml", "test/fixtures/api/create_rule_for_domain.yml", "test/fixtures/api/create_user.yml", "test/fixtures/api/delete_directory.yml", "test/fixtures/api/delete_group.yml", "test/fixtures/api/delete_rule.yml", "test/fixtures/api/domain_by_id.yml", "test/fixtures/api/domain_by_id_not_found.yml", "test/fixtures/api/domain_rule.yml", "test/fixtures/api/domains.yml", "test/fixtures/api/emailsync_delete.yml", "test/fixtures/api/emailsync_fetch_all.yml", "test/fixtures/api/emailsync_task_by_id.yml", "test/fixtures/api/fetch_directory.yml", "test/fixtures/api/fetch_user.yml", "test/fixtures/api/ldap_info.yml", "test/fixtures/api/move_to_trial.yml", "test/fixtures/api/pst_inactive_tasks.yml", "test/fixtures/api/refresh_directory.yml", "test/fixtures/api/remove_account_from_group_twice.yml", "test/fixtures/api/remove_inexistente_account_from_group.yml", "test/fixtures/api/rule_status.yml", "test/fixtures/api/rules_for_domain.yml", "test/fixtures/api/rules_for_domain_by_component.yml", "test/fixtures/api/save_group.yml", "test/fixtures/api/search_accounts_starts_with_a.yml", "test/fixtures/api/search_accounts_starts_with_ab.yml", "test/fixtures/api/system_properties.yml", "test/fixtures/api/system_properties_create.yml", "test/fixtures/api/system_properties_element.yml", "test/fixtures/api/test_domain.yml", "test/fixtures/api/update_account_properties.yml", "test/fixtures/api/update_accounts_group_scope.yml", "test/fixtures/api/update_accounts_properties_scope.yml", "test/fixtures/api/update_directory.yml", "test/fixtures/api/update_rule.yml", "test/fixtures/api/update_user.yml", "test/fixtures/api/user_domains.yml", "test/fixtures/api/users_for_domain.yml", "test/fixtures/api/validate_user_credential.yml", "test/fixtures/domain.rb", "test/helper.rb", "test/test_directories.rb", "test/test_domain.rb", "test/test_dto.rb", "test/test_emailsync.rb", "test/test_feature.rb", "test/test_groups.rb", "test/test_mxhero_api.rb", "test/test_mxhero_api_response.rb", "test/test_pst-converter.rb", "test/test_resource.rb"]
   s.homepage = "http://github.com/mxhero/mxhero-api"
   s.licenses = ["GPL-3"]
-  s.require_paths = ["lib"]
   s.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
-  s.rubygems_version = "2.1.9"
+  s.rubygems_version = "2.5.1"
   s.summary = "A MxHero API client for ruby"
-  s.test_files = ["test/fixtures/api/account_properties.yml", "test/fixtures/api/account_properties_not_found.yml", "test/fixtures/api/accounts.yml", "test/fixtures/api/accounts_filtered.yml", "test/fixtures/api/accounts_from_domain.yml", "test/fixtures/api/accounts_from_domain_paginated.yml", "test/fixtures/api/accounts_without_group.yml", "test/fixtures/api/add_an_inexistent_account_to_group.yml", "test/fixtures/api/add_and_remove_account.yml", "test/fixtures/api/add_feature.yml", "test/fixtures/api/all_groups.yml", "test/fixtures/api/associate_user_domain.yml", "test/fixtures/api/create_directory.yml", "test/fixtures/api/create_domain.yml", "test/fixtures/api/create_rule_for_domain.yml", "test/fixtures/api/create_user.yml", "test/fixtures/api/delete_directory.yml", "test/fixtures/api/delete_group.yml", "test/fixtures/api/delete_rule.yml", "test/fixtures/api/domain_by_id.yml", "test/fixtures/api/domain_by_id_not_found.yml", "test/fixtures/api/domain_rule.yml", "test/fixtures/api/domains.yml", "test/fixtures/api/emailsync_delete.yml", "test/fixtures/api/emailsync_fetch_all.yml", "test/fixtures/api/emailsync_task_by_id.yml", "test/fixtures/api/fetch_directory.yml", "test/fixtures/api/fetch_user.yml", "test/fixtures/api/ldap_info.yml", "test/fixtures/api/move_to_trial.yml", "test/fixtures/api/pst_inactive_tasks.yml", "test/fixtures/api/refresh_directory.yml", "test/fixtures/api/remove_account_from_group_twice.yml", "test/fixtures/api/remove_inexistente_account_from_group.yml", "test/fixtures/api/rule_status.yml", "test/fixtures/api/rules_for_domain.yml", "test/fixtures/api/rules_for_domain_by_component.yml", "test/fixtures/api/save_group.yml", "test/fixtures/api/system_properties.yml", "test/fixtures/api/system_properties_create.yml", "test/fixtures/api/system_properties_element.yml", "test/fixtures/api/test_domain.yml", "test/fixtures/api/update_account_properties.yml", "test/fixtures/api/update_accounts_group_scope.yml", "test/fixtures/api/update_accounts_properties_scope.yml", "test/fixtures/api/update_directory.yml", "test/fixtures/api/update_rule.yml", "test/fixtures/api/update_user.yml", "test/fixtures/api/user_domains.yml", "test/fixtures/api/users_for_domain.yml", "test/fixtures/api/validate_user_credential.yml", "test/fixtures/domain.rb", "test/helper.rb", "test/test_directories.rb", "test/test_domain.rb", "test/test_dto.rb", "test/test_emailsync.rb", "test/test_feature.rb", "test/test_groups.rb", "test/test_mxhero_api.rb", "test/test_mxhero_api_response.rb", "test/test_pst-converter.rb", "test/test_resource.rb"]
+  s.test_files = ["test/fixtures/api/account_properties.yml", "test/fixtures/api/account_properties_not_found.yml", "test/fixtures/api/accounts.yml", "test/fixtures/api/accounts_filtered.yml", "test/fixtures/api/accounts_from_domain.yml", "test/fixtures/api/accounts_from_domain_paginated.yml", "test/fixtures/api/accounts_without_group.yml", "test/fixtures/api/add_an_inexistent_account_to_group.yml", "test/fixtures/api/add_and_remove_account.yml", "test/fixtures/api/add_feature.yml", "test/fixtures/api/all_groups.yml", "test/fixtures/api/associate_user_domain.yml", "test/fixtures/api/create_directory.yml", "test/fixtures/api/create_domain.yml", "test/fixtures/api/create_rule_for_domain.yml", "test/fixtures/api/create_user.yml", "test/fixtures/api/delete_directory.yml", "test/fixtures/api/delete_group.yml", "test/fixtures/api/delete_rule.yml", "test/fixtures/api/domain_by_id.yml", "test/fixtures/api/domain_by_id_not_found.yml", "test/fixtures/api/domain_rule.yml", "test/fixtures/api/domains.yml", "test/fixtures/api/emailsync_delete.yml", "test/fixtures/api/emailsync_fetch_all.yml", "test/fixtures/api/emailsync_task_by_id.yml", "test/fixtures/api/fetch_directory.yml", "test/fixtures/api/fetch_user.yml", "test/fixtures/api/ldap_info.yml", "test/fixtures/api/move_to_trial.yml", "test/fixtures/api/pst_inactive_tasks.yml", "test/fixtures/api/refresh_directory.yml", "test/fixtures/api/remove_account_from_group_twice.yml", "test/fixtures/api/remove_inexistente_account_from_group.yml", "test/fixtures/api/rule_status.yml", "test/fixtures/api/rules_for_domain.yml", "test/fixtures/api/rules_for_domain_by_component.yml", "test/fixtures/api/save_group.yml", "test/fixtures/api/search_accounts_starts_with_a.yml", "test/fixtures/api/search_accounts_starts_with_ab.yml", "test/fixtures/api/system_properties.yml", "test/fixtures/api/system_properties_create.yml", "test/fixtures/api/system_properties_element.yml", "test/fixtures/api/test_domain.yml", "test/fixtures/api/update_account_properties.yml", "test/fixtures/api/update_accounts_group_scope.yml", "test/fixtures/api/update_accounts_properties_scope.yml", "test/fixtures/api/update_directory.yml", "test/fixtures/api/update_rule.yml", "test/fixtures/api/update_user.yml", "test/fixtures/api/user_domains.yml", "test/fixtures/api/users_for_domain.yml", "test/fixtures/api/validate_user_credential.yml", "test/fixtures/domain.rb", "test/helper.rb", "test/test_directories.rb", "test/test_domain.rb", "test/test_dto.rb", "test/test_emailsync.rb", "test/test_feature.rb", "test/test_groups.rb", "test/test_mxhero_api.rb", "test/test_mxhero_api_response.rb", "test/test_pst-converter.rb", "test/test_resource.rb"]
 
   if s.respond_to? :specification_version then
     s.specification_version = 4

data/test/fixtures/api/search_accounts_starts_with_a.yml

@@ -0,0 +1,34 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://admin:password@test.mxhero.com/webapi/api/v1/domains/tesla.com/groups/accounts/available?account=a
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - application/json
+      Content-Type:
+      - application/json
+      Authorization:
+      - Basic YWRtaW46cGFzc3dvcmQ=
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - Apache-Coyote/1.1
+      Content-Type:
+      - application/json
+      Transfer-Encoding:
+      - chunked
+      Date:
+      - Tue, 06 Jun 2017 15:17:42 GMT
+    body:
+      encoding: UTF-8
+      string: '{"totalElements":3,"totalPages":1,"actualPage":1,"elements":[{"account":"abuse","domain":"mxhero.com","createdDate":1395439948000,"updatedDate":1465322769000,"group":null,"dataSource":"manual","isEmailList":true,"aliases":[{"name":"abuse","domain":"mail2box.io","dataSource":"manual"},{"name":"abuse","domain":"mail2cloud.io","dataSource":"manual"},{"name":"abuse","domain":"mxhero.com","dataSource":"manual"},{"name":"abuse","domain":"mxhero.net","dataSource":"manual"},{"name":"abuse","domain":"mxheromail.com","dataSource":"manual"}],"properties":null},{"account":"antonio","domain":"mxhero.com","createdDate":1465308356000,"updatedDate":1465322769000,"group":null,"dataSource":"manual","isEmailList":false,"aliases":[{"name":"antonio","domain":"mail2box.io","dataSource":"manual"},{"name":"antonio","domain":"mail2cloud.io","dataSource":"manual"},{"name":"antonio","domain":"mxhero.com","dataSource":"manual"},{"name":"antonio","domain":"mxhero.net","dataSource":"manual"},{"name":"antonio","domain":"mxheromail.com","dataSource":"manual"},{"name":"antoniodelaheria","domain":"mail2box.io","dataSource":"manual"},{"name":"antoniodelaheria","domain":"mail2cloud.io","dataSource":"manual"},{"name":"antoniodelaheria","domain":"mxhero.com","dataSource":"manual"},{"name":"antoniodelaheria","domain":"mxhero.net","dataSource":"manual"},{"name":"antoniodelaheria","domain":"mxheromail.com","dataSource":"manual"}],"properties":null},{"account":"archive","domain":"mxhero.com","createdDate":1395439948000,"updatedDate":1465322769000,"group":null,"dataSource":"manual","isEmailList":true,"aliases":[{"name":"archive","domain":"mail2box.io","dataSource":"manual"},{"name":"archive","domain":"mail2cloud.io","dataSource":"manual"},{"name":"archive","domain":"mxhero.com","dataSource":"manual"},{"name":"archive","domain":"mxhero.net","dataSource":"manual"},{"name":"archive","domain":"mxheromail.com","dataSource":"manual"}],"properties":null}]}'
+    http_version: 
+  recorded_at: Tue, 06 Jun 2017 15:17:42 GMT
+recorded_with: VCR 3.0.1

data/test/fixtures/api/search_accounts_starts_with_ab.yml

@@ -0,0 +1,34 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://admin:password@test.mxhero.com/webapi/api/v1/domains/tesla.com/groups/accounts/available?account=ab
+    body:
+      encoding: UTF-8
+      string: ''
+    headers:
+      Accept:
+      - application/json
+      Content-Type:
+      - application/json
+      Authorization:
+      - Basic YWRtaW46cGFzc3dvcmQ=
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - Apache-Coyote/1.1
+      Content-Type:
+      - application/json
+      Transfer-Encoding:
+      - chunked
+      Date:
+      - Tue, 06 Jun 2017 15:20:32 GMT
+    body:
+      encoding: UTF-8
+      string: '{"totalElements":1,"totalPages":1,"actualPage":1,"elements":[{"account":"abuse","domain":"mxhero.com","createdDate":1395439948000,"updatedDate":1465322769000,"group":null,"dataSource":"manual","isEmailList":true,"aliases":[{"name":"abuse","domain":"mail2box.io","dataSource":"manual"},{"name":"abuse","domain":"mail2cloud.io","dataSource":"manual"},{"name":"abuse","domain":"mxhero.com","dataSource":"manual"},{"name":"abuse","domain":"mxhero.net","dataSource":"manual"},{"name":"abuse","domain":"mxheromail.com","dataSource":"manual"}],"properties":null}]}'
+    http_version: 
+  recorded_at: Tue, 06 Jun 2017 15:20:32 GMT
+recorded_with: VCR 3.0.1

data/test/test_directories.rb

@@ -116,7 +116,7 @@ class DirectoriesTest < MiniTest::Test
       override: true, dn_authenticate: 'dn_autheticate message'
     }
     directory.update_properties changes
-    changes.keys.each { |prop| assert_equal changes[prop], directory.send(prop) }
+    changes.keys.each { |prop| assert_equal(changes[prop], directory.send(prop)) }
   end
 
   def test_initialize_properties

data/test/test_groups.rb

@@ -120,5 +120,21 @@ class GroupsTest < Minitest::Test
     assert_equal '?limit=10&offset=2', @groups.send(:pagination_query, per_page: 10, page: 2)
   end
 
+	def test_search_accounts
+		VCR.use_cassette('search_accounts_starts_with_a') do
+			response = @groups.search_accounts('a')
+			assert response.success?
+			assert_equal 3, response.msg[:totalElements]
+			assert_equal [ 'abuse', 'antonio', 'archive' ], response.msg[:elements].map { |e| e[:account] }
+		end
+
+		VCR.use_cassette('search_accounts_starts_with_ab') do
+			response = @groups.search_accounts('ab')
+			assert response.success?
+			assert_equal 1, response.msg[:totalElements]
+			assert_equal [ 'abuse' ], response.msg[:elements].map { |e| e[:account] }
+		end
+	end
+
 end
 

data/test/test_mxhero_api.rb

@@ -3,7 +3,7 @@ require_relative 'helper'
 class MxHeroAPITest < Minitest::Test
 
   def setup
-    @api = MxHero::API::Client.new(username: TEST_API_USER, password: TEST_API_PASSWORD, verbose: false, api_url: TEST_API_URL)
+    @api = MxHero::API::Client.new(username: TEST_API_USER, password: TEST_API_PASSWORD, verbose: false, api_url: TEST_API_URL, as_user: 'tester@mxhero.com')
   end
 
   def domain
@@ -18,6 +18,7 @@ class MxHeroAPITest < Minitest::Test
     assert api.verbose?, 'Verbose state must be changed'
   end
 
+
   def test_update_rule
     VCR.use_cassette('update_rule') do
       rules = obtain_rules(domain)
@@ -35,6 +36,7 @@ class MxHeroAPITest < Minitest::Test
     end
   end
 
+=begin
   def test_rule_status
     VCR.use_cassette('rule_status') do
       mx_domain = 'mxhero.com'
@@ -169,7 +171,7 @@ class MxHeroAPITest < Minitest::Test
   def test_delete_rule
     VCR.use_cassette('delete_rule') do
       rules = obtain_rules(domain)
-      one_rule = rules.first      
+      one_rule = rules.first
       response = @api.delete_rule(domain, one_rule[:id])
       assert response
     end
@@ -423,7 +425,7 @@ class MxHeroAPITest < Minitest::Test
       refute @api.valid_user_credentials?('inexistent.user', 'xxx')
     end
   end
-
+=end
   private
   
   def delete_all_rules

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mxhero-api
 version: !ruby/object:Gem::Version
-  version: 1.2.3
+  version: 1.2.8
 platform: ruby
 authors:
 - Maximiliano Dello Russo
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-31 00:00:00.000000000 Z
+date: 2020-05-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: vcr
@@ -63,9 +63,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .ruby-gemset
-- .ruby-version
+- ".gitignore"
+- ".ruby-gemset"
+- ".ruby-version"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -123,6 +123,8 @@ files:
 - test/fixtures/api/rules_for_domain.yml
 - test/fixtures/api/rules_for_domain_by_component.yml
 - test/fixtures/api/save_group.yml
+- test/fixtures/api/search_accounts_starts_with_a.yml
+- test/fixtures/api/search_accounts_starts_with_ab.yml
 - test/fixtures/api/system_properties.yml
 - test/fixtures/api/system_properties_create.yml
 - test/fixtures/api/system_properties_element.yml
@@ -158,17 +160,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.9
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: A MxHero API client for ruby
@@ -211,6 +213,8 @@ test_files:
 - test/fixtures/api/rules_for_domain.yml
 - test/fixtures/api/rules_for_domain_by_component.yml
 - test/fixtures/api/save_group.yml
+- test/fixtures/api/search_accounts_starts_with_a.yml
+- test/fixtures/api/search_accounts_starts_with_ab.yml
 - test/fixtures/api/system_properties.yml
 - test/fixtures/api/system_properties_create.yml
 - test/fixtures/api/system_properties_element.yml