RubyGems - mxhero-api - Versions diffs - 0.1.10 → 0.1.11 - Mend

mxhero-api 0.1.10 → 0.1.11

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (6) hide show

data/VERSION +1 -1
data/lib/mxhero-api.rb +17 -8
data/mxhero-api.gemspec +4 -4
data/test/fixtures/api/accounts_filtered.yml +96 -0
data/test/test_mxhero_api.rb +13 -0
metadata +5 -3

data/VERSION CHANGED Viewed

	@@ -1 +1 @@
1	- 0.1.10
1	+ 0.1.11

data/lib/mxhero-api.rb CHANGED Viewed

@@ -169,9 +169,12 @@ module MxHero
       # Retrive all the account from one domain
       #
       # @params [String] domain
-      # @param [Hash] pagination
-      # @option pagination [Fixnum] :limit of elements per page
-      # @option pagination [Fixnum] :offset number of page (start in 1)
+      # @params [String] filter_account the account to filter in the list. This can be a part of an account.
+      # @param [Hash] refinement
+      # @option refinement [Fixnum] :limit of elements per page
+      # @option refinement [Fixnum] :offset number of page (start in 1)
+      # @option refinement [String] :account filter accounts that start with this value
+      #
       #
       # @return [Hash] with the following elements:
       #   * :elements [Array<Hash>] the list of accounts as a Hash, when any element contains:
@@ -190,8 +193,12 @@ module MxHero
       #   * :actualPage [Fixnum]
       #
       # @raise an exception when the status code isn't 200
-      def accounts_by_domain(domain, pagination = {})
-        url = paginate accounts_by_domain_url(domain), pagination
+      def accounts_by_domain(domain, refinement = {}) #filter_account = nil, pagination = {})
+        params = refinement.dup
+        filter_account = params.delete(:account)
+        limit, offset = params.values_at(:limit, :offset)
+        url = paginate accounts_by_domain_url(domain, filter_account), { limit: limit, offset: offset }
         response = call(:get, url)
         json_parse(response.content)
       end
@@ -252,7 +259,7 @@ module MxHero
         paginated = url.dup
         connector = url.include?('?') ? '&' : '?'
         [ :limit, :offset ].map do |elem|
-          if pagination.key? elem
+          if pagination[elem]
             paginated << "#{connector}#{elem.to_s}=#{pagination[elem]}"
             connector = '&'
           end
@@ -293,6 +300,7 @@ module MxHero
         unless more_options[:throw_exception] == false
           raise "An error ocurred when try to communicate with the API\nError: #{response}" if (500..600).include?(response.status)
         end
         response
       end
@@ -313,8 +321,9 @@ module MxHero
         service_url + '/domains'
       end
-      def accounts_by_domain_url(domain)
-        domain_by_id_url(domain) + 'accounts'
+      def accounts_by_domain_url(domain, filter_account = nil)
+        filter = filter_account ? "?account=#{filter_account}" : ''
+        domain_by_id_url(domain) + 'accounts' + filter
       end
       def domain_by_id_url(domain)

data/mxhero-api.gemspec CHANGED Viewed

@@ -2,20 +2,20 @@
 Gem::Specification.new do |s|
   s.name = "mxhero-api"
-  s.version = "0.1.10"
+  s.version = "0.1.11"
   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-17"
+  s.date = "2013-09-10"
   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/mxhero-api.rb", "mxhero-api.gemspec", "test/fixtures/api/account_properties.yml", "test/fixtures/api/account_properties_not_found.yml", "test/fixtures/api/accounts_from_domain.yml", "test/fixtures/api/accounts_from_domain_paginated.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/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/rules_for_domain.yml", "test/fixtures/api/rules_for_domain_by_component.yml", "test/fixtures/api/update_account_properties.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", "LICENSE.txt", "README.md", "Rakefile", "VERSION", "lib/mxhero-api.rb", "mxhero-api.gemspec", "test/fixtures/api/account_properties.yml", "test/fixtures/api/account_properties_not_found.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/create_rule_alredy_exist.yml", "test/fixtures/api/create_rule_for_domain.yml", "test/fixtures/api/create_rule_success.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/rules_for_domain.yml", "test/fixtures/api/rules_for_domain_by_component.yml", "test/fixtures/api/update_account_properties.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.licenses = ["GPL-3"]
   s.require_paths = ["lib"]
   s.rubygems_version = "1.8.25"
   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_from_domain.yml", "test/fixtures/api/accounts_from_domain_paginated.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/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/rules_for_domain.yml", "test/fixtures/api/rules_for_domain_by_component.yml", "test/fixtures/api/update_account_properties.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/account_properties.yml", "test/fixtures/api/account_properties_not_found.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/create_rule_alredy_exist.yml", "test/fixtures/api/create_rule_for_domain.yml", "test/fixtures/api/create_rule_success.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/rules_for_domain.yml", "test/fixtures/api/rules_for_domain_by_component.yml", "test/fixtures/api/update_account_properties.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_filtered.yml ADDED Viewed

@@ -0,0 +1,96 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://admin:password@localhost:8080/webapi/api/v1/domains/tesla.com/accounts?account=user
+    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:
+      - Sat, 10 Aug 2013 21:24:29 GMT
+    body:
+      encoding: UTF-8
+      string: '{"elements":[{"account":"user_1","domain":"tesla.com","createdDate":1376105684000,"updatedDate":1376105684000,"group":null,"aliases":[{"name":"user_1","domain":"tesla.com","dataSource":"manual"}],"dataSource":"manual"},{"account":"user_2","domain":"tesla.com","createdDate":1376105691000,"updatedDate":1376105691000,"group":null,"aliases":[{"name":"user_2","domain":"tesla.com","dataSource":"manual"}],"dataSource":"manual"},{"account":"user_3","domain":"tesla.com","createdDate":1376105698000,"updatedDate":1376105698000,"group":null,"aliases":[{"name":"user_3","domain":"tesla.com","dataSource":"manual"}],"dataSource":"manual"}],"totalElements":3,"totalPages":1,"actualPage":1}'
+    http_version:
+  recorded_at: Tue, 10 Sep 2013 15:07:05 GMT
+- request:
+    method: get
+    uri: http://admin:password@localhost:8080/webapi/api/v1/domains/tesla.com/accounts?account=test
+    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:
+      - Sat, 10 Aug 2013 21:24:29 GMT
+    body:
+      encoding: UTF-8
+      string: '{"elements":[{"account":"test","domain":"tesla.com","createdDate":1376065216000,"updatedDate":1376069631000,"group":null,"aliases":[{"name":"test","domain":"tesla.com","dataSource":"manual"}],"dataSource":"manual"}],"totalElements":1,"totalPages":1,"actualPage":1}'
+    http_version:
+  recorded_at: Tue, 10 Sep 2013 15:07:05 GMT
+- request:
+    method: get
+    uri: http://admin:password@localhost:8080/webapi/api/v1/domains/tesla.com/accounts?account=user_2
+    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:
+      - Sat, 10 Aug 2013 21:24:29 GMT
+    body:
+      encoding: UTF-8
+      string: '{"elements":[{"account":"user_2","domain":"tesla.com","createdDate":1376105691000,"updatedDate":1376105691000,"group":null,"aliases":[{"name":"user_2","domain":"tesla.com","dataSource":"manual"}],"dataSource":"manual"}],"totalElements":1,"totalPages":1,"actualPage":1}'
+    http_version:
+  recorded_at: Tue, 10 Sep 2013 15:07:05 GMT
+recorded_with: VCR 2.5.0

data/test/test_mxhero_api.rb CHANGED Viewed

@@ -110,6 +110,19 @@ class MxHeroAPITest < MiniTest::Unit::TestCase
     end
   end
+  def test_accounts_by_domain_filtered
+    VCR.use_cassette('accounts_filtered') do
+      # The test environment have 4 accounts:
+      # user_1, user_2, user_3 and test
+      response = @api.accounts_by_domain(domain, account: 'user')
+      assert_equal 3, response[:elements].count
+      response = @api.accounts_by_domain(domain, account: 'test')
+      assert_equal 1, response[:elements].count
+      response = @api.accounts_by_domain(domain, account: 'user_2')
+      assert_equal 1, response[:elements].count
+    end
+  end
   def test_accounts_by_domain_paginated
     VCR.use_cassette('accounts_from_domain_paginated') do
       response = @api.accounts_by_domain(domain, limit: 4, offset: 1)

metadata CHANGED Viewed

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mxhero-api
 version: !ruby/object:Gem::Version
-  version: 0.1.10
+  version: 0.1.11
   prerelease:
 platform: ruby
 authors:
@@ -11,7 +11,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2013-08-17 00:00:00.000000000 Z
+date: 2013-09-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: vcr
@@ -81,6 +81,7 @@ files:
 - mxhero-api.gemspec
 - test/fixtures/api/account_properties.yml
 - test/fixtures/api/account_properties_not_found.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/create_rule_alredy_exist.yml
@@ -113,7 +114,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -400696915372951367
+      hash: 1574735906110401669
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -129,6 +130,7 @@ summary: A MxHero API client for ruby
 test_files:
 - test/fixtures/api/account_properties.yml
 - test/fixtures/api/account_properties_not_found.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/create_rule_alredy_exist.yml