Merge pull request #246 from zenizh/get-follower-with-limit

Get the follower ids with a limit

Author: kimoto

lib/line/bot/client.rb

@@ -333,15 +333,22 @@ def get_room_member_profile(room_id, user_id)
 
       # Get user IDs of who added your LINE Official Account as a friend
       #
-      # @param continuation_token [String] Identifier to return next page
-      #                                   (next property to be included in the response)
+      # @param start [String] Identifier to return next page (next property to be included in the response)
+      # @param limit [Integer] The maximum number of user IDs to retrieve in a single request
       #
       # @return [Net::HTTPResponse]
-      def get_follower_ids(continuation_token = nil)
+      def get_follower_ids(deprecated_continuation_token = nil, start: nil, limit: nil)
         channel_token_required
 
+        if deprecated_continuation_token
+          warn "continuation_token as the first argument is deprecated. Please use :start instead."
+          start = deprecated_continuation_token
+        end
+
+        params = { start: start, limit: limit }.compact
+
         endpoint_path = "/bot/followers/ids"
-        endpoint_path += "?start=#{continuation_token}" if continuation_token
+        endpoint_path += "?" + URI.encode_www_form(params) unless params.empty?
         get(endpoint, endpoint_path, credentials)
       end
 

spec/line/bot/client_get_follower_spec.rb

@@ -23,6 +23,15 @@
 }
 EOS
 
+LIMITED_USER_ID_CONTENT = <<"EOS"
+{
+    "userIds": [
+        "Uxxxxxxxxxxxxxx1",
+        "Uxxxxxxxxxxxxxx2"
+    ]
+}
+EOS
+
 describe Line::Bot::Client do
   def dummy_config
     {
@@ -42,7 +51,57 @@ def generate_client
     uri_template = Addressable::Template.new Line::Bot::API::DEFAULT_ENDPOINT + '/bot/followers/ids'
     stub_request(:get, uri_template).to_return { |request| {body: USER_ID_CONTENT, status: 200} }
 
-    uri_template = Addressable::Template.new Line::Bot::API::DEFAULT_ENDPOINT + '/bot/followers/ids?start={continuationToken}'
+    uri_template = Addressable::Template.new Line::Bot::API::DEFAULT_ENDPOINT + '/bot/followers/ids?start={start}'
+    stub_request(:get, uri_template).to_return { |request| {body: NEXT_USER_ID_CONTENT, status: 200} }
+
+    client = generate_client
+
+    # first page
+    response = client.get_follower_ids
+
+    expect(response).to be_a(Net::HTTPOK)
+    result = JSON.parse(response.body)
+    expect(result['userIds']).to eq ["Uxxxxxxxxxxxxxx1", "Uxxxxxxxxxxxxxx2", "Uxxxxxxxxxxxxxx3"]
+    expect(result['next']).to eq "jxEWCEEP"
+
+    # second page
+    response = client.get_follower_ids(start: result['next'])
+
+    expect(response).to be_a(Net::HTTPOK)
+    result = JSON.parse(response.body)
+    expect(result['userIds']).to eq ["Uxxxxxxxxxxxxxx4", "Uxxxxxxxxxxxxxx5", "Uxxxxxxxxxxxxxx6"]
+    expect(result['next']).to be nil
+  end
+
+  it 'gets limited number of follower ids' do
+    # without any other conditions
+    uri_template = Addressable::Template.new Line::Bot::API::DEFAULT_ENDPOINT + '/bot/followers/ids?limit={limit}'
+    stub_request(:get, uri_template).to_return { |request| {body: LIMITED_USER_ID_CONTENT, status: 200} }
+
+    # with other conditions
+    uri_template = Addressable::Template.new Line::Bot::API::DEFAULT_ENDPOINT + '/bot/followers/ids?limit={limit}&start={start}'
+    stub_request(:get, uri_template).to_return { |request| {body: LIMITED_USER_ID_CONTENT, status: 200} }
+
+    client = generate_client
+
+    # without any other conditions
+    response = client.get_follower_ids(limit: 2)
+    result = JSON.parse(response.body)
+    expect(response).to be_a(Net::HTTPOK)
+    expect(result['userIds']).to eq ["Uxxxxxxxxxxxxxx1", "Uxxxxxxxxxxxxxx2"]
+
+    # with other conditions
+    response = client.get_follower_ids(start: 'foo', limit: 2)
+    result = JSON.parse(response.body)
+    expect(response).to be_a(Net::HTTPOK)
+    expect(result['userIds']).to eq ["Uxxxxxxxxxxxxxx1", "Uxxxxxxxxxxxxxx2"]
+  end
+
+  it 'gets follower ids using deprecated_continuation_token argument' do
+    uri_template = Addressable::Template.new Line::Bot::API::DEFAULT_ENDPOINT + '/bot/followers/ids'
+    stub_request(:get, uri_template).to_return { |request| {body: USER_ID_CONTENT, status: 200} }
+
+    uri_template = Addressable::Template.new Line::Bot::API::DEFAULT_ENDPOINT + '/bot/followers/ids?start={start}'
     stub_request(:get, uri_template).to_return { |request| {body: NEXT_USER_ID_CONTENT, status: 200} }
 
     client = generate_client