vmware-vra 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 56ccef7bb2c458c16968ac45d3ba00306e0cfe39
-  data.tar.gz: 8023755792111c3fbebb453f3b651c6d12dde66f
+  metadata.gz: 01f8978ee0a6e0ed1865001f50876e122b5ee30f
+  data.tar.gz: ff5897d229cc674c2f5b3310c29bbe7857f6b55c
 SHA512:
-  metadata.gz: 24cd4008b751382b4869c1a5e9abb49c35087ad0f65c29e9e2c9911a34a07ada9a31323e16c1867454ba19081b73ec788da3807b9a78d4b0d33148edd4ca2737
-  data.tar.gz: cd5567b6825a179d15a043d048fa5862fd88b6ee8ae3ef1a4ca4ed01acc378ee1cd1a28f148705a8c2d36ee39de2672aae72c0f1f92df471e50440c347012583
+  metadata.gz: fe516b37bc68296e53500270d3ac357d52ed176974e55ae539ab302f3cffa6453be5cc264c27f0b41ba1813027145d2ad99641ee9f545704213e827ee55b67ae
+  data.tar.gz: b94a9d038ea6dbe094b601baedd89fc2c0c26b455613699ffc88cad4556c8117d2244204a3671c336252a51bfbd6eb50d490975785eac7268c47d03fd8636f0d

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## v1.2.0
+* [pr#11](https://github.com/chef-partners/vmware-vra-gem/pull/11) Ability to set paginated results page size, which is a workaround for issue reported in #10 regarding duplicate items returned in paginated results.
+
 ## v1.1.0
 * [pr#9](https://github.com/chef-partners/vmware-vra-gem/pull/9) Mask password and bearer token in console/debug/log output. 
   Thanks to [@rubytester](https://github.com/rubytester) for the idea and initial proposal to address in [pr#7](https://github.com/chef-partners/vmware-vra-gem/pull/7)

data/README.md

@@ -170,6 +170,20 @@ vra.resources.all_resources
 vra.requests.all_requests
 ```
 
+### Pagination
+
+vRA paginates API requests where lists of items are returned.  By default, this gem will ask vRA to provide items in groups of 20.  However, as reported in [Issue 10](https://github.com/chef-partners/vmware-vra-gem/issues/10), it appears vRA may have a pagination bug.  You can change the default page size from 20 to a value of your choice by passing in a `page_size` option when setting up the client:
+
+```ruby
+vra = Vra::Client.new(username: 'devmgr@corp.local', password: 'mypassword', tenant: 'mytenant', base_url: 'https://vra.corp.local', verify_ssl: true, page_size: 100)
+```
+
+... or setting `page_size` on the client object after you've created it:
+
+```ruby
+client.page_size = 100
+```
+
 ## License and Authors
 
 Author:: Chef Partner Engineering (<partnereng@chef.io>)

data/lib/vra/client.rb

@@ -23,7 +23,7 @@ require 'passwordmasker'
 module Vra
   # rubocop:disable ClassLength
   class Client
-    attr_accessor :bearer_token
+    attr_accessor :bearer_token, :page_size
 
     def initialize(opts)
       @base_url     = opts[:base_url]
@@ -32,6 +32,7 @@ module Vra
       @tenant       = opts[:tenant]
       @verify_ssl   = opts.fetch(:verify_ssl, true)
       @bearer_token = PasswordMasker.new(nil)
+      @page_size    = opts.fetch(:page_size, 20)
 
       validate_client_options!
     end
@@ -138,10 +139,10 @@ module Vra
       response.body
     end
 
-    def http_get_paginated_array!(path, limit=20)
+    def http_get_paginated_array!(path)
       items = []
       page = 1
-      base_path = path + "?limit=#{limit}"
+      base_path = path + "?limit=#{page_size}"
 
       loop do
         response = FFI_Yajl::Parser.parse(http_get!("#{base_path}&page=#{page}"))
@@ -151,6 +152,12 @@ module Vra
         page += 1
       end
 
+      raise Vra::Exception::DuplicateItemsDetected,
+            'Duplicate items were returned by the vRA API. ' \
+            'Increase your page size to avoid this vRA API bug. ' \
+            'See https://github.com/chef-partners/vmware-vra-gem#pagination ' \
+            'for more information.' if items.uniq!
+
       items
     end
 

data/lib/vra/exceptions.rb

@@ -20,6 +20,7 @@ require 'ffi_yajl'
 
 module Vra
   module Exception
+    class DuplicateItemsDetected < RuntimeError; end
     class NotFound < RuntimeError; end
     class RequestError < RuntimeError; end
     class Unauthorized < RuntimeError; end

data/lib/vra/version.rb

@@ -17,5 +17,5 @@
 #
 
 module Vra
-  VERSION = '1.1.0'
+  VERSION = '1.2.0'
 end

data/spec/client_spec.rb

@@ -275,11 +275,12 @@ describe Vra::Client do
 
   describe '#http_get_paginated_array!' do
     it 'allows a limit override' do
+      client.page_size = 10
       expect(client).to receive(:http_get!)
         .with('/test?limit=10&page=1')
         .and_return({ 'content' => [], 'metadata' => { 'totalPages' => 1 } }.to_json)
 
-      client.http_get_paginated_array!('/test', 10)
+      client.http_get_paginated_array!('/test')
     end
 
     it 'only calls http_get! once when total pages is 0 (no items)' do
@@ -313,6 +314,14 @@ describe Vra::Client do
 
       client.http_get_paginated_array!('/test')
     end
+
+    it 'raises an exception if duplicate items are returned by the API' do
+      allow(client).to receive(:http_get!)
+        .with('/test?limit=20&page=1')
+        .and_return({ 'content' => [ 1, 2, 3, 1 ], 'metadata' => { 'totalPages' => 1 } }.to_json)
+
+      expect { client.http_get_paginated_array!('/test') }.to raise_error(Vra::Exception::DuplicateItemsDetected)
+    end
   end
 
   describe '#http_post' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vmware-vra
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Adam Leff
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-17 00:00:00.000000000 Z
+date: 2015-09-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client