mxhero-api 0.1.15 → 0.1.16

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ZTkxYTllMDVlMDk4ZjdiZmFjMGY3N2E4Y2FmMTUwYTI2NTFjMzhmMA==
+  data.tar.gz: !binary |-
+    YTNlM2I1MmVmMzViMjJiMjZmZThjMjg1YmEzNmEwZmVlYzllYjQyZg==
+SHA512:
+  metadata.gz: !binary |-
+    MjU2M2MzYTAwZDViODMwZGYzYjJiMjY4MWE4NTQyN2NmM2E0N2IzN2UwNzEy
+    NjQ4YWQ2YjAyYjA3OGI3NzMyODA1NzlmYmEwZmVkMDZhNWY5YzQ3YzdmMDU4
+    OWU0MmU4YjY2NDVlMTAzMGUxMjc4NWRiNTQxZTRlOTI2NWJjNjA=
+  data.tar.gz: !binary |-
+    YmFjOTBmZmU0Yjk2NmI0ZDYwMjA0ZTE5NmM0OWRjOTdhMGU0ODI2NGE3MThl
+    YjFjZGJjM2IzNGYxYmViYzYxZjJlN2U3NTg2MWUyZjVlMWU4N2MyY2ZkMzA4
+    YjkxMDc3MDZhNTRkYmI2NmRkZjMyMjliNTlhMTg1Yjc2ODkzYjg=

data/VERSION

@@ -1 +1 @@
-0.1.15
+0.1.16

data/lib/mxhero-api.rb

@@ -129,25 +129,54 @@ module MxHero::API
       response_as_a_hash 
     end
 
-    # Retrive the domain by id according to the parameter if exist
-    #
-    # @param id The domain name or id. For example: 'mydomain.com'
+    
+    # Retrive the domain information 
+    # 
+    # @param name The domain name or id. For example: 'mydomain.com'
     # @return [Hash] with the domain attributes if exist
     #   * :domain [String]
     #   * :server [String]
     #   * :creationDate [Fixnum]
     #   * :updateDate [Fixnum]
-    #   * :aliases 
+    #   * :aliases [Array<String>]
     #   * :ldap
-    # @raise an exception when the status code is one of the 5xx status error
-    # @raise an exception if @param id is nil
-    def domain_by_id(id = nil)
-      raise 'Id domain could not be nil' if id.nil?
-      response = call(:get, domain_by_id_url(id))
-      response_as_a_hash = json_parse(response.content)
-      response_as_a_hash 
+    #   
+    #   Or nil if not found
+    #
+    # @raise an exception when the status code is not 200 (ok) or 404 (not found)
+    #
+    def domain(name)
+      fetch domain_by_id_url(name), 
+           on_error: "An error ocurred when try to fetch the domain #{name}."
+    end
+
+
+    # Fetch the LDAP information of the domain
+    #
+    # @return [Hash] with
+    #   * :domain
+    #   * :directoryType
+    #   * :addres
+    #   * :port
+    #   * :sslFlag [Boolean]
+    #   * :user 
+    #   * :password
+    #   * :filter
+    #   * :base
+    #   * :nextUpdate
+    #   * :lastUpdate
+    #   * :error
+    #   * :overrideFlag
+    #   * :dnAuthenticate
+    #   * :properties [Array]
+    #
+    def ldap_info(domain)
+      fetch domain_by_id_url(domain) + '/adldap',
+        on_error: "An error was ocurred when try to fecht the ldap information of #{domain}"
     end
 
+
+
     #
     # Retrive all the account from one domain
     #
@@ -318,6 +347,24 @@ module MxHero::API
     # --------------------------------------------------------------------------------------------------------------------------------
     private
     
+    # Fetch an element from an URL. That element maybe not found
+    # @return a Hash when the element exist. Or return nil when not found.
+    #
+    # @raise RuntimeError when an error ocurrs.
+    def fetch(url, msg)
+      response = call(:get, url)
+      return json_parse(response.content) if response.ok?
+      return nil if response.code == 404
+     
+      error = msg[:on_error] + " HTTP code: #{response.code}"
+      if response.content.include?('message')
+        hash = json_parse(response.content)
+        error << " Response message: #{hash[:message]}"
+      end
+ 
+      raise error
+    end
+    
     def remap_properties(properties)
       return nil if properties.nil?
       properties.keys.map { |name| { name: name, value: properties[name] } }

data/mxhero-api.gemspec

@@ -1,24 +1,25 @@
 # -*- encoding: utf-8 -*-
+# stub: mxhero-api 0.1.16 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "mxhero-api"
-  s.version = "0.1.15"
+  s.version = "0.1.16"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Maximiliano Dello Russo", "Juan Pablo Royo", "mxHero"]
-  s.date = "2013-10-01"
+  s.date = "2013-10-21"
   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", ".rvmrc", "Gemfile", "LICENSE.txt", "README.md", "Rakefile", "VERSION", "lib/communication.rb", "lib/dto.rb", "lib/groups.rb", "lib/mxhero-api.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/all_groups.yml", "test/fixtures/api/create_rule_for_domain.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/remove_account_from_group_twice.yml", "test/fixtures/api/remove_inexistente_account_from_group.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/update_account_properties.yml", "test/fixtures/api/update_accounts_group_scope.yml", "test/fixtures/api/update_accounts_properties_scope.yml", "test/fixtures/api/update_rule.yml", "test/helper.rb", "test/test_dto.rb", "test/test_groups.rb", "test/test_mxhero_api.rb", "test/test_mxhero_api_response.rb"]
+  s.files = [".gitignore", ".rvmrc", "Gemfile", "LICENSE.txt", "README.md", "Rakefile", "VERSION", "lib/communication.rb", "lib/dto.rb", "lib/groups.rb", "lib/mxhero-api.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/all_groups.yml", "test/fixtures/api/create_rule_for_domain.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/ldap_info.yml", "test/fixtures/api/remove_account_from_group_twice.yml", "test/fixtures/api/remove_inexistente_account_from_group.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/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_rule.yml", "test/helper.rb", "test/test_dto.rb", "test/test_groups.rb", "test/test_mxhero_api.rb", "test/test_mxhero_api_response.rb"]
   s.homepage = "http://github.com/mxhero/mxhero-api"
   s.licenses = ["GPL-3"]
   s.require_paths = ["lib"]
-  s.rubygems_version = "1.8.25"
+  s.rubygems_version = "2.1.9"
   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/all_groups.yml", "test/fixtures/api/create_rule_for_domain.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/remove_account_from_group_twice.yml", "test/fixtures/api/remove_inexistente_account_from_group.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/update_account_properties.yml", "test/fixtures/api/update_accounts_group_scope.yml", "test/fixtures/api/update_accounts_properties_scope.yml", "test/fixtures/api/update_rule.yml", "test/helper.rb", "test/test_dto.rb", "test/test_groups.rb", "test/test_mxhero_api.rb", "test/test_mxhero_api_response.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/all_groups.yml", "test/fixtures/api/create_rule_for_domain.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/ldap_info.yml", "test/fixtures/api/remove_account_from_group_twice.yml", "test/fixtures/api/remove_inexistente_account_from_group.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/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_rule.yml", "test/helper.rb", "test/test_dto.rb", "test/test_groups.rb", "test/test_mxhero_api.rb", "test/test_mxhero_api_response.rb"]
 
   if s.respond_to? :specification_version then
-    s.specification_version = 3
+    s.specification_version = 4
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_development_dependency(%q<vcr>, ["= 2.5.0"])

data/test/fixtures/api/ldap_info.yml

@@ -0,0 +1,39 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://admin:password@test.mxhero.com/webapi/api/v1/domains/mxhero.com//adldap
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - application/json
+      Content-Type:
+      - application/json
+      Authorization:
+      - Basic YWRtaW46cGFzc3dvcmQ=
+  response:
+    status:
+      code: 200
+      message: !binary |-
+        T0s=
+    headers:
+      !binary "RGF0ZQ==":
+      - !binary |-
+        RnJpLCAxOCBPY3QgMjAxMyAyMTo0MjoxNyBHTVQ=
+      !binary "U2VydmVy":
+      - !binary |-
+        QXBhY2hlLzIuMi4xNCAoVWJ1bnR1KQ==
+      !binary "VHJhbnNmZXItRW5jb2Rpbmc=":
+      - !binary |-
+        Y2h1bmtlZA==
+      !binary "Q29udGVudC1UeXBl":
+      - !binary |-
+        YXBwbGljYXRpb24vanNvbg==
+    body:
+      encoding: US-ASCII
+      string: ! '{"domain":"mxhero.com","directoryType":"gapps","addres":null,"port":null,"sslFlag":false,"user":"1039076283917.apps.googleusercontent.com","password":"B9tHGe2nkLcIyPHKz2eQ6FtM","filter":null,"base":null,"nextUpdate":1379949740000,"lastUpdate":1379946140000,"error":null,"overrideFlag":true,"dnAuthenticate":null,"properties":[]}'
+    http_version: 
+  recorded_at: Fri, 18 Oct 2013 21:42:17 GMT
+recorded_with: VCR 2.5.0

data/test/fixtures/api/test_domain.yml

@@ -0,0 +1,75 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://admin:password@test.mxhero.com/webapi/api/v1/domains/mxhero.com/
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - application/json
+      Content-Type:
+      - application/json
+      Authorization:
+      - Basic YWRtaW46cGFzc3dvcmQ=
+  response:
+    status:
+      code: 200
+      message: !binary |-
+        T0s=
+    headers:
+      !binary "RGF0ZQ==":
+      - !binary |-
+        RnJpLCAxOCBPY3QgMjAxMyAxOTo1MToyNSBHTVQ=
+      !binary "U2VydmVy":
+      - !binary |-
+        QXBhY2hlLzIuMi4xNCAoVWJ1bnR1KQ==
+      !binary "VHJhbnNmZXItRW5jb2Rpbmc=":
+      - !binary |-
+        Y2h1bmtlZA==
+      !binary "Q29udGVudC1UeXBl":
+      - !binary |-
+        YXBwbGljYXRpb24vanNvbg==
+    body:
+      encoding: US-ASCII
+      string: ! '{"domain":"mxhero.com","server":"gmail.mxhero.com","creationDate":1371220326000,"updatedDate":1375909534000,"aliases":["hero.mx","mxhero.com","mxhero.net","mxhero.org"],"ldap":null}'
+    http_version: 
+  recorded_at: Fri, 18 Oct 2013 19:51:25 GMT
+- request:
+    method: get
+    uri: http://admin:password@test.mxhero.com/webapi/api/v1/domains/xxxx.xxx/
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - application/json
+      Content-Type:
+      - application/json
+      Authorization:
+      - Basic YWRtaW46cGFzc3dvcmQ=
+  response:
+    status:
+      code: 404
+      message: !binary |-
+        Tm90IEZvdW5k
+    headers:
+      !binary "RGF0ZQ==":
+      - !binary |-
+        RnJpLCAxOCBPY3QgMjAxMyAxOTo1MToyNiBHTVQ=
+      !binary "U2VydmVy":
+      - !binary |-
+        QXBhY2hlLzIuMi4xNCAoVWJ1bnR1KQ==
+      !binary "VHJhbnNmZXItRW5jb2Rpbmc=":
+      - !binary |-
+        Y2h1bmtlZA==
+      !binary "Q29udGVudC1UeXBl":
+      - !binary |-
+        YXBwbGljYXRpb24vanNvbg==
+    body:
+      encoding: US-ASCII
+      string: ! '{"status":404,"code":404,"message":"domain.not.found","developerMessage":"domain.not.found","moreInfoUrl":"mailto:support@mxhero.com"}'
+    http_version: 
+  recorded_at: Fri, 18 Oct 2013 19:51:26 GMT
+recorded_with: VCR 2.5.0

data/test/test_mxhero_api.rb

@@ -75,30 +75,6 @@ class MxHeroAPITest < MiniTest::Unit::TestCase
     end
   end
 
-  def test_domain_by_id
-    VCR.use_cassette('domain_by_id') do
-      id = domain
-      tesla_domain = @api.domain_by_id(id)
-      assert tesla_domain.key?(:domain)
-      assert tesla_domain.key?(:server)
-      assert tesla_domain.key?(:creationDate)
-      assert tesla_domain.key?(:aliases)
-      assert tesla_domain.key?(:ldap)
-    end
-  end
-
-  def test_domain_by_id_not_found
-    VCR.use_cassette('domain_by_id_not_found') do
-      id = "test.notfound.com"
-      tesla_domain = @api.domain_by_id(id)
-      assert tesla_domain[:status] == 404
-    end
-  end
-
-  def test_domain_by_id_param_could_not_be_nil
-    assert_raises(RuntimeError) { @api.domain_by_id }
-  end
-
   def test_accounts_by_domain
     VCR.use_cassette('accounts_from_domain') do
       response = @api.accounts_by_domain(domain)
@@ -245,7 +221,60 @@ class MxHeroAPITest < MiniTest::Unit::TestCase
       assert_equal original + '011', properties['mobile']
     end
   end
+def test_domain_by_name
+    VCR.use_cassette('domain_by_id') do
+      id = domain
+          end
+  end
+
+
+  def test_domain
+    VCR.use_cassette('test_domain') do
+      domain = @api.domain('mxhero.com')
+      assert domain.key?(:domain)
+      assert domain.key?(:server)
+      assert domain.key?(:creationDate)
+      assert domain.key?(:aliases)
+      assert domain.key?(:ldap)
+
+      response = @api.domain('xxxx.xxx')
+      assert response.nil?
+    end
+
+    def @api.call(_, _)
+      Class.new do
+        def ok?
+          false
+        end
+
+        def code
+          500
+        end
+
+        def content
+          ""
+        end
+      end.new
+    end
+
+    err = assert_raises ::RuntimeError do 
+      @api.domain('nop') 
+    end
+
+    assert_match /An error ocurred when try to fetch the domain nop/, err.message
+    assert_match /HTTP code: 500/, err.message
+  end
 
+  def test_ldap_info
+    VCR.use_cassette('ldap_info') do
+      ldap = @api.ldap_info('mxhero.com')
+      %w{domain directoryType addres port sslFlag user password filter 
+      base nextUpdate lastUpdate error overrideFlag 
+      dnAuthenticate properties}.each do |field|
+        assert ldap.key?(field.to_sym), "must retrieve ldap hash info with key: #{field}"
+      end
+    end
+  end
 
   private
   

metadata

@@ -1,8 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mxhero-api
 version: !ruby/object:Gem::Version
-  version: 0.1.15
-  prerelease: 
+  version: 0.1.16
 platform: ruby
 authors:
 - Maximiliano Dello Russo
@@ -11,12 +10,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-01 00:00:00.000000000 Z
+date: 2013-10-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: vcr
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - '='
       - !ruby/object:Gem::Version
@@ -24,7 +22,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - '='
       - !ruby/object:Gem::Version
@@ -32,7 +29,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - '='
       - !ruby/object:Gem::Version
@@ -40,7 +36,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - '='
       - !ruby/object:Gem::Version
@@ -48,7 +43,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: httpclient
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - '='
       - !ruby/object:Gem::Version
@@ -56,7 +50,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - '='
       - !ruby/object:Gem::Version
@@ -100,11 +93,13 @@ files:
 - test/fixtures/api/domain_by_id_not_found.yml
 - test/fixtures/api/domain_rule.yml
 - test/fixtures/api/domains.yml
+- test/fixtures/api/ldap_info.yml
 - test/fixtures/api/remove_account_from_group_twice.yml
 - test/fixtures/api/remove_inexistente_account_from_group.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/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
@@ -117,30 +112,26 @@ files:
 homepage: http://github.com/mxhero/mxhero-api
 licenses:
 - GPL-3
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -4512878157478229079
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.25
+rubygems_version: 2.1.9
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: A MxHero API client for ruby
 test_files:
 - test/fixtures/api/account_properties.yml
@@ -160,11 +151,13 @@ test_files:
 - test/fixtures/api/domain_by_id_not_found.yml
 - test/fixtures/api/domain_rule.yml
 - test/fixtures/api/domains.yml
+- test/fixtures/api/ldap_info.yml
 - test/fixtures/api/remove_account_from_group_twice.yml
 - test/fixtures/api/remove_inexistente_account_from_group.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/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