Added automatic paging for all resources and added tests

lib/spaceship/client.rb

@@ -52,6 +52,29 @@ def api_key
       end
     end
 
+    # Automatic paging
+
+    def page_size
+      @page_size ||= 500
+    end
+
+    # Handles the paging for you... for free
+    # Just pass a block and use the parameter as page number
+    def paging
+      page = 0
+      results = []
+      loop do
+        page += 1
+        current = yield(page)
+
+        results = results + current
+
+        break if ((current || []).count < page_size) # no more results
+      end
+
+      return results
+    end
+
     ##
     # perform login procedure. this sets a cookie that will be used in subsequent requests
     # raises InvalidUserCredentialsError if authentication failed.
@@ -105,13 +128,15 @@ def current_team_id=(team_id)
     end
 
     def apps
-      r = request(:post, 'account/ios/identifiers/listAppIds.action', {
-        teamId: team_id,
-        pageNumber: 1,
-        pageSize: 500,
-        sort: 'name=asc'
-      })
-      parse_response(r, 'appIds')
+      paging do |page_number|
+        r = request(:post, 'account/ios/identifiers/listAppIds.action', {
+          teamId: team_id,
+          pageNumber: page_number,
+          pageSize: page_size,
+          sort: 'name=asc'
+        })
+        parse_response(r, 'appIds')
+      end
     end
 
     def create_app!(type, name, bundle_id)
@@ -153,24 +178,28 @@ def delete_app!(app_id)
     end
 
     def devices
-      r = request(:post, 'account/ios/device/listDevices.action', {
-        teamId: team_id,
-        pageNumber: 1,
-        pageSize: 500,
-        sort: 'name=asc'
-      })
-      parse_response(r, 'devices')
+      paging do |page_number|
+        r = request(:post, 'account/ios/device/listDevices.action', {
+          teamId: team_id,
+          pageNumber: page_number,
+          pageSize: page_size,
+          sort: 'name=asc'
+        })
+        parse_response(r, 'devices')
+      end
     end
 
     def certificates(types)
-      r = request(:post, 'account/ios/certificate/listCertRequests.action', {
-        teamId: team_id,
-        types: types.join(','),
-        pageNumber: 1,
-        pageSize: 500,
-        sort: 'certRequestStatusCode=asc'
-      })
-      parse_response(r, 'certRequests')
+      paging do |page_number|
+        r = request(:post, 'account/ios/certificate/listCertRequests.action', {
+          teamId: team_id,
+          types: types.join(','),
+          pageNumber: page_number,
+          pageSize: page_size,
+          sort: 'certRequestStatusCode=asc'
+        })
+        parse_response(r, 'certRequests')
+      end
     end
 
     def create_certificate!(type, csr, app_id = nil)

spec/client_spec.rb

@@ -77,6 +77,19 @@
       end
     end
 
+    describe "#paging" do
+      it "default page size is correct" do
+        expect(subject.page_size).to eq(500)
+      end
+
+      it "Properly pages if required with support for a custom page size", now: true do
+        allow(subject).to receive(:page_size).and_return(8)
+
+        expect(subject.devices.count).to eq(9)
+        expect(subject.devices.last['name']).to eq("The last phone")
+      end
+    end
+
     describe '#devices' do
       let(:devices) { subject.devices }
       it 'returns a list of device hashes' do

spec/fixtures/listDevicesPage1-2.action.json

@@ -0,0 +1,65 @@
+{
+  "creationTimestamp": "2015-05-24T16:37:32Z",
+  "resultCode": 0,
+  "userLocale": "en_US",
+  "protocolVersion": "QH65B2",
+  "requestId": null,
+  "requestUrl": "https://developer.apple.com:443//services-account/QH65B2/account/ios/device/listDevices.action",
+  "responseId": "881a1f34-bc13-425b-ae18-9f4f8fb40aaa",
+  "isAdmin": true,
+  "isMember": false,
+  "isAgent": true,
+  "pageNumber": 1,
+  "pageSize": 8,
+  "totalRecords": 9,
+  "httpResponseHeaders": null,
+  "devices": [{
+    "deviceId": "9T5RA84AAA",
+    "name": "Felix Krause's iPhone 6",
+    "deviceNumber": "aaabbbccccddddaaabbb",
+    "devicePlatform": "ios",
+    "status": "c"
+  }, {
+    "deviceId": "L4378H2AAA",
+    "name": "Felix's iPad",
+    "deviceNumber": "aaabbbccccddddaaabbb",
+    "devicePlatform": "ios",
+    "status": "c"
+  }, {
+    "deviceId": "LEL449RAAA",
+    "name": "4s",
+    "deviceNumber": "aaabbbccccddddaaabbb",
+    "devicePlatform": "ios",
+    "status": "c"
+  }, {
+    "deviceId": "S4227Y4AAA",
+    "name": "Simon iOS",
+    "deviceNumber": "aaabbbccccddddaaabbb",
+    "devicePlatform": "ios",
+    "status": "c"
+  }, {
+    "deviceId": "5YTNZ5AAAA",
+    "name": "iPhone 4S",
+    "deviceNumber": "aaabbbccccddddaaabbb",
+    "devicePlatform": "ios",
+    "status": "c"
+  }, {
+    "deviceId": "WXQ7V239BE",
+    "name": "iPhone 4s",
+    "deviceNumber": "aaabbbccccddddaaabbb",
+    "devicePlatform": "ios",
+    "status": "c"
+  }, {
+    "deviceId": "9K3WR66AAA",
+    "name": "MyName",
+    "deviceNumber": "aaabbbccccddddaaabbb",
+    "devicePlatform": "ios",
+    "status": "c"
+  }, {
+    "deviceId": "GD25LDGAAA",
+    "name": "iPhonekajsdf",
+    "deviceNumber": "aaabbbccccddddaaabbb",
+    "devicePlatform": "ios",
+    "status": "c"
+  }]
+}

spec/fixtures/listDevicesPage2-2.action.json

@@ -0,0 +1,23 @@
+{
+  "creationTimestamp": "2015-05-24T16:37:33Z",
+  "resultCode": 0,
+  "userLocale": "en_US",
+  "protocolVersion": "QH65B2",
+  "requestId": null,
+  "requestUrl": "https://developer.apple.com:443//services-account/QH65B2/account/ios/device/listDevices.action",
+  "responseId": "558ba377-d979-45c6-b2f8-ee6d2d692aaa",
+  "isAdmin": true,
+  "isMember": false,
+  "isAgent": true,
+  "pageNumber": 2,
+  "pageSize": 8,
+  "totalRecords": 9,
+  "httpResponseHeaders": null,
+  "devices": [{
+    "deviceId": "XJXGVS4AAAA",
+    "name": "The last phone",
+    "deviceNumber": "4c24a7ee5c8674847f49b4fb2d87483053faaaaa",
+    "devicePlatform": "ios",
+    "status": "c"
+  }]
+}

spec/spaceship_stubbing.rb

@@ -66,6 +66,16 @@ def stub_devices
   stub_request(:post, 'https://developer.apple.com/services-account/QH65B2/account/ios/device/listDevices.action').
     with(:body => {:teamId => 'XXXXXXXXXX', :pageSize => "500", :pageNumber => "1", :sort => 'name=asc'}, :headers => {'Cookie' => 'myacinfo=abcdef;'}).
     to_return(:status => 200, :body => read_fixture_file('listDevices.action.json'), :headers => {'Content-Type' => 'application/json'})
+
+  # Custom paging
+  stub_request(:post, "https://developer.apple.com/services-account/QH65B2/account/ios/device/listDevices.action").
+         with(:body => {"pageNumber"=>"1", "pageSize"=>"8", "sort"=>"name=asc", "teamId"=>"XXXXXXXXXX"},
+              :headers => {'Accept'=>'*/*', 'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', 'Content-Type'=>'application/x-www-form-urlencoded', 'Cookie'=>'myacinfo=abcdef;', 'User-Agent'=>'spaceship'}).
+         to_return(:status => 200, :body => read_fixture_file('listDevicesPage1-2.action.json'), :headers => {'Content-Type' => 'application/json'})
+  stub_request(:post, "https://developer.apple.com/services-account/QH65B2/account/ios/device/listDevices.action").
+         with(:body => {"pageNumber"=>"2", "pageSize"=>"8", "sort"=>"name=asc", "teamId"=>"XXXXXXXXXX"},
+              :headers => {'Accept'=>'*/*', 'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', 'Content-Type'=>'application/x-www-form-urlencoded', 'Cookie'=>'myacinfo=abcdef;', 'User-Agent'=>'spaceship'}).
+         to_return(:status => 200, :body => read_fixture_file('listDevicesPage2-2.action.json'), :headers => {'Content-Type' => 'application/json'})
 end
 
 def stub_certificates