mxhero-api 0.1.18 → 0.1.19

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    YTZkZmZhYWI5ODJmMGQyNzIwMjE1YmJiNmU3YWNmZDNjYmMwM2QzZg==
+    OGRmM2JmNjliZTQyOWQ1ZTE5OTU4ZWQzOTEzNTY4ZDc5Yzg0ODJlZQ==
   data.tar.gz: !binary |-
-    MjJmYWYxZDg4NWQyMjlhNWM5ZGU3YjE1ODBhMmIxZGRmNjAwZWMxZQ==
+    ZGQ0YzY5YzZjNDUxZGYxYWQwMGZiYmM4OTZkOTU5Y2QyMTE5NWJmMQ==
 SHA512:
   metadata.gz: !binary |-
-    NDhkZmI3MjRiN2U4MjMyMzZhZWNmOTY0ZjA4MzExYmQ2ODJjYzlmM2U3Njdh
-    OTk1MzY2ZGQwNDU3N2NlMGFiMTIwM2M5Y2FlZjA1MjU1M2QyOGMwMmUyMWVi
-    NTg0NjI1NTZkYWViNGEyMDgxZGJmMTMzM2ZkYWNjMGExNTNmMGQ=
+    Y2ZhYWM4ZTExNDlkMmUyMzJlZjMxMmJmNzk1MjRjOGVkYzNkYmJiODMzNjVk
+    ODY1YWY3YmZlODI0MWI0Mzg0Y2ZiYmIyNjZmZWY1YmU3ZDdmMjc5YWQ4ZTZl
+    OTAyOTIzMTA4MzJkMGUyMWNjZWZjZjYzM2NjZWZhZDdiOTBmZTE=
   data.tar.gz: !binary |-
-    ZTRkN2JhZmEyYjAxZjFmNTdiZDNhNWM1NWViMmIwYjE5NWYwMjlhM2JiOGIy
-    MzI2ZGZkOWYwMzk1ZDM2MmY1ZDk4OTc4MzBhZmM5MWIzN2IwYjBmMmJjZjQ0
-    MTgwYThkMWM0ZDBiOTM4MDExM2IzNjdiN2IzODA2MzBmM2I5Y2E=
+    NTc4YmIwOWIwYmU1ZDRjYmU5ODNkMTFhMmYwY2Q3ODIzMGI3ZDUxN2U1ZGQ1
+    OGE4YzBlZTUyMjVlMjc4MzRkNDRjYWZjMWYxYzE3MzE5NjEwYWIyMzVhMTI2
+    NGE4Y2RjNWQ5MGRjMDU0ODRlMTkwZTQ5MTA5YTY1YTU4YWU4NmM=

data/VERSION

@@ -1 +1 @@
-0.1.18
+0.1.19

data/lib/groups.rb

@@ -60,10 +60,13 @@ module MxHero::API
 
     # Retrieve all the groups
     #
+    # @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  
-    def all(limit = nil, offset = nil)
-      response = call(:get, groups_url)
+    #
+    def all(pagination = { page: nil, per_page: nil })
+      response = call(:get, groups_url(pagination))
       paginate_wrap(response) do |hash|
         hash[:elements].map { |e| Group.new(e) }
       end
@@ -94,10 +97,12 @@ module MxHero::API
     # Retrieve all the accounts for one group
     #
     # @param group_name [String]
+    # @param options [Hash] pagination options (page and/or per_page)
     #
     # @return [MxHero::API::PaginatedElements] the list of accounts [MxHero::API::Account]
-    def accounts(group_name)
-      response = call(:get, group_accounts_url(group_name))
+    #
+    def accounts(group_name, options = { per_page: nil, page: nil })
+      response = call(:get, group_accounts_url(group_name, options))
       paginate_wrap response do |hash|
         hash[:elements].map { |e| Account.new(e) }
       end
@@ -153,16 +158,24 @@ module MxHero::API
       hash[:elements].map { |e| Group.new(e) }
     end
 
-    def groups_url
-      domain_by_id_url(domain) + 'groups'
+    def groups_url(pagination = {})
+      domain_by_id_url(domain) + 'groups' + pagination_query(pagination)
+    end
+
+    def pagination_query(params = { page: nil, per_page: nil })
+      return '' unless params[:page] || params[:per_page]
+      '?' + [].tap do |section|
+        section << "limit=#{params[:per_page]}" if params[:per_page]
+        section << "offset=#{params[:page]}"    if params[:page]
+      end.join('&')
     end
     
     def group_url(group_name)
       groups_url + "/#{group_name}"
     end
 
-    def group_accounts_url(group_name)
-      group_url(group_name) + "/accounts"
+    def group_accounts_url(group_name, pagination = {})
+      group_url(group_name) + "/accounts" + pagination_query(pagination)
     end
 
     def group_add_accounts_url(group_name, account_name)

data/mxhero-api.gemspec

@@ -1,13 +1,13 @@
 # -*- encoding: utf-8 -*-
-# stub: mxhero-api 0.1.18 ruby lib
+# stub: mxhero-api 0.1.19 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "mxhero-api"
-  s.version = "0.1.18"
+  s.version = "0.1.19"
 
   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-11-20"
+  s.date = "2013-11-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", ".rvmrc", "Gemfile", "LICENSE.txt", "README.md", "Rakefile", "VERSION", "lib/communication.rb", "lib/directories.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_directory.yml", "test/fixtures/api/create_rule_for_domain.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/fetch_directory.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_directory.yml", "test/fixtures/api/update_rule.yml", "test/helper.rb", "test/test_directories.rb", "test/test_dto.rb", "test/test_groups.rb", "test/test_mxhero_api.rb", "test/test_mxhero_api_response.rb"]

data/test/test_groups.rb

@@ -99,6 +99,14 @@ class GroupsTest < MiniTest::Unit::TestCase
       assert_equal 'domain.account.not.found', response.content[:developerMessage] 
     end
   end
+  
+
+  def test_pagination
+    assert @groups.send(:pagination_query).empty?
+    assert_equal '?offset=10', @groups.send(:pagination_query, page: 10)
+    assert_equal '?limit=10', @groups.send(:pagination_query, per_page: 10)
+    assert_equal '?limit=10&offset=2', @groups.send(:pagination_query, per_page: 10, page: 2)
+  end
 
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mxhero-api
 version: !ruby/object:Gem::Version
-  version: 0.1.18
+  version: 0.1.19
 platform: ruby
 authors:
 - Maximiliano Dello Russo
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-20 00:00:00.000000000 Z
+date: 2013-11-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: vcr