mxhero-api 0.1.7 → 0.1.8

data/VERSION

@@ -1 +1 @@
-0.1.7
+0.1.8

data/lib/mxhero-api.rb

@@ -161,9 +161,13 @@ 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?
+      # @params [String] domain
+      # @param [Hash] pagination 
+      # @option pagination [Fixnum] :limit of elements per page
+      # @option pagination [Fixnum] :offset number of page (start in 1)
       #
       # @return [Hash] with the following elements:
       #   * :elements [Array<Hash>] the list of accounts as a Hash, when any element contains:
@@ -182,12 +186,13 @@ module MxHero
       #   * :actualPage [Fixnum]
       #
       # @raise an exception when the status code isn't 200
-      def accounts_by_domain(domain)
-        url = accounts_by_domain_url(domain)
+      def accounts_by_domain(domain, pagination = {})
+        url = paginate accounts_by_domain_url(domain), pagination
         response = call(:get, url)
         json_parse(response.content)
       end
 
+      
       # @return [Boolean] true when operation it's ok
       def delete_rule(domain, id)
         url = domain_rule_url(domain, id)
@@ -227,6 +232,29 @@ module MxHero
       end
 
       private
+      
+
+      # Complete the URL with the pagination info (:limit and :offset)
+      # @param [String] original URL. Ex.: http://www.example.com/api/accounts
+      # @param [Hash] pagination 
+      # @option pagination [Fixnum] :limit of elements per page
+      # @option pagination [Fixnum] :offset number of page (start in 1)
+      #
+      # @return [String] the URL with the pagination parameters.
+      #   Ex.: url: http://www.example.com/api/accounts
+      #        pagination: { limit: 4, offset: 2 }
+      #        return > http://www.example.com/api/accounts?limit=4&offset=2
+      def paginate(url, pagination)
+        paginated = url.dup
+        connector = url.include?('?') ? '&' : '?'
+        [ :limit, :offset ].map do |elem|
+          if pagination.key? elem
+            paginated << "#{connector}#{elem.to_s}=#{pagination[elem]}"
+            connector = '&'
+          end
+        end
+        paginated
+      end
 
       def account_properties_to_json(properties)
         out = []

data/mxhero-api.gemspec

@@ -2,20 +2,20 @@
 
 Gem::Specification.new do |s|
   s.name = "mxhero-api"
-  s.version = "0.1.7"
+  s.version = "0.1.8"
 
   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-14"
+  s.date = "2013-08-15"
   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/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/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_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/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/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/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_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/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_from_domain_paginated.yml

@@ -0,0 +1,39 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://admin:password@localhost:8080/webapi/api/v1/domains/tesla.com/accounts?limit=4&offset=1
+    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 "U2VydmVy":
+      - !binary |-
+        QXBhY2hlLUNveW90ZS8xLjE=
+      !binary "Q29udGVudC1UeXBl":
+      - !binary |-
+        YXBwbGljYXRpb24vanNvbg==
+      !binary "VHJhbnNmZXItRW5jb2Rpbmc=":
+      - !binary |-
+        Y2h1bmtlZA==
+      !binary "RGF0ZQ==":
+      - !binary |-
+        U2F0LCAxMCBBdWcgMjAxMyAwMzozNToxNSBHTVQ=
+    body:
+      encoding: US-ASCII
+      string: ! '{"elements":[{"account":"test","domain":"tesla.com","createdDate":1376065216000,"updatedDate":1376069631000,"group":null,"aliases":[{"name":"test","domain":"tesla.com","dataSource":"manual"}],"dataSource":"manual"},{"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":6,"totalPages":2,"actualPage":1}'
+    http_version: 
+  recorded_at: Thu, 15 Aug 2013 21:29:19 GMT
+recorded_with: VCR 2.5.0

data/test/test_mxhero_api.rb

@@ -92,6 +92,15 @@ class MxHeroAPITest < MiniTest::Unit::TestCase
     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)
+      must_have_the_keys(response, %w( elements totalElements totalPages actualPage ))
+      assert_equal 4, response[:elements].count
+      assert_equal 1, response[:actualPage]
+    end
+  end
+
   def test_delete_rule
     VCR.use_cassette('delete_rule') do
       rules = obtain_rules(domain)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mxhero-api
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.1.8
   prerelease: 
 platform: ruby
 authors:
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-14 00:00:00.000000000 Z
+date: 2013-08-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: vcr
@@ -82,6 +82,7 @@ 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
@@ -111,7 +112,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -69256700798046253
+      hash: -3291556788727679228
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -128,6 +129,7 @@ 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