mxhero-api 0.1.2 → 0.1.3

data/VERSION

@@ -1 +1 @@
-0.1.2
+0.1.3

data/lib/mxhero-api.rb

@@ -95,7 +95,8 @@ module MxHero
       #   * :updateDate [Fixnum]
       #   * :aliases 
       #   * :ldap
-      # @raise an exception when the status code isn't 200
+      # @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))
@@ -133,7 +134,6 @@ module MxHero
     
       # Create a rule
       #
-      # @param domain [String]
       # @param [Hash] msg 
       # @option msg [String]      :domain
       # @option msg [Boolean]     :twoWays
@@ -147,7 +147,7 @@ module MxHero
       #
       # @return [MxHero::API::Response]
       def create_rule(msg)
-        response = call(:post, rules_url, msg.to_json)
+        response = call(:post, rules_url, msg.to_json, throw_exception: false)
         parse_response(response)
       end
 
@@ -161,6 +161,33 @@ module MxHero
         parse_response(response, on_empty: [])
       end
 
+      # Retrive all the account from one domain
+      #
+      # TODO: Improve the response. We really need manage pagination here?
+      #
+      # @return [Hash] with the following elements:
+      #   * :elements [Array<Hash>] the list of accounts as a Hash, when any element contains:
+      #     * :account [String] example: alex
+      #     * :domain [String] example: mxhero.com
+      #     * :createdDate [Fixnum] example: 1375909565000 (epoch format)
+      #     * :updatedDate [Fixnum]
+      #     * :group [String]
+      #     * :aliases [Array<Hash>] the list of aliases of one account
+      #       * :name [String]
+      #       * :domain [String]
+      #       * :dataSource [String]
+      #     * :dataSource [String]
+      #   * :totalElements [Fixnum]
+      #   * :totalPages [Fixnum]
+      #   * :actualPage [Fixnum]
+      #
+      # @raise an exception when the status code isn't 200
+      def accounts_by_domain(domain)
+        url = accounts_by_domain_url(domain)
+        response = call(:get, url)
+        json_parse(response.content)
+      end
+
       private
 
       # @return [MxHero::API::Response] a response object
@@ -179,11 +206,15 @@ module MxHero
       # @param method [Symbol] indicate the HTTP verb (:get, :post, :put, etc)
       # @param url [String]
       # @param body [String] (default: nil)
-      def call(method, url, body = nil)
+      # @param [Hash] more_options
+      # @option more_options [Boolean] :throw_exception (default: true) throw exception if the response status are between 500 and 600
+      def call(method, url, body = nil, more_options = {})
         client = HTTPClient.new
         client.set_auth(url, @username, @password)
         response = client.request(method, url, nil, body, headers)
-        raise 'an error ocurred when try to communicate with the API' if 500..600.include?(response.status)
+        unless more_options[:throw_exception] == false
+          raise 'an error ocurred when try to communicate with the API' if (500..600).include?(response.status)
+        end
         response
       end
 
@@ -204,6 +235,10 @@ module MxHero
         service_url + '/domains'
       end
 
+      def accounts_by_domain_url(domain)
+        domain_by_id_url(domain) + 'accounts'
+      end
+
       def domain_by_id_url(domain)
         domains_url + "/#{domain}/"
       end

data/mxhero-api.gemspec

@@ -2,19 +2,19 @@
 
 Gem::Specification.new do |s|
   s.name = "mxhero-api"
-  s.version = "0.1.2"
+  s.version = "0.1.3"
 
   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-08-07"
   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", "README.md", "Rakefile", "VERSION", "lib/mxhero-api.rb", "mxhero-api.gemspec", "test/fixtures/api/create_rule_alredy_exist.yml", "test/fixtures/api/create_rule_for_domain.yml", "test/fixtures/api/create_rule_success.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/rules_for_domain.yml", "test/fixtures/api/service_create_footer.yml", "test/fixtures/api/service_footer_for_domain.yml", "test/fixtures/api/update_rule.yml", "test/helper.rb", "test/test_mxhero_api.rb", "test/test_mxhero_api_response.rb"]
+  s.files = [".gitignore", ".rvmrc", "Gemfile", "README.md", "Rakefile", "VERSION", "lib/mxhero-api.rb", "mxhero-api.gemspec", "test/fixtures/api/accounts_from_domain.yml", "test/fixtures/api/create_rule_alredy_exist.yml", "test/fixtures/api/create_rule_for_domain.yml", "test/fixtures/api/create_rule_success.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/rules_for_domain.yml", "test/fixtures/api/service_create_footer.yml", "test/fixtures/api/service_footer_for_domain.yml", "test/fixtures/api/update_rule.yml", "test/helper.rb", "test/test_mxhero_api.rb", "test/test_mxhero_api_response.rb"]
   s.homepage = "http://github.com/mxhero/mxhero-api"
   s.require_paths = ["lib"]
   s.rubygems_version = "1.8.25"
   s.summary = "A MxHero API client for ruby"
-  s.test_files = ["test/fixtures/api/create_rule_alredy_exist.yml", "test/fixtures/api/create_rule_for_domain.yml", "test/fixtures/api/create_rule_success.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/rules_for_domain.yml", "test/fixtures/api/service_create_footer.yml", "test/fixtures/api/service_footer_for_domain.yml", "test/fixtures/api/update_rule.yml", "test/helper.rb", "test/test_mxhero_api.rb", "test/test_mxhero_api_response.rb"]
+  s.test_files = ["test/fixtures/api/accounts_from_domain.yml", "test/fixtures/api/create_rule_alredy_exist.yml", "test/fixtures/api/create_rule_for_domain.yml", "test/fixtures/api/create_rule_success.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/rules_for_domain.yml", "test/fixtures/api/service_create_footer.yml", "test/fixtures/api/service_footer_for_domain.yml", "test/fixtures/api/update_rule.yml", "test/helper.rb", "test/test_mxhero_api.rb", "test/test_mxhero_api_response.rb"]
 
   if s.respond_to? :specification_version then
     s.specification_version = 3

data/test/fixtures/api/accounts_from_domain.yml

@@ -0,0 +1,39 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://admin:password@localhost:8080/webapi/api/v1/domains/mxhero.com/accounts
+    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 |-
+        V2VkLCAwNyBBdWcgMjAxMyAyMTo0MjoyMyBHTVQ=
+      !binary "U2VydmVy":
+      - !binary |-
+        QXBhY2hlLzIuMi4xNCAoVWJ1bnR1KQ==
+      !binary "Q29udGVudC1MZW5ndGg=":
+      - !binary |-
+        MjkwMg==
+      !binary "Q29udGVudC1UeXBl":
+      - !binary |-
+        YXBwbGljYXRpb24vanNvbg==
+    body:
+      encoding: US-ASCII
+      string: ! '{"elements":[{"account":"alex","domain":"mxhero.com","createdDate":1375909565000,"updatedDate":1375909565000,"group":null,"aliases":[{"name":"alex","domain":"hero.mx","dataSource":"manual"},{"name":"alex","domain":"mxhero.com","dataSource":"manual"},{"name":"alex","domain":"mxhero.net","dataSource":"manual"},{"name":"alex","domain":"mxhero.org","dataSource":"manual"}],"dataSource":"manual"},{"account":"bruno","domain":"mxhero.com","createdDate":1375909591000,"updatedDate":1375909591000,"group":null,"aliases":[{"name":"bcsantos","domain":"hero.mx","dataSource":"manual"},{"name":"bcsantos","domain":"mxhero.com","dataSource":"manual"},{"name":"bcsantos","domain":"mxhero.net","dataSource":"manual"},{"name":"bcsantos","domain":"mxhero.org","dataSource":"manual"},{"name":"bruno","domain":"mxhero.com","dataSource":"manual"}],"dataSource":"manual"},{"account":"gussoler","domain":"mxhero.com","createdDate":1375909608000,"updatedDate":1375909608000,"group":null,"aliases":[{"name":"gussoler","domain":"hero.mx","dataSource":"manual"},{"name":"gussoler","domain":"mxhero.com","dataSource":"manual"},{"name":"gussoler","domain":"mxhero.net","dataSource":"manual"},{"name":"gussoler","domain":"mxhero.org","dataSource":"manual"}],"dataSource":"manual"},{"account":"jproyo","domain":"mxhero.com","createdDate":1375909608000,"updatedDate":1375909608000,"group":null,"aliases":[{"name":"jproyo","domain":"hero.mx","dataSource":"manual"},{"name":"jproyo","domain":"mxhero.com","dataSource":"manual"},{"name":"jproyo","domain":"mxhero.net","dataSource":"manual"}],"dataSource":"manual"},{"account":"martinm","domain":"mxhero.com","createdDate":1375909591000,"updatedDate":1375909591000,"group":null,"aliases":[{"name":"martinm","domain":"hero.mx","dataSource":"manual"},{"name":"martinm","domain":"mxhero.com","dataSource":"manual"},{"name":"martinm","domain":"mxhero.net","dataSource":"manual"}],"dataSource":"manual"},{"account":"maxidr","domain":"mxhero.com","createdDate":1375909624000,"updatedDate":1375909624000,"group":null,"aliases":[{"name":"maxidr","domain":"hero.mx","dataSource":"manual"},{"name":"maxidr","domain":"mxhero.com","dataSource":"manual"},{"name":"maxidr","domain":"mxhero.net","dataSource":"manual"},{"name":"maxidr","domain":"mxhero.org","dataSource":"manual"}],"dataSource":"manual"},{"account":"mmarmol","domain":"mxhero.com","createdDate":1375909565000,"updatedDate":1375909565000,"group":null,"aliases":[{"name":"mmarmol","domain":"hero.mx","dataSource":"manual"},{"name":"mmarmol","domain":"mxhero.com","dataSource":"manual"},{"name":"mmarmol","domain":"mxhero.net","dataSource":"manual"}],"dataSource":"manual"},{"account":"test","domain":"mxhero.com","createdDate":1375741652000,"updatedDate":1375741652000,"group":"development","aliases":[{"name":"test","domain":"mxhero.com","dataSource":"manual"}],"dataSource":"manual"}],"totalElements":8,"totalPages":1,"actualPage":1}'
+    http_version: 
+  recorded_at: Wed, 07 Aug 2013 21:42:22 GMT
+recorded_with: VCR 2.5.0

data/test/helper.rb

@@ -10,7 +10,7 @@ require 'minitest/pride'
 Dir['./lib/**/*.rb'].each { |rb| require rb }
 
 TEST_API_DOMAIN   = 'tesla.com'
-TEST_API_URL      = 'http://localhost:8080/webapi/api/v1'
+TEST_API_URL      = ENV['TEST_API_URL'] || 'http://localhost:8080/webapi/api/v1'
 TEST_API_USER     = 'admin'
 TEST_API_PASSWORD = 'password' 
 

data/test/test_mxhero_api.rb

@@ -1,4 +1,4 @@
-  require_relative 'helper'
+require_relative 'helper'
 
 class MxHeroAPITest < MiniTest::Unit::TestCase
 
@@ -70,6 +70,24 @@ class MxHeroAPITest < MiniTest::Unit::TestCase
     assert_raises(RuntimeError) { @api.domain_by_id }
   end
 
+  def test_accounts_by_domain
+    VCR.use_cassette('accounts_from_domain') do
+      domain = 'mxhero.com'
+      response = @api.accounts_by_domain(domain)
+      must_have_the_keys(response, %w( elements totalElements totalPages actualPage ))
+      response[:elements].each do |account|
+        must_have_the_keys(account, %w( account domain createdDate updatedDate group aliases dataSource ) )
+        account[:aliases].each { |t_alias| must_have_the_keys(t_alias, %w( name domain dataSource )) }
+      end
+    end
+  end
+
+  def must_have_the_keys(hash, keys)
+    keys.each do |key|
+      assert hash.key?(key.to_sym), "must have the key #{key}"
+    end
+  end
+
   def rule_msg_with_domain(domain)
     msg = create_rule_msg
     msg[:domain] = domain

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mxhero-api
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
   prerelease: 
 platform: ruby
 authors:
@@ -78,6 +78,7 @@ files:
 - VERSION
 - lib/mxhero-api.rb
 - mxhero-api.gemspec
+- test/fixtures/api/accounts_from_domain.yml
 - test/fixtures/api/create_rule_alredy_exist.yml
 - test/fixtures/api/create_rule_for_domain.yml
 - test/fixtures/api/create_rule_success.yml
@@ -106,7 +107,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1666481203265487076
+      hash: 2775185487953988515
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -120,6 +121,7 @@ signing_key:
 specification_version: 3
 summary: A MxHero API client for ruby
 test_files:
+- test/fixtures/api/accounts_from_domain.yml
 - test/fixtures/api/create_rule_alredy_exist.yml
 - test/fixtures/api/create_rule_for_domain.yml
 - test/fixtures/api/create_rule_success.yml